metalint 0.14.1 → 0.15.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-2023 Sébastien Règne
+Copyright (c) 2020-2024 Sébastien Règne
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,6 +1,7 @@
 # Metalint
 
-<!-- Utiliser du HTML pour faire flotter l'image à droite. -->
+<!-- Utiliser du HTML (avec l'attribut "align" obsolète) pour faire flotter
+     l'image à droite. -->
 <!-- markdownlint-disable-next-line no-inline-html-->
 <img src="asset/logo.svg" align="right" alt="">
 
@@ -72,6 +73,7 @@ source) :
   <tr>
     <td>JSON</td>
     <td>
+      <a title="ajv" href="https://www.npmjs.com/package/ajv">Ajv</a>,
       <a title="@prantlf/jsonlint"
          href="https://www.npmjs.com/package/@prantlf/jsonlint">@prantlf/JSON
         Lint</a>,
@@ -100,18 +102,16 @@ source) :
   <tr>
     <td>package.json</td>
     <td>
-      <!-- markdownlint-disable no-bare-urls -->
-      <!-- https://github.com/DavidAnson/markdownlint/issues/961 -->
+      <a title="depcheck"
+         href="https://www.npmjs.com/package/depcheck">Depcheck</a>
       <a title="npm-check-updates"
          href="https://www.npmjs.com/package/npm-check-updates"
          >npm-check-updates</a>,
-      <!-- markdownlint-enable no-bare-urls -->
-      <!-- markdownlint-disable no-bare-urls -->
-      <!-- https://github.com/DavidAnson/markdownlint/issues/961 -->
       <a title="npm-package-json-lint"
          href="https://www.npmjs.com/package/npm-package-json-lint"
          >npm-package-json-lint</a>,
-      <!-- markdownlint-enable no-bare-urls -->
+      <a title="publint"
+         href="https://www.npmjs.com/package/publint">publint</a>,
       <a title="sort-package-json"
          href="https://www.npmjs.com/package/sort-package-json">Sort
         Package.json</a>
@@ -133,6 +133,15 @@ source) :
          href="https://www.npmjs.com/package/stylelint">Stylelint</a>
     </td>
   </tr>
+  <tr>
+    <td>SVG</td>
+    <td>
+      <a title="prettier"
+         href="https://www.npmjs.com/package/prettier">Prettier</a>,
+      <a title="svglint"
+         href="https://www.npmjs.com/package/svglint">SVGLint</a>
+    </td>
+  </tr>
   <tr>
     <td>WebExtension</td>
     <td>
@@ -221,6 +230,8 @@ export default {
 
 ## Intégration
 
+### npm
+
 Après avoir installé Metalint et les linters dans votre projet npm, vous pouvez
 ajouter le script suivant dans votre `package.json` :
 
@@ -234,6 +245,26 @@ ajouter le script suivant dans votre `package.json` :
 
 Metalint est maintenant utilisable avec la commande : `npm run lint`
 
+### GitHub Actions
+
+Pour lancer Metalint dans vos GitHub Actions, vous pouvez utiliser le formateur
+`github` pour rapporter les problèmes dans les pull requests.
+
+```YAML
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-node@v4
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Install dependencies
+        run: npm ci
+      - name: Lint files
+        run: npm run lint -- --formatter github
+```
+
 [img-npm]: https://img.shields.io/npm/dm/metalint?label=npm&logo=npm&logoColor=whitesmoke
 [img-build]: https://img.shields.io/github/actions/workflow/status/regseb/metalint/ci.yml?branch=main&logo=github&logoColor=whitesmoke
 [img-coverage]: https://img.shields.io/endpoint?label=coverage&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fregseb%2Fmetalint%2Fmain&logo=stryker&logoColor=whitesmoke

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "metalint",
-  "version": "0.14.1",
+  "version": "0.15.0",
   "description": "Un linter pour les gouverner tous.",
   "keywords": [
     "checker",
@@ -24,7 +24,7 @@
   "exports": {
     ".": {
       "types": "./types/index.d.ts",
-      "default": "./src/code/index.js"
+      "default": "./src/core/index.js"
     },
     "./api/formatter": {
       "types": "./types/formatter/formatter.d.ts",
@@ -47,7 +47,7 @@
     "lint:types": "tsc --project .tsconfig_lint.json",
     "test": "npm run test:unit",
     "test:unit": "mocha --config test/unit/mocharc.json",
-    "test:coverage": "stryker run .stryker.config.js",
+    "test:coverage": "stryker run",
     "jsdocs": "typedoc --tsconfig .tsconfig_jsdocs.json",
     "prepare": "tsc --project .tsconfig_types.json",
     "clean": "node .script/clean.js"
@@ -59,51 +59,54 @@
   "devDependencies": {
     "@coffeelint/cli": "5.2.11",
     "@prantlf/jsonlint": "14.0.3",
-    "@prettier/plugin-xml": "3.2.0",
-    "@stryker-mutator/core": "7.1.1",
-    "@stryker-mutator/mocha-runner": "7.1.1",
-    "@types/eslint": "8.44.2",
-    "@types/htmlhint": "1.1.2",
-    "@types/jshint": "2.12.2",
-    "@types/mocha": "10.0.1",
-    "@types/mock-fs": "4.13.1",
-    "@types/sinon": "10.0.16",
-    "@types/yargs": "17.0.24",
-    "addons-linter": "6.13.0",
+    "@prettier/plugin-xml": "3.2.2",
+    "@stryker-mutator/core": "8.0.0",
+    "@stryker-mutator/mocha-runner": "8.0.0",
+    "@types/eslint": "8.56.1",
+    "@types/htmlhint": "1.1.5",
+    "@types/jshint": "2.12.4",
+    "@types/mocha": "10.0.6",
+    "@types/sinon": "17.0.2",
+    "@types/yargs": "17.0.32",
+    "addons-linter": "6.19.0",
+    "ajv": "8.12.0",
     "csslint": "1.0.5",
+    "depcheck": "1.4.7",
     "doiuse": "6.0.2",
-    "eslint": "8.49.0",
-    "eslint-plugin-array-func": "3.1.8",
+    "eslint": "8.56.0",
+    "eslint-plugin-array-func": "4.0.0",
     "eslint-plugin-eslint-comments": "3.2.0",
-    "eslint-plugin-import": "2.28.1",
-    "eslint-plugin-jsdoc": "46.5.1",
-    "eslint-plugin-mocha": "10.1.0",
-    "eslint-plugin-n": "16.0.2",
+    "eslint-plugin-import": "2.29.1",
+    "eslint-plugin-jsdoc": "48.0.2",
+    "eslint-plugin-mocha": "10.2.0",
+    "eslint-plugin-n": "16.6.1",
     "eslint-plugin-no-unsanitized": "4.0.2",
     "eslint-plugin-promise": "6.1.1",
-    "eslint-plugin-regexp": "1.15.0",
-    "eslint-plugin-unicorn": "48.0.1",
+    "eslint-plugin-regexp": "2.1.2",
+    "eslint-plugin-unicorn": "50.0.1",
     "htmlhint": "1.1.4",
     "htmllint": "0.8.0",
     "jshint": "2.13.6",
     "jsonlint-mod": "1.7.6",
-    "markdownlint": "0.31.0",
-    "markuplint": "3.12.1",
+    "jszip": "3.10.1",
+    "markdownlint": "0.32.1",
+    "markuplint": "3.15.0",
     "mocha": "10.2.0",
-    "mock-fs": "5.2.0",
-    "npm-check-updates": "16.13.3",
-    "npm-package-json-lint": "7.0.0",
-    "prettier": "3.0.3",
+    "npm-check-updates": "16.14.12",
+    "npm-package-json-lint": "7.1.0",
+    "prettier": "3.1.1",
+    "publint": "0.2.7",
     "purgecss": "5.0.0",
-    "sinon": "15.2.0",
-    "sort-package-json": "2.5.1",
+    "sinon": "17.0.1",
+    "sort-package-json": "2.6.0",
     "standard": "17.1.0",
-    "stylelint": "15.10.3",
-    "typedoc": "0.25.1",
-    "typescript": "5.2.2",
+    "stylelint": "16.1.0",
+    "svglint": "2.6.0",
+    "typedoc": "0.25.6",
+    "typescript": "5.3.3",
     "yaml-lint": "1.7.0"
   },
   "engines": {
-    "node": ">=20.0.0"
+    "node": ">=20.6.0"
   }
 }

package/src/bin/index.js

@@ -1,86 +1,12 @@
 #!/usr/bin/env node
 
-// Désactiver cette règle, car elle ne supporte pas les valeurs de la propriété
-// "files" (du package.json) commençant par "./".
-// https://github.com/eslint-community/eslint-plugin-n/issues/99
-// eslint-disable-next-line n/no-unpublished-bin
 import fs from "node:fs/promises";
-import path from "node:path";
 import process from "node:process";
-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 { fileURLToPath } from "node:url";
+import Metalint from "../core/index.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("../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) {
-    /**
-     * Résous un chemin relatif à partir du module.
-     *
-     * @param {string} specifier Le chemin relatif vers un fichier ou un
-     *                           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 new URL(specifier, import.meta.url).href;
-    };
-}
-
-/**
- * Vérifie (en appelant des linters) une liste de fichiers.
- *
- * @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 élevé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 élevée des résultats.
-        if (undefined !== notices) {
-            for (const notice of notices) {
-                if (undefined === severity || severity > notice.severity) {
-                    severity = notice.severity;
-                }
-            }
-        }
-
-        // Afficher les notifications avec chaque rapporteur.
-        for (const formatter of formatters) {
-            await formatter.notify(file, notices);
-        }
-    }
-
-    // Attendre tous les rapporteurs.
-    await Promise.all(formatters.map((f) => f.finalize()));
-    return severity;
-};
-
 const argv = await parse();
 if (argv.help) {
     process.stdout.write(
@@ -89,37 +15,16 @@ if (argv.help) {
     process.exit(0);
 }
 
-let root = process.cwd();
-// Rechercher le fichier de configuration dans le répertoire courant, puis dans
-// les parents, grands-parents...
-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");
-        process.exit(10);
-    }
-    root = path.join(root, "..");
-}
-
 try {
-    // eslint-disable-next-line no-unsanitized/method
-    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 glob = new Glob(patterns, { root });
-    const files = [];
-    for (const base of argv._) {
-        files.push(...(await glob.walk(base)));
-    }
+    const metalint = await Metalint.fromFileSystem({
+        config: argv.config,
+        fix: argv.fix,
+        formatter: argv.formatter,
+        level: argv.level,
+    });
+    const results = await metalint.lintFiles(argv._);
+    const severity = await metalint.report(results);
 
-    const severity = await check(files, checkers, root, reporters);
     let code;
     switch (severity) {
         case Severities.FATAL:

package/src/core/configuration/flatten.js

@@ -255,16 +255,18 @@ export const flattenChecker = function (hierarchy, { fix, level }) {
 /**
  * Fusionne la configuration.
  *
- * @param {NormalizedConfig}  hierarchy      L'objet JSON normalisé contenant la
- *                                           configuration.
- * @param {Object}            argv           Certaines options de la ligne de
- *                                           commande.
- * @param {boolean|undefined} argv.fix       L'option <code>--fix</code> de la
- *                                           ligne de commande.
- * @param {TypeofFormatter}   argv.formatter L'option <code>--formatter</code>
- *                                           de la ligne de commande.
- * @param {Level}             argv.level     L'options <code>--level</code> de
- *                                           la ligne de commande.
+ * @param {NormalizedConfig}          hierarchy      L'objet JSON normalisé
+ *                                                   contenant la configuration.
+ * @param {Object}                    argv           Certaines options de la
+ *                                                   ligne de commande.
+ * @param {boolean|undefined}         argv.fix       L'option <code>--fix</code>
+ *                                                   de la ligne de commande.
+ * @param {TypeofFormatter|undefined} argv.formatter L'option
+ *                                                   <code>--formatter</code> de
+ *                                                   la ligne de commande.
+ * @param {Level|undefined}           argv.level     L'options
+ *                                                   <code>--level</code> de la
+ *                                                   ligne de commande.
  * @returns {FlattenedConfig} L'objet JSON fusionné.
  */
 export const flatten = function (hierarchy, argv) {
@@ -272,7 +274,6 @@ export const flatten = function (hierarchy, argv) {
     const level = flattenLevel(argv.level ?? Levels.INFO, {
         level: hierarchy.level,
     });
-    // TODO Vérifier que checkers n'est pas vide.
     return {
         patterns: hierarchy.patterns,
         reporters: flattenReporters(hierarchy.reporters, {

package/src/core/formatter/console.js

@@ -112,14 +112,14 @@ const printCodeSource = function (locations, content, writer) {
         printCodeSourceLine(line - 1, content, false, writer);
         printCodeSourceLine(line, content, true, writer);
         if (0 !== columns.length) {
-            let dashs = "-".repeat(6 + columns.at(-1));
+            let dashes = "-".repeat(6 + columns.at(-1));
             for (const column of columns) {
-                dashs =
-                    dashs.slice(0, 6 + column) +
+                dashes =
+                    dashes.slice(0, 6 + column) +
                     "^" +
-                    dashs.slice(6 + column + 1);
+                    dashes.slice(6 + column + 1);
             }
-            print(writer, dashs + "\n");
+            print(writer, dashes + "\n");
         }
         printCodeSourceLine(line + 1, content, false, writer);
         printCodeSourceLine(line + 2, content, false, writer);

package/src/core/formatter/formatter.js

@@ -12,20 +12,6 @@ import { fileURLToPath } from "node:url";
  * @typedef {import("../../type/index.js").Notice} Notice
  */
 
-if (undefined === import.meta.resolve) {
-    /**
-     * Résous un chemin relatif à partir du module.
-     *
-     * @param {string} specifier Le chemin relatif vers un fichier ou un
-     *                           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 new URL(specifier, import.meta.url).href;
-    };
-}
-
 /**
  * La liste des fichiers JavaScript des formateurs.
  *
@@ -39,10 +25,11 @@ const scripts = await fs.readdir(fileURLToPath(import.meta.resolve("./")));
  * @constant {string[]} FORMATTERS
  */
 export const FORMATTERS = scripts
-    // Enlever l'extension du fichier.
-    .map((f) => f.slice(0, -3))
-    // Enlever ce fichier qui n'est pas un vrai formateur.
-    .filter((f) => "formatter" !== f);
+    // Garder seulement les fichiers JavaScript et enlever le fichier
+    // "formatter.js" qui n'est pas un vrai formateur.
+    .filter((f) => f.endsWith(".js") && "formatter.js" !== f)
+    // Enlever l'extension des fichiers.
+    .map((f) => f.slice(0, -3));
 
 /**
  * Le formateur parent.