metalint 0.15.0 → 0.16.0

package/src/core/index.js

@@ -15,17 +15,72 @@ import { exists } from "./utils/file.js";
 import Glob from "./utils/glob.js";
 
 /**
- * @typedef {import("../type/index.d.ts").FlattenedConfigChecker} FlattenedConfigChecker
- * @typedef {import("../type/index.d.ts").Notice} Notice
+ * @typedef {import("../types/configuration/flattened.d.ts").FlattenedConfig} FlattenedConfig
+ * @typedef {import("../types/configuration/flattened.d.ts").FlattenedConfigChecker} FlattenedConfigChecker
+ * @typedef {import("../types/level.d.ts").default} Level
+ * @typedef {import("../types/notice.d.ts").default} Notice
+ * @typedef {import("../types/severity.d.ts").default} Severity
+ * @typedef {import("../types/typeofformatter.d.ts").default} TypeofFormatter
+ * @typedef {import("./formatter/formatter.js").default} Formatter
+ * @typedef {import("./wrapper/wrapper.js").default} Wrapper
  */
 
 export default class Metalint {
+    /**
+     * Le répertoire racine.
+     *
+     * @type {string}
+     */
     #root;
+
+    /**
+     * Les motifs généraux des fichiers.
+     *
+     * @type {Glob}
+     */
     #glob;
+
+    /**
+     * Les checkers (avec leurs linters).
+     */
     #checkers;
+
+    /**
+     * Les formatters.
+     *
+     * @type {Formatter[]}
+     */
     #formatters;
+
+    /**
+     * Le cache des wrappers.
+     *
+     * @type {Map<string, Wrapper[]>}
+     */
     #cache = new Map();
 
+    /**
+     * Crée une instance de Metalint à partir d'une configuration sur le système
+     * de fichiers.
+     *
+     * @param {Object}          [options]           Les éventuelles options pour
+     *                                              créer une instance de
+     *                                              Metalint.
+     * @param {string}          [options.config]    L'éventuel chemin vers le
+     *                                              fichier de configuration de
+     *                                              Metalint.
+     * @param {boolean}         [options.fix]       L'éventuelle marque
+     *                                              indiquant si les linters
+     *                                              doivent corriger les
+     *                                              fichiers.
+     * @param {TypeofFormatter} [options.formatter] L'éventuel formatteur à
+     *                                              utiliser.
+     * @param {Level}           [options.level]     L'éventuel niveau minimum
+     *                                              des notifications à
+     *                                              rapporter.
+     * @returns {Promise<Metalint>} Une promesse contenant l'instance de
+     *                              Metalint.
+     */
     static async fromFileSystem(options = {}) {
         const config = options.config ?? ".metalint/metalint.config.js";
 
@@ -42,7 +97,7 @@ export default class Metalint {
 
         // eslint-disable-next-line no-unsanitized/method
         const { default: configuration } = await import(
-            pathToFileURL(path.join(root, config))
+            pathToFileURL(path.join(root, config)).href
         );
         const { patterns, reporters, checkers } = flatten(
             await normalize(configuration, {
@@ -54,12 +109,19 @@ export default class Metalint {
                 level: options.level,
             },
         );
-        return new Metalint({ root, patterns, reporters, checkers });
+        return new Metalint({ patterns, reporters, checkers }, { root });
     }
 
-    constructor(config) {
-        this.#root = config.root;
-        this.#glob = new Glob(config.patterns, { root: config.root });
+    /**
+     * Crée une instance de Metalint.
+     *
+     * @param {FlattenedConfig} config       La configuration de Metalint.
+     * @param {Object}          context      Le contexte.
+     * @param {string}          context.root Le répertoire racine.
+     */
+    constructor(config, { root }) {
+        this.#root = root;
+        this.#glob = new Glob(config.patterns, { root: this.#root });
 
         this.#formatters = config.reporters.map((reporter) => {
             // eslint-disable-next-line new-cap
@@ -67,11 +129,11 @@ export default class Metalint {
         });
 
         this.#checkers = config.checkers.map((checker) => ({
-            ...checker,
             glob: new Glob(checker.patterns, { root: this.#root }),
+            linters: checker.linters,
             overrides: checker.overrides.map((override) => ({
-                ...override,
                 glob: new Glob(override.patterns, { root: this.#root }),
+                linters: override.linters,
             })),
         }));
     }
@@ -88,42 +150,41 @@ export default class Metalint {
      *                                                        fichier.
      */
     async lintFiles(bases) {
-        const files = [];
+        const files = /** @type {string[]} */ ([]);
         for (const base of bases) {
             files.push(...(await this.#glob.walk(base)));
         }
         const results = new Results(files);
         for (const file of files) {
-            for (const checker of this.#checkers) {
+            for (const [i, checker] of Object.entries(this.#checkers)) {
                 if (checker.glob.test(file)) {
-                    let key = checker.patterns.join();
+                    let key = i.toString();
                     const values = [checker.linters];
-                    for (const override of checker.overrides) {
+                    for (const [j, override] of Object.entries(
+                        checker.overrides,
+                    )) {
                         if (override.glob.test(file)) {
-                            key += "|" + override.patterns.join();
+                            key += `.${j}`;
                             values.push(override.linters);
                         }
                     }
 
-                    let wrappers = [];
+                    let wrappers;
                     if (this.#cache.has(key)) {
                         wrappers = this.#cache.get(key);
                     } else {
-                        const linters = values.reduce(mergeLinters);
-                        for (const linter of linters) {
-                            wrappers.push(
-                                // eslint-disable-next-line new-cap
-                                new linter.wrapper(
-                                    {
-                                        fix: linter.fix,
-                                        level: linter.level,
-                                        root: this.#root,
-                                        files,
-                                    },
-                                    linter.options,
-                                ),
+                        wrappers = values.reduce(mergeLinters).map((linter) => {
+                            // eslint-disable-next-line new-cap
+                            return new linter.wrapper(
+                                {
+                                    fix: linter.fix,
+                                    level: linter.level,
+                                    root: this.#root,
+                                    files,
+                                },
+                                linter.options,
                             );
-                        }
+                        });
                         this.#cache.set(key, wrappers);
                     }
                     for (const wrapper of wrappers) {
@@ -136,6 +197,18 @@ export default class Metalint {
         return results.toObject();
     }
 
+    /**
+     * Rapporte des résultats dans les formats choisis.
+     *
+     * @param {Record<string, Notice[]|undefined>} results La liste des
+     *                                                     notifications
+     *                                                     regroupées par
+     *                                                     fichier.
+     * @returns {Promise<Severity|undefined>} La sévérité la plus élevée des
+     *                                        notifications ; ou
+     *                                        <code>undefined</code> si les
+     *                                        résultats ont aucune notification.
+     */
     async report(results) {
         let severity;
 

package/src/core/results.js

@@ -7,7 +7,8 @@
 import Severities from "./severities.js";
 
 /**
- * @typedef {import("../type/index.d.ts").Notice} Notice
+ * @typedef {import("../types/notice.d.ts").Notice} Notice
+ * @typedef {import("../types/notice.d.ts").PartialNotice} PartialNotice
  */
 
 /**
@@ -42,6 +43,9 @@ const compare = function (notice1, notice2) {
     return notice1.locations.length - notice2.locations.length;
 };
 
+/**
+ * Les résultats d'une analyse.
+ */
 export default class Results {
     /**
      * Les données des résultats.
@@ -50,10 +54,21 @@ export default class Results {
      */
     #data;
 
+    /**
+     * Crée des résultats pour des fichiers.
+     *
+     * @param {string[]} files Les noms des fichiers.
+     */
     constructor(files) {
         this.#data = Object.fromEntries(files.map((f) => [f, undefined]));
     }
 
+    /**
+     * Ajoute des notifications d'un fichier dans les résultats.
+     *
+     * @param {string}          file    Le nom du fichier.
+     * @param {PartialNotice[]} notices Les notifications.
+     */
     add(file, notices) {
         // Ajouter un tableau vide dans les données pour indiquer que le fichier
         // a été analysé par au moins un linter.
@@ -76,6 +91,11 @@ export default class Results {
         }
     }
 
+    /**
+     * Retourne les résultats en objet.
+     *
+     * @returns {Record<string, Notice[]|undefined>} Les résultats.
+     */
     toObject() {
         // Trier les notifications.
         Object.values(this.#data)

package/src/core/wrapper/addons-linter.js

@@ -5,14 +5,15 @@
  */
 
 import path from "node:path/posix";
+// @ts-expect-error -- Add-ons Linter ne fournit pas de types.
 import linter from "addons-linter";
 import Levels from "../levels.js";
 import Severities from "../severities.js";
 import Wrapper from "./wrapper.js";
 
 /**
- * @typedef {import("../../type/index.d.ts").Level} Level
- * @typedef {import("../../type/index.d.ts").PartialNotice} PartialNotice
+ * @typedef {import("../../types/notice.d.ts").PartialNotice} PartialNotice
+ * @typedef {import("../../types/level.d.ts").default} Level
  */
 
 /**
@@ -24,7 +25,7 @@ export default class AddonsLinterWrapper extends Wrapper {
     /**
      * Les options du linter.
      *
-     * @type {Record<string, any>}
+     * @type {Record<string, unknown>}
      * @see https://github.com/mozilla/addons-linter#linter-api-usage
      */
     #options;
@@ -32,17 +33,18 @@ export default class AddonsLinterWrapper extends Wrapper {
     /**
      * Crée un enrobage pour le linter <strong>Add-ons Linter</strong>.
      *
-     * @param {Object}              context       Le contexte de l'enrobage.
-     * @param {Level}               context.level Le niveau de sévérité minimum
-     *                                            des notifications retournées.
-     * @param {boolean}             context.fix   La marque indiquant s'il faut
-     *                                            corriger le fichier.
-     * @param {string}              context.root  L'adresse du répertoire où se
-     *                                            trouve le répertoire
-     *                                            <code>.metalint/</code>.
-     * @param {string[]}            context.files La liste de tous les fichiers
-     *                                            analysés.
-     * @param {Record<string, any>} options       Les options du linter.
+     * @param {Object}                  context       Le contexte de l'enrobage.
+     * @param {Level}                   context.level Le niveau de sévérité
+     *                                                minimum des notifications
+     *                                                retournées.
+     * @param {boolean}                 context.fix   La marque indiquant s'il
+     *                                                faut corriger le fichier.
+     * @param {string}                  context.root  L'adresse du répertoire où
+     *                                                se trouve le répertoire
+     *                                                <code>.metalint/</code>.
+     * @param {string[]}                context.files La liste de tous les
+     *                                                fichiers analysés.
+     * @param {Record<string, unknown>} options       Les options du linter.
      */
     constructor(context, options) {
         super(context);

package/src/core/wrapper/ajv.js

@@ -11,8 +11,8 @@ import Severities from "../severities.js";
 import Wrapper from "./wrapper.js";
 
 /**
- * @typedef {import("../../type/index.d.ts").Level} Level
- * @typedef {import("../../type/index.d.ts").PartialNotice} PartialNotice
+ * @typedef {import("../../types/notice.d.ts").PartialNotice} PartialNotice
+ * @typedef {import("../../types/level.d.ts").default} Level
  */
 
 /**
@@ -24,7 +24,7 @@ export default class AjvWrapper extends Wrapper {
     /**
      * Les options du linter.
      *
-     * @type {Record<string, any>}
+     * @type {Record<string, unknown>}
      * @see https://ajv.js.org/options.html#ajv-options
      */
     #options;
@@ -40,24 +40,25 @@ export default class AjvWrapper extends Wrapper {
     /**
      * Le schéma du fichier JSON.
      *
-     * @type {Record<string, any>}
+     * @type {Record<string, unknown>}
      */
     #schema;
 
     /**
      * Crée un enrobage pour le linter <strong>Ajv</strong>.
      *
-     * @param {Object}              context       Le contexte de l'enrobage.
-     * @param {Level}               context.level Le niveau de sévérité minimum
-     *                                            des notifications retournées.
-     * @param {boolean}             context.fix   La marque indiquant s'il faut
-     *                                            corriger le fichier.
-     * @param {string}              context.root  L'adresse du répertoire où se
-     *                                            trouve le répertoire
-     *                                            <code>.metalint/</code>.
-     * @param {string[]}            context.files La liste de tous les fichiers
-     *                                            analysés.
-     * @param {Record<string, any>} options       Les options du linter.
+     * @param {Object}                  context       Le contexte de l'enrobage.
+     * @param {Level}                   context.level Le niveau de sévérité
+     *                                                minimum des notifications
+     *                                                retournées.
+     * @param {boolean}                 context.fix   La marque indiquant s'il
+     *                                                faut corriger le fichier.
+     * @param {string}                  context.root  L'adresse du répertoire où
+     *                                                se trouve le répertoire
+     *                                                <code>.metalint/</code>.
+     * @param {string[]}                context.files La liste de tous les
+     *                                                fichiers analysés.
+     * @param {Record<string, unknown>} options       Les options du linter.
      */
     constructor(context, options) {
         super(context);

package/src/core/wrapper/coffeelint__cli.js

@@ -5,14 +5,15 @@
  */
 
 import fs from "node:fs/promises";
+// @ts-expect-error -- CoffeeLint ne fournit pas de types.
 import coffeelint from "@coffeelint/cli";
 import Levels from "../levels.js";
 import Severities from "../severities.js";
 import Wrapper from "./wrapper.js";
 
 /**
- * @typedef {import("../../type/index.js").Level} Level
- * @typedef {import("../../type/index.js").PartialNotice} PartialNotice
+ * @typedef {import("../../types/notice.d.ts").PartialNotice} PartialNotice
+ * @typedef {import("../../types/level.d.ts").default} Level
  */
 
 /**
@@ -24,7 +25,7 @@ export default class CoffeeLintCliWrapper extends Wrapper {
     /**
      * Les options du linter.
      *
-     * @type {Record<string, any>}
+     * @type {Record<string, unknown>}
      * @see https://coffeelint.github.io/#options
      */
     #options;
@@ -32,17 +33,18 @@ export default class CoffeeLintCliWrapper extends Wrapper {
     /**
      * Crée un enrobage pour le linter <strong>CoffeeLint</strong>.
      *
-     * @param {Object}              context       Le contexte de l'enrobage.
-     * @param {Level}               context.level Le niveau de sévérité minimum
-     *                                            des notifications retournées.
-     * @param {boolean}             context.fix   La marque indiquant s'il faut
-     *                                            corriger le fichier.
-     * @param {string}              context.root  L'adresse du répertoire où se
-     *                                            trouve le répertoire
-     *                                            <code>.metalint/</code>.
-     * @param {string[]}            context.files La liste de tous les fichiers
-     *                                            analysés.
-     * @param {Record<string, any>} options       Les options du linter.
+     * @param {Object}                  context       Le contexte de l'enrobage.
+     * @param {Level}                   context.level Le niveau de sévérité
+     *                                                minimum des notifications
+     *                                                retournées.
+     * @param {boolean}                 context.fix   La marque indiquant s'il
+     *                                                faut corriger le fichier.
+     * @param {string}                  context.root  L'adresse du répertoire où
+     *                                                se trouve le répertoire
+     *                                                <code>.metalint/</code>.
+     * @param {string[]}                context.files La liste de tous les
+     *                                                fichiers analysés.
+     * @param {Record<string, unknown>} options       Les options du linter.
      */
     constructor(context, options) {
         super(context);

package/src/core/wrapper/csslint.js

@@ -5,14 +5,15 @@
  */
 
 import fs from "node:fs/promises";
+// @ts-expect-error -- CSSLint ne fournit pas de types.
 import { CSSLint } from "csslint";
 import Levels from "../levels.js";
 import Severities from "../severities.js";
 import Wrapper from "./wrapper.js";
 
 /**
- * @typedef {import("../../type/index.d.ts").Level} Level
- * @typedef {import("../../type/index.d.ts").PartialNotice} PartialNotice
+ * @typedef {import("../../types/notice.d.ts").PartialNotice} PartialNotice
+ * @typedef {import("../../types/level.d.ts").default} Level
  */
 
 /**
@@ -24,7 +25,7 @@ export default class CSSLintWrapper extends Wrapper {
     /**
      * Les options du linter.
      *
-     * @type {Record<string, any>}
+     * @type {Record<string, unknown>}
      * @see https://github.com/CSSLint/csslint/wiki/Rules
      */
     #options;
@@ -32,17 +33,18 @@ export default class CSSLintWrapper extends Wrapper {
     /**
      * Crée un enrobage pour le linter <strong>CSSLint</strong>.
      *
-     * @param {Object}              context       Le contexte de l'enrobage.
-     * @param {Level}               context.level Le niveau de sévérité minimum
-     *                                            des notifications retournées.
-     * @param {boolean}             context.fix   La marque indiquant s'il faut
-     *                                            corriger le fichier.
-     * @param {string}              context.root  L'adresse du répertoire où se
-     *                                            trouve le répertoire
-     *                                            <code>.metalint/</code>.
-     * @param {string[]}            context.files La liste de tous les fichiers
-     *                                            analysés.
-     * @param {Record<string, any>} options       Les options du linter.
+     * @param {Object}                  context       Le contexte de l'enrobage.
+     * @param {Level}                   context.level Le niveau de sévérit
+     *                                                minimum des notifications
+     *                                                retournées.
+     * @param {boolean}                 context.fix   La marque indiquant s'il
+     *                                                faut corriger le fichier.
+     * @param {string}                  context.root  L'adresse du répertoire où
+     *                                                se trouve le répertoire
+     *                                                <code>.metalint/</code>.
+     * @param {string[]}                context.files La liste de tous les
+     *                                                fichiers analysés.
+     * @param {Record<string, unknown>} options       Les options du linter.
      */
     constructor(context, options) {
         super(context);

package/src/core/wrapper/depcheck.js

@@ -11,8 +11,8 @@ import Severities from "../severities.js";
 import Wrapper from "./wrapper.js";
 
 /**
- * @typedef {import("../../type/index.d.ts").Level} Level
- * @typedef {import("../../type/index.d.ts").PartialNotice} PartialNotice
+ * @typedef {import("../../types/notice.d.ts").PartialNotice} PartialNotice
+ * @typedef {import("../../types/level.d.ts").default} Level
  */
 
 /**
@@ -24,24 +24,25 @@ export default class DepcheckWrapper extends Wrapper {
     /**
      * Les options du linter.
      *
-     * @type {Record<string, any>}
+     * @type {Record<string, unknown>}
      */
     #options;
 
     /**
      * Crée un enrobage pour le linter <strong>Depcheck</strong>.
      *
-     * @param {Object}              context       Le contexte de l'enrobage.
-     * @param {Level}               context.level Le niveau de sévérité minimum
-     *                                            des notifications retournées.
-     * @param {boolean}             context.fix   La marque indiquant s'il faut
-     *                                            corriger le fichier.
-     * @param {string}              context.root  L'adresse du répertoire où se
-     *                                            trouve le répertoire
-     *                                            <code>.metalint/</code>.
-     * @param {string[]}            context.files La liste de tous les fichiers
-     *                                            analysés.
-     * @param {Record<string, any>} options       Les options du linter.
+     * @param {Object}                  context       Le contexte de l'enrobage.
+     * @param {Level}                   context.level Le niveau de sévérité
+     *                                                minimum des notifications
+     *                                                retournées.
+     * @param {boolean}                 context.fix   La marque indiquant s'il
+     *                                                faut corriger le fichier.
+     * @param {string}                  context.root  L'adresse du répertoire où
+     *                                                se trouve le répertoire
+     *                                                <code>.metalint/</code>.
+     * @param {string[]}                context.files La liste de tous les
+     *                                                fichiers analysés.
+     * @param {Record<string, unknown>} options       Les options du linter.
      */
     constructor(context, options) {
         super(context);

package/src/core/wrapper/doiuse.js

@@ -7,6 +7,7 @@
 // Ne pas utiliser la version promise de fs car la fonction createReadStream()
 // n'y est pas. https://github.com/nodejs/node/issues/38627
 import { createReadStream } from "node:fs";
+// @ts-expect-error -- doiuse ne fournit pas de types.
 // Désactiver la règle suivante pour cet import, car elle ne supporte pas la
 // propriété "exports" du package.json.
 // https://github.com/import-js/eslint-plugin-import/issues/1810
@@ -16,8 +17,9 @@ import Levels from "../levels.js";
 import Wrapper from "./wrapper.js";
 
 /**
- * @typedef {import("../../type/index.d.ts").Level} Level
- * @typedef {import("../../type/index.d.ts").PartialNotice} PartialNotice
+ * @typedef {import("node:stream").Writable} Writable
+ * @typedef {import("../../types/notice.d.ts").PartialNotice} PartialNotice
+ * @typedef {import("../../types/level.d.ts").default} Level
  */
 
 /**
@@ -29,24 +31,25 @@ export default class DoIUseWrapper extends Wrapper {
     /**
      * L'instance de DoIUse.
      *
-     * @type {Object}
+     * @type {Writable}
      */
     #doiuse;
 
     /**
      * Crée un enrobage pour le linter <strong>doiuse</strong>.
      *
-     * @param {Object}              context       Le contexte de l'enrobage.
-     * @param {Level}               context.level Le niveau de sévérité minimum
-     *                                            des notifications retournées.
-     * @param {boolean}             context.fix   La marque indiquant s'il faut
-     *                                            corriger le fichier.
-     * @param {string}              context.root  L'adresse du répertoire où se
-     *                                            trouve le répertoire
-     *                                            <code>.metalint/</code>.
-     * @param {string[]}            context.files La liste de tous les fichiers
-     *                                            analysés.
-     * @param {Record<string, any>} options       Les options du linter.
+     * @param {Object}                  context       Le contexte de l'enrobage.
+     * @param {Level}                   context.level Le niveau de sévérité
+     *                                                minimum des notifications
+     *                                                retournées.
+     * @param {boolean}                 context.fix   La marque indiquant s'il
+     *                                                faut corriger le fichier.
+     * @param {string}                  context.root  L'adresse du répertoire où
+     *                                                se trouve le répertoire
+     *                                                <code>.metalint/</code>.
+     * @param {string[]}                context.files La liste de tous les
+     *                                                fichiers analysés.
+     * @param {Record<string, unknown>} options       Les options du linter.
      */
     constructor(context, options) {
         super(context);

package/src/core/wrapper/eslint.js

@@ -18,8 +18,8 @@ import Wrapper from "./wrapper.js";
 const { FlatESLint } = pkg;
 
 /**
- * @typedef {import("../../type/index.d.ts").Level} Level
- * @typedef {import("../../type/index.d.ts").PartialNotice} PartialNotice
+ * @typedef {import("../../types/notice.d.ts").PartialNotice} PartialNotice
+ * @typedef {import("../../types/level.d.ts").default} Level
  */
 
 /**
@@ -31,7 +31,7 @@ export default class ESLintWrapper extends Wrapper {
     /**
      * L'instance de ESLint.
      *
-     * @type {typeof ESLint}
+     * @type {ESLint}
      * @see https://eslint.org/docs/latest/integrate/nodejs-api
      */
     #eslint;
@@ -39,17 +39,18 @@ export default class ESLintWrapper extends Wrapper {
     /**
      * Crée un enrobage pour le linter <strong>ESLint</strong>.
      *
-     * @param {Object}              context       Le contexte de l'enrobage.
-     * @param {Level}               context.level Le niveau de sévérité minimum
-     *                                            des notifications retournées.
-     * @param {boolean}             context.fix   La marque indiquant s'il faut
-     *                                            corriger le fichier.
-     * @param {string}              context.root  L'adresse du répertoire où se
-     *                                            trouve le répertoire
-     *                                            <code>.metalint/</code>.
-     * @param {string[]}            context.files La liste de tous les fichiers
-     *                                            analysés.
-     * @param {Record<string, any>} options       Les options du linter.
+     * @param {Object}                  context       Le contexte de l'enrobage.
+     * @param {Level}                   context.level Le niveau de sévérité
+     *                                                minimum des notifications
+     *                                                retournées.
+     * @param {boolean}                 context.fix   La marque indiquant s'il
+     *                                                faut corriger le fichier.
+     * @param {string}                  context.root  L'adresse du répertoire où
+     *                                                se trouve le répertoire
+     *                                                <code>.metalint/</code>.
+     * @param {string[]}                context.files La liste de tous les
+     *                                                fichiers analysés.
+     * @param {Record<string, unknown>} options       Les options du linter.
      */
     constructor(context, options) {
         super(context);