@adrien-chinour/js-quality 0.2.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +37 -17
  2. package/dist/cli.mjs +22 -9
  3. package/package.json +12 -7
package/README.md CHANGED
@@ -7,7 +7,7 @@ Portes qualité JS/TS que [Vite+](https://viteplus.dev) ne fournit pas, réunies
7
7
  | Complexité cognitive | Complexité de chaque fonction, règle `sonarjs/cognitive-complexity` (définition SonarSource) | 15 au plus |
8
8
  | CRAP | `complexité² × (1 − couverture)³ + complexité`, par fonction, couverture lue dans `coverage/lcov.info` | moins de 10 |
9
9
  | Duplication | Blocs copiés-collés (jscpd), 40 tokens et 4 lignes au moins | 0 % |
10
- | Mutation | Score Stryker, les tests du projet lancés par sa propre commande | 70 % au moins |
10
+ | Mutation | Score Stryker, tests du projet lancés par Vitest, seuls ceux qui couvrent chaque mutant | 70 % au moins |
11
11
 
12
12
  Format, lint, types et tests restent à Vite+ (`vp check`, `vp test`). `jsq` n'a besoin d'aucune configuration ESLint,
13
13
  Stryker ou jscpd dans le projet : tout est embarqué.
@@ -18,9 +18,16 @@ Paquet npm [`@adrien-chinour/js-quality`](https://www.npmjs.com/package/@adrien-
18
18
  dev avec la couverture v8 de Vitest :
19
19
 
20
20
  ```sh
21
- vp add -D @adrien-chinour/js-quality @vitest/coverage-v8@<version du Vitest de Vite+>
21
+ vp add -D @adrien-chinour/js-quality @vitest/coverage-v8@<version du Vitest de Vite+> vitest@<version du Vitest de Vite+>
22
22
  ```
23
23
 
24
+ `vitest` se déclare à la version exacte dont dépend `vite-plus` (ligne `vitest` de `vp --version`) : le runner
25
+ Vitest de Stryker, embarqué dans `jsq`, importe `vitest` depuis son propre emplacement, et la déclaration garantit
26
+ qu'il charge celui de Vite+. C'est une dépendance peer facultative de `js-quality`, inutile avec
27
+ `mutation.command`. Les tests continuent d'importer `vite-plus/test`. Le projet garde l'override de `vite` que pose
28
+ `vp create` (`vite@*` vers `@voidzero-dev/vite-plus-core`) : sans lui, `vitest` peut exister en deux copies, et le
29
+ runner échoue sur « Vitest failed to find the current suite ».
30
+
24
31
  Aucun script d'installation : `dist/` est construit avant publication, pnpm n'a rien à approuver.
25
32
 
26
33
  `vite.config.ts` doit produire un rapport lcov :
@@ -63,10 +70,13 @@ Facultative, bloc `jsq` du `package.json`. Valeurs par défaut :
63
70
  "lcov": "coverage/lcov.info",
64
71
  "baseline": "jsq-baseline.json",
65
72
  "duplication": { "minTokens": 40, "minLines": 4, "threshold": 0 },
66
- "mutation": { "command": "vp test run", "break": 70, "mutate": [] }
73
+ "mutation": { "break": 70, "mutate": [] }
67
74
  }
68
75
  ```
69
76
 
77
+ `mutation.command` (absent par défaut), pour un projet dont les tests ne passent pas par Vitest : Stryker lance
78
+ alors cette commande pour chaque mutant (runner « command »), sans analyse de couverture par test.
79
+
70
80
  Un seuil assoupli se justifie dans le README du projet qui l'assouplit.
71
81
 
72
82
  ## Adoption progressive
@@ -114,12 +124,16 @@ Monorepo : chaque lancement de `jsq` a sa référence, dans le dossier où il to
114
124
  `oxlint-disable` sont rendus inertes (`eslint_disable`, même longueur) : aucun commentaire ne masque une fonction
115
125
  ni ne fait échouer la mesure, et les sources du projet ne sont pas modifiées. Un lancement d'Oxlint coûte environ
116
126
  une seconde, quel que soit le nombre de fichiers.
117
- - La mutation utilise le runner « command » de Stryker : il lance `mutation.command` dans un bac à sable, sans
118
- plugin Stryker dans le projet. Stryker n'y ajoute pas `// @ts-nocheck` et ne réécrit pas lui-même les
119
- `tsconfig.json`, car il le ferait avec l'API JavaScript de TypeScript, que TypeScript 7 n'a plus. `jsq` les
120
- réécrit par son propre script (commande de build de Stryker) : les chemins `extends`, `references`, `include`,
121
- `exclude` et `files` qui sortent du bac à sable (`.stryker-tmp/sandbox-…`, deux niveaux plus bas) gagnent deux
122
- `../`.
127
+ - La mutation utilise le runner Vitest de Stryker (`@stryker-mutator/vitest-runner`), embarqué dans `jsq` et chargé
128
+ par chemin absolu, avec analyse de couverture par test (`coverageAnalysis: "perTest"`) : chaque mutant ne relance
129
+ que les tests qui le couvrent. Aucune configuration ni dépendance Stryker dans le projet. Stryker lit la
130
+ configuration Vitest du projet (`vite.config.ts`) et pose `STRYKER_MUTATOR_WORKER` dans ses processus.
131
+ - `thresholds.high` vaut 90, ou `mutation.break` s'il est plus haut.
132
+ - Stryker n'ajoute pas `// @ts-nocheck` et ne réécrit pas lui-même les `tsconfig.json`, car il le ferait avec l'API
133
+ JavaScript de TypeScript, que TypeScript 7 n'a plus. `jsq` les réécrit par son propre script (commande de build de
134
+ Stryker) : les chemins `extends`, `references`, `include`, `exclude` et `files` qui sortent du bac à sable
135
+ (`.stryker-tmp/sandbox-…`, deux niveaux plus bas) gagnent deux `../`. Vitest lit ces fichiers : sans la
136
+ réécriture, il échoue dans le bac à sable sur un `tsconfig.json` qui étend un fichier hors du paquet.
123
137
  - Ajouter `coverage/` et `.stryker-tmp/` au `.gitignore` du projet.
124
138
 
125
139
  ### Monorepo
@@ -128,11 +142,10 @@ Monorepo : chaque lancement de `jsq` a sa référence, dans le dossier où il to
128
142
  et un `tsconfig.json` qui étend un fichier de la racine (`"extends": "../../tsconfig.base.json"`) est réécrit pour
129
143
  le retrouver. Les `node_modules` du paquet et de ses parents restent résolus par Node depuis le bac à sable.
130
144
 
131
- Le runner « command » relance toute la suite du paquet pour chaque mutant, sans l'analyse de couverture par test
132
- du runner Vitest. Sur un gros paquet, l'écart est important : sur `apps/api` de software-atlas (suite unitaire
133
- de 15 s), `src/ssm.ts` (26 mutants) prend 34 s avec le runner Vitest et 6 min 53 s avec `jsq mutation`, machine
134
- chargée. Sous charge, des mutants dépassent le délai de Stryker et comptent comme tués (21 sur 26 dans cette
135
- mesure) : le score est alors surestimé. Sur un tel paquet, limiter `--mutate` aux fichiers modifiés.
145
+ Le runner « command » (`mutation.command`) relance toute la suite du paquet pour chaque mutant. Sur `apps/api` de
146
+ software-atlas, `src/ssm.ts` (26 mutants) prend 6 s avec le runner Vitest (score 73 %, aucune expiration) et 1 min
147
+ 27 s avec `"command": "vp test run"`, où les 26 mutants expirent et comptent comme tués (score 100 %, faux).
148
+ Sous charge, le runner « command » surestime donc le score.
136
149
 
137
150
  ## Développement
138
151
 
@@ -153,9 +166,16 @@ sortie. Publier une version :
153
166
  3. Le workflow `release.yml` vérifie que le tag égale la version, lance `vp run qa`, construit l'archive et la publie
154
167
  sur npm par trusted publishing (OIDC, sans jeton), avec attestation de provenance.
155
168
 
156
- Mise en place, une seule fois : la première version est publiée à la main (`vp pm login`, puis `vp pm publish
157
- --no-git-checks` depuis `main`), puis sur npmjs.com, _Settings_ du paquet, _Trusted Publisher_ : GitHub Actions,
158
- dépôt `adrien-chinour/js-quality`, workflow `release.yml`.
169
+ Mise en place, une seule fois : la première version se publie à la main, puis le paquet déclare le workflow comme
170
+ éditeur de confiance, hors du projet : `npm trust github @adrien-chinour/js-quality --repo adrien-chinour/js-quality
171
+ --file release.yml --allow-publish`, ou sur npmjs.com, _Settings_ du paquet, _Trusted Publisher_. La publication à
172
+ la main passe par npm, pas par `vp pm publish` : le jeton de `vp pm login` est rangé dans
173
+ `~/.config/pnpm/auth.ini`, que npm ne lit pas, et npm refuse d'agir dans le projet (`devEngines` impose pnpm). Le
174
+ compte npm exige la double authentification : passkey, ou jeton granulaire avec _bypass 2FA_, à révoquer ensuite.
175
+
176
+ 1. Sur `main` à jour : `vp install`.
177
+ 2. Construire l'archive hors du projet : `vp pm pack --pack-destination <dossier>`.
178
+ 3. Depuis ce dossier : `npm publish ./<archive>.tgz --access public`.
159
179
 
