Fix ESLint issues for api-extractor-model

octogonz · octogonz · commit 9f5dbdd57dcd · 2019-10-21T00:20:05.000-07:00
diff --git a/apps/api-extractor-model/.eslintrc.js b/apps/api-extractor-model/.eslintrc.js
@@ -0,0 +1,12 @@
+// 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 },
+
+  rules: {
+    // api-extractor-model uses namespaces to represent mixins
+    "@typescript-eslint/no-namespace": "off"
+  }
+};
diff --git a/apps/api-extractor-model/src/items/ApiDeclaredItem.ts b/apps/api-extractor-model/src/items/ApiDeclaredItem.ts
@@ -31,7 +31,7 @@ export interface IApiDeclaredItemJson extends IApiDocumentedItemJson {
  *
  * @public
  */
-// tslint:disable-next-line:interface-name
+// eslint-disable-next-line @typescript-eslint/interface-name-prefix
 export class ApiDeclaredItem extends ApiDocumentedItem {
   private _excerptTokens: ExcerptToken[];
   private _excerpt: Excerpt;
diff --git a/apps/api-extractor-model/src/items/ApiItem.ts b/apps/api-extractor-model/src/items/ApiItem.ts
@@ -52,8 +52,7 @@ export interface IApiItemJson {
 
 // PRIVATE - Allows ApiItemContainerMixin to assign the parent.
 //
-// tslint:disable-next-line:variable-name
-export const ApiItem_onParentChanged: unique symbol = Symbol('ApiItem._onAddToContainer');
+export const apiItem_onParentChanged: unique symbol = Symbol('ApiItem._onAddToContainer');
 
 /**
  * The abstract base class for all members of an `ApiModel` object.
@@ -70,6 +69,7 @@ export class ApiItem {
   public static deserialize(jsonObject: IApiItemJson, context: DeserializerContext): ApiItem {
     // The Deserializer class is coupled with a ton of other classes, so  we delay loading it
     // to avoid ES5 circular imports.
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
     const deserializerModule: typeof import('../model/Deserializer') = require('../model/Deserializer');
     return deserializerModule.Deserializer.deserialize(context, jsonObject);
   }
@@ -268,7 +268,7 @@ export class ApiItem {
    *
    * @internal
    */
-  public [ApiItem_onParentChanged](parent: ApiItem | undefined): void {
+  public [apiItem_onParentChanged](parent: ApiItem | undefined): void {
     this._parent = parent;
     this._canonicalReference = undefined;
   }
diff --git a/apps/api-extractor-model/src/mixins/ApiItemContainerMixin.ts b/apps/api-extractor-model/src/mixins/ApiItemContainerMixin.ts
@@ -3,7 +3,7 @@
 
 import {
   ApiItem,
-  ApiItem_onParentChanged,
+  apiItem_onParentChanged,
   IApiItemJson,
   IApiItemOptions,
   IApiItemConstructor,
@@ -51,7 +51,7 @@ const _membersByKind: unique symbol = Symbol('ApiItemContainerMixin._membersByKi
  *
  * @public
  */
-// tslint:disable-next-line:interface-name
+// eslint-disable-next-line @typescript-eslint/interface-name-prefix
 export interface ApiItemContainerMixin extends ApiItem {
   /**
    * Returns the members of this container, sorted alphabetically.
@@ -129,7 +129,7 @@ export function ApiItemContainerMixin<TBaseClass extends IApiItemConstructor>(ba
     }
 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    constructor(...args: any[]) {
+    public constructor(...args: any[]) {
       super(...args);
       const options: IApiItemContainerMixinOptions = args[0] as IApiItemContainerMixinOptions;
 
@@ -168,7 +168,7 @@ export function ApiItemContainerMixin<TBaseClass extends IApiItemConstructor>(ba
       this[_membersSorted] = false;
       this[_membersByContainerKey].set(member.containerKey, member);
 
-      member[ApiItem_onParentChanged](this);
+      member[apiItem_onParentChanged](this);
     }
 
     public tryGetMemberByKey(containerKey: string): ApiItem | undefined {
diff --git a/apps/api-extractor-model/src/mixins/ApiNameMixin.ts b/apps/api-extractor-model/src/mixins/ApiNameMixin.ts
@@ -34,7 +34,7 @@ const _name: unique symbol = Symbol('ApiNameMixin._name');
  *
  * @public
  */
-// tslint:disable-next-line:interface-name
+// eslint-disable-next-line @typescript-eslint/interface-name-prefix
 export interface ApiNameMixin extends ApiItem {
   /**
    * The exported name of this API item.
@@ -72,7 +72,7 @@ export function ApiNameMixin<TBaseClass extends IApiItemConstructor>(baseClass:
     }
 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    constructor(...args: any[]) {
+    public constructor(...args: any[]) {
       super(...args);
 
       const options: IApiNameMixinOptions = args[0];
diff --git a/apps/api-extractor-model/src/mixins/ApiParameterListMixin.ts b/apps/api-extractor-model/src/mixins/ApiParameterListMixin.ts
@@ -49,7 +49,7 @@ const _parameters: unique symbol = Symbol('ApiParameterListMixin._parameters');
  *
  * @public
  */
-// tslint:disable-next-line:interface-name
+// eslint-disable-next-line @typescript-eslint/interface-name-prefix
 export interface ApiParameterListMixin extends ApiItem {
   /**
    * When a function has multiple overloaded declarations, this zero-based integer index can be used to unqiuely
@@ -114,7 +114,7 @@ export function ApiParameterListMixin<TBaseClass extends IApiItemConstructor>(ba
     }
 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    constructor(...args: any[]) {
+    public constructor(...args: any[]) {
       super(...args);
 
       const options: IApiParameterListMixinOptions = args[0];
diff --git a/apps/api-extractor-model/src/mixins/ApiReleaseTagMixin.ts b/apps/api-extractor-model/src/mixins/ApiReleaseTagMixin.ts
@@ -35,7 +35,7 @@ const _releaseTag: unique symbol = Symbol('ApiReleaseTagMixin._releaseTag');
  *
  * @public
  */
-// tslint:disable-next-line:interface-name
+// eslint-disable-next-line @typescript-eslint/interface-name-prefix
 export interface ApiReleaseTagMixin extends ApiItem {
   /**
    * The effective release tag for this declaration.  If it is not explicitly specified, the value may be
@@ -79,7 +79,7 @@ export function ApiReleaseTagMixin<TBaseClass extends IApiItemConstructor>(baseC
     }
 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    constructor(...args: any[]) {
+    public constructor(...args: any[]) {
       super(...args);
 
       const options: IApiReleaseTagMixinOptions = args[0];
diff --git a/apps/api-extractor-model/src/mixins/ApiReturnTypeMixin.ts b/apps/api-extractor-model/src/mixins/ApiReturnTypeMixin.ts
@@ -36,7 +36,7 @@ const _returnTypeExcerpt: unique symbol = Symbol('ApiReturnTypeMixin._returnType
  *
  * @public
  */
-// tslint:disable-next-line:interface-name
+// eslint-disable-next-line @typescript-eslint/interface-name-prefix
 export interface ApiReturnTypeMixin extends ApiItem {
   /**
    * An {@link Excerpt} that describes the type of the function's return value.
@@ -71,7 +71,7 @@ export function ApiReturnTypeMixin<TBaseClass extends IApiItemConstructor>(baseC
     }
 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    constructor(...args: any[]) {
+    public constructor(...args: any[]) {
       super(...args);
 
       const options: IApiReturnTypeMixinOptions = args[0];
diff --git a/apps/api-extractor-model/src/mixins/ApiStaticMixin.ts b/apps/api-extractor-model/src/mixins/ApiStaticMixin.ts
@@ -33,7 +33,7 @@ const _isStatic: unique symbol = Symbol('ApiStaticMixin._isStatic');
  *
  * @public
  */
-// tslint:disable-next-line:interface-name
+// eslint-disable-next-line @typescript-eslint/interface-name-prefix
 export interface ApiStaticMixin extends ApiItem {
   /**
    * Whether the declaration has the TypeScript `static` keyword.
@@ -68,7 +68,7 @@ export function ApiStaticMixin<TBaseClass extends IApiItemConstructor>(baseClass
     }
 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    constructor(...args: any[]) {
+    public constructor(...args: any[]) {
       super(...args);
 
       const options: IApiStaticMixinOptions = args[0];
diff --git a/apps/api-extractor-model/src/mixins/ApiTypeParameterListMixin.ts b/apps/api-extractor-model/src/mixins/ApiTypeParameterListMixin.ts
@@ -47,7 +47,7 @@ const _typeParameters: unique symbol = Symbol('ApiTypeParameterListMixin._typePa
  *
  * @public
  */
-// tslint:disable-next-line:interface-name
+// eslint-disable-next-line @typescript-eslint/interface-name-prefix
 export interface ApiTypeParameterListMixin extends ApiItem {
   /**
    * The type parameters.
@@ -82,7 +82,7 @@ export function ApiTypeParameterListMixin<TBaseClass extends IApiItemConstructor
     }
 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    constructor(...args: any[]) {
+    public constructor(...args: any[]) {
       super(...args);
 
       const options: IApiTypeParameterListMixinOptions = args[0];
diff --git a/apps/api-extractor-model/tslint.json b/apps/api-extractor-model/tslint.json
diff --git a/common/reviews/api/api-extractor-model.api.md b/common/reviews/api/api-extractor-model.api.md
@@ -234,7 +234,7 @@ export class ApiInterface extends ApiInterface_base {
 // @public
 export class ApiItem {
     // @internal
-    [ApiItem_onParentChanged](parent: ApiItem | undefined): void;
+    [apiItem_onParentChanged](parent: ApiItem | undefined): void;
     constructor(options: IApiItemOptions);
     // @virtual
     protected buildCanonicalReference(): DeclarationReference;

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ export interface IApiDeclaredItemJson extends IApiDocumentedItemJson {`
`31`	`31`	`*`
`32`	`32`	`* @public`
`33`	`33`	`*/`
`34`		`-// tslint:disable-next-line:interface-name`
	`34`	`+// eslint-disable-next-line @typescript-eslint/interface-name-prefix`
`35`	`35`	`export class ApiDeclaredItem extends ApiDocumentedItem {`
`36`	`36`	`private _excerptTokens: ExcerptToken[];`
`37`	`37`	`private _excerpt: Excerpt;`