metalint 0.11.1 → 0.12.0

package/README.md

@@ -14,46 +14,138 @@
 ## Description
 
 **Metalint** est un outil pour analyser tous les fichiers de votre projet.
-L'analyse est déléguée à des linters (outils d'analyse statique de code source)
-ou des utilitaires selon le type de fichier :
-
-- _Générique_ :
-  [Prettier](https://regseb.github.io/metalint/user/linters/prettier/) ;
-- WebExtension : [Add-ons
-  Linter](https://regseb.github.io/metalint/user/linters/addons-linter/) ;
-- CoffeeScript :
-  [CoffeeLint](https://regseb.github.io/metalint/user/linters/coffeelint/) ;
-- CSS (SCSS, Sass, Less) :
-  [CSSLint](https://regseb.github.io/metalint/user/linters/csslint/),
-  [doiuse](https://regseb.github.io/metalint/user/linters/doiuse/),
-  [lesshint](https://regseb.github.io/metalint/user/linters/lesshint/),
-  [PurgeCSS](https://regseb.github.io/metalint/user/linters/purgecss/) et
-  [stylelint](https://regseb.github.io/metalint/user/linters/stylelint/) ;
-- HTML : [HTMLHint](https://regseb.github.io/metalint/user/linters/htmlhint/),
-  [htmllint](https://regseb.github.io/metalint/user/linters/htmllint/) et
-  [markuplint](https://regseb.github.io/metalint/user/linters/markuplint/) ;
-- JavaScript : [ESLint](https://regseb.github.io/metalint/user/linters/eslint/),
-  [Flow](https://regseb.github.io/metalint/user/linters/flow-bin/),
-  [JSHint](https://regseb.github.io/metalint/user/linters/jshint/) et
-  [JavaScript Standard
-  Style](https://regseb.github.io/metalint/user/linters/standard/) ;
-- JSON : [JSON-Lint](https://regseb.github.io/metalint/user/linters/json-lint/),
-  [JSON Lint](https://regseb.github.io/metalint/user/linters/jsonlint/) et
-  [JSON Lint
-  (mod)](https://regseb.github.io/metalint/user/linters/jsonlint-mod/) ;
-  - package.json (npm) :
-    [npm-package-json-lint](https://regseb.github.io/metalint/user/linters/npm-package-json-lint/)
-    ;
-- Markdown :
-  [MarkdownLint](https://regseb.github.io/metalint/user/linters/markdownlint/) ;
-- YAML : [YAML Lint](https://regseb.github.io/metalint/user/linters/yaml-lint/).
+L'analyse est déléguée à des linters (outils d'analyse statique de code
+source) :
+
+<!-- markdownlint-disable no-inline-html -->
+<table>
+  <tr>
+    <th>Langage / Technologie</th>
+    <th>Linters</th>
+  </tr>
+  <tr>
+    <td>CoffeeScript</td>
+    <td>
+      <a title="@coffeelint/cli"
+         href="https://www.npmjs.com/package/@coffeelint/cli">CoffeeLint</a>
+    </td>
+  </tr>
+  <tr>
+    <td>CSS</td>
+    <td>
+      <a title="csslint"
+         href="https://www.npmjs.com/package/csslint">CSSLint</a>,
+      <a title="doiuse" href="https://www.npmjs.com/package/doiuse">doiuse</a>,
+      <a title="prettier"
+         href="https://www.npmjs.com/package/prettier">Prettier</a>,
+      <a title="purgecss"
+         href="https://www.npmjs.com/package/purgecss">PurgeCSS</a>,
+      <a title="stylelint"
+         href="https://www.npmjs.com/package/stylelint">Stylelint</a>
+   </td>
+  </tr>
+  <tr>
+    <td>HTML</td>
+    <td>
+      <a title="htmlhint"
+         href="https://www.npmjs.com/package/htmlhint">HTMLHint</a>,
+      <a title="htmllint"
+         href="https://www.npmjs.com/package/htmllint">htmllint</a>,
+      <a title="markuplint"
+         href="https://www.npmjs.com/package/markuplint">markuplint</a>,
+      <a title="prettier"
+         href="https://www.npmjs.com/package/prettier">Prettier</a>
+    </td>
+  </tr>
+  <tr>
+    <td>JavaScript</td>
+    <td>
+      <a title="eslint" href="https://www.npmjs.com/package/eslint">ESLint</a>,
+      <a title="jshint" href="https://www.npmjs.com/package/jshint">JSHint</a>,
+      <a title="standard"
+         href="https://www.npmjs.com/package/standard">JavaScript Standard
+        Style</a>,
+      <a title="prettier"
+         href="https://www.npmjs.com/package/prettier">Prettier</a>
+    </td>
+  </tr>
+  <tr>
+    <td>JSON</td>
+    <td>
+      <a title="@prantlf/jsonlint"
+         href="https://www.npmjs.com/package/@prantlf/jsonlint">@prantlf/JSON
+        Lint</a>,
+      <a title="jsonlint-mod"
+         href="https://www.npmjs.com/package/jsonlint-mod">JSON Lint (mod)</a>,
+      <a title="prettier"
+         href="https://www.npmjs.com/package/prettier">Prettier</a>
+    </td>
+  </tr>
+  <tr>
+    <td>Less</td>
+    <td>
+      <a title="prettier"
+         href="https://www.npmjs.com/package/prettier">Prettier</a>,
+      <a title="stylelint"
+         href="https://www.npmjs.com/package/stylelint">Stylelint</a>
+    </td>
+  </tr>
+  <tr>
+    <td>Markdown</td>
+    <td>
+      <a title="markdownlint"
+         href="https://www.npmjs.com/package/markdownlint">MarkdownLint</a>
+    </td>
+  </tr>
+  <tr>
+    <td>package.json</td>
+    <td>
+      <a title="npm-package-json-lint"
+         href="https://www.npmjs.com/package/npm-package-json-lint"
+         >npm-package-json-lint</a>
+    </td>
+  </tr>
+  <tr>
+    <td>SCSS</td>
+    <td>
+      <a title="prettier"
+         href="https://www.npmjs.com/package/prettier">Prettier</a>,
+      <a title="stylelint"
+         href="https://www.npmjs.com/package/stylelint">Stylelint</a>
+  </td>
+  </tr>
+  <tr>
+    <td>SugarSS</td>
+    <td>
+      <a title="stylelint"
+         href="https://www.npmjs.com/package/stylelint">Stylelint</a>
+    </td>
+  </tr>
+  <tr>
+    <td>WebExtension</td>
+    <td>
+      <a title="addons-linter"
+         href="https://www.npmjs.com/package/addons-linter">Add-ons Linter</a>
+    </td>
+  </tr>
+  <tr>
+    <td>YAML</td>
+    <td>
+      <a title="yaml-lint"
+         href="https://www.npmjs.com/package/yaml-lint">YAML Lint</a>,
+      <a title="prettier"
+         href="https://www.npmjs.com/package/prettier">Prettier</a>
+    </td>
+  </tr>
+</table>
+<!-- markdownlint-enable no-inline-html -->
 
 ## Installation
 
 Vous pouvez installer Metalint en utilisant [npm][link-npm] :
 
 ```Shell
-npm install metalint --save-dev
+npm install --save-dev metalint
 ```
 
 ## Configuration
@@ -68,15 +160,15 @@ linters.
 
 Dans cet exemple des fichiers de configuration, Metalint analyse les fichiers
 JavaScript (non-minifiés), HTML et CSS ; avec respectivement les linters ESLint,
-HTMLHint et stylelint.
+HTMLHint et Stylelint.
 
 ```JavaScript
 // .metalint/metalint.config.js
 export default {
-    patterns: ["!/.git/", "!/node_modules/", "**"],
+    patterns: ["**", "!/.git/**", "!/node_modules/**"],
     checkers: [
         {
-            patterns: ["!*.min.js", "*.js"],
+            patterns: ["*.js", "!*.min.js"],
             linters: "eslint",
         }, {
             patterns: "*.html",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "metalint",
-  "version": "0.11.1",
+  "version": "0.12.0",
   "description": "Un linter pour les gouverner tous.",
   "keywords": [
     "checker",
@@ -27,72 +27,65 @@
   "repository": "regseb/metalint",
   "type": "module",
   "scripts": {
-    "lint": "src/bin/index.js",
-    "lint:fix": "src/bin/index.js --fix",
+    "lint": "node src/bin/index.js",
+    "lint:fix": "node src/bin/index.js --fix",
     "lint:types": "tsc --project .tsconfig_lint.json",
     "test": "npm run test:unit",
-    "test:unit": "mocha --config test/mocharc.json",
+    "test:unit": "mocha --config test/unit/mocharc.json",
     "test:coverage": "stryker run .stryker.config.js",
-    "jsdocs": "typedoc --tsconfig .tsconfig_jsdocs.json --out jsdocs/ src/core/",
+    "jsdocs": "typedoc --tsconfig .tsconfig_jsdocs.json",
     "prepare": "tsc --project .tsconfig_types.json",
     "release": "standard-version",
     "clean": "node .script/clean.js"
   },
   "dependencies": {
     "chalk": "5.2.0",
-    "yargs": "17.7.1"
+    "yargs": "17.7.2"
   },
   "devDependencies": {
     "@coffeelint/cli": "5.2.11",
+    "@prantlf/jsonlint": "14.0.3",
     "@prettier/plugin-xml": "2.2.0",
-    "@stryker-mutator/core": "6.4.1",
-    "@stryker-mutator/mocha-runner": "6.4.1",
-    "@types/debug": "4.1.7",
-    "@types/eslint": "8.21.1",
-    "@types/file-entry-cache": "5.0.2",
+    "@stryker-mutator/core": "6.4.2",
+    "@stryker-mutator/mocha-runner": "6.4.2",
+    "@types/eslint": "8.37.0",
     "@types/htmlhint": "1.1.2",
-    "@types/js-yaml": "4.0.5",
-    "@types/jshint": "2.12.1",
     "@types/mocha": "10.0.1",
     "@types/mock-fs": "4.13.1",
-    "@types/node": "18.14.6",
-    "@types/sinon": "10.0.13",
-    "@types/yargs": "17.0.22",
-    "addons-linter": "5.30.0",
+    "@types/prettier": "2.7.2",
+    "@types/sinon": "10.0.14",
+    "@types/yargs": "17.0.24",
+    "addons-linter": "6.2.0",
     "csslint": "1.0.5",
     "doiuse": "4.4.1",
-    "eslint": "8.35.0",
+    "eslint": "8.39.0",
     "eslint-plugin-array-func": "3.1.8",
     "eslint-plugin-eslint-comments": "3.2.0",
     "eslint-plugin-import": "2.27.5",
-    "eslint-plugin-jsdoc": "40.0.1",
+    "eslint-plugin-jsdoc": "43.1.1",
     "eslint-plugin-mocha": "10.1.0",
-    "eslint-plugin-n": "15.6.1",
+    "eslint-plugin-n": "15.7.0",
     "eslint-plugin-no-unsanitized": "4.0.2",
     "eslint-plugin-promise": "6.1.1",
-    "eslint-plugin-regexp": "1.12.0",
+    "eslint-plugin-regexp": "1.14.0",
     "eslint-plugin-unicorn": "46.0.0",
-    "flow-bin": "0.201.0",
     "htmlhint": "1.1.4",
     "htmllint": "0.8.0",
     "jshint": "2.13.6",
-    "json-lint": "0.1.0",
-    "jsonlint": "1.6.3",
     "jsonlint-mod": "1.7.6",
-    "lesshint": "6.3.7",
-    "markdownlint": "0.27.0",
-    "markuplint": "3.3.0",
+    "markdownlint": "0.28.2",
+    "markuplint": "3.9.0",
     "mocha": "10.2.0",
     "mock-fs": "5.2.0",
     "npm-package-json-lint": "6.4.0",
-    "prettier": "2.8.4",
+    "prettier": "2.8.8",
     "purgecss": "5.0.0",
-    "sinon": "15.0.1",
+    "sinon": "15.0.4",
     "standard": "17.0.0",
     "standard-version": "9.5.0",
-    "stylelint": "15.2.0",
-    "typedoc": "0.23.26",
-    "typescript": "4.9.5",
+    "stylelint": "15.6.0",
+    "typedoc": "0.24.6",
+    "typescript": "5.0.4",
     "yaml-lint": "1.7.0"
   },
   "engines": {

package/src/bin/argv.js

@@ -0,0 +1,102 @@
+/**
+ * @module
+ * @license MIT
+ * @author Sébastien Règne
+ */
+
+import fs from "node:fs/promises";
+import yargs from "yargs";
+import {
+    normalizeFormatter,
+    normalizeLevel,
+} from "../core/configuration/normalize.js";
+import { FORMATTERS } from "../core/formatter/formatter.js";
+import Levels from "../core/levels.js";
+
+/**
+ * @typedef {import("../core/formatter/formatter.js").default} TypeofFormatter
+ * @typedef {import("../type/index.d.ts").Level} Level
+ */
+
+/**
+ * @typedef {Object} Argv
+ * @property {string[]}                  _         Le paramètres de la ligne de
+ *                                                 commande.
+ * @property {string}                    config    L'option
+ *                                                 <code>--config</code> de la
+ *                                                 ligne de commande.
+ * @property {boolean|undefined}         fix       L'option <code>--fix</code>
+ *                                                 de la ligne de commande.
+ * @property {TypeofFormatter|undefined} formatter L'option
+ *                                                 <code>--formatter</code> de
+ *                                                 la ligne de commande.
+ * @property {Level}                     level     L'option <code>--level</code>
+ *                                                 de la ligne de commande.
+ * @property {boolean}                   help      L'option <code>--help</code>
+ *                                                 de la ligne de commande.
+ */
+/**
+ * Extrait, vérifie et normalise les paramètres et les options de la ligne de
+ * commande.
+ *
+ * @param {string[]} argv Les paramètres et les options de la ligne de commande.
+ * @returns {Promise<Argv>} Les paramètres et les options normalisés.
+ */
+export const parse = async function (argv = process.argv.slice(2)) {
+    const args = yargs(argv)
+        .options({
+            c: {
+                alias: "config",
+                default: ".metalint/metalint.config.js",
+                requiresArg: true,
+                type: "string",
+            },
+            f: {
+                alias: "formatter",
+                choices: FORMATTERS,
+                requiresArg: true,
+                type: "string",
+            },
+            fix: {
+                alias: "fix",
+                type: "boolean",
+            },
+            l: {
+                alias: "level",
+                choices: Object.keys(Levels).map((l) => l.toLowerCase()),
+                default: "info",
+                requiresArg: true,
+                type: "string",
+            },
+            help: {
+                alias: "help",
+                type: "boolean",
+            },
+        })
+        .help(false)
+        .parse();
+
+    return {
+        // Ajouter une barre oblique à la fin pour les répertoires.
+        _:
+            0 === args._.length
+                ? ["./"]
+                : await Promise.all(
+                      args._.map(async (base) => {
+                          const stats = await fs.lstat(base);
+                          return base + (stats.isDirectory() ? "/" : "");
+                      }),
+                  ),
+        config: args.config,
+        fix: args.fix,
+        // Ne pas utiliser yargs.coerce() pour convertir les données car cette
+        // méthode est incompatible avec yargs.choices().
+        // https://github.com/yargs/yargs/issues/1379
+        formatter:
+            undefined === args.formatter
+                ? undefined
+                : await normalizeFormatter(args.formatter),
+        level: normalizeLevel(args.level),
+        help: args.help ?? false,
+    };
+};

package/src/bin/help.txt

@@ -7,14 +7,10 @@ options courtes.
   -f, --formatter=FORMATTER  définir le formateur utilisé pour afficher les
                                résultats
   --fix                      corriger les fichiers
-  -l, --level=NIVEAU         définir le niveau de sévérité global
-  -o, --output=OUTPUT        spécifier le fichier de sortie où seront écrit les
-                               résultats
-  -p, --patterns=PATRONS     spécifier les patrons pour filtrer les fichiers qui
-                               seront analysés
+  -l, --level=LEVEL          définir le niveau de sévérité global
   --help     afficher l'aide et quitter
   --version  afficher des informations de version et quitter
 
-L'argument NIVEAU peut avoir comme valeur : off, fatal, error, warn ou info.
+L'argument LEVEL peut avoir comme valeur : off, fatal, error, warn ou info.
 
-Documentation complète à : <https://regseb.github.io/metalint/>
+Documentation complète à : <https://github.com/regseb/metalint>

package/src/bin/index.js

@@ -1,17 +1,21 @@
 #!/usr/bin/env node
 
-import fs from "node:fs";
+import fs from "node:fs/promises";
 import path from "node:path";
-import { fileURLToPath } from "node:url";
-import yargs from "yargs";
-import glob from "../core/glob.js";
+import { fileURLToPath, pathToFileURL } from "node:url";
+import flatten from "../core/configuration/flatten.js";
+import normalize from "../core/configuration/normalize.js";
 import metalint from "../core/index.js";
-import normalize from "../core/normalize.js";
-import SEVERITY from "../core/severity.js";
+import Severities from "../core/severities.js";
+import { exists } from "../core/utils/file.js";
+import Glob from "../core/utils/glob.js";
+import { parse } from "./argv.js";
 
 /**
- * @typedef {import("../types").Checker} Checker
- * @typedef {import("../types").Formatter} Formatter
+ * @typedef {import("../core/formatter/formatter.js")} Formatter
+ * @typedef {import("../type/index.d.ts").FlattenedConfigChecker} FlattenedConfigChecker
+ * @typedef {import("../type/index.d.ts").FlattenedConfigReporter} FlattenedConfigReporter
+ * @typedef {import("../type/index.d.ts").Severity} Severity
  */
 
 if (undefined === import.meta.resolve) {
@@ -20,72 +24,36 @@ if (undefined === import.meta.resolve) {
      *
      * @param {string} specifier Le chemin relatif vers un fichier ou un
      *                           répertoire.
-     * @returns {Promise<string>} Une promesse contenant le chemin absolue vers
-     *                            le fichier ou le répertoire.
+     * @returns {string} L'URL absolue vers le fichier ou le répertoire.
      * @see https://nodejs.org/api/esm.html#importmetaresolvespecifier-parent
      */
     import.meta.resolve = (specifier) => {
-        return Promise.resolve(
-            fileURLToPath(new URL(specifier, import.meta.url).href),
-        );
+        return new URL(specifier, import.meta.url).href;
     };
 }
 
-const argv = yargs(process.argv.slice(2))
-    .options({
-        c: {
-            alias: "config",
-            default: ".metalint/metalint.config.js",
-            requiresArg: true,
-            type: "string",
-        },
-        f: {
-            alias: "formatter",
-            requiresArg: true,
-            type: "string",
-        },
-        fix: {
-            alias: "fix",
-            type: "boolean",
-        },
-        l: {
-            alias: "level",
-            requiresArg: true,
-            type: "string",
-        },
-        o: {
-            alias: "output",
-            requiresArg: true,
-            type: "string",
-        },
-        p: {
-            alias: "patterns",
-            requiresArg: true,
-            type: "array",
-        },
-        help: {
-            alias: "help",
-            type: "boolean",
-        },
-    })
-    .help(false).argv;
-
 /**
  * Vérifie (en appelant des linters) une liste de fichiers.
  *
- * @param {string[]}    files     La liste des fichiers.
- * @param {Checker[]}   checkers  La liste des vérifications faites sur les
- *                                fichiers.
- * @param {string}      root      L'adresse du répertoire où se trouve le
- *                                dossier <code>.metalint/</code>.
- * @param {Formatter[]} reporters La liste des rapporteurs utilisés pour
- *                                afficher les résultats.
- * @returns {Promise<number|undefined>} La sévérité la plus élévée des
- *                                      résultats.
+ * @param {string[]}                  files     La liste des fichiers.
+ * @param {FlattenedConfigChecker[]}  checkers  La liste des vérifications
+ *                                              faites sur les fichiers.
+ * @param {string}                    root      L'adresse du répertoire où se
+ *                                              trouve le répertoire
+ *                                              <code>.metalint/</code>.
+ * @param {FlattenedConfigReporter[]} reporters La liste des rapporteurs
+ *                                              utilisés pour afficher les
+ *                                              résultats.
+ * @returns {Promise<Severity|undefined>} La sévérité la plus élévée des
+ *                                        résultats.
  */
 const check = async function (files, checkers, root, reporters) {
     let severity;
 
+    const formatters = reporters.map((reporter) => {
+        // eslint-disable-next-line new-cap
+        return new reporter.formatter(reporter.level, reporter.options);
+    });
     const results = await metalint(files, checkers, root);
     for (const [file, notices] of Object.entries(results)) {
         // Déterminer la sévérité la plus élévée des résultats.
@@ -98,19 +66,20 @@ const check = async function (files, checkers, root, reporters) {
         }
 
         // Afficher les notifications avec chaque rapporteur.
-        for (const reporter of reporters) {
-            await reporter.notify(file, notices);
+        for (const formatter of formatters) {
+            await formatter.notify(file, notices);
         }
     }
 
     // Attendre tous les rapporteurs.
-    await Promise.all(reporters.map((r) => r.finalize(severity)));
+    await Promise.all(formatters.map((f) => f.finalize()));
     return severity;
 };
 
+const argv = await parse();
 if (argv.help) {
     process.stdout.write(
-        fs.readFileSync(await import.meta.resolve("./help.txt")),
+        await fs.readFile(fileURLToPath(import.meta.resolve("./help.txt"))),
     );
     process.exit(0);
 }
@@ -118,7 +87,7 @@ if (argv.help) {
 let root = process.cwd();
 // Rechercher le fichier de configuration dans le répertoire courant, puis dans
 // les parents, grands-parents...
-while (!fs.existsSync(path.join(root, argv.config))) {
+while (!(await exists(path.join(root, argv.config)))) {
     // Si on est remonté à la racine.
     if (path.join(root, "..") === root) {
         process.stderr.write("metalint: no such config file.\n");
@@ -129,24 +98,29 @@ while (!fs.existsSync(path.join(root, argv.config))) {
 
 try {
     // eslint-disable-next-line no-unsanitized/method
-    const { default: config } = await import(path.join(root, argv.config));
-    const { patterns, checkers, reporters } = await normalize(
-        config,
-        root,
-        path.dirname(path.join(root, argv.config)),
+    const { default: config } = await import(
+        pathToFileURL(path.join(root, argv.config))
+    );
+    const { patterns, reporters, checkers } = flatten(
+        await normalize(config, {
+            dir: path.dirname(path.join(root, argv.config)),
+        }),
         argv,
     );
 
-    const bases = await Promise.resolve(argv._.map((a) => glob.normalize(a)));
-    const files = await glob.walk(bases, patterns, root);
+    const glob = new Glob(patterns, { root });
+    const files = [];
+    for (const base of argv._) {
+        files.push(...(await glob.walk(base)));
+    }
 
     const severity = await check(files, checkers, root, reporters);
     let code;
     switch (severity) {
-        case SEVERITY.FATAL:
+        case Severities.FATAL:
             code = 2;
             break;
-        case SEVERITY.ERROR:
+        case Severities.ERROR:
             code = 1;
             break;
         default: