Fix ESLint issues for api-extractor

octogonz · octogonz · commit 81cf7241b8ed · 2019-10-21T00:20:06.000-07:00
diff --git a/apps/api-extractor/.eslintrc.js b/apps/api-extractor/.eslintrc.js
@@ -0,0 +1,7 @@
+// This is a workaround for https://github.com/eslint/eslint/issues/3458
+require("@rushstack/eslint-config/patch-eslint6");
+
+module.exports = {
+  extends: [ "@rushstack/eslint-config" ],
+  parserOptions: { tsconfigRootDir: __dirname },
+};
diff --git a/apps/api-extractor/src/analyzer/ExportAnalyzer.ts b/apps/api-extractor/src/analyzer/ExportAnalyzer.ts
@@ -333,7 +333,7 @@ export class ExportAnalyzer {
     if (referringModuleIsExternal) {
       current = TypeScriptHelpers.followAliases(symbol, this._typeChecker);
     } else {
-      while (true) { // tslint:disable-line:no-constant-condition
+      for (; ;) {
         // Is this symbol an import/export that we need to follow to find the real declaration?
         for (const declaration of current.declarations || []) {
 
@@ -348,7 +348,7 @@ export class ExportAnalyzer {
           }
         }
 
-        if (!(current.flags & ts.SymbolFlags.Alias)) { // tslint:disable-line:no-bitwise
+        if (!(current.flags & ts.SymbolFlags.Alias)) { // eslint-disable-line no-bitwise
           break;
         }
 
diff --git a/apps/api-extractor/src/analyzer/PackageMetadataManager.ts b/apps/api-extractor/src/analyzer/PackageMetadataManager.ts
@@ -8,7 +8,8 @@ import {
   FileSystem,
   JsonFile,
   NewlineKind,
-  INodePackageJson
+  INodePackageJson,
+  JsonObject
 } from '@microsoft/node-core-library';
 import { Extractor } from '../api/Extractor';
 import { MessageRouter } from '../collector/MessageRouter';
@@ -127,7 +128,7 @@ export class PackageMetadataManager {
    * Writes the TSDoc metadata file to the specified output file.
    */
   public static writeTsdocMetadataFile(tsdocMetadataPath: string): void {
-    const fileObject: Object = {
+    const fileObject: JsonObject = {
       tsdocVersion: '0.12',
       toolPackages: [
         {
diff --git a/apps/api-extractor/src/analyzer/Span.ts b/apps/api-extractor/src/analyzer/Span.ts
@@ -33,20 +33,20 @@ export class SpanModification {
    */
   public sortKey: string | undefined;
 
-  private readonly span: Span;
+  private readonly _span: Span;
   private _prefix: string | undefined;
   private _suffix: string | undefined;
 
   public constructor(span: Span) {
-    this.span = span;
+    this._span = span;
     this.reset();
   }
 
   /**
    * Allows the Span.prefix text to be changed.
    */
   public get prefix(): string {
-    return this._prefix !== undefined ? this._prefix : this.span.prefix;
+    return this._prefix !== undefined ? this._prefix : this._span.prefix;
   }
 
   public set prefix(value: string) {
@@ -57,7 +57,7 @@ export class SpanModification {
    * Allows the Span.suffix text to be changed.
    */
   public get suffix(): string {
-    return this._suffix !== undefined ? this._suffix : this.span.suffix;
+    return this._suffix !== undefined ? this._suffix : this._span.suffix;
   }
 
   public set suffix(value: string) {
diff --git a/apps/api-extractor/src/analyzer/TypeScriptHelpers.ts b/apps/api-extractor/src/analyzer/TypeScriptHelpers.ts
@@ -21,7 +21,7 @@ export class TypeScriptHelpers {
    */
   public static followAliases(symbol: ts.Symbol, typeChecker: ts.TypeChecker): ts.Symbol {
     let current: ts.Symbol = symbol;
-    while (true) { // tslint:disable-line:no-constant-condition
+    for (;;) {
       if (!(current.flags & ts.SymbolFlags.Alias)) {
         break;
       }
@@ -84,7 +84,7 @@ export class TypeScriptHelpers {
       // is acting as a module or not).
       const sourceFile: ts.SourceFile = firstDeclaration.getSourceFile();
 
-      if (!!typeChecker.getSymbolAtLocation(sourceFile)) {
+      if (typeChecker.getSymbolAtLocation(sourceFile)) {
         return false;
       }
     }
@@ -199,7 +199,7 @@ export class TypeScriptHelpers {
     let current: ts.Node | undefined = node;
     let highest: T | undefined = undefined;
 
-    while (true) { // tslint:disable-line:no-constant-condition
+    for (;;) {
       current = TypeScriptHelpers.findFirstParent<T>(current, kindToMatch);
       if (!current) {
         break;
diff --git a/apps/api-extractor/src/analyzer/TypeScriptInternals.ts b/apps/api-extractor/src/analyzer/TypeScriptInternals.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 
-// tslint:disable:no-any
+/* eslint-disable @typescript-eslint/no-explicit-any */
 
 import * as ts from 'typescript';
 
diff --git a/apps/api-extractor/src/analyzer/test/PackageMetadataManager.test.ts b/apps/api-extractor/src/analyzer/test/PackageMetadataManager.test.ts
@@ -3,7 +3,7 @@ import * as path from 'path';
 import { PackageMetadataManager } from '../PackageMetadataManager';
 import { FileSystem, PackageJsonLookup, INodePackageJson } from '@microsoft/node-core-library';
 
-/* tslint:disable:typedef */
+/* eslint-disable @typescript-eslint/typedef */
 
 describe('PackageMetadataManager', () => {
   describe('.writeTsdocMetadataFile()', () => {
@@ -115,7 +115,7 @@ describe('PackageMetadataManager', () => {
   });
 });
 
-/* tslint:enable:typedef */
+/* eslint-enable @typescript-eslint/typedef */
 
 const packageJsonLookup: PackageJsonLookup = new PackageJsonLookup();
 
diff --git a/apps/api-extractor/src/cli/ApiExtractorCommandLine.ts b/apps/api-extractor/src/cli/ApiExtractorCommandLine.ts
@@ -13,7 +13,7 @@ import { InitAction } from './InitAction';
 export class ApiExtractorCommandLine extends CommandLineParser {
   private _debugParameter: CommandLineFlagParameter;
 
-  constructor() {
+  public constructor() {
     super({
       toolFilename: 'api-extractor',
       toolDescription: 'API Extractor helps you build better TypeScript libraries.  It analyzes the main entry'
diff --git a/apps/api-extractor/src/cli/InitAction.ts b/apps/api-extractor/src/cli/InitAction.ts
@@ -11,7 +11,7 @@ import { ExtractorConfig } from '../api/ExtractorConfig';
 
 export class InitAction extends CommandLineAction {
 
-  constructor(parser: ApiExtractorCommandLine) {
+  public constructor(parser: ApiExtractorCommandLine) {
     super({
       actionName: 'init',
       summary: `Create an ${ExtractorConfig.FILENAME} config file`,
diff --git a/apps/api-extractor/src/cli/RunAction.ts b/apps/api-extractor/src/cli/RunAction.ts
@@ -29,7 +29,7 @@ export class RunAction extends CommandLineAction {
   private _diagnosticsParameter: CommandLineFlagParameter;
   private _typescriptCompilerFolder: CommandLineStringParameter;
 
-  constructor(parser: ApiExtractorCommandLine) {
+  public constructor(parser: ApiExtractorCommandLine) {
     super({
       actionName: 'run',
       summary: 'Invoke API Extractor on a project',
diff --git a/apps/api-extractor/src/collector/Collector.ts b/apps/api-extractor/src/collector/Collector.ts
@@ -82,7 +82,7 @@ export class Collector {
   private readonly _dtsTypeReferenceDirectives: Set<string> = new Set<string>();
   private readonly _dtsLibReferenceDirectives: Set<string> = new Set<string>();
 
-  constructor(options: ICollectorOptions) {
+  public constructor(options: ICollectorOptions) {
     this.packageJsonLookup = new PackageJsonLookup();
 
     this._program = options.program;
diff --git a/apps/api-extractor/src/collector/MessageRouter.ts b/apps/api-extractor/src/collector/MessageRouter.ts
@@ -252,7 +252,7 @@ export class MessageRouter {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   public static buildJsonDumpObject(input: any): any | undefined {
     if (input === null || input === undefined) {
-      // tslint:disable-next-line:no-null-keyword
+      // eslint-disable-next-line no-restricted-syntax
       return null; // JSON uses null instead of undefined
     }
 
diff --git a/apps/api-extractor/src/enhancers/DocCommentEnhancer.ts b/apps/api-extractor/src/enhancers/DocCommentEnhancer.ts
@@ -16,7 +16,7 @@ import { ResolverFailure } from '../analyzer/AstReferenceResolver';
 export class DocCommentEnhancer {
   private readonly _collector: Collector;
 
-  constructor(collector: Collector) {
+  public constructor(collector: Collector) {
     this._collector = collector;
   }
 
diff --git a/apps/api-extractor/src/generators/ApiModelGenerator.ts b/apps/api-extractor/src/generators/ApiModelGenerator.ts
@@ -265,7 +265,7 @@ export class ApiModelGenerator {
   private _processApiClass(astDeclaration: AstDeclaration, exportedName: string | undefined,
     parentApiItem: ApiItemContainerMixin): void {
 
-    const name: string = !!exportedName ? exportedName : astDeclaration.astSymbol.localName;
+    const name: string = exportedName ? exportedName : astDeclaration.astSymbol.localName;
     const containerKey: string = ApiClass.getContainerKey(name);
 
     let apiClass: ApiClass | undefined = parentApiItem.tryGetMemberByKey(containerKey) as ApiClass;
@@ -371,7 +371,7 @@ export class ApiModelGenerator {
   private _processApiEnum(astDeclaration: AstDeclaration, exportedName: string | undefined,
     parentApiItem: ApiItemContainerMixin): void {
 
-    const name: string = !!exportedName ? exportedName : astDeclaration.astSymbol.localName;
+    const name: string = exportedName ? exportedName : astDeclaration.astSymbol.localName;
     const containerKey: string = ApiEnum.getContainerKey(name);
 
     let apiEnum: ApiEnum | undefined = parentApiItem.tryGetMemberByKey(containerKey) as ApiEnum;
@@ -396,7 +396,7 @@ export class ApiModelGenerator {
   private _processApiEnumMember(astDeclaration: AstDeclaration, exportedName: string | undefined,
     parentApiItem: ApiItemContainerMixin): void {
 
-    const name: string = !!exportedName ? exportedName : astDeclaration.astSymbol.localName;
+    const name: string = exportedName ? exportedName : astDeclaration.astSymbol.localName;
     const containerKey: string = ApiEnumMember.getContainerKey(name);
 
     let apiEnumMember: ApiEnumMember | undefined = parentApiItem.tryGetMemberByKey(containerKey) as ApiEnumMember;
@@ -433,7 +433,7 @@ export class ApiModelGenerator {
   private _processApiFunction(astDeclaration: AstDeclaration, exportedName: string | undefined,
     parentApiItem: ApiItemContainerMixin): void {
 
-    const name: string = !!exportedName ? exportedName : astDeclaration.astSymbol.localName;
+    const name: string = exportedName ? exportedName : astDeclaration.astSymbol.localName;
 
     const overloadIndex: number = this._getOverloadIndex(astDeclaration);
     const containerKey: string = ApiFunction.getContainerKey(name, overloadIndex);
@@ -526,7 +526,7 @@ export class ApiModelGenerator {
   private _processApiInterface(astDeclaration: AstDeclaration, exportedName: string | undefined,
     parentApiItem: ApiItemContainerMixin): void {
 
-    const name: string = !!exportedName ? exportedName : astDeclaration.astSymbol.localName;
+    const name: string = exportedName ? exportedName : astDeclaration.astSymbol.localName;
     const containerKey: string = ApiInterface.getContainerKey(name);
 
     let apiInterface: ApiInterface | undefined = parentApiItem.tryGetMemberByKey(containerKey) as ApiInterface;
@@ -579,7 +579,7 @@ export class ApiModelGenerator {
   private _processApiMethod(astDeclaration: AstDeclaration, exportedName: string | undefined,
     parentApiItem: ApiItemContainerMixin): void {
 
-    const name: string = !!exportedName ? exportedName : astDeclaration.astSymbol.localName;
+    const name: string = exportedName ? exportedName : astDeclaration.astSymbol.localName;
 
     const isStatic: boolean = (astDeclaration.modifierFlags & ts.ModifierFlags.Static) !== 0;
     const overloadIndex: number = this._getOverloadIndex(astDeclaration);
@@ -631,7 +631,7 @@ export class ApiModelGenerator {
   private _processApiMethodSignature(astDeclaration: AstDeclaration, exportedName: string | undefined,
     parentApiItem: ApiItemContainerMixin): void {
 
-    const name: string = !!exportedName ? exportedName : astDeclaration.astSymbol.localName;
+    const name: string = exportedName ? exportedName : astDeclaration.astSymbol.localName;
 
     const overloadIndex: number = this._getOverloadIndex(astDeclaration);
     const containerKey: string = ApiMethodSignature.getContainerKey(name, overloadIndex);
@@ -679,7 +679,7 @@ export class ApiModelGenerator {
   private _processApiNamespace(astDeclaration: AstDeclaration, exportedName: string | undefined,
     parentApiItem: ApiItemContainerMixin): void {
 
-    const name: string = !!exportedName ? exportedName : astDeclaration.astSymbol.localName;
+    const name: string = exportedName ? exportedName : astDeclaration.astSymbol.localName;
     const containerKey: string = ApiNamespace.getContainerKey(name);
 
     let apiNamespace: ApiNamespace | undefined = parentApiItem.tryGetMemberByKey(containerKey) as ApiNamespace;
@@ -704,7 +704,7 @@ export class ApiModelGenerator {
   private _processApiProperty(astDeclaration: AstDeclaration, exportedName: string | undefined,
     parentApiItem: ApiItemContainerMixin): void {
 
-    const name: string = !!exportedName ? exportedName : astDeclaration.astSymbol.localName;
+    const name: string = exportedName ? exportedName : astDeclaration.astSymbol.localName;
 
     const isStatic: boolean = (astDeclaration.modifierFlags & ts.ModifierFlags.Static) !== 0;
 
@@ -741,7 +741,7 @@ export class ApiModelGenerator {
   private _processApiPropertySignature(astDeclaration: AstDeclaration, exportedName: string | undefined,
     parentApiItem: ApiItemContainerMixin): void {
 
-    const name: string = !!exportedName ? exportedName : astDeclaration.astSymbol.localName;
+    const name: string = exportedName ? exportedName : astDeclaration.astSymbol.localName;
     const containerKey: string = ApiPropertySignature.getContainerKey(name);
 
     let apiPropertySignature: ApiPropertySignature | undefined
@@ -782,7 +782,7 @@ export class ApiModelGenerator {
   private _processApiTypeAlias(astDeclaration: AstDeclaration, exportedName: string | undefined,
     parentApiItem: ApiItemContainerMixin): void {
 
-    const name: string = !!exportedName ? exportedName : astDeclaration.astSymbol.localName;
+    const name: string = exportedName ? exportedName : astDeclaration.astSymbol.localName;
 
     const containerKey: string = ApiTypeAlias.getContainerKey(name);
 
@@ -825,7 +825,7 @@ export class ApiModelGenerator {
   private _processApiVariable(astDeclaration: AstDeclaration, exportedName: string | undefined,
     parentApiItem: ApiItemContainerMixin): void {
 
-    const name: string = !!exportedName ? exportedName : astDeclaration.astSymbol.localName;
+    const name: string = exportedName ? exportedName : astDeclaration.astSymbol.localName;
 
     const containerKey: string = ApiVariable.getContainerKey(name);
 
diff --git a/apps/api-extractor/src/generators/ApiReportGenerator.ts b/apps/api-extractor/src/generators/ApiReportGenerator.ts
@@ -164,7 +164,7 @@ export class ApiReportGenerator {
     astDeclaration: AstDeclaration, insideTypeLiteral: boolean): void {
 
     // Should we process this declaration at all?
-    if ((astDeclaration.modifierFlags & ts.ModifierFlags.Private) !== 0) { // tslint:disable-line:no-bitwise
+    if ((astDeclaration.modifierFlags & ts.ModifierFlags.Private) !== 0) { // eslint-disable-line no-bitwise
       span.modification.skipAll();
       return;
     }
diff --git a/apps/api-extractor/src/generators/DeclarationReferenceGenerator.ts b/apps/api-extractor/src/generators/DeclarationReferenceGenerator.ts
@@ -22,7 +22,7 @@ export class DeclarationReferenceGenerator {
   private _program: ts.Program;
   private _typeChecker: ts.TypeChecker;
 
-  constructor(packageJsonLookup: PackageJsonLookup, workingPackageName: string, program: ts.Program,
+  public constructor(packageJsonLookup: PackageJsonLookup, workingPackageName: string, program: ts.Program,
     typeChecker: ts.TypeChecker) {
 
     this._packageJsonLookup = packageJsonLookup;
diff --git a/apps/api-extractor/tslint.json b/apps/api-extractor/tslint.json

Original file line number	Diff line number	Diff line change
`@@ -333,7 +333,7 @@ export class ExportAnalyzer {`
`333`	`333`	`if (referringModuleIsExternal) {`
`334`	`334`	`current = TypeScriptHelpers.followAliases(symbol, this._typeChecker);`
`335`	`335`	`} else {`
`336`		`- while (true) { // tslint:disable-line:no-constant-condition`
	`336`	`+ for (; ;) {`
`337`	`337`	`// Is this symbol an import/export that we need to follow to find the real declaration?`
`338`	`338`	`for (const declaration of current.declarations \|\| []) {`
`339`	`339`
`@@ -348,7 +348,7 @@ export class ExportAnalyzer {`
`348`	`348`	`}`
`349`	`349`	`}`
`350`	`350`
`351`		`- if (!(current.flags & ts.SymbolFlags.Alias)) { // tslint:disable-line:no-bitwise`
	`351`	`+ if (!(current.flags & ts.SymbolFlags.Alias)) { // eslint-disable-line no-bitwise`
`352`	`352`	`break;`
`353`	`353`	`}`
`354`	`354`