Skip to content

Commit f67a9ba

Browse files
author
Andy
authored
Apply 'interface-name' lint rule (#19695)
1 parent c70eae4 commit f67a9ba

12 files changed

+43
-41
lines changed

‎Gulpfile.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1106,7 +1106,7 @@ gulp.task("lint", "Runs tslint on the compiler sources. Optional arguments are:
11061106
const fileMatcher = cmdLineOptions.files;
11071107
const files = fileMatcher
11081108
? `src/**/${fileMatcher}`
1109-
: "Gulpfile.ts 'scripts/generateLocalizedDiagnosticMessages.ts' 'scripts/tslint/**/*.ts' 'src/**/*.ts' --exclude src/lib/es5.d.ts --exclude 'src/lib/*.generated.d.ts'";
1109+
: "Gulpfile.ts 'scripts/generateLocalizedDiagnosticMessages.ts' 'scripts/tslint/**/*.ts' 'src/**/*.ts' --exclude 'src/lib/*.d.ts'";
11101110
const cmd = `node node_modules/tslint/bin/tslint ${files} --formatters-dir ./built/local/tslint/formatters --format autolinkableStylish`;
11111111
console.log("Linting: " + cmd);
11121112
child_process.execSync(cmd, { stdio: [0, 1, 2] });

‎Jakefile.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1283,7 +1283,7 @@ task("lint", ["build-rules"], () => {
12831283
const fileMatcher = process.env.f || process.env.file || process.env.files;
12841284
const files = fileMatcher
12851285
? `src/**/${fileMatcher}`
1286-
: "Gulpfile.ts 'scripts/generateLocalizedDiagnosticMessages.ts' 'scripts/tslint/**/*.ts' 'src/**/*.ts' --exclude src/lib/es5.d.ts --exclude 'src/lib/*.generated.d.ts'";
1286+
: "Gulpfile.ts 'scripts/generateLocalizedDiagnosticMessages.ts' 'scripts/tslint/**/*.ts' 'src/**/*.ts' --exclude 'src/lib/*.d.ts'";
12871287
const cmd = `node node_modules/tslint/bin/tslint ${files} --formatters-dir ./built/local/tslint/formatters --format autolinkableStylish`;
12881288
console.log("Linting: " + cmd);
12891289
jake.exec([cmd], { interactive: true }, () => {

‎src/harness/harness.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -479,7 +479,7 @@ namespace Utils {
479479
}
480480

481481
namespace Harness {
482-
export interface IO {
482+
export interface Io {
483483
newLine(): string;
484484
getCurrentDirectory(): string;
485485
useCaseSensitiveFileNames(): boolean;
@@ -502,7 +502,7 @@ namespace Harness {
502502
tryEnableSourceMapsForHost?(): void;
503503
getEnvironmentVariable?(name: string): string;
504504
}
505-
export let IO: IO;
505+
export let IO: Io;
506506

507507
// harness always uses one kind of new line
508508
// But note that `parseTestData` in `fourslash.ts` uses "\n"
@@ -2151,7 +2151,7 @@ namespace Harness {
21512151
return filePath.indexOf(Harness.libFolder) === 0;
21522152
}
21532153

2154-
export function getDefaultLibraryFile(io: Harness.IO): Harness.Compiler.TestFile {
2154+
export function getDefaultLibraryFile(io: Harness.Io): Harness.Compiler.TestFile {
21552155
const libFile = Harness.userSpecifiedRoot + Harness.libFolder + Harness.Compiler.defaultLibFileName;
21562156
return { unitName: libFile, content: io.readFile(libFile) };
21572157
}

‎src/harness/harnessLanguageService.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -544,9 +544,9 @@ namespace Harness.LanguageService {
544544
getClassifier(): ts.Classifier { return new ClassifierShimProxy(this.factory.createClassifierShim(this.host)); }
545545
getPreProcessedFileInfo(fileName: string, fileContents: string): ts.PreProcessedFileInfo {
546546
let shimResult: {
547-
referencedFiles: ts.IFileReference[];
548-
typeReferenceDirectives: ts.IFileReference[];
549-
importedFiles: ts.IFileReference[];
547+
referencedFiles: ts.ShimsFileReference[];
548+
typeReferenceDirectives: ts.ShimsFileReference[];
549+
importedFiles: ts.ShimsFileReference[];
550550
isLibFile: boolean;
551551
};
552552

‎src/harness/loggedIO.ts

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,19 @@ interface FileInformation {
1414
interface FindFileResult {
1515
}
1616

17-
interface IOLogFile {
17+
interface IoLogFile {
1818
path: string;
1919
codepage: number;
2020
result?: FileInformation;
2121
}
2222

23-
interface IOLog {
23+
interface IoLog {
2424
timestamp: string;
2525
arguments: string[];
2626
executingPath: string;
2727
currentDirectory: string;
2828
useCustomLibraryFile?: boolean;
29-
filesRead: IOLogFile[];
29+
filesRead: IoLogFile[];
3030
filesWritten: {
3131
path: string;
3232
contents?: string;
@@ -80,16 +80,16 @@ interface IOLog {
8080
interface PlaybackControl {
8181
startReplayFromFile(logFileName: string): void;
8282
startReplayFromString(logContents: string): void;
83-
startReplayFromData(log: IOLog): void;
83+
startReplayFromData(log: IoLog): void;
8484
endReplay(): void;
8585
startRecord(logFileName: string): void;
8686
endRecord(): void;
8787
}
8888

8989
namespace Playback {
90-
let recordLog: IOLog = undefined;
91-
let replayLog: IOLog = undefined;
92-
let replayFilesRead: ts.Map<IOLogFile> | undefined = undefined;
90+
let recordLog: IoLog = undefined;
91+
let replayLog: IoLog = undefined;
92+
let replayFilesRead: ts.Map<IoLogFile> | undefined = undefined;
9393
let recordLogFileNameBase = "";
9494

9595
interface Memoized<T> {
@@ -110,11 +110,11 @@ namespace Playback {
110110
return run;
111111
}
112112

113-
export interface PlaybackIO extends Harness.IO, PlaybackControl { }
113+
export interface PlaybackIO extends Harness.Io, PlaybackControl { }
114114

115115
export interface PlaybackSystem extends ts.System, PlaybackControl { }
116116

117-
function createEmptyLog(): IOLog {
117+
function createEmptyLog(): IoLog {
118118
return {
119119
timestamp: (new Date()).toString(),
120120
arguments: [],
@@ -134,7 +134,7 @@ namespace Playback {
134134
};
135135
}
136136

137-
export function newStyleLogIntoOldStyleLog(log: IOLog, host: ts.System | Harness.IO, baseName: string) {
137+
export function newStyleLogIntoOldStyleLog(log: IoLog, host: ts.System | Harness.Io, baseName: string) {
138138
for (const file of log.filesAppended) {
139139
if (file.contentsPath) {
140140
file.contents = host.readFile(ts.combinePaths(baseName, file.contentsPath));
@@ -167,7 +167,7 @@ namespace Playback {
167167
return path;
168168
}
169169

170-
export function oldStyleLogIntoNewStyleLog(log: IOLog, writeFile: typeof Harness.IO.writeFile, baseTestName: string) {
170+
export function oldStyleLogIntoNewStyleLog(log: IoLog, writeFile: typeof Harness.IO.writeFile, baseTestName: string) {
171171
if (log.filesAppended) {
172172
for (const file of log.filesAppended) {
173173
if (file.contents !== undefined) {
@@ -210,8 +210,8 @@ namespace Playback {
210210
}
211211

212212
function initWrapper(wrapper: PlaybackSystem, underlying: ts.System): void;
213-
function initWrapper(wrapper: PlaybackIO, underlying: Harness.IO): void;
214-
function initWrapper(wrapper: PlaybackSystem | PlaybackIO, underlying: ts.System | Harness.IO): void {
213+
function initWrapper(wrapper: PlaybackIO, underlying: Harness.Io): void;
214+
function initWrapper(wrapper: PlaybackSystem | PlaybackIO, underlying: ts.System | Harness.Io): void {
215215
ts.forEach(Object.keys(underlying), prop => {
216216
(<any>wrapper)[prop] = (<any>underlying)[prop];
217217
});
@@ -261,7 +261,7 @@ namespace Playback {
261261
}
262262
};
263263

264-
function generateTsconfig(newLog: IOLog): undefined | { compilerOptions: ts.CompilerOptions, files: string[] } {
264+
function generateTsconfig(newLog: IoLog): undefined | { compilerOptions: ts.CompilerOptions, files: string[] } {
265265
if (newLog.filesRead.some(file => /tsconfig.+json$/.test(file.path))) {
266266
return;
267267
}
@@ -426,7 +426,7 @@ namespace Playback {
426426
// console.log("Swallowed write operation during replay: " + name);
427427
}
428428

429-
export function wrapIO(underlying: Harness.IO): PlaybackIO {
429+
export function wrapIO(underlying: Harness.Io): PlaybackIO {
430430
const wrapper: PlaybackIO = <any>{};
431431
initWrapper(wrapper, underlying);
432432

‎src/harness/rwcRunner.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
/* tslint:disable:no-null-keyword */
77

88
namespace RWC {
9-
function runWithIOLog(ioLog: IOLog, fn: (oldIO: Harness.IO) => void) {
9+
function runWithIOLog(ioLog: IoLog, fn: (oldIO: Harness.Io) => void) {
1010
const oldIO = Harness.IO;
1111

1212
const wrappedIO = Playback.wrapIO(oldIO);
@@ -58,7 +58,7 @@ namespace RWC {
5858
this.timeout(800000); // Allow long timeouts for RWC compilations
5959
let opts: ts.ParsedCommandLine;
6060

61-
const ioLog: IOLog = Playback.newStyleLogIntoOldStyleLog(JSON.parse(Harness.IO.readFile(`internal/cases/rwc/${jsonPath}/test.json`)), Harness.IO, `internal/cases/rwc/${baseName}`);
61+
const ioLog: IoLog = Playback.newStyleLogIntoOldStyleLog(JSON.parse(Harness.IO.readFile(`internal/cases/rwc/${jsonPath}/test.json`)), Harness.IO, `internal/cases/rwc/${baseName}`);
6262
currentDirectory = ioLog.currentDirectory;
6363
useCustomLibraryFile = ioLog.useCustomLibraryFile;
6464
runWithIOLog(ioLog, () => {

‎src/server/scriptVersionCache.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ namespace ts.server {
1010
charCount(): number;
1111
lineCount(): number;
1212
isLeaf(): this is LineLeaf;
13-
walk(rangeStart: number, rangeLength: number, walkFns: ILineIndexWalker): void;
13+
walk(rangeStart: number, rangeLength: number, walkFns: LineIndexWalker): void;
1414
}
1515

1616
export interface AbsolutePositionAndLineText {
@@ -27,7 +27,7 @@ namespace ts.server {
2727
PostEnd
2828
}
2929

30-
interface ILineIndexWalker {
30+
interface LineIndexWalker {
3131
goSubtree: boolean;
3232
done: boolean;
3333
leaf(relativeStart: number, relativeLength: number, lineCollection: LineLeaf): void;
@@ -37,7 +37,7 @@ namespace ts.server {
3737
parent: LineNode, nodeType: CharRangeSection): void;
3838
}
3939

40-
class EditWalker implements ILineIndexWalker {
40+
class EditWalker implements LineIndexWalker {
4141
goSubtree = true;
4242
get done() { return false; }
4343

@@ -429,7 +429,7 @@ namespace ts.server {
429429
}
430430
}
431431

432-
walk(rangeStart: number, rangeLength: number, walkFns: ILineIndexWalker) {
432+
walk(rangeStart: number, rangeLength: number, walkFns: LineIndexWalker) {
433433
this.root.walk(rangeStart, rangeLength, walkFns);
434434
}
435435

@@ -458,7 +458,7 @@ namespace ts.server {
458458
const walkFns = {
459459
goSubtree: true,
460460
done: false,
461-
leaf(this: ILineIndexWalker, relativeStart: number, relativeLength: number, ll: LineLeaf) {
461+
leaf(this: LineIndexWalker, relativeStart: number, relativeLength: number, ll: LineLeaf) {
462462
if (!f(ll, relativeStart, relativeLength)) {
463463
this.done = true;
464464
}
@@ -580,7 +580,7 @@ namespace ts.server {
580580
}
581581
}
582582

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) {
584584
if (walkFns.pre) {
585585
walkFns.pre(rangeStart, rangeLength, this.children[childIndex], this, nodeType);
586586
}
@@ -596,14 +596,14 @@ namespace ts.server {
596596
return walkFns.done;
597597
}
598598

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) {
600600
if (walkFns.pre && (!walkFns.done)) {
601601
walkFns.pre(relativeStart, relativeLength, this.children[childIndex], this, nodeType);
602602
walkFns.goSubtree = true;
603603
}
604604
}
605605

606-
walk(rangeStart: number, rangeLength: number, walkFns: ILineIndexWalker) {
606+
walk(rangeStart: number, rangeLength: number, walkFns: LineIndexWalker) {
607607
// assume (rangeStart < this.totalChars) && (rangeLength <= this.totalChars)
608608
let childIndex = 0;
609609
let childCharCount = this.children[childIndex].charCount();
@@ -814,7 +814,7 @@ namespace ts.server {
814814
return true;
815815
}
816816

817-
walk(rangeStart: number, rangeLength: number, walkFns: ILineIndexWalker) {
817+
walk(rangeStart: number, rangeLength: number, walkFns: LineIndexWalker) {
818818
walkFns.leaf(rangeStart, rangeLength, this);
819819
}
820820

‎src/server/server.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/// <reference path="session.ts" />
44

55
namespace ts.server {
6-
interface IOSessionOptions {
6+
interface IoSessionOptions {
77
host: ServerHost;
88
cancellationToken: ServerCancellationToken;
99
canUseEvents: boolean;
@@ -529,7 +529,7 @@ namespace ts.server {
529529
}
530530

531531
class IOSession extends Session {
532-
constructor(options: IOSessionOptions) {
532+
constructor(options: IoSessionOptions) {
533533
const { host, installerEventPort, globalTypingsCacheLocation, typingSafeListLocation, typesMapLocation, npmLocation, canUseEvents } = options;
534534
const typingsInstaller = disableAutomaticTypingAcquisition
535535
? undefined
@@ -933,7 +933,7 @@ namespace ts.server {
933933
const disableAutomaticTypingAcquisition = hasArgument("--disableAutomaticTypingAcquisition");
934934
const telemetryEnabled = hasArgument(Arguments.EnableTelemetry);
935935

936-
const options: IOSessionOptions = {
936+
const options: IoSessionOptions = {
937937
host: sys,
938938
cancellationToken,
939939
installerEventPort: eventPort,

‎src/server/typingsCache.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ namespace ts.server {
55
projectRootPath: Path;
66
}
77

8+
// tslint:disable-next-line interface-name (for backwards-compatibility)
89
export interface ITypingsInstaller {
910
isKnownTypesPackageName(name: string): boolean;
1011
installPackage(options: InstallPackageOptionsWithProjectRootPath): Promise<ApplyCodeActionCommandResult>;

‎src/services/shims.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ namespace ts {
106106
///
107107
// Note: This is being using by the host (VS) and is marshaled back and forth.
108108
// When changing this make sure the changes are reflected in the managed side as well
109-
export interface IFileReference {
109+
export interface ShimsFileReference {
110110
path: string;
111111
position: number;
112112
length: number;
@@ -1104,11 +1104,11 @@ namespace ts {
11041104
);
11051105
}
11061106

1107-
private convertFileReferences(refs: FileReference[]): IFileReference[] {
1107+
private convertFileReferences(refs: FileReference[]): ShimsFileReference[] {
11081108
if (!refs) {
11091109
return undefined;
11101110
}
1111-
const result: IFileReference[] = [];
1111+
const result: ShimsFileReference[] = [];
11121112
for (const ref of refs) {
11131113
result.push({
11141114
path: normalizeSlashes(ref.fileName),

‎src/services/types.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ namespace ts {
8686
* snapshot is observably immutable. i.e. the same calls with the same parameters will return
8787
* the same values.
8888
*/
89+
// tslint:disable-next-line interface-name
8990
export interface IScriptSnapshot {
9091
/** Gets a portion of the script snapshot specified by [start, end). */
9192
getText(start: number, end: number): string;

‎tslint.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
"indent": [true,
1414
"spaces"
1515
],
16+
"interface-name": [true, "never-prefix"],
1617
"interface-over-type-literal": true,
1718
"jsdoc-format": true,
1819
"linebreak-style": [true, "CRLF"],
@@ -110,7 +111,6 @@
110111
"no-consecutive-blank-lines": false,
111112

112113
// Not doing
113-
"interface-name": false,
114114
"max-classes-per-file": false,
115115
"member-ordering": false,
116116
"no-angle-bracket-type-assertion": false,

0 commit comments

Comments
 (0)