Apply 'interface-name' lint rule (microsoft#19695)

Andy · web-flow · commit f67a9ba96e26 · 2017-11-02T17:20:18.000-07:00
diff --git a/Gulpfile.ts b/Gulpfile.ts
@@ -1106,7 +1106,7 @@ gulp.task("lint", "Runs tslint on the compiler sources. Optional arguments are:
     const fileMatcher = cmdLineOptions.files;
     const files = fileMatcher
         ? `src/**/${fileMatcher}`
-        : "Gulpfile.ts 'scripts/generateLocalizedDiagnosticMessages.ts' 'scripts/tslint/**/*.ts' 'src/**/*.ts' --exclude src/lib/es5.d.ts --exclude 'src/lib/*.generated.d.ts'";
+        : "Gulpfile.ts 'scripts/generateLocalizedDiagnosticMessages.ts' 'scripts/tslint/**/*.ts' 'src/**/*.ts' --exclude 'src/lib/*.d.ts'";
     const cmd = `node node_modules/tslint/bin/tslint ${files} --formatters-dir ./built/local/tslint/formatters --format autolinkableStylish`;
     console.log("Linting: " + cmd);
     child_process.execSync(cmd, { stdio: [0, 1, 2] });
diff --git a/Jakefile.js b/Jakefile.js
@@ -1283,7 +1283,7 @@ task("lint", ["build-rules"], () => {
     const fileMatcher = process.env.f || process.env.file || process.env.files;
     const files = fileMatcher
         ? `src/**/${fileMatcher}`
-        : "Gulpfile.ts 'scripts/generateLocalizedDiagnosticMessages.ts' 'scripts/tslint/**/*.ts' 'src/**/*.ts' --exclude src/lib/es5.d.ts --exclude 'src/lib/*.generated.d.ts'";
+        : "Gulpfile.ts 'scripts/generateLocalizedDiagnosticMessages.ts' 'scripts/tslint/**/*.ts' 'src/**/*.ts' --exclude 'src/lib/*.d.ts'";
     const cmd = `node node_modules/tslint/bin/tslint ${files} --formatters-dir ./built/local/tslint/formatters --format autolinkableStylish`;
     console.log("Linting: " + cmd);
     jake.exec([cmd], { interactive: true }, () => {
diff --git a/src/harness/harness.ts b/src/harness/harness.ts
@@ -479,7 +479,7 @@ namespace Utils {
 }
 
 namespace Harness {
-    export interface IO {
+    export interface Io {
         newLine(): string;
         getCurrentDirectory(): string;
         useCaseSensitiveFileNames(): boolean;
@@ -502,7 +502,7 @@ namespace Harness {
         tryEnableSourceMapsForHost?(): void;
         getEnvironmentVariable?(name: string): string;
     }
-    export let IO: IO;
+    export let IO: Io;
 
     // harness always uses one kind of new line
     // But note that `parseTestData` in `fourslash.ts` uses "\n"
@@ -2151,7 +2151,7 @@ namespace Harness {
         return filePath.indexOf(Harness.libFolder) === 0;
     }
 
-    export function getDefaultLibraryFile(io: Harness.IO): Harness.Compiler.TestFile {
+    export function getDefaultLibraryFile(io: Harness.Io): Harness.Compiler.TestFile {
         const libFile = Harness.userSpecifiedRoot + Harness.libFolder + Harness.Compiler.defaultLibFileName;
         return { unitName: libFile, content: io.readFile(libFile) };
     }
diff --git a/src/harness/harnessLanguageService.ts b/src/harness/harnessLanguageService.ts
@@ -544,9 +544,9 @@ namespace Harness.LanguageService {
         getClassifier(): ts.Classifier { return new ClassifierShimProxy(this.factory.createClassifierShim(this.host)); }
         getPreProcessedFileInfo(fileName: string, fileContents: string): ts.PreProcessedFileInfo {
             let shimResult: {
-                referencedFiles: ts.IFileReference[];
-                typeReferenceDirectives: ts.IFileReference[];
-                importedFiles: ts.IFileReference[];
+                referencedFiles: ts.ShimsFileReference[];
+                typeReferenceDirectives: ts.ShimsFileReference[];
+                importedFiles: ts.ShimsFileReference[];
                 isLibFile: boolean;
             };
 
diff --git a/src/harness/loggedIO.ts b/src/harness/loggedIO.ts
@@ -14,19 +14,19 @@ interface FileInformation {
 interface FindFileResult {
 }
 
-interface IOLogFile {
+interface IoLogFile {
     path: string;
     codepage: number;
     result?: FileInformation;
 }
 
-interface IOLog {
+interface IoLog {
     timestamp: string;
     arguments: string[];
     executingPath: string;
     currentDirectory: string;
     useCustomLibraryFile?: boolean;
-    filesRead: IOLogFile[];
+    filesRead: IoLogFile[];
     filesWritten: {
         path: string;
         contents?: string;
@@ -80,16 +80,16 @@ interface IOLog {
 interface PlaybackControl {
     startReplayFromFile(logFileName: string): void;
     startReplayFromString(logContents: string): void;
-    startReplayFromData(log: IOLog): void;
+    startReplayFromData(log: IoLog): void;
     endReplay(): void;
     startRecord(logFileName: string): void;
     endRecord(): void;
 }
 
 namespace Playback {
-    let recordLog: IOLog = undefined;
-    let replayLog: IOLog = undefined;
-    let replayFilesRead: ts.Map<IOLogFile> | undefined = undefined;
+    let recordLog: IoLog = undefined;
+    let replayLog: IoLog = undefined;
+    let replayFilesRead: ts.Map<IoLogFile> | undefined = undefined;
     let recordLogFileNameBase = "";
 
     interface Memoized<T> {
@@ -110,11 +110,11 @@ namespace Playback {
         return run;
     }
 
-    export interface PlaybackIO extends Harness.IO, PlaybackControl { }
+    export interface PlaybackIO extends Harness.Io, PlaybackControl { }
 
     export interface PlaybackSystem extends ts.System, PlaybackControl { }
 
-    function createEmptyLog(): IOLog {
+    function createEmptyLog(): IoLog {
         return {
             timestamp: (new Date()).toString(),
             arguments: [],
@@ -134,7 +134,7 @@ namespace Playback {
         };
     }
 
-    export function newStyleLogIntoOldStyleLog(log: IOLog, host: ts.System | Harness.IO, baseName: string) {
+    export function newStyleLogIntoOldStyleLog(log: IoLog, host: ts.System | Harness.Io, baseName: string) {
         for (const file of log.filesAppended) {
             if (file.contentsPath) {
                 file.contents = host.readFile(ts.combinePaths(baseName, file.contentsPath));
@@ -167,7 +167,7 @@ namespace Playback {
         return path;
     }
 
-    export function oldStyleLogIntoNewStyleLog(log: IOLog, writeFile: typeof Harness.IO.writeFile, baseTestName: string) {
+    export function oldStyleLogIntoNewStyleLog(log: IoLog, writeFile: typeof Harness.IO.writeFile, baseTestName: string) {
         if (log.filesAppended) {
             for (const file of log.filesAppended) {
                 if (file.contents !== undefined) {
@@ -210,8 +210,8 @@ namespace Playback {
     }
 
     function initWrapper(wrapper: PlaybackSystem, underlying: ts.System): void;
-    function initWrapper(wrapper: PlaybackIO, underlying: Harness.IO): void;
-    function initWrapper(wrapper: PlaybackSystem | PlaybackIO, underlying: ts.System | Harness.IO): void {
+    function initWrapper(wrapper: PlaybackIO, underlying: Harness.Io): void;
+    function initWrapper(wrapper: PlaybackSystem | PlaybackIO, underlying: ts.System | Harness.Io): void {
         ts.forEach(Object.keys(underlying), prop => {
             (<any>wrapper)[prop] = (<any>underlying)[prop];
         });
@@ -261,7 +261,7 @@ namespace Playback {
             }
         };
 
-        function generateTsconfig(newLog: IOLog): undefined | { compilerOptions: ts.CompilerOptions, files: string[] } {
+        function generateTsconfig(newLog: IoLog): undefined | { compilerOptions: ts.CompilerOptions, files: string[] } {
             if (newLog.filesRead.some(file => /tsconfig.+json$/.test(file.path))) {
                 return;
             }
@@ -426,7 +426,7 @@ namespace Playback {
         // console.log("Swallowed write operation during replay: " + name);
     }
 
-    export function wrapIO(underlying: Harness.IO): PlaybackIO {
+    export function wrapIO(underlying: Harness.Io): PlaybackIO {
         const wrapper: PlaybackIO = <any>{};
         initWrapper(wrapper, underlying);
 
diff --git a/src/harness/rwcRunner.ts b/src/harness/rwcRunner.ts
@@ -6,7 +6,7 @@
 /* tslint:disable:no-null-keyword */
 
 namespace RWC {
-    function runWithIOLog(ioLog: IOLog, fn: (oldIO: Harness.IO) => void) {
+    function runWithIOLog(ioLog: IoLog, fn: (oldIO: Harness.Io) => void) {
         const oldIO = Harness.IO;
 
         const wrappedIO = Playback.wrapIO(oldIO);
@@ -58,7 +58,7 @@ namespace RWC {
                 this.timeout(800000); // Allow long timeouts for RWC compilations
                 let opts: ts.ParsedCommandLine;
 
-                const ioLog: IOLog = Playback.newStyleLogIntoOldStyleLog(JSON.parse(Harness.IO.readFile(`internal/cases/rwc/${jsonPath}/test.json`)), Harness.IO, `internal/cases/rwc/${baseName}`);
+                const ioLog: IoLog = Playback.newStyleLogIntoOldStyleLog(JSON.parse(Harness.IO.readFile(`internal/cases/rwc/${jsonPath}/test.json`)), Harness.IO, `internal/cases/rwc/${baseName}`);
                 currentDirectory = ioLog.currentDirectory;
                 useCustomLibraryFile = ioLog.useCustomLibraryFile;
                 runWithIOLog(ioLog, () => {
diff --git a/src/server/scriptVersionCache.ts b/src/server/scriptVersionCache.ts
@@ -10,7 +10,7 @@ namespace ts.server {
         charCount(): number;
         lineCount(): number;
         isLeaf(): this is LineLeaf;
-        walk(rangeStart: number, rangeLength: number, walkFns: ILineIndexWalker): void;
+        walk(rangeStart: number, rangeLength: number, walkFns: LineIndexWalker): void;
     }
 
     export interface AbsolutePositionAndLineText {
@@ -27,7 +27,7 @@ namespace ts.server {
         PostEnd
     }
 
-    interface ILineIndexWalker {
+    interface LineIndexWalker {
         goSubtree: boolean;
         done: boolean;
         leaf(relativeStart: number, relativeLength: number, lineCollection: LineLeaf): void;
@@ -37,7 +37,7 @@ namespace ts.server {
             parent: LineNode, nodeType: CharRangeSection): void;
     }
 
-    class EditWalker implements ILineIndexWalker {
+    class EditWalker implements LineIndexWalker {
         goSubtree = true;
         get done() { return false; }
 
@@ -429,7 +429,7 @@ namespace ts.server {
             }
         }
 
-        walk(rangeStart: number, rangeLength: number, walkFns: ILineIndexWalker) {
+        walk(rangeStart: number, rangeLength: number, walkFns: LineIndexWalker) {
             this.root.walk(rangeStart, rangeLength, walkFns);
         }
 
@@ -458,7 +458,7 @@ namespace ts.server {
             const walkFns = {
                 goSubtree: true,
                 done: false,
-                leaf(this: ILineIndexWalker, relativeStart: number, relativeLength: number, ll: LineLeaf) {
+                leaf(this: LineIndexWalker, relativeStart: number, relativeLength: number, ll: LineLeaf) {
                     if (!f(ll, relativeStart, relativeLength)) {
                         this.done = true;
                     }
@@ -580,7 +580,7 @@ namespace ts.server {
             }
         }
 
-        private execWalk(rangeStart: number, rangeLength: number, walkFns: ILineIndexWalker, childIndex: number, nodeType: CharRangeSection) {
+        private execWalk(rangeStart: number, rangeLength: number, walkFns: LineIndexWalker, childIndex: number, nodeType: CharRangeSection) {
             if (walkFns.pre) {
                 walkFns.pre(rangeStart, rangeLength, this.children[childIndex], this, nodeType);
             }
@@ -596,14 +596,14 @@ namespace ts.server {
             return walkFns.done;
         }
 
-        private skipChild(relativeStart: number, relativeLength: number, childIndex: number, walkFns: ILineIndexWalker, nodeType: CharRangeSection) {
+        private skipChild(relativeStart: number, relativeLength: number, childIndex: number, walkFns: LineIndexWalker, nodeType: CharRangeSection) {
             if (walkFns.pre && (!walkFns.done)) {
                 walkFns.pre(relativeStart, relativeLength, this.children[childIndex], this, nodeType);
                 walkFns.goSubtree = true;
             }
         }
 
-        walk(rangeStart: number, rangeLength: number, walkFns: ILineIndexWalker) {
+        walk(rangeStart: number, rangeLength: number, walkFns: LineIndexWalker) {
             // assume (rangeStart < this.totalChars) && (rangeLength <= this.totalChars)
             let childIndex = 0;
             let childCharCount = this.children[childIndex].charCount();
@@ -814,7 +814,7 @@ namespace ts.server {
             return true;
         }
 
-        walk(rangeStart: number, rangeLength: number, walkFns: ILineIndexWalker) {
+        walk(rangeStart: number, rangeLength: number, walkFns: LineIndexWalker) {
             walkFns.leaf(rangeStart, rangeLength, this);
         }
 
diff --git a/src/server/server.ts b/src/server/server.ts
@@ -3,7 +3,7 @@
 /// <reference path="session.ts" />
 
 namespace ts.server {
-    interface IOSessionOptions {
+    interface IoSessionOptions {
         host: ServerHost;
         cancellationToken: ServerCancellationToken;
         canUseEvents: boolean;
@@ -529,7 +529,7 @@ namespace ts.server {
     }
 
     class IOSession extends Session {
-        constructor(options: IOSessionOptions) {
+        constructor(options: IoSessionOptions) {
             const { host, installerEventPort, globalTypingsCacheLocation, typingSafeListLocation, typesMapLocation, npmLocation, canUseEvents } = options;
             const typingsInstaller = disableAutomaticTypingAcquisition
                 ? undefined
@@ -933,7 +933,7 @@ namespace ts.server {
     const disableAutomaticTypingAcquisition = hasArgument("--disableAutomaticTypingAcquisition");
     const telemetryEnabled = hasArgument(Arguments.EnableTelemetry);
 
-    const options: IOSessionOptions = {
+    const options: IoSessionOptions = {
         host: sys,
         cancellationToken,
         installerEventPort: eventPort,
diff --git a/src/server/typingsCache.ts b/src/server/typingsCache.ts
@@ -5,6 +5,7 @@ namespace ts.server {
         projectRootPath: Path;
     }
 
+    // tslint:disable-next-line interface-name (for backwards-compatibility)
     export interface ITypingsInstaller {
         isKnownTypesPackageName(name: string): boolean;
         installPackage(options: InstallPackageOptionsWithProjectRootPath): Promise<ApplyCodeActionCommandResult>;
diff --git a/src/services/shims.ts b/src/services/shims.ts
@@ -106,7 +106,7 @@ namespace ts {
     ///
     // Note: This is being using by the host (VS) and is marshaled back and forth.
     // When changing this make sure the changes are reflected in the managed side as well
-    export interface IFileReference {
+    export interface ShimsFileReference {
         path: string;
         position: number;
         length: number;
@@ -1104,11 +1104,11 @@ namespace ts {
             );
         }
 
-        private convertFileReferences(refs: FileReference[]): IFileReference[] {
+        private convertFileReferences(refs: FileReference[]): ShimsFileReference[] {
             if (!refs) {
                 return undefined;
             }
-            const result: IFileReference[] = [];
+            const result: ShimsFileReference[] = [];
             for (const ref of refs) {
                 result.push({
                     path: normalizeSlashes(ref.fileName),
diff --git a/src/services/types.ts b/src/services/types.ts
@@ -86,6 +86,7 @@ namespace ts {
      * snapshot is observably immutable. i.e. the same calls with the same parameters will return
      * the same values.
      */
+    // tslint:disable-next-line interface-name
     export interface IScriptSnapshot {
         /** Gets a portion of the script snapshot specified by [start, end). */
         getText(start: number, end: number): string;
diff --git a/tslint.json b/tslint.json
@@ -13,6 +13,7 @@
         "indent": [true,
             "spaces"
         ],
+        "interface-name": [true, "never-prefix"],
         "interface-over-type-literal": true,
         "jsdoc-format": true,
         "linebreak-style": [true, "CRLF"],
@@ -110,7 +111,6 @@
         "no-consecutive-blank-lines": false,
 
         // Not doing
-        "interface-name": false,
         "max-classes-per-file": false,
         "member-ordering": false,
         "no-angle-bracket-type-assertion": false,

Original file line number	Diff line number	Diff line change
`@@ -479,7 +479,7 @@ namespace Utils {`
`479`	`479`	`}`
`480`	`480`
`481`	`481`	`namespace Harness {`
`482`		`- export interface IO {`
	`482`	`+ export interface Io {`
`483`	`483`	`newLine(): string;`
`484`	`484`	`getCurrentDirectory(): string;`
`485`	`485`	`useCaseSensitiveFileNames(): boolean;`
`@@ -502,7 +502,7 @@ namespace Harness {`
`502`	`502`	`tryEnableSourceMapsForHost?(): void;`
`503`	`503`	`getEnvironmentVariable?(name: string): string;`
`504`	`504`	`}`
`505`		`- export let IO: IO;`
	`505`	`+ export let IO: Io;`
`506`	`506`
`507`	`507`	`// harness always uses one kind of new line`
`508`	`508`	// But note that `parseTestData` in `fourslash.ts` uses "\n"
`@@ -2151,7 +2151,7 @@ namespace Harness {`
`2151`	`2151`	`return filePath.indexOf(Harness.libFolder) === 0;`
`2152`	`2152`	`}`
`2153`	`2153`
`2154`		`- export function getDefaultLibraryFile(io: Harness.IO): Harness.Compiler.TestFile {`
	`2154`	`+ export function getDefaultLibraryFile(io: Harness.Io): Harness.Compiler.TestFile {`
`2155`	`2155`	`const libFile = Harness.userSpecifiedRoot + Harness.libFolder + Harness.Compiler.defaultLibFileName;`
`2156`	`2156`	`return { unitName: libFile, content: io.readFile(libFile) };`
`2157`	`2157`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ namespace ts.server {`
`10`	`10`	`charCount(): number;`
`11`	`11`	`lineCount(): number;`
`12`	`12`	`isLeaf(): this is LineLeaf;`
`13`		`- walk(rangeStart: number, rangeLength: number, walkFns: ILineIndexWalker): void;`
	`13`	`+ walk(rangeStart: number, rangeLength: number, walkFns: LineIndexWalker): void;`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`export interface AbsolutePositionAndLineText {`
`@@ -27,7 +27,7 @@ namespace ts.server {`
`27`	`27`	`PostEnd`
`28`	`28`	`}`
`29`	`29`
`30`		`- interface ILineIndexWalker {`
	`30`	`+ interface LineIndexWalker {`
`31`	`31`	`goSubtree: boolean;`
`32`	`32`	`done: boolean;`
`33`	`33`	`leaf(relativeStart: number, relativeLength: number, lineCollection: LineLeaf): void;`
`@@ -37,7 +37,7 @@ namespace ts.server {`
`37`	`37`	`parent: LineNode, nodeType: CharRangeSection): void;`
`38`	`38`	`}`
`39`	`39`
`40`		`- class EditWalker implements ILineIndexWalker {`
	`40`	`+ class EditWalker implements LineIndexWalker {`
`41`	`41`	`goSubtree = true;`
`42`	`42`	`get done() { return false; }`
`43`	`43`
`@@ -429,7 +429,7 @@ namespace ts.server {`
`429`	`429`	`}`
`430`	`430`	`}`
`431`	`431`
`432`		`- walk(rangeStart: number, rangeLength: number, walkFns: ILineIndexWalker) {`
	`432`	`+ walk(rangeStart: number, rangeLength: number, walkFns: LineIndexWalker) {`
`433`	`433`	`this.root.walk(rangeStart, rangeLength, walkFns);`
`434`	`434`	`}`
`435`	`435`
`@@ -458,7 +458,7 @@ namespace ts.server {`
`458`	`458`	`const walkFns = {`
`459`	`459`	`goSubtree: true,`
`460`	`460`	`done: false,`
`461`		`- leaf(this: ILineIndexWalker, relativeStart: number, relativeLength: number, ll: LineLeaf) {`
	`461`	`+ leaf(this: LineIndexWalker, relativeStart: number, relativeLength: number, ll: LineLeaf) {`
`462`	`462`	`if (!f(ll, relativeStart, relativeLength)) {`
`463`	`463`	`this.done = true;`
`464`	`464`	`}`
`@@ -580,7 +580,7 @@ namespace ts.server {`
`580`	`580`	`}`
`581`	`581`	`}`
`582`	`582`
`583`		`- private execWalk(rangeStart: number, rangeLength: number, walkFns: ILineIndexWalker, childIndex: number, nodeType: CharRangeSection) {`
	`583`	`+ private execWalk(rangeStart: number, rangeLength: number, walkFns: LineIndexWalker, childIndex: number, nodeType: CharRangeSection) {`
`584`	`584`	`if (walkFns.pre) {`
`585`	`585`	`walkFns.pre(rangeStart, rangeLength, this.children[childIndex], this, nodeType);`
`586`	`586`	`}`
`@@ -596,14 +596,14 @@ namespace ts.server {`
`596`	`596`	`return walkFns.done;`
`597`	`597`	`}`
`598`	`598`
`599`		`- private skipChild(relativeStart: number, relativeLength: number, childIndex: number, walkFns: ILineIndexWalker, nodeType: CharRangeSection) {`
	`599`	`+ private skipChild(relativeStart: number, relativeLength: number, childIndex: number, walkFns: LineIndexWalker, nodeType: CharRangeSection) {`
`600`	`600`	`if (walkFns.pre && (!walkFns.done)) {`
`601`	`601`	`walkFns.pre(relativeStart, relativeLength, this.children[childIndex], this, nodeType);`
`602`	`602`	`walkFns.goSubtree = true;`
`603`	`603`	`}`
`604`	`604`	`}`
`605`	`605`
`606`		`- walk(rangeStart: number, rangeLength: number, walkFns: ILineIndexWalker) {`
	`606`	`+ walk(rangeStart: number, rangeLength: number, walkFns: LineIndexWalker) {`
`607`	`607`	`// assume (rangeStart < this.totalChars) && (rangeLength <= this.totalChars)`
`608`	`608`	`let childIndex = 0;`
`609`	`609`	`let childCharCount = this.children[childIndex].charCount();`
`@@ -814,7 +814,7 @@ namespace ts.server {`
`814`	`814`	`return true;`
`815`	`815`	`}`
`816`	`816`
`817`		`- walk(rangeStart: number, rangeLength: number, walkFns: ILineIndexWalker) {`
	`817`	`+ walk(rangeStart: number, rangeLength: number, walkFns: LineIndexWalker) {`
`818`	`818`	`walkFns.leaf(rangeStart, rangeLength, this);`
`819`	`819`	`}`
`820`	`820`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ namespace ts.server {`
`5`	`5`	`projectRootPath: Path;`
`6`	`6`	`}`
`7`	`7`
	`8`	`+ // tslint:disable-next-line interface-name (for backwards-compatibility)`
`8`	`9`	`export interface ITypingsInstaller {`
`9`	`10`	`isKnownTypesPackageName(name: string): boolean;`
`10`	`11`	`installPackage(options: InstallPackageOptionsWithProjectRootPath): Promise<ApplyCodeActionCommandResult>;`