metalint 0.11.0 → 0.11.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-2022 Sébastien Règne
+Copyright (c) 2020-2023 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,5 +1,9 @@
 # Metalint
 
+<!-- Utiliser du HTML pour faire flotter l'image à droite. -->
+<!-- markdownlint-disable-next-line no-inline-html-->
+<img src="asset/logo.svg" align="right" alt="">
+
 [![npm][img-npm]][link-npm]
 [![build][img-build]][link-build]
 [![coverage][img-coverage]][link-coverage]
@@ -13,6 +17,8 @@
 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 :
@@ -24,8 +30,7 @@ ou des utilitaires selon le type de fichier :
   [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/),
-  [linthtml](https://regseb.github.io/metalint/user/linters/linthtml/) et
+  [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/),
@@ -37,8 +42,8 @@ ou des utilitaires selon le type de fichier :
   [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/) ;
+    [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/).
@@ -47,7 +52,7 @@ ou des utilitaires selon le type de fichier :
 
 Vous pouvez installer Metalint en utilisant [npm][link-npm] :
 
-```shell
+```Shell
 npm install metalint --save-dev
 ```
 
@@ -55,17 +60,18 @@ npm install metalint --save-dev
 
 Tous les fichiers de configuration sont à regrouper dans le répertoire
 `.metalint/` qui doit être placé à la racine du projet. Le fichier
-`metalint.config.js` contient un objet JSON indiquant les linters à utiliser
-pour chaque fichier. Les autres fichiers contiennent les options spécifiques
-pour les linters.
+`metalint.config.js` export un objet JSON indiquant les linters à utiliser pour
+chaque fichier. Les autres fichiers contiennent les options spécifiques pour les
+linters.
 
 ## Exemple
 
-Dans cet exemple du fichier de configuration `metalint.json`, Metalint analyse
-les fichiers JavaScript (non-minifiés), HTML et CSS ; avec respectivement les
-linters ESLint, HTMLHint et stylelint.
+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.
 
 ```JavaScript
+// .metalint/metalint.config.js
 export default {
     patterns: ["!/.git/", "!/node_modules/", "**"],
     checkers: [
@@ -83,20 +89,56 @@ export default {
 };
 ```
 
-## Usage
+```JavaScript
+// .metalint/eslint.config.js
+export default {
+    rules: {
+        quotes: ["error", "double"],
+        semi: ["error", "always"],
+    },
+};
+```
+
+```JavaScript
+// .metalint/htmlhint.config.js
+export default {
+    "attr-value-not-empty": false,
+};
+```
+
+```JavaScript
+// .metalint/stylelint.config.js
+export default {
+    rules: {
+        "color-no-invalid-hex": true,
+    },
+};
+```
+
+## Intégration
+
+Après avoir installé Metalint et les linters dans votre projet npm, vous pouvez
+ajouter le script suivant dans votre `package.json` :
 
-```shell
-metalint
+```JSON
+{
+    "scripts": {
+        "lint": "metalint"
+    }
+}
 ```
 
-<!-- Ne pas ajouter les logos car la couleur du logo de npm n'est pas
-     personnalisable. https://github.com/badges/shields/issues/6208 -->
-[img-npm]:https://img.shields.io/npm/dm/metalint?label=npm
-[img-build]:https://img.shields.io/github/workflow/status/regseb/metalint/CI
-[img-coverage]:https://img.shields.io/coveralls/github/regseb/metalint
-[img-semver]:https://img.shields.io/badge/semver-2.0.0-blue
-
-[link-npm]:https://www.npmjs.com/package/metalint
-[link-build]:https://github.com/regseb/metalint/actions/workflows/ci.yml?query=branch%3Amain
-[link-coverage]:https://coveralls.io/github/regseb/metalint
-[link-semver]:https://semver.org/spec/v2.0.0.html "Semantic Versioning 2.0.0"
+Metalint est maintenant utilisable avec la commande : `npm run lint`
+
+[img-npm]: https://img.shields.io/npm/dm/metalint?label=npm&logo=npm&logoColor=white
+[img-build]: https://img.shields.io/github/actions/workflow/status/regseb/metalint/ci.yml?branch=main&logo=github&logoColor=white
+
+<!-- Attendre que le logo de Stryker soit accepté.
+     https://github.com/simple-icons/simple-icons/pull/7388 -->
+
+[img-coverage]: https://img.shields.io/endpoint?label=coverage&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fregseb%2Fmetalint%2Fmain
+[img-semver]: https://img.shields.io/badge/semver-2.0.0-blue?logo=semver&logoColor=white
+[link-npm]: https://www.npmjs.com/package/metalint
+[link-build]: https://github.com/regseb/metalint/actions/workflows/ci.yml?query=branch%3Amain
+[link-coverage]: https://dashboard.stryker-mutator.io/reports/github.com/regseb/metalint/main
+[link-semver]: https://semver.org/spec/v2.0.0.html "Semantic Versioning 2.0.0"

package/package.json

@@ -1,96 +1,101 @@
 {
-    "name": "metalint",
-    "version": "0.11.0",
-    "description": "Un linter pour les gouverner tous.",
-    "keywords": [
-        "checker",
-        "lint",
-        "metalint",
-        "quality",
-        "static-analysis"
-    ],
-    "homepage": "https://github.com/regseb/metalint#readme",
-    "bugs": {
-        "url": "https://github.com/regseb/metalint/issues",
-        "email": "regseb@gmail.com"
-    },
-    "license": "MIT",
-    "author": "Sébastien Règne <regseb@gmail.com> (https://github.com/regseb)",
-    "funding": "https://www.paypal.me/sebastienregne",
-    "files": [
-        "src/",
-        "types/"
-    ],
-    "main": "src/core/index.js",
-    "types": "types/index.d.ts",
-    "bin": "src/bin/index.js",
-    "repository": "regseb/metalint",
-    "type": "module",
-    "scripts": {
-        "lint": "src/bin/index.js",
-        "lint:types": "tsc --project .tsconfig_lint.json",
-        "test": "c8 mocha --config test/mocharc.json",
-        "coverage:html": "c8 report --reporter html",
-        "coverage:lcov": "c8 report --reporter lcovonly",
-        "jsdocs": "typedoc --tsconfig .tsconfig_jsdocs.json --out jsdocs/ src/core/",
-        "release": "standard-version",
-        "clean": "node .script/clean.js"
-    },
-    "dependencies": {
-        "chalk": "5.1.2",
-        "yargs": "17.6.2"
-    },
-    "devDependencies": {
-        "@coffeelint/cli": "5.2.11",
-        "@linthtml/linthtml": "0.9.3",
-        "@types/debug": "4.1.7",
-        "@types/eslint": "8.4.10",
-        "@types/file-entry-cache": "5.0.2",
-        "@types/htmlhint": "1.1.2",
-        "@types/js-yaml": "4.0.5",
-        "@types/jshint": "2.12.1",
-        "@types/mocha": "10.0.0",
-        "@types/mock-fs": "4.13.1",
-        "@types/node": "18.11.9",
-        "@types/sinon": "10.0.13",
-        "@types/yargs": "17.0.13",
-        "addons-linter": "5.21.0",
-        "c8": "7.12.0",
-        "csslint": "1.0.5",
-        "doiuse": "4.4.1",
-        "eslint": "8.27.0",
-        "eslint-plugin-eslint-comments": "3.2.0",
-        "eslint-plugin-import": "2.26.0",
-        "eslint-plugin-jsdoc": "39.6.2",
-        "eslint-plugin-mocha": "10.1.0",
-        "eslint-plugin-n": "15.5.1",
-        "eslint-plugin-no-unsanitized": "4.0.1",
-        "eslint-plugin-promise": "6.1.1",
-        "eslint-plugin-regexp": "1.10.0",
-        "eslint-plugin-unicorn": "44.0.2",
-        "flow-bin": "0.193.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.26.2",
-        "markuplint": "2.11.0",
-        "mocha": "10.1.0",
-        "mock-fs": "5.2.0",
-        "npm-package-json-lint": "6.3.0",
-        "purgecss": "5.0.0",
-        "sinon": "14.0.2",
-        "standard": "17.0.0",
-        "standard-version": "9.5.0",
-        "stylelint": "14.15.0",
-        "typedoc": "0.23.21",
-        "typescript": "4.8.4",
-        "yaml-lint": "1.7.0"
-    },
-    "engines": {
-        "node": ">=18.12.0"
-    }
+  "name": "metalint",
+  "version": "0.11.1",
+  "description": "Un linter pour les gouverner tous.",
+  "keywords": [
+    "checker",
+    "lint",
+    "metalint",
+    "quality",
+    "static-analysis"
+  ],
+  "homepage": "https://github.com/regseb/metalint#readme",
+  "bugs": {
+    "url": "https://github.com/regseb/metalint/issues",
+    "email": "regseb@gmail.com"
+  },
+  "license": "MIT",
+  "author": "Sébastien Règne <regseb@gmail.com> (https://github.com/regseb)",
+  "funding": "https://www.paypal.me/sebastienregne",
+  "files": [
+    "src/",
+    "types/"
+  ],
+  "main": "src/core/index.js",
+  "types": "types/index.d.ts",
+  "bin": "src/bin/index.js",
+  "repository": "regseb/metalint",
+  "type": "module",
+  "scripts": {
+    "lint": "src/bin/index.js",
+    "lint:fix": "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:coverage": "stryker run .stryker.config.js",
+    "jsdocs": "typedoc --tsconfig .tsconfig_jsdocs.json --out jsdocs/ src/core/",
+    "prepare": "tsc --project .tsconfig_types.json",
+    "release": "standard-version",
+    "clean": "node .script/clean.js"
+  },
+  "dependencies": {
+    "chalk": "5.2.0",
+    "yargs": "17.7.1"
+  },
+  "devDependencies": {
+    "@coffeelint/cli": "5.2.11",
+    "@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",
+    "@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",
+    "csslint": "1.0.5",
+    "doiuse": "4.4.1",
+    "eslint": "8.35.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-mocha": "10.1.0",
+    "eslint-plugin-n": "15.6.1",
+    "eslint-plugin-no-unsanitized": "4.0.2",
+    "eslint-plugin-promise": "6.1.1",
+    "eslint-plugin-regexp": "1.12.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",
+    "mocha": "10.2.0",
+    "mock-fs": "5.2.0",
+    "npm-package-json-lint": "6.4.0",
+    "prettier": "2.8.4",
+    "purgecss": "5.0.0",
+    "sinon": "15.0.1",
+    "standard": "17.0.0",
+    "standard-version": "9.5.0",
+    "stylelint": "15.2.0",
+    "typedoc": "0.23.26",
+    "typescript": "4.9.5",
+    "yaml-lint": "1.7.0"
+  },
+  "engines": {
+    "node": ">=18.12.0"
+  }
 }

package/src/bin/help.txt

@@ -6,13 +6,14 @@ options courtes.
   -c, --config=CONFIG        spécifier l'emplacement du fichier de configuration
   -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
-      --help     afficher l'aide et quitter
-      --version  afficher des informations de version et quitter
+  --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.
 

package/src/bin/index.js

@@ -5,8 +5,8 @@ import path from "node:path";
 import { fileURLToPath } from "node:url";
 import yargs from "yargs";
 import glob from "../core/glob.js";
-import normalize from "../core/normalize.js";
 import metalint from "../core/index.js";
+import normalize from "../core/normalize.js";
 import SEVERITY from "../core/severity.js";
 
 /**
@@ -15,7 +15,6 @@ import SEVERITY from "../core/severity.js";
  */
 
 if (undefined === import.meta.resolve) {
-
     /**
      * Résous un chemin relatif à partir du module.
      *
@@ -26,43 +25,50 @@ if (undefined === import.meta.resolve) {
      * @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 Promise.resolve(
+            fileURLToPath(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",
-    },
-    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;
+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.
@@ -103,9 +109,9 @@ const check = async function (files, checkers, root, reporters) {
 };
 
 if (argv.help) {
-    process.stdout.write(fs.readFileSync(
-        await import.meta.resolve("./help.txt"),
-    ));
+    process.stdout.write(
+        fs.readFileSync(await import.meta.resolve("./help.txt")),
+    );
     process.exit(0);
 }
 
@@ -124,20 +130,27 @@ 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)),
-                            argv);
+    const { patterns, checkers, reporters } = await normalize(
+        config,
+        root,
+        path.dirname(path.join(root, argv.config)),
+        argv,
+    );
 
-    const files = await glob.walk(argv._, patterns, root);
+    const bases = await Promise.resolve(argv._.map((a) => glob.normalize(a)));
+    const files = await glob.walk(bases, patterns, root);
 
     const severity = await check(files, checkers, root, reporters);
     let code;
     switch (severity) {
-        case SEVERITY.FATAL: code = 2; break;
-        case SEVERITY.ERROR: code = 1; break;
-        default:             code = 0;
+        case SEVERITY.FATAL:
+            code = 2;
+            break;
+        case SEVERITY.ERROR:
+            code = 1;
+            break;
+        default:
+            code = 0;
     }
     process.exit(code);
 } catch (err) {

package/src/core/formatter/checkstyle.js

@@ -1,5 +1,7 @@
 /**
  * @module
+ * @license MIT
+ * @author Sébastien Règne
  */
 
 import SEVERITY from "../severity.js";
@@ -18,15 +20,15 @@ import SEVERITY from "../severity.js";
  */
 const encode = function (input) {
     const ENTITIES = {
-        "&":  "&",
-        "<":  "&lt;",
-        ">":  "&gt;",
-        "'":  "&apos;",
-        "\"": "&quot;",
+        "&": "&amp;",
+        "<": "&lt;",
+        ">": "&gt;",
+        "'": "&apos;",
+        '"': "&quot;",
     };
     let output = input;
     for (const [character, entity] of Object.entries(ENTITIES)) {
-        output = output.replace(new RegExp(character, "gu"), entity);
+        output = output.replaceAll(new RegExp(character, "gu"), entity);
     }
     return output;
 };
@@ -52,7 +54,6 @@ const shift = function (depth, writer, size) {
  * <strong>checkstyle</strong>.
  */
 export const Formatter = class {
-
     /**
      * Le niveau de sévérité minimum des notifications affichées.
      *
@@ -88,7 +89,7 @@ export const Formatter = class {
      *                                          retour à la ligne.
      */
     constructor(level, writer, options) {
-        this.#level  = level;
+        this.#level = level;
         this.#writer = writer;
         this.#indent = options.indent ?? -1;
 
@@ -120,14 +121,16 @@ export const Formatter = class {
             if (0 !== notice.locations.length) {
                 this.#writer.write(` line="${notice.locations[0].line}"`);
                 if ("column" in notice.locations[0]) {
-                    this.#writer.write(` column="` +
-                                       `${notice.locations[0].column}"`);
+                    this.#writer.write(
+                        ` column="${notice.locations[0].column}"`,
+                    );
                 }
             }
 
             this.#writer.write(` severity="`);
             switch (notice.severity) {
-                case SEVERITY.FATAL: case SEVERITY.ERROR:
+                case SEVERITY.FATAL:
+                case SEVERITY.ERROR:
                     this.#writer.write("error");
                     break;
                 case SEVERITY.WARN: