lint

Author: cyrilletuzi

.eslintrc.json

@@ -82,6 +82,7 @@
         "plugin:@angular-eslint/template/all"
       ],
       "rules": {
+        "@angular-eslint/template/i18n": "off",
         "@angular-eslint/template/no-any": "error"
       }
     }

lib/schematics/ng-add/index.ts

@@ -19,7 +19,6 @@ export default function (): Rule {
     const rxjsMajorVersion = getDependencyMajorVersion("rxjs", host);
 
     if (!rxjsMajorVersion) {
-      // eslint-disable-next-line max-len
       context.logger.warn(`Not able to detect rxjs version. Be aware that rxjs version >= 7.4 is recommended for Angular 14 and required for Angular >= 15.`);
     }
 

lib/schematics/ng-update/index.ts

@@ -50,7 +50,6 @@ export function updateToV15(): Rule {
     const rxjsMajorVersion = getDependencyMajorVersion("rxjs", host);
 
     if (!rxjsMajorVersion) {
-      // eslint-disable-next-line max-len
       context.logger.warn(`Not able to detect rxjs version. Be aware that rxjs version >= 7.4 is required for version 15 of this lib, rxjs 6 is not supported.`);
     }
 

lib/schematics/utility/module.ts

@@ -60,7 +60,6 @@ export function updateModule(mainPath: string): Rule {
         /* If the file is still the same, it means we didn't catch the module
           * (for example, it can happen if the user aliased `StorageModule`) */
         if (updatedAppModuleFile === appModuleFile) {
-          // eslint-disable-next-line max-len
           throw new SchematicsException(`We couldn't update AppModule automatically. Be sure to follow the documentation to update manually, otherwise previsouly stored data could be lost.`);
         }
 

lib/src/lib/databases/indexeddb-database.ts

@@ -114,10 +114,10 @@ export class IndexedDBDatabase implements LocalDatabase {
 
             /* Prior to v8, the value was wrapped in an `{ value: ...}` object */
             if (!this.noWrap && (typeof request.result === "object") && (this.wrapIndex in request.result) &&
-              // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+              // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access -- Required by indexedDb behavior
               (request.result[this.wrapIndex] !== undefined) && (request.result[this.wrapIndex] !== null)) {
 
-              // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+              // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access -- Required by indexedDb behavior
               return request.result[this.wrapIndex];
 
             } else {
@@ -250,14 +250,14 @@ export class IndexedDBDatabase implements LocalDatabase {
         /* Listen to success event */
         const success$ = fromEvent(request, "success").pipe(
           /* Stop the `Observable` when the cursor is `null` */
-          // eslint-disable-next-line rxjs/no-ignored-takewhile-value -- Due to how indexedDb works, getting the result from the event does not always work
+          // eslint-disable-next-line rxjs/no-ignored-takewhile-value -- Required by indexedDb behavior, getting the result from the event does not always work
           takeWhile(() => (request.result !== null)),
           /* This lib only allows string keys, but user could have added other types of keys from outside
            * It's OK to cast as the cursor as been tested in the previous operator */
-          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion, @typescript-eslint/no-base-to-string
+          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion, @typescript-eslint/no-base-to-string -- Required by indexedDb behavior, and strings are enforced by the lib
           map(() => request.result!.key.toString()),
           /* Iterate on the cursor */
-          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- Required by indexedDb behavior
           tap(() => { request.result!.continue(); }),
         );
 

lib/src/lib/databases/localstorage-database.ts

@@ -138,7 +138,7 @@ export class LocalStorageDatabase implements LocalDatabase {
       for (let index = 0; index < localStorage.length; index += 1) {
 
         /* Cast as we are sure in this case the key is not `null` */
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- Ensured by the logic
         subscriber.next(this.getUnprefixedKey(index)!);
 
       }

lib/src/lib/storage.module.ts

@@ -5,7 +5,7 @@ import { IDB_DB_NAME, IDB_DB_VERSION, IDB_NO_WRAP, IDB_STORE_NAME, LS_PREFIX, ty
  * This module is only here for backward compatibility, do not add it by yourself
  */
 @NgModule()
-export class StorageModule { // eslint-disable-line @typescript-eslint/no-extraneous-class
+export class StorageModule {
 
   /**
    * Only useful to provide options, otherwise it does nothing.

lib/src/lib/storages/storage-map.service.ts

@@ -168,9 +168,9 @@ export class StorageMap {
   get<T extends number = number>(key: string, schema: JSONSchemaInteger | JSONSchemaNumber): Observable<T | undefined>;
   get<T extends boolean = boolean>(key: string, schema: JSONSchemaBoolean): Observable<T | undefined>;
   get<T extends readonly string[] = string[]>(key: string, schema: JSONSchemaArrayOf<JSONSchemaString>): Observable<T | undefined>;
-  // eslint-disable-next-line @typescript-eslint/unified-signatures
-  get<T extends readonly number[] = number[]>(key: string, schema: JSONSchemaArrayOf<JSONSchemaInteger | JSONSchemaNumber>): Observable<T | undefined>; // eslint-disable-line max-len
-  // eslint-disable-next-line @typescript-eslint/unified-signatures
+  // eslint-disable-next-line @typescript-eslint/unified-signatures -- Better for documentation
+  get<T extends readonly number[] = number[]>(key: string, schema: JSONSchemaArrayOf<JSONSchemaInteger | JSONSchemaNumber>): Observable<T | undefined>;
+  // eslint-disable-next-line @typescript-eslint/unified-signatures -- Better for documentation
   get<T extends readonly boolean[] = boolean[]>(key: string, schema: JSONSchemaArrayOf<JSONSchemaBoolean>): Observable<T | undefined>;
   get<T>(key: string, schema: JSONSchema): Observable<T | undefined>;
   get<T = unknown>(key: string, schema?: JSONSchema): Observable<unknown> {
@@ -331,9 +331,9 @@ export class StorageMap {
   watch<T extends number = number>(key: string, schema: JSONSchemaInteger | JSONSchemaNumber): Observable<T | undefined>;
   watch<T extends boolean = boolean>(key: string, schema: JSONSchemaBoolean): Observable<T | undefined>;
   watch<T extends readonly string[] = string[]>(key: string, schema: JSONSchemaArrayOf<JSONSchemaString>): Observable<T | undefined>;
-  // eslint-disable-next-line @typescript-eslint/unified-signatures
-  watch<T extends readonly number[] = number[]>(key: string, schema: JSONSchemaArrayOf<JSONSchemaInteger | JSONSchemaNumber>): Observable<T | undefined>; // eslint-disable-line max-len
-  // eslint-disable-next-line @typescript-eslint/unified-signatures
+  // eslint-disable-next-line @typescript-eslint/unified-signatures -- Better for documentation
+  watch<T extends readonly number[] = number[]>(key: string, schema: JSONSchemaArrayOf<JSONSchemaInteger | JSONSchemaNumber>): Observable<T | undefined>;
+  // eslint-disable-next-line @typescript-eslint/unified-signatures -- Better for documentation
   watch<T extends readonly boolean[] = boolean[]>(key: string, schema: JSONSchemaArrayOf<JSONSchemaBoolean>): Observable<T | undefined>;
   watch<T>(key: string, schema: JSONSchema): Observable<T | undefined>;
   watch<T = unknown>(key: string, schema?: JSONSchema): Observable<unknown> {
@@ -344,7 +344,7 @@ export class StorageMap {
     }
 
     /* Non-null assertion is required because TypeScript doesn't narrow `.has()` yet */
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- Ensured by the logic
     const notifier = this.#notifiers.get(key)!;
 
     /* Get the current item value */
@@ -391,7 +391,7 @@ export class StorageMap {
       /* Check if `indexedDB` is broken based on error message (the specific error class seems to be lost in the process) */
       if ((error !== undefined) && (error !== null)
         && (typeof error === "object") && ("message" in error)
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access -- Required because TypeScript narrowing is not working here
         && (error.message === IDB_BROKEN_ERROR)) {
 
         /* When storage is fully disabled in browser (via the "Block all cookies" option),
@@ -440,7 +440,7 @@ export class StorageMap {
    * @private
    * @ignore
    */
-  // eslint-disable-next-line @typescript-eslint/ban-ts-comment, @typescript-eslint/prefer-ts-expect-error
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment, @typescript-eslint/prefer-ts-expect-error -- Silence the not used error, it is used in tests
   // @ts-ignore
   private ɵinternalGetDatabase(): LocalDatabase {
 

lib/src/lib/validation/json-validator.ts

@@ -236,7 +236,7 @@ export class JSONValidator {
 
       for (let i = 0; i < schemas.length; i += 1) {
 
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- Ensured by the logic
         if (!this.validate(data[i], schemas[i]!)) {
           return false;
         }
@@ -288,7 +288,7 @@ export class JSONValidator {
       /* Filter to keep only real properties (no internal JS stuff) and check if the data has the property too */
       if (Object.hasOwn(schema.properties, property) && Object.hasOwn(data, property)) {
 
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- Ensured by the logic
         if (!this.validate((data as Record<string, unknown>)[property], schema.properties[property]!)) {
           return false;
         }

testing-apps/demo/src/app/app.component.ts

@@ -14,7 +14,6 @@ interface Data {
   standalone: true,
   imports: [AsyncPipe, JsonPipe],
   template: `
-    <!-- eslint-disable @angular-eslint/template/cyclomatic-complexity -->
     @if (getItem$ | async; as getItem) {
       <p id="get-item">{{getItem.title}}</p>
     }