From 9599d394d147180ebe154b6b0c59ece88193cd10 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20R=C3=A8gne?= Date: Mon, 2 Oct 2023 19:06:13 +0200 Subject: [PATCH] =?UTF-8?q?docs:=20Corriger=20des=20fautes=20de=20fran?= =?UTF-8?q?=C3=A7ais.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 2 +- .metalint/eslint.config.js | 26 +++++++++++------------ .metalint/npm-package-json-lint.config.js | 20 ++++++++--------- src/at.js | 2 +- src/cronexp.js | 2 +- src/parse.js | 8 ++++++- test/cron.js | 6 +++--- test/parse.js | 22 +++++++++---------- 8 files changed, 47 insertions(+), 41 deletions(-) diff --git a/.gitignore b/.gitignore index aac57d3..641feae 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ -# Ignorer les répertoires et les fichiers générés. +# Ignorer les répertoires générés. /.stryker/ /jsdocs/ /node_modules/ diff --git a/.metalint/eslint.config.js b/.metalint/eslint.config.js index 37e7b37..02ad7e1 100644 --- a/.metalint/eslint.config.js +++ b/.metalint/eslint.config.js @@ -373,7 +373,7 @@ export default { "max-len": [ "warn", { - // Ignorer les imports et les déclarations de tests unitaires + // Ignorer les imports et les déclarations de tests unitaires, // car Prettier n'ajoute pas de retour à la ligne pour ne pas // dépasser les 80 caractères. ignorePattern: @@ -381,7 +381,7 @@ export default { "|^ +\\* @typedef \\{import\\(" + "|^ +\\* @see " + '|^ +it\\("', - // Ignorer les expressions rationnelles car il n'est pas + // Ignorer les expressions rationnelles, car il n'est pas // possible de les écrire sur plusieurs lignes. ignoreRegExpLiterals: true, }, @@ -394,7 +394,7 @@ export default { "no-mixed-spaces-and-tabs": "off", "no-multi-spaces": "off", "no-multiple-empty-lines": "off", - // Activer cette règle car Prettier garde des tabulations (par exemple + // Activer cette règle, car Prettier garde des tabulations (par exemple // dans les chaines de caractères). "no-tabs": "error", "no-trailing-spaces": "off", @@ -483,14 +483,14 @@ export default { "import/no-mutable-exports": "error", "import/no-named-as-default": "off", "import/no-named-as-default-member": "off", - // Ne pas appliquer cette règle car elle ne fonctionnne pas quand le nom + // Ne pas appliquer cette règle, car elle ne fonctionne pas quand le nom // du fichier de configuration de ESLint n'est pas standard. // https://github.com/import-js/eslint-plugin-import/issues/2678 "import/no-unused-modules": "off", // Module systems. - // Désactiver cette règle car no-undef remontera une erreur car les - // méthodes define() et require() ne sont pas définies. + // Désactiver cette règle et laisser la règle no-undef remonter les + // erreurs, car les méthodes define() et require() ne sont pas définies. "import/no-amd": "off", // Désactiver cette règle et préférer unicorn/prefer-module. "import/no-commonjs": "off", @@ -504,7 +504,7 @@ export default { "import/namespace": "error", "import/no-absolute-path": "error", "import/no-cycle": ["error", { ignoreExternal: true }], - // Désactiver cette règle car la méthode require() est déjà interdite. + // Désactiver cette règle, car la méthode require() est déjà interdite. "import/no-dynamic-require": "off", "import/no-internal-modules": "off", "import/no-relative-packages": "error", @@ -532,8 +532,8 @@ export default { "import/first": "error", "import/group-exports": "off", "import/max-dependencies": "off", - // Ne pas activer l'option "considerComments" car les commentaires entre - // les imports ne sont pas gérés. + // Ne pas activer l'option "considerComments", car les commentaires + // entre les imports ne sont pas gérés. // https://github.com/import-js/eslint-plugin-import/issues/2673 "import/newline-after-import": ["error", { considerComments: false }], "import/no-anonymous-default-export": [ @@ -562,7 +562,7 @@ export default { // Plugin eslint-plugin-jsdoc. "jsdoc/check-access": "error", "jsdoc/check-alignment": "error", - // Désactiver cette règle car elle n'est pas pour le moment compatible + // Désactiver cette règle, car elle n'est pas pour le moment compatible // avec ESLint 8. // https://github.com/gajus/eslint-plugin-jsdoc/releases/tag/v37.0.0 "jsdoc/check-examples": "off", @@ -586,7 +586,7 @@ export default { "jsdoc/check-values": "error", "jsdoc/empty-tags": "error", "jsdoc/implements-on-classes": "error", - // Désactiver la règle car elle ne supporte pas la propriété "exports". + // Désactiver la règle, car elle ne supporte pas la propriété "exports". // https://github.com/gajus/eslint-plugin-jsdoc/issues/1114 "jsdoc/imports-as-dependencies": "off", "jsdoc/informative-docs": "error", @@ -775,7 +775,7 @@ export default { "unicorn/no-invalid-remove-event-listener": "error", "unicorn/no-keyword-prefix": "error", "unicorn/no-lonely-if": "error", - // Utiliser la règle no-negated-condition d'ESLint car celle d'unicorn + // Utiliser la règle no-negated-condition d'ESLint, car celle d'unicorn // apporte seulement la correction automatique. "unicorn/no-negated-condition": "off", "unicorn/no-nested-ternary": "off", @@ -859,7 +859,7 @@ export default { "unicorn/relative-url-style": "error", "unicorn/require-array-join-separator": "off", "unicorn/require-number-to-fixed-digits-argument": "off", - // Désactiver cette règles car il y a des faux-positifs avec la méthode + // Désactiver cette règle, car il y a des faux-positifs avec la méthode // port.postMessage() des WebExtensions. // https://github.com/sindresorhus/eslint-plugin-unicorn/issues/1396 "unicorn/require-post-message-target-origin": "off", diff --git a/.metalint/npm-package-json-lint.config.js b/.metalint/npm-package-json-lint.config.js index c1fd672..07a0d10 100644 --- a/.metalint/npm-package-json-lint.config.js +++ b/.metalint/npm-package-json-lint.config.js @@ -79,21 +79,21 @@ export default { "no-repeated-dependencies": "error", "no-absolute-version-dependencies": "off", - // Ne pas activer cette règle car la règle + // Ne pas activer cette règle, car la règle // prefer-absolute-version-dependencies oblige les versions absolues. "no-archive-dependencies": "off", - // Ne pas activer cette règle car la règle + // Ne pas activer cette règle, car la règle // prefer-absolute-version-dependencies oblige les versions absolues. "no-caret-version-dependencies": "off", - // Ne pas activer cette règle car la règle + // Ne pas activer cette règle, car la règle // prefer-absolute-version-dependencies oblige les versions absolues. "no-file-dependencies": "off", - // Ne pas activer cette règle car la règle + // Ne pas activer cette règle, car la règle // prefer-absolute-version-dependencies oblige les versions absolues. "no-git-dependencies": "off", "no-restricted-dependencies": "off", "no-restricted-pre-release-dependencies": "off", - // Ne pas activer cette règle car la règle + // Ne pas activer cette règle, car la règle // prefer-absolute-version-dependencies oblige les versions absolues. "no-tilde-version-dependencies": "off", "prefer-absolute-version-dependencies": "error", @@ -103,21 +103,21 @@ export default { "prefer-tilde-version-dependencies": "off", "no-absolute-version-devDependencies": "off", - // Ne pas activer cette règle car la règle + // Ne pas activer cette règle, car la règle // prefer-absolute-version-devDependencies oblige les versions absolues. "no-archive-devDependencies": "off", - // Ne pas activer cette règle car la règle + // Ne pas activer cette règle, car la règle // prefer-absolute-version-devDependencies oblige les versions absolues. "no-caret-version-devDependencies": "off", - // Ne pas activer cette règle car la règle + // Ne pas activer cette règle, car la règle // prefer-absolute-version-devDependencies oblige les versions absolues. "no-file-devDependencies": "off", - // Ne pas activer cette règle car la règle + // Ne pas activer cette règle, car la règle // prefer-absolute-version-devDependencies oblige les versions absolues. "no-git-devDependencies": "off", "no-restricted-devDependencies": "off", "no-restricted-pre-release-devDependencies": "off", - // Ne pas activer cette règle car la règle + // Ne pas activer cette règle, car la règle // prefer-absolute-version-devDependencies oblige les versions absolues. "no-tilde-version-devDependencies": "off", "prefer-absolute-version-devDependencies": "error", diff --git a/src/at.js b/src/at.js index 8f95d33..f4b9c78 100644 --- a/src/at.js +++ b/src/at.js @@ -81,7 +81,7 @@ export default class At { // Planifier l'exécution. this.#timeoutID = setTimeout(() => this.run(), delay); } else { - // Planifier des étapes intermédiaires car Node.js n'accepte pas + // Planifier des étapes intermédiaires, car Node.js n'accepte pas // un grand délai. this.#timeoutID = setTimeout(() => this.#schedule(), MAX_DELAY); } diff --git a/src/cronexp.js b/src/cronexp.js index ed5f22b..e909c0f 100644 --- a/src/cronexp.js +++ b/src/cronexp.js @@ -284,7 +284,7 @@ export default class CronExp { const date = new Date(start.getTime()); // Mettre temporairement le premier jour du mois et calculer le bon jour - // après avoir trouver le bon mois. + // après avoir trouvé le bon mois. date.setDate(1); date.setHours(this.#hours.min); date.setMinutes(this.#minutes.min); diff --git a/src/parse.js b/src/parse.js index 7fa7a2f..cffcc83 100644 --- a/src/parse.js +++ b/src/parse.js @@ -1,3 +1,9 @@ +/** + * @module + * @license MIT + * @author Sébastien Règne + */ + import Field from "./field.js"; /** @@ -170,7 +176,7 @@ const getIndexValue = (date, index, max = false) => { // Utiliser le nombre sept pour le dimanche quand il est placé dans // la borne supérieure. return max && 0 === date.getDay() ? 7 : date.getDay(); - // Stryker disable next-line all: Désactiver Stryker pour le défaut car + // Stryker disable next-line all: Désactiver Stryker pour le défaut, car // la fonction getIndexValue() est toujours appelée avec un index entre // 0 et 5. Il est donc impossible de tester cette condition. default: diff --git a/test/cron.js b/test/cron.js index 1c33075..bdbd9f6 100644 --- a/test/cron.js +++ b/test/cron.js @@ -87,13 +87,13 @@ describe("cron.js", function () { }); describe("get active()", function () { - it("should return 'true' when task is actived", function () { + it("should return 'true' when task is activated", function () { const cron = new Cron("0 0 1 1 *", () => {}); assert.equal(cron.active, true); cron.stop(); }); - it("should return 'false' when task is deactived", function () { + it("should return 'false' when task is deactivated", function () { const cron = new Cron("0 0 1 1 *", () => {}, { active: false }); assert.equal(cron.active, false); }); @@ -199,7 +199,7 @@ describe("cron.js", function () { assert.equal(fake.callCount, 0); }); - it("should ignore call when task is deactive", function () { + it("should ignore call when task is deactivated", function () { const fake = sinon.fake(); const clock = sinon.useFakeTimers(new Date("2000-01-01T00:00")); diff --git a/test/parse.js b/test/parse.js index 66d1814..f938e22 100644 --- a/test/parse.js +++ b/test/parse.js @@ -11,7 +11,7 @@ import parse from "../src/parse.js"; * Génère les valeurs d'un intervalle. * * @param {number} min La valeur minimale (incluse) de l'intervalle. - * @param {number} max La valeur maximal (incluse) de l'intervalle. + * @param {number} max La valeur maximale (incluse) de l'intervalle. * @param {number} [step] Le pas entre les valeurs (1> par défaut). * @returns {number[]} La liste des valeurs. */ @@ -313,7 +313,7 @@ describe("parse.js", function () { assert.ok(!fields.day.restricted); }); - it("should support litteral uppercase month", function () { + it("should support literal uppercase month", function () { const fields = parse("* * * * DEC *"); assert.ok(!fields.seconds.restricted); assert.ok(!fields.minutes.restricted); @@ -323,7 +323,7 @@ describe("parse.js", function () { assert.ok(!fields.day.restricted); }); - it("should reject litteral invalid month", function () { + it("should reject literal invalid month", function () { assert.throws(() => parse("* * * * foo *"), { name: "Error", message: "Syntax error, unrecognized expression: * * * * foo *", @@ -400,7 +400,7 @@ describe("parse.js", function () { assert.deepEqual(fields.day.values(), [6]); }); - it("should support litteral uppercase day", function () { + it("should support literal uppercase day", function () { const fields = parse("* * * * * SAT"); assert.ok(!fields.seconds.restricted); assert.ok(!fields.minutes.restricted); @@ -410,7 +410,7 @@ describe("parse.js", function () { assert.deepEqual(fields.day.values(), [6]); }); - it("should reject litteral invalid day", function () { + it("should reject literal invalid day", function () { assert.throws(() => parse("* * * * * foo"), { name: "Error", message: "Syntax error, unrecognized expression: * * * * * foo", @@ -537,7 +537,7 @@ describe("parse.js", function () { assert.deepEqual(fields.day.values(), [1, 2, 3, 4, 5, 6]); }); - it("should support litteral month in max", function () { + it("should support literal month in max", function () { const fields = parse("* * * * 6-sep *"); assert.ok(!fields.seconds.restricted); assert.ok(!fields.minutes.restricted); @@ -547,7 +547,7 @@ describe("parse.js", function () { assert.ok(!fields.day.restricted); }); - it("should support litteral uppercase month in max", function () { + it("should support literal uppercase month in max", function () { const fields = parse("* * * * 5-OCT *"); assert.ok(!fields.seconds.restricted); assert.ok(!fields.minutes.restricted); @@ -557,7 +557,7 @@ describe("parse.js", function () { assert.ok(!fields.day.restricted); }); - it("should reject litteral invalid month in max", function () { + it("should reject literal invalid month in max", function () { assert.throws(() => parse("* * * * 1-foo *"), { name: "Error", message: @@ -565,7 +565,7 @@ describe("parse.js", function () { }); }); - it("should support litteral day in max", function () { + it("should support literal day in max", function () { const fields = parse("* * * * * 1-fri"); assert.ok(!fields.seconds.restricted); assert.ok(!fields.minutes.restricted); @@ -575,7 +575,7 @@ describe("parse.js", function () { assert.deepEqual(fields.day.values(), [1, 2, 3, 4, 5]); }); - it("should support litteral uppercase day in max", function () { + it("should support literal uppercase day in max", function () { const fields = parse("* * * * * 2-THU"); assert.ok(!fields.seconds.restricted); assert.ok(!fields.minutes.restricted); @@ -595,7 +595,7 @@ describe("parse.js", function () { assert.deepEqual(fields.day.values(), [0, 6]); }); - it("should reject litteral invalid day in max", function () { + it("should reject literal invalid day in max", function () { assert.throws(() => parse("* * * * * 0-foo"), { name: "Error", message: