eslint

transifex · Sep 22, 2023 · c2371e9 · c2371e9
1 parent 930138e
commit c2371e9
Show file tree

Hide file tree

Showing 8 changed files with 52 additions and 75 deletions.
diff --git a/packages/angular/.eslintrc.json b/packages/angular/.eslintrc.json
@@ -1,5 +1,6 @@
 {
   "root": true,
+  "reportUnusedDisableDirectives": true,
   "ignorePatterns": [
     "projects/**/*"
   ],
@@ -10,24 +11,57 @@
       ],
       "parserOptions": {
         "project": [
-          "tsconfig.json",
-          "e2e/tsconfig.json"
+          "tsconfig.json"
         ],
-        "createDefaultProgram": true
+        "createDefaultProgram": true,
+        "warnOnUnsupportedTypeScriptVersion": true
       },
+      "plugins": [
+        "eslint-plugin-import",
+        "eslint-plugin-prefer-arrow",
+        "eslint-plugin-promise",
+        "eslint-plugin-rxjs",
+        "eslint-plugin-rxjs-angular",
+        "eslint-plugin-tsdoc",
+        "eslint-plugin-unicorn"
+      ],
       "extends": [
-        "plugin:@angular-eslint/ng-cli-compat",
-        "plugin:@angular-eslint/ng-cli-compat--formatting-add-on",
+        "plugin:@angular-eslint/recommended",
         "plugin:@angular-eslint/template/process-inline-templates",
-        "airbnb-typescript/base"
+        "plugin:@typescript-eslint/recommended",
+        "plugin:import/recommended",
+        "plugin:import/typescript",
+        "plugin:promise/recommended",
+        "plugin:rxjs/recommended",
+        "plugin:unicorn/recommended"
       ],
       "rules": {
-        "import/export": 0,
-        "import/prefer-default-export": 0,
-        "import/no-extraneous-dependencies": 0,
-        "@typescript-eslint/no-unused-vars": 0,
-        "class-methods-use-this": 0,
-        "@typescript-eslint/member-ordering": 0
+        "@typescript-eslint/no-unused-vars": [
+          "error",
+          {
+            "varsIgnorePattern": "^_",
+            "argsIgnorePattern": "^_"
+          }
+        ],
+        "class-methods-use-this": "off",
+        "import/no-extraneous-dependencies": [
+          "error",
+          {
+            "devDependencies": ["**/*.spec.ts"],
+            "packageDir": "./" // Needed for angular library support
+          }
+        ],
+        "tsdoc/syntax": "warn",
+        "unicorn/filename-case": "off", // We are naming files with capitals
+        // I think some of these are silly. `e` is bad, but `err` and `exc` are decent. `user of users` is confusing, `usr of users` is safer.
+        "unicorn/prevent-abbreviations": "off"
+      },
+      "settings": {
+        "import/resolver": {
+          "typescript": {
+            "alwaysTryTypes": true // always try to resolve types under `<root>@types` directory even it doesn't contain any source code, like `@types/unist`
+          }
+        }
       }
     },
     {

diff --git a/packages/angular/package.json b/packages/angular/package.json
@@ -60,6 +60,7 @@
     "@typescript-eslint/eslint-plugin": "^5.36.2",
     "@typescript-eslint/parser": "^5.36.2",
     "eslint": "^8.23.0",
+    "eslint-config-airbnb-typescript": "^16.0.0",
     "eslint-import-resolver-typescript": "^3.5.5",
     "eslint-plugin-import": "^2.25.3",
     "eslint-plugin-prefer-arrow": "^1.2.3",

diff --git a/packages/angular/projects/tx-native-angular-sdk/src/lib/T.component.ts b/packages/angular/projects/tx-native-angular-sdk/src/lib/T.component.ts
@@ -14,20 +14,6 @@ import { TranslationService } from './translation.service';
   styles: [],
 })
 
-/**
- * A translation component
- *
- * @param {string} str
- * @param {string=} key
- * @param {string=} context
- * @param {string=} comment
- * @param {number=} charlimit
- * @param {string=} tags
- * @param {boolean=} escapeVars
- * @param {boolean=} inline
- * @param {boolean=} sanitize
- * @param {Object=} vars
- */
 export class TComponent implements OnInit, OnDestroy, OnChanges {
   @Input()
     str = '';
@@ -91,12 +77,6 @@ export class TComponent implements OnInit, OnDestroy, OnChanges {
 
   private actualVars: Record<string, unknown> = {};
 
-  /**
-   * Constructor
-   *
-   * @param translationService
-   * @param instance
-   */
   constructor(protected translationService: TranslationService,
     protected instance: TXInstanceComponent) {
     this.onLocaleChange = this.localeChanged.subscribe(

diff --git a/packages/angular/projects/tx-native-angular-sdk/src/lib/UT.component.ts b/packages/angular/projects/tx-native-angular-sdk/src/lib/UT.component.ts
@@ -14,26 +14,7 @@ import { TranslationService } from './translation.service';
   encapsulation: ViewEncapsulation.None,
 })
 
-/**
- * A translation component with escaped variables
- *
- * @param {string} str
- * @param {string=} key
- * @param {string=} context
- * @param {string=} comment
- * @param {number=} charlimit
- * @param {string=} tags
- * @param {boolean=} escapeVars
- * @param {boolean=} inline
- * @param {Object=} vars
- */
 export class UTComponent extends TComponent {
-  /**
-   * Constructor
-   *
-   * @param translationService
-   * @param instance
-   */
   constructor(
       translationService: TranslationService,
       protected override instance: TXInstanceComponent,

diff --git a/packages/angular/projects/tx-native-angular-sdk/src/lib/instance.component.ts b/packages/angular/projects/tx-native-angular-sdk/src/lib/instance.component.ts
@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-useless-constructor */
 import { Component, EventEmitter, Input, OnInit, Output } from '@angular/core';
 import { Observable, ReplaySubject } from 'rxjs';
 
@@ -12,14 +11,6 @@ import {TxNative} from "@transifex/native";
   `,
 })
 
-/**
- * A TX Native instance selector component
- *
- * @param {string} alias
- * @param {string} token
- * @param {boolean} controlled
- * @param {EventEmitter} instanceReady
- */
 export class TXInstanceComponent implements OnInit {
   @Input() alias = '';
 
@@ -39,11 +30,6 @@ export class TXInstanceComponent implements OnInit {
   // The instance
   private instance?: TxNative;
 
-  /**
-   * Constructor
-   *
-   * @param translationService
-   */
   constructor(private translationService: TranslationService) {}
 
   async ngOnInit(): Promise<void>  {

diff --git a/packages/angular/projects/tx-native-angular-sdk/tests/T.decorator.spec.ts b/packages/angular/projects/tx-native-angular-sdk/tests/T.decorator.spec.ts
@@ -1,4 +1,3 @@
-/* eslint-disable prefer-arrow/prefer-arrow-functions */
 import { Component } from '@angular/core';
 import { TestBed } from '@angular/core/testing';
 import { tx } from '@transifex/native';

diff --git a/packages/angular/projects/tx-native-angular-sdk/tests/load-translations.directive.spec.ts b/packages/angular/projects/tx-native-angular-sdk/tests/load-translations.directive.spec.ts
@@ -1,4 +1,4 @@
-import { Component, OnDestroy } from '@angular/core';
+import {Component, DebugElement } from '@angular/core';
 import { ComponentFixture, TestBed } from '@angular/core/testing';
 import { By } from '@angular/platform-browser';
 import { ReplaySubject } from 'rxjs';
@@ -12,18 +12,14 @@ describe('LoadTranslationsDirective', () => {
       <div [txLoadTranslations]="'tag1'"></div>
     `,
   })
-  class TestComponent implements OnDestroy {
-    ngOnDestroy() {}
-  }
+  class TestComponent {}
 
   let localeChangedSubject: ReplaySubject<string>;
 
-  let directives: any;
+  let directives: DebugElement[];
   let fixture: ComponentFixture<TestComponent>;
   let service: TranslationService;
 
-
-
   beforeEach(() => {
     fixture = TestBed.configureTestingModule({
       declarations: [LoadTranslationsDirective, TestComponent],

diff --git a/packages/angular/projects/tx-native-angular-sdk/tsconfig.lib.json b/packages/angular/projects/tx-native-angular-sdk/tsconfig.lib.json
@@ -3,15 +3,15 @@
   "extends": "../../tsconfig.json",
   "compilerOptions": {
     "outDir": "../../out-tsc/lib",
-    "target": "es2015",
+    "target": "es2020",
     "declaration": true,
     "declarationMap": true,
     "inlineSources": true,
     "types": [ "node" ],
     "typeRoots": [ "../node_modules/@types" ],
     "lib": [
       "dom",
-      "es2018"
+      "es2020"
     ]
   },
   "angularCompilerOptions": {