160
180
  ## Licence
161
181
 
package/dist/cli.mjs CHANGED
@@ -584,7 +584,6 @@ const defaults = {
584
584
  threshold: 0
585
585
  },
586
586
  mutation: {
587
- command: "vp test run",
588
587
  break: 70,
589
588
  mutate: []
590
589
  }
@@ -626,19 +625,33 @@ function mutateGlobs(config, only) {
626
625
  return [...config.src, ...config.ignore.map((glob) => `!${glob}`)];
627
626
  }
628
627
  /**
629
- * Stryker configuration. The command runner runs the project's own tests, whatever runs them,
630
- * so the project needs no Stryker plugin of its own.
628
+ * How Stryker runs the tests. By default, the Vitest runner jsq embeds, loaded by absolute path so the project
629
+ * needs no Stryker plugin, with per-test coverage: each mutant runs only the tests that cover it. With
630
+ * `mutation.command`, the command runner runs that command for every mutant, whatever runs the tests.
631
631
  */
632
+ function testRunner(command) {
633
+ if (command) return {
634
+ testRunner: "command",
635
+ commandRunner: { command },
636
+ coverageAnalysis: "off"
637
+ };
638
+ return {
639
+ testRunner: "vitest",
640
+ plugins: [require.resolve("@stryker-mutator/vitest-runner")],
641
+ coverageAnalysis: "perTest"
642
+ };
643
+ }
644
+ /** Stryker configuration. */
632
645
  function strykerConfig(config, only) {
646
+ const { command, break: breaking } = config.mutation;
633
647
  return {
634
- testRunner: "command",
635
- commandRunner: { command: config.mutation.command },
648
+ ...testRunner(command),
636
649
  mutate: mutateGlobs(config, only),
637
650
  reporters: ["clear-text", "progress"],
638
651
  thresholds: {
639
- high: 90,
640
- low: config.mutation.break,
641
- break: config.mutation.break
652
+ high: Math.max(90, breaking),
653
+ low: breaking,
654
+ break: breaking
642
655
  },
643
656
  tempDirName: ".stryker-tmp",
644
657
  disableTypeChecks: false,
@@ -680,7 +693,7 @@ async function runMutation(root, config, only) {
680
693
  const USAGE = `Usage:
681
694
  jsq check [--only complexity,crap,duplication] cognitive complexity, CRAP and duplication gates
682
695
  jsq check --write-baseline [--only …] freeze the current violations of the gates
683
- jsq mutation [--mutate <glob>]... mutation testing with Stryker
696
+ jsq mutation [--mutate <glob>]... mutation testing with Stryker and Vitest
684
697
 
685
698
  Settings: optional "jsq" block of package.json (src, ignore, complexity, crap, lcov, baseline,
686
699
  duplication.{minTokens,minLines,threshold}, mutation.{command,break,mutate}).`;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@adrien-chinour/js-quality",
3
- "version": "0.2.0",
3
+ "version": "0.3.0",
4
4
  "description": "Advanced quality gates for JS/TS projects: cognitive complexity, CRAP, duplication, mutation.",
5
5
  "license": "0BSD",
6
6
  "repository": {
@@ -19,6 +19,7 @@
19
19
  },
20
20
  "dependencies": {
21
21
  "@stryker-mutator/core": "10.1.1",
22
+ "@stryker-mutator/vitest-runner": "10.1.1",
22
23
  "eslint-plugin-sonarjs": "4.2.2",
23
24
  "jscpd": "5.4.3",
24
25
  "oxc-parser": "0.158.0",
@@ -28,7 +29,16 @@
28
29
  "devDependencies": {
29
30
  "@types/node": "24.19.2",
30
31
  "@vitest/coverage-v8": "5.1.0",
31
- "vite-plus": "1.5.0"
32
+ "vite-plus": "1.5.0",
33
+ "vitest": "5.1.0"
34
+ },
35
+ "peerDependencies": {
36
+ "vitest": ">=5.1.0"
37
+ },
38
+ "peerDependenciesMeta": {
39
+ "vitest": {
40
+ "optional": true
41
+ }
32
42
  },
33
43
  "devEngines": {
34
44
  "packageManager": {
@@ -41,11 +51,6 @@
41
51
  "version": "24"
42
52
  }
43
53
  },
44
- "jsq": {
45
- "mutation": {
46
- "command": "vp test run --exclude test/mutation.integration.test.ts"
47
- }
48
- },
49
54
  "scripts": {
50
55
  "build": "vp pack",
51
56
  "qa": "vp check --deny-warnings && vp test run --coverage && node src/cli.ts check",