@terra-symposium/hygiene 0.0.0-stage → 2.4.4
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.
- package/README.md +70 -2
- package/dist/accessibility.d.ts +39 -0
- package/dist/accessibility.d.ts.map +1 -0
- package/dist/accessibility.js +524 -0
- package/dist/accessibility.js.map +1 -0
- package/dist/app/workspace-test-runner.d.ts +6 -0
- package/dist/app/workspace-test-runner.d.ts.map +1 -0
- package/dist/app/workspace-test-runner.js +39 -0
- package/dist/app/workspace-test-runner.js.map +1 -0
- package/dist/capabilities/core/analysis.d.ts +22 -0
- package/dist/capabilities/core/analysis.d.ts.map +1 -0
- package/dist/capabilities/core/analysis.js +44 -0
- package/dist/capabilities/core/analysis.js.map +1 -0
- package/dist/capabilities/core/cli.d.ts +19 -0
- package/dist/capabilities/core/cli.d.ts.map +1 -0
- package/dist/capabilities/core/cli.js +58 -0
- package/dist/capabilities/core/cli.js.map +1 -0
- package/dist/capabilities/core/config.d.ts +49 -0
- package/dist/capabilities/core/config.d.ts.map +1 -0
- package/dist/capabilities/core/config.js +88 -0
- package/dist/capabilities/core/config.js.map +1 -0
- package/dist/capabilities/core/index.d.ts +11 -0
- package/dist/capabilities/core/index.d.ts.map +1 -0
- package/dist/capabilities/core/index.js +11 -0
- package/dist/capabilities/core/index.js.map +1 -0
- package/dist/capabilities/core/lib/files.d.ts +55 -0
- package/dist/capabilities/core/lib/files.d.ts.map +1 -0
- package/dist/capabilities/core/lib/files.js +287 -0
- package/dist/capabilities/core/lib/files.js.map +1 -0
- package/dist/capabilities/core/lib/progress.d.ts +25 -0
- package/dist/capabilities/core/lib/progress.d.ts.map +1 -0
- package/dist/capabilities/core/lib/progress.js +40 -0
- package/dist/capabilities/core/lib/progress.js.map +1 -0
- package/dist/capabilities/core/lib/source-kind.d.ts +14 -0
- package/dist/capabilities/core/lib/source-kind.d.ts.map +1 -0
- package/dist/capabilities/core/lib/source-kind.js +29 -0
- package/dist/capabilities/core/lib/source-kind.js.map +1 -0
- package/dist/capabilities/core/types.d.ts +156 -0
- package/dist/capabilities/core/types.d.ts.map +1 -0
- package/dist/capabilities/core/types.js +35 -0
- package/dist/capabilities/core/types.js.map +1 -0
- package/dist/capabilities/documentation/cli.d.ts +3 -0
- package/dist/capabilities/documentation/cli.d.ts.map +1 -0
- package/dist/capabilities/documentation/cli.js +14 -0
- package/dist/capabilities/documentation/cli.js.map +1 -0
- package/dist/capabilities/documentation/index.d.ts +5 -0
- package/dist/capabilities/documentation/index.d.ts.map +1 -0
- package/dist/capabilities/documentation/index.js +5 -0
- package/dist/capabilities/documentation/index.js.map +1 -0
- package/dist/capabilities/documentation/lib/documentation.d.ts +108 -0
- package/dist/capabilities/documentation/lib/documentation.d.ts.map +1 -0
- package/dist/capabilities/documentation/lib/documentation.js +1007 -0
- package/dist/capabilities/documentation/lib/documentation.js.map +1 -0
- package/dist/capabilities/formatting/cli.d.ts +3 -0
- package/dist/capabilities/formatting/cli.d.ts.map +1 -0
- package/dist/capabilities/formatting/cli.js +15 -0
- package/dist/capabilities/formatting/cli.js.map +1 -0
- package/dist/capabilities/formatting/index.d.ts +8 -0
- package/dist/capabilities/formatting/index.d.ts.map +1 -0
- package/dist/capabilities/formatting/index.js +8 -0
- package/dist/capabilities/formatting/index.js.map +1 -0
- package/dist/capabilities/formatting/lib/collapse.d.ts +13 -0
- package/dist/capabilities/formatting/lib/collapse.d.ts.map +1 -0
- package/dist/capabilities/formatting/lib/collapse.js +179 -0
- package/dist/capabilities/formatting/lib/collapse.js.map +1 -0
- package/dist/capabilities/formatting/lib/inline-if.d.ts +13 -0
- package/dist/capabilities/formatting/lib/inline-if.d.ts.map +1 -0
- package/dist/capabilities/formatting/lib/inline-if.js +49 -0
- package/dist/capabilities/formatting/lib/inline-if.js.map +1 -0
- package/dist/capabilities/formatting/lib/run-formatting.d.ts +14 -0
- package/dist/capabilities/formatting/lib/run-formatting.d.ts.map +1 -0
- package/dist/capabilities/formatting/lib/run-formatting.js +134 -0
- package/dist/capabilities/formatting/lib/run-formatting.js.map +1 -0
- package/dist/capabilities/imports/cli.d.ts +3 -0
- package/dist/capabilities/imports/cli.d.ts.map +1 -0
- package/dist/capabilities/imports/cli.js +9 -0
- package/dist/capabilities/imports/cli.js.map +1 -0
- package/dist/capabilities/imports/index.d.ts +6 -0
- package/dist/capabilities/imports/index.d.ts.map +1 -0
- package/dist/capabilities/imports/index.js +6 -0
- package/dist/capabilities/imports/index.js.map +1 -0
- package/dist/capabilities/imports/lib/imports.d.ts +19 -0
- package/dist/capabilities/imports/lib/imports.d.ts.map +1 -0
- package/dist/capabilities/imports/lib/imports.js +88 -0
- package/dist/capabilities/imports/lib/imports.js.map +1 -0
- package/dist/capabilities/languages/cli.d.ts +3 -0
- package/dist/capabilities/languages/cli.d.ts.map +1 -0
- package/dist/capabilities/languages/cli.js +9 -0
- package/dist/capabilities/languages/cli.js.map +1 -0
- package/dist/capabilities/languages/index.d.ts +6 -0
- package/dist/capabilities/languages/index.d.ts.map +1 -0
- package/dist/capabilities/languages/index.js +6 -0
- package/dist/capabilities/languages/index.js.map +1 -0
- package/dist/capabilities/languages/lib/language-profiles.d.ts +110 -0
- package/dist/capabilities/languages/lib/language-profiles.d.ts.map +1 -0
- package/dist/capabilities/languages/lib/language-profiles.js +509 -0
- package/dist/capabilities/languages/lib/language-profiles.js.map +1 -0
- package/dist/capabilities/languages/lib/run-language-checks.d.ts +12 -0
- package/dist/capabilities/languages/lib/run-language-checks.d.ts.map +1 -0
- package/dist/capabilities/languages/lib/run-language-checks.js +109 -0
- package/dist/capabilities/languages/lib/run-language-checks.js.map +1 -0
- package/dist/capabilities/naming/cli.d.ts +3 -0
- package/dist/capabilities/naming/cli.d.ts.map +1 -0
- package/dist/capabilities/naming/cli.js +15 -0
- package/dist/capabilities/naming/cli.js.map +1 -0
- package/dist/capabilities/naming/index.d.ts +5 -0
- package/dist/capabilities/naming/index.d.ts.map +1 -0
- package/dist/capabilities/naming/index.js +5 -0
- package/dist/capabilities/naming/index.js.map +1 -0
- package/dist/capabilities/naming/lib/naming.d.ts +169 -0
- package/dist/capabilities/naming/lib/naming.d.ts.map +1 -0
- package/dist/capabilities/naming/lib/naming.js +908 -0
- package/dist/capabilities/naming/lib/naming.js.map +1 -0
- package/dist/capabilities/patterns/cli.d.ts +3 -0
- package/dist/capabilities/patterns/cli.d.ts.map +1 -0
- package/dist/capabilities/patterns/cli.js +30 -0
- package/dist/capabilities/patterns/cli.js.map +1 -0
- package/dist/capabilities/patterns/index.d.ts +5 -0
- package/dist/capabilities/patterns/index.d.ts.map +1 -0
- package/dist/capabilities/patterns/index.js +5 -0
- package/dist/capabilities/patterns/index.js.map +1 -0
- package/dist/capabilities/patterns/lib/patterns.d.ts +102 -0
- package/dist/capabilities/patterns/lib/patterns.d.ts.map +1 -0
- package/dist/capabilities/patterns/lib/patterns.js +1584 -0
- package/dist/capabilities/patterns/lib/patterns.js.map +1 -0
- package/dist/capabilities/refactoring/cli.d.ts +3 -0
- package/dist/capabilities/refactoring/cli.d.ts.map +1 -0
- package/dist/capabilities/refactoring/cli.js +15 -0
- package/dist/capabilities/refactoring/cli.js.map +1 -0
- package/dist/capabilities/refactoring/index.d.ts +6 -0
- package/dist/capabilities/refactoring/index.d.ts.map +1 -0
- package/dist/capabilities/refactoring/index.js +6 -0
- package/dist/capabilities/refactoring/index.js.map +1 -0
- package/dist/capabilities/refactoring/lib/object-forwarding.d.ts +42 -0
- package/dist/capabilities/refactoring/lib/object-forwarding.d.ts.map +1 -0
- package/dist/capabilities/refactoring/lib/object-forwarding.js +166 -0
- package/dist/capabilities/refactoring/lib/object-forwarding.js.map +1 -0
- package/dist/capabilities/refactoring/lib/single-use.d.ts +61 -0
- package/dist/capabilities/refactoring/lib/single-use.d.ts.map +1 -0
- package/dist/capabilities/refactoring/lib/single-use.js +1791 -0
- package/dist/capabilities/refactoring/lib/single-use.js.map +1 -0
- package/dist/capabilities/reports/cli.d.ts +3 -0
- package/dist/capabilities/reports/cli.d.ts.map +1 -0
- package/dist/capabilities/reports/cli.js +34 -0
- package/dist/capabilities/reports/cli.js.map +1 -0
- package/dist/capabilities/reports/index.d.ts +10 -0
- package/dist/capabilities/reports/index.d.ts.map +1 -0
- package/dist/capabilities/reports/index.js +10 -0
- package/dist/capabilities/reports/index.js.map +1 -0
- package/dist/capabilities/reports/lib/github-report.d.ts +94 -0
- package/dist/capabilities/reports/lib/github-report.d.ts.map +1 -0
- package/dist/capabilities/reports/lib/github-report.js +499 -0
- package/dist/capabilities/reports/lib/github-report.js.map +1 -0
- package/dist/capabilities/reports/lib/history-report.d.ts +58 -0
- package/dist/capabilities/reports/lib/history-report.d.ts.map +1 -0
- package/dist/capabilities/reports/lib/history-report.js +300 -0
- package/dist/capabilities/reports/lib/history-report.js.map +1 -0
- package/dist/capabilities/reports/lib/node-reporter.d.ts +79 -0
- package/dist/capabilities/reports/lib/node-reporter.d.ts.map +1 -0
- package/dist/capabilities/reports/lib/node-reporter.js +244 -0
- package/dist/capabilities/reports/lib/node-reporter.js.map +1 -0
- package/dist/capabilities/reports/lib/playwright-reporter.d.ts +100 -0
- package/dist/capabilities/reports/lib/playwright-reporter.d.ts.map +1 -0
- package/dist/capabilities/reports/lib/playwright-reporter.js +122 -0
- package/dist/capabilities/reports/lib/playwright-reporter.js.map +1 -0
- package/dist/capabilities/security/cli.d.ts +3 -0
- package/dist/capabilities/security/cli.d.ts.map +1 -0
- package/dist/capabilities/security/cli.js +9 -0
- package/dist/capabilities/security/cli.js.map +1 -0
- package/dist/capabilities/security/index.d.ts +5 -0
- package/dist/capabilities/security/index.d.ts.map +1 -0
- package/dist/capabilities/security/index.js +5 -0
- package/dist/capabilities/security/index.js.map +1 -0
- package/dist/capabilities/security/lib/security.d.ts +19 -0
- package/dist/capabilities/security/lib/security.d.ts.map +1 -0
- package/dist/capabilities/security/lib/security.js +115 -0
- package/dist/capabilities/security/lib/security.js.map +1 -0
- package/dist/capabilities/ui/cli.d.ts +3 -0
- package/dist/capabilities/ui/cli.d.ts.map +1 -0
- package/dist/capabilities/ui/cli.js +22 -0
- package/dist/capabilities/ui/cli.js.map +1 -0
- package/dist/capabilities/ui/index.d.ts +8 -0
- package/dist/capabilities/ui/index.d.ts.map +1 -0
- package/dist/capabilities/ui/index.js +8 -0
- package/dist/capabilities/ui/index.js.map +1 -0
- package/dist/capabilities/ui/lib/accessibility.d.ts +37 -0
- package/dist/capabilities/ui/lib/accessibility.d.ts.map +1 -0
- package/dist/capabilities/ui/lib/accessibility.js +676 -0
- package/dist/capabilities/ui/lib/accessibility.js.map +1 -0
- package/dist/capabilities/ui/lib/display-name.d.ts +42 -0
- package/dist/capabilities/ui/lib/display-name.d.ts.map +1 -0
- package/dist/capabilities/ui/lib/display-name.js +277 -0
- package/dist/capabilities/ui/lib/display-name.js.map +1 -0
- package/dist/capabilities/ui/lib/error-boundaries.d.ts +30 -0
- package/dist/capabilities/ui/lib/error-boundaries.d.ts.map +1 -0
- package/dist/capabilities/ui/lib/error-boundaries.js +401 -0
- package/dist/capabilities/ui/lib/error-boundaries.js.map +1 -0
- package/dist/capabilities/ui/lib/ui-recommendations.d.ts +45 -0
- package/dist/capabilities/ui/lib/ui-recommendations.d.ts.map +1 -0
- package/dist/capabilities/ui/lib/ui-recommendations.js +183 -0
- package/dist/capabilities/ui/lib/ui-recommendations.js.map +1 -0
- package/dist/display-name.d.ts +44 -0
- package/dist/display-name.d.ts.map +1 -0
- package/dist/display-name.js +256 -0
- package/dist/display-name.js.map +1 -0
- package/dist/index.d.ts +5 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +5 -0
- package/dist/index.js.map +1 -0
- package/dist/lib/accessibility.d.ts +5 -0
- package/dist/lib/accessibility.d.ts.map +1 -0
- package/dist/lib/accessibility.js +5 -0
- package/dist/lib/accessibility.js.map +1 -0
- package/dist/lib/collapse.d.ts +5 -0
- package/dist/lib/collapse.d.ts.map +1 -0
- package/dist/lib/collapse.js +5 -0
- package/dist/lib/collapse.js.map +1 -0
- package/dist/lib/dev.d.ts +3 -0
- package/dist/lib/dev.d.ts.map +1 -0
- package/dist/lib/dev.js +126 -0
- package/dist/lib/dev.js.map +1 -0
- package/dist/lib/display-name.d.ts +5 -0
- package/dist/lib/display-name.d.ts.map +1 -0
- package/dist/lib/display-name.js +5 -0
- package/dist/lib/display-name.js.map +1 -0
- package/dist/lib/documentation.d.ts +5 -0
- package/dist/lib/documentation.d.ts.map +1 -0
- package/dist/lib/documentation.js +5 -0
- package/dist/lib/documentation.js.map +1 -0
- package/dist/lib/error-boundaries-astro.d.ts +6 -0
- package/dist/lib/error-boundaries-astro.d.ts.map +1 -0
- package/dist/lib/error-boundaries-astro.js +6 -0
- package/dist/lib/error-boundaries-astro.js.map +1 -0
- package/dist/lib/error-boundaries-react.d.ts +6 -0
- package/dist/lib/error-boundaries-react.d.ts.map +1 -0
- package/dist/lib/error-boundaries-react.js +6 -0
- package/dist/lib/error-boundaries-react.js.map +1 -0
- package/dist/lib/error-boundaries.d.ts +5 -0
- package/dist/lib/error-boundaries.d.ts.map +1 -0
- package/dist/lib/error-boundaries.js +5 -0
- package/dist/lib/error-boundaries.js.map +1 -0
- package/dist/lib/eslint-api.d.ts +13 -0
- package/dist/lib/eslint-api.d.ts.map +1 -0
- package/dist/lib/eslint-api.js +24 -0
- package/dist/lib/eslint-api.js.map +1 -0
- package/dist/lib/files.d.ts +5 -0
- package/dist/lib/files.d.ts.map +1 -0
- package/dist/lib/files.js +5 -0
- package/dist/lib/files.js.map +1 -0
- package/dist/lib/formatting.d.ts +5 -0
- package/dist/lib/formatting.d.ts.map +1 -0
- package/dist/lib/formatting.js +5 -0
- package/dist/lib/formatting.js.map +1 -0
- package/dist/lib/github-report.d.ts +5 -0
- package/dist/lib/github-report.d.ts.map +1 -0
- package/dist/lib/github-report.js +5 -0
- package/dist/lib/github-report.js.map +1 -0
- package/dist/lib/history-report.d.ts +5 -0
- package/dist/lib/history-report.d.ts.map +1 -0
- package/dist/lib/history-report.js +5 -0
- package/dist/lib/history-report.js.map +1 -0
- package/dist/lib/imports.d.ts +5 -0
- package/dist/lib/imports.d.ts.map +1 -0
- package/dist/lib/imports.js +5 -0
- package/dist/lib/imports.js.map +1 -0
- package/dist/lib/index.d.ts +20 -0
- package/dist/lib/index.d.ts.map +1 -0
- package/dist/lib/index.js +20 -0
- package/dist/lib/index.js.map +1 -0
- package/dist/lib/inline-if.d.ts +5 -0
- package/dist/lib/inline-if.d.ts.map +1 -0
- package/dist/lib/inline-if.js +5 -0
- package/dist/lib/inline-if.js.map +1 -0
- package/dist/lib/language-checks.d.ts +5 -0
- package/dist/lib/language-checks.d.ts.map +1 -0
- package/dist/lib/language-checks.js +5 -0
- package/dist/lib/language-checks.js.map +1 -0
- package/dist/lib/language-profiles.d.ts +5 -0
- package/dist/lib/language-profiles.d.ts.map +1 -0
- package/dist/lib/language-profiles.js +5 -0
- package/dist/lib/language-profiles.js.map +1 -0
- package/dist/lib/naming.d.ts +5 -0
- package/dist/lib/naming.d.ts.map +1 -0
- package/dist/lib/naming.js +5 -0
- package/dist/lib/naming.js.map +1 -0
- package/dist/lib/node-reporter.d.ts +6 -0
- package/dist/lib/node-reporter.d.ts.map +1 -0
- package/dist/lib/node-reporter.js +6 -0
- package/dist/lib/node-reporter.js.map +1 -0
- package/dist/lib/object-forwarding.d.ts +5 -0
- package/dist/lib/object-forwarding.d.ts.map +1 -0
- package/dist/lib/object-forwarding.js +5 -0
- package/dist/lib/object-forwarding.js.map +1 -0
- package/dist/lib/patterns.d.ts +5 -0
- package/dist/lib/patterns.d.ts.map +1 -0
- package/dist/lib/patterns.js +5 -0
- package/dist/lib/patterns.js.map +1 -0
- package/dist/lib/playwright-reporter.d.ts +6 -0
- package/dist/lib/playwright-reporter.d.ts.map +1 -0
- package/dist/lib/playwright-reporter.js +6 -0
- package/dist/lib/playwright-reporter.js.map +1 -0
- package/dist/lib/port.d.ts +21 -0
- package/dist/lib/port.d.ts.map +1 -0
- package/dist/lib/port.js +81 -0
- package/dist/lib/port.js.map +1 -0
- package/dist/lib/progress.d.ts +5 -0
- package/dist/lib/progress.d.ts.map +1 -0
- package/dist/lib/progress.js +5 -0
- package/dist/lib/progress.js.map +1 -0
- package/dist/lib/reports.d.ts +5 -0
- package/dist/lib/reports.d.ts.map +1 -0
- package/dist/lib/reports.js +5 -0
- package/dist/lib/reports.js.map +1 -0
- package/dist/lib/runner.d.ts +150 -0
- package/dist/lib/runner.d.ts.map +1 -0
- package/dist/lib/runner.js +4522 -0
- package/dist/lib/runner.js.map +1 -0
- package/dist/lib/security.d.ts +5 -0
- package/dist/lib/security.d.ts.map +1 -0
- package/dist/lib/security.js +5 -0
- package/dist/lib/security.js.map +1 -0
- package/dist/lib/single-use.d.ts +6 -0
- package/dist/lib/single-use.d.ts.map +1 -0
- package/dist/lib/single-use.js +5 -0
- package/dist/lib/single-use.js.map +1 -0
- package/dist/lib/source-kind.d.ts +5 -0
- package/dist/lib/source-kind.d.ts.map +1 -0
- package/dist/lib/source-kind.js +5 -0
- package/dist/lib/source-kind.js.map +1 -0
- package/dist/lib/spinner-worker.d.ts +6 -0
- package/dist/lib/spinner-worker.d.ts.map +1 -0
- package/dist/lib/spinner-worker.js +33 -0
- package/dist/lib/spinner-worker.js.map +1 -0
- package/dist/lib/ui-quality.d.ts +5 -0
- package/dist/lib/ui-quality.d.ts.map +1 -0
- package/dist/lib/ui-quality.js +5 -0
- package/dist/lib/ui-quality.js.map +1 -0
- package/dist/lib/ui-recommendations.d.ts +5 -0
- package/dist/lib/ui-recommendations.d.ts.map +1 -0
- package/dist/lib/ui-recommendations.js +5 -0
- package/dist/lib/ui-recommendations.js.map +1 -0
- package/dist/spinner-worker.d.ts +6 -0
- package/dist/spinner-worker.d.ts.map +1 -0
- package/dist/spinner-worker.js +39 -0
- package/dist/spinner-worker.js.map +1 -0
- package/package.json +160 -5
- package/quality-configs/checkstyle.xml +29 -0
- package/quality-configs/pmd-rules.xml +11 -0
- package/quality.schema.json +392 -0
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* packages/quality/src/spinner-worker.ts
|
|
3
|
+
* Animates a quality check while synchronous work blocks the runner's main thread.
|
|
4
|
+
*/
|
|
5
|
+
/*//////////////////////////////////////////////////
|
|
6
|
+
IMPORTS
|
|
7
|
+
//////////////////////////////////////////////////*/
|
|
8
|
+
// API
|
|
9
|
+
import { workerData } from 'node:worker_threads';
|
|
10
|
+
import { writeSync } from 'node:fs';
|
|
11
|
+
/*//////////////////////////////////////////////////
|
|
12
|
+
CONFIG
|
|
13
|
+
//////////////////////////////////////////////////*/
|
|
14
|
+
const { label, sharedBuffer } = workerData;
|
|
15
|
+
const state = new Int32Array(sharedBuffer);
|
|
16
|
+
const frames = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'];
|
|
17
|
+
/*//////////////////////////////////////////////////
|
|
18
|
+
HELPERS
|
|
19
|
+
//////////////////////////////////////////////////*/
|
|
20
|
+
/**
|
|
21
|
+
* Draws the next spinner frame until the parent stops the check.
|
|
22
|
+
*
|
|
23
|
+
* @return Nothing; frames are written directly to standard error.
|
|
24
|
+
*/
|
|
25
|
+
function draw() {
|
|
26
|
+
if (Atomics.load(state, 0)) {
|
|
27
|
+
writeSync(2, '\r\u001b[2K');
|
|
28
|
+
Atomics.store(state, 2, 1);
|
|
29
|
+
Atomics.notify(state, 2);
|
|
30
|
+
return;
|
|
31
|
+
}
|
|
32
|
+
writeSync(2, `\r ${frames[frame++ % frames.length]} ${label}`);
|
|
33
|
+
Atomics.store(state, 1, 1);
|
|
34
|
+
Atomics.notify(state, 1);
|
|
35
|
+
setTimeout(draw, 90);
|
|
36
|
+
}
|
|
37
|
+
let frame = 0;
|
|
38
|
+
draw();
|
|
39
|
+
//# sourceMappingURL=spinner-worker.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"spinner-worker.js","sourceRoot":"","sources":["../src/spinner-worker.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;oDAEoD;AAEpD,MAAM;AACN,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEpC;;oDAEoD;AAEpD,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,GAAG,UAAgE,CAAC;AACjG,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,YAAY,CAAC,CAAC;AAC3C,MAAM,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAElE;;oDAEoD;AAEpD;;;;GAIG;AACH,SAAS,IAAI;IACZ,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC;QAC5B,SAAS,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC;QAC5B,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAC3B,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QACzB,OAAO;IACR,CAAC;IACD,SAAS,CAAC,CAAC,EAAE,OAAO,MAAM,CAAC,KAAK,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC;IAChE,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3B,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IACzB,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;AACtB,CAAC;AACD,IAAI,KAAK,GAAG,CAAC,CAAC;AACd,IAAI,EAAE,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,161 @@
|
|
|
1
1
|
{
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
2
|
+
"name": "@terra-symposium/hygiene",
|
|
3
|
+
"version": "2.4.4",
|
|
4
|
+
"description": "Configurable quality checks and maintenance tooling for software repositories",
|
|
5
|
+
"homepage": "https://standards-docs.netlify.app/",
|
|
6
|
+
"type": "module",
|
|
7
|
+
"engines": {
|
|
8
|
+
"node": ">=18.18"
|
|
9
|
+
},
|
|
10
|
+
"main": "./dist/index.js",
|
|
11
|
+
"types": "./dist/index.d.ts",
|
|
12
|
+
"bin": {
|
|
13
|
+
"hygiene": "dist/lib/runner.js",
|
|
14
|
+
"hygiene-dev": "dist/lib/dev.js",
|
|
15
|
+
"hygiene-reports": "dist/capabilities/reports/cli.js",
|
|
16
|
+
"ui-quality": "dist/capabilities/ui/cli.js",
|
|
17
|
+
"language-checks": "dist/capabilities/languages/cli.js",
|
|
18
|
+
"documentation": "dist/capabilities/documentation/cli.js",
|
|
19
|
+
"formatting": "dist/capabilities/formatting/cli.js",
|
|
20
|
+
"imports": "dist/capabilities/imports/cli.js",
|
|
21
|
+
"naming": "dist/capabilities/naming/cli.js",
|
|
22
|
+
"patterns": "dist/capabilities/patterns/cli.js",
|
|
23
|
+
"refactoring": "dist/capabilities/refactoring/cli.js",
|
|
24
|
+
"security": "dist/capabilities/security/cli.js"
|
|
25
|
+
},
|
|
26
|
+
"publishConfig": {
|
|
27
|
+
"registry": "https://registry.npmjs.org",
|
|
28
|
+
"access": "public"
|
|
29
|
+
},
|
|
30
|
+
"repository": {
|
|
31
|
+
"type": "git",
|
|
32
|
+
"url": "git+https://github.com/Terra-Symposium/standards.git"
|
|
33
|
+
},
|
|
34
|
+
"exports": {
|
|
35
|
+
".": "./dist/index.js",
|
|
36
|
+
"./error-boundaries/react": "./dist/lib/error-boundaries-react.js",
|
|
37
|
+
"./astro-integration": "./dist/lib/error-boundaries-astro.js",
|
|
38
|
+
"./cli": "./dist/lib/runner.js",
|
|
39
|
+
"./naming": {
|
|
40
|
+
"types": "./dist/capabilities/naming/index.d.ts",
|
|
41
|
+
"import": "./dist/capabilities/naming/index.js"
|
|
42
|
+
},
|
|
43
|
+
"./object-forwarding": "./dist/lib/object-forwarding.js",
|
|
44
|
+
"./single-use": "./dist/lib/single-use.js",
|
|
45
|
+
"./port": "./dist/lib/port.js",
|
|
46
|
+
"./documentation": {
|
|
47
|
+
"types": "./dist/capabilities/documentation/index.d.ts",
|
|
48
|
+
"import": "./dist/capabilities/documentation/index.js"
|
|
49
|
+
},
|
|
50
|
+
"./formatting": {
|
|
51
|
+
"types": "./dist/capabilities/formatting/index.d.ts",
|
|
52
|
+
"import": "./dist/capabilities/formatting/index.js"
|
|
53
|
+
},
|
|
54
|
+
"./imports": {
|
|
55
|
+
"types": "./dist/capabilities/imports/index.d.ts",
|
|
56
|
+
"import": "./dist/capabilities/imports/index.js"
|
|
57
|
+
},
|
|
58
|
+
"./patterns": {
|
|
59
|
+
"types": "./dist/capabilities/patterns/index.d.ts",
|
|
60
|
+
"import": "./dist/capabilities/patterns/index.js"
|
|
61
|
+
},
|
|
62
|
+
"./security": {
|
|
63
|
+
"types": "./dist/capabilities/security/index.d.ts",
|
|
64
|
+
"import": "./dist/capabilities/security/index.js"
|
|
65
|
+
},
|
|
66
|
+
"./ui-quality": "./dist/lib/ui-quality.js",
|
|
67
|
+
"./language-checks": "./dist/lib/language-checks.js",
|
|
68
|
+
"./reports": {
|
|
69
|
+
"types": "./dist/capabilities/reports/index.d.ts",
|
|
70
|
+
"import": "./dist/capabilities/reports/index.js"
|
|
71
|
+
},
|
|
72
|
+
"./core": {
|
|
73
|
+
"types": "./dist/capabilities/core/index.d.ts",
|
|
74
|
+
"import": "./dist/capabilities/core/index.js"
|
|
75
|
+
},
|
|
76
|
+
"./ui": {
|
|
77
|
+
"types": "./dist/capabilities/ui/index.d.ts",
|
|
78
|
+
"import": "./dist/capabilities/ui/index.js"
|
|
79
|
+
},
|
|
80
|
+
"./languages": {
|
|
81
|
+
"types": "./dist/capabilities/languages/index.d.ts",
|
|
82
|
+
"import": "./dist/capabilities/languages/index.js"
|
|
83
|
+
},
|
|
84
|
+
"./refactoring": {
|
|
85
|
+
"types": "./dist/capabilities/refactoring/index.d.ts",
|
|
86
|
+
"import": "./dist/capabilities/refactoring/index.js"
|
|
87
|
+
},
|
|
88
|
+
"./reports/github": "./dist/capabilities/reports/lib/github-report.js",
|
|
89
|
+
"./reports/history": "./dist/capabilities/reports/lib/history-report.js",
|
|
90
|
+
"./reports/node-reporter": "./dist/capabilities/reports/lib/node-reporter.js",
|
|
91
|
+
"./reports/playwright-reporter": "./dist/capabilities/reports/lib/playwright-reporter.js",
|
|
92
|
+
"./reports/cli": {
|
|
93
|
+
"types": "./dist/capabilities/reports/cli.d.ts",
|
|
94
|
+
"import": "./dist/capabilities/reports/cli.js"
|
|
95
|
+
},
|
|
96
|
+
"./ui/cli": {
|
|
97
|
+
"types": "./dist/capabilities/ui/cli.d.ts",
|
|
98
|
+
"import": "./dist/capabilities/ui/cli.js"
|
|
99
|
+
},
|
|
100
|
+
"./languages/cli": {
|
|
101
|
+
"types": "./dist/capabilities/languages/cli.d.ts",
|
|
102
|
+
"import": "./dist/capabilities/languages/cli.js"
|
|
103
|
+
},
|
|
104
|
+
"./documentation/cli": {
|
|
105
|
+
"types": "./dist/capabilities/documentation/cli.d.ts",
|
|
106
|
+
"import": "./dist/capabilities/documentation/cli.js"
|
|
107
|
+
},
|
|
108
|
+
"./formatting/cli": {
|
|
109
|
+
"types": "./dist/capabilities/formatting/cli.d.ts",
|
|
110
|
+
"import": "./dist/capabilities/formatting/cli.js"
|
|
111
|
+
},
|
|
112
|
+
"./imports/cli": {
|
|
113
|
+
"types": "./dist/capabilities/imports/cli.d.ts",
|
|
114
|
+
"import": "./dist/capabilities/imports/cli.js"
|
|
115
|
+
},
|
|
116
|
+
"./naming/cli": {
|
|
117
|
+
"types": "./dist/capabilities/naming/cli.d.ts",
|
|
118
|
+
"import": "./dist/capabilities/naming/cli.js"
|
|
119
|
+
},
|
|
120
|
+
"./patterns/cli": {
|
|
121
|
+
"types": "./dist/capabilities/patterns/cli.d.ts",
|
|
122
|
+
"import": "./dist/capabilities/patterns/cli.js"
|
|
123
|
+
},
|
|
124
|
+
"./refactoring/cli": {
|
|
125
|
+
"types": "./dist/capabilities/refactoring/cli.d.ts",
|
|
126
|
+
"import": "./dist/capabilities/refactoring/cli.js"
|
|
127
|
+
},
|
|
128
|
+
"./security/cli": {
|
|
129
|
+
"types": "./dist/capabilities/security/cli.d.ts",
|
|
130
|
+
"import": "./dist/capabilities/security/cli.js"
|
|
131
|
+
}
|
|
132
|
+
},
|
|
133
|
+
"files": [
|
|
134
|
+
"dist",
|
|
135
|
+
"quality.schema.json",
|
|
136
|
+
"quality-configs"
|
|
137
|
+
],
|
|
138
|
+
"scripts": {
|
|
139
|
+
"quality": "node \"$(git rev-parse --show-toplevel)/scripts/quality-runner.mjs\" quality",
|
|
140
|
+
"quality:all": "node \"$(git rev-parse --show-toplevel)/scripts/quality-runner.mjs\" quality --all",
|
|
141
|
+
"build": "tsc -p config/tsconfig.json",
|
|
142
|
+
"test": "npm run build && mkdir -p tests/results && node --test --test-reporter=spec --test-reporter-destination=stdout --test-reporter=junit --test-reporter-destination=tests/results/junit.xml",
|
|
143
|
+
"prepare": "npm run build",
|
|
144
|
+
"typecheck": "tsc --noEmit -p config/tsconfig.json"
|
|
145
|
+
},
|
|
146
|
+
"dependencies": {
|
|
147
|
+
"typescript": "^5.0.0",
|
|
148
|
+
"@terra-symposium/boundaries": "^0.2.0"
|
|
149
|
+
},
|
|
150
|
+
"peerDependencies": {
|
|
151
|
+
"eslint": ">=9"
|
|
152
|
+
},
|
|
153
|
+
"peerDependenciesMeta": {
|
|
154
|
+
"eslint": {
|
|
155
|
+
"optional": true
|
|
156
|
+
}
|
|
157
|
+
},
|
|
158
|
+
"devDependencies": {
|
|
159
|
+
"@types/node": "^26.6.5"
|
|
160
|
+
}
|
|
161
|
+
}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
<?xml version="1.0"?>
|
|
2
|
+
<!DOCTYPE module PUBLIC "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN" "https://checkstyle.org/dtds/configuration_1_3.dtd">
|
|
3
|
+
<module name="Checker">
|
|
4
|
+
<module name="TreeWalker">
|
|
5
|
+
<module name="MissingJavadocMethod">
|
|
6
|
+
<property name="scope" value="private"/>
|
|
7
|
+
<property name="allowMissingPropertyJavadoc" value="false"/>
|
|
8
|
+
<property name="allowedAnnotations" value=""/>
|
|
9
|
+
</module>
|
|
10
|
+
<module name="MissingJavadocType">
|
|
11
|
+
<property name="scope" value="private"/>
|
|
12
|
+
</module>
|
|
13
|
+
<module name="JavadocMethod">
|
|
14
|
+
<property name="accessModifiers" value="public,protected,package,private"/>
|
|
15
|
+
<property name="allowMissingParamTags" value="false"/>
|
|
16
|
+
<property name="allowMissingReturnTag" value="false"/>
|
|
17
|
+
<property name="allowedAnnotations" value=""/>
|
|
18
|
+
</module>
|
|
19
|
+
<module name="JavadocType">
|
|
20
|
+
<property name="scope" value="private"/>
|
|
21
|
+
</module>
|
|
22
|
+
<module name="UnusedImports"/>
|
|
23
|
+
<module name="AvoidStarImport"/>
|
|
24
|
+
<module name="MethodName"/>
|
|
25
|
+
<module name="TypeName"/>
|
|
26
|
+
<module name="ParameterName"/>
|
|
27
|
+
<module name="LocalVariableName"/>
|
|
28
|
+
</module>
|
|
29
|
+
</module>
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<?xml version="1.0"?>
|
|
2
|
+
<ruleset xmlns="http://pmd.sourceforge.net/ruleset/2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="Terra Quality Java" xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.github.io/schema/ruleset_2_0_0.xsd">
|
|
3
|
+
<description>Source-level correctness, style, imports, performance, security, and unused-code checks.</description>
|
|
4
|
+
<rule ref="category/java/bestpractices.xml"/>
|
|
5
|
+
<rule ref="category/java/codestyle.xml"/>
|
|
6
|
+
<rule ref="category/java/design.xml"/>
|
|
7
|
+
<rule ref="category/java/errorprone.xml"/>
|
|
8
|
+
<rule ref="category/java/imports.xml"/>
|
|
9
|
+
<rule ref="category/java/performance.xml"/>
|
|
10
|
+
<rule ref="category/java/security.xml"/>
|
|
11
|
+
</ruleset>
|
|
@@ -0,0 +1,392 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"title": "Terra quality configuration",
|
|
4
|
+
"type": "object",
|
|
5
|
+
"additionalProperties": false,
|
|
6
|
+
"required": ["sourceRoots", "extensions"],
|
|
7
|
+
"properties": {
|
|
8
|
+
"$schema": { "type": "string" },
|
|
9
|
+
"root": {
|
|
10
|
+
"type": "string",
|
|
11
|
+
"description": "Repository root used for source paths and subprocess working directories. Relative to the inferred project root."
|
|
12
|
+
},
|
|
13
|
+
"configRoot": {
|
|
14
|
+
"type": "string",
|
|
15
|
+
"description": "Directory searched for centralized tool configs such as ESLint, Prettier, Knip, and tsconfig.json. Relative to root; defaults to the quality.json directory when it is a config folder, otherwise root/config."
|
|
16
|
+
},
|
|
17
|
+
"sourceRoots": { "type": "array", "items": { "type": "string" } },
|
|
18
|
+
"includeRoots": { "type": "array", "items": { "type": "string" } },
|
|
19
|
+
"skippedDirectories": {
|
|
20
|
+
"type": "array",
|
|
21
|
+
"items": { "type": "string" },
|
|
22
|
+
"description": "Directory names or repository-relative directory paths excluded from source discovery."
|
|
23
|
+
},
|
|
24
|
+
"skippedFiles": {
|
|
25
|
+
"type": "array",
|
|
26
|
+
"items": { "type": "string" },
|
|
27
|
+
"description": "Repository-relative files excluded from source discovery."
|
|
28
|
+
},
|
|
29
|
+
"singleUse": {
|
|
30
|
+
"type": "object",
|
|
31
|
+
"properties": {
|
|
32
|
+
"skippedDirectories": {
|
|
33
|
+
"type": "array",
|
|
34
|
+
"items": { "type": "string" },
|
|
35
|
+
"description": "Directory names, repository-relative paths, or files excluded as single-use declaration candidates while remaining available as references."
|
|
36
|
+
}
|
|
37
|
+
},
|
|
38
|
+
"additionalProperties": false
|
|
39
|
+
},
|
|
40
|
+
"extensions": {
|
|
41
|
+
"type": "array",
|
|
42
|
+
"items": { "type": "string", "pattern": "^\\." }
|
|
43
|
+
},
|
|
44
|
+
"aliases": {
|
|
45
|
+
"type": "object",
|
|
46
|
+
"additionalProperties": { "type": "string" }
|
|
47
|
+
},
|
|
48
|
+
"frameworkEntryExports": {
|
|
49
|
+
"type": "object",
|
|
50
|
+
"additionalProperties": { "type": "array", "items": { "type": "string" } }
|
|
51
|
+
},
|
|
52
|
+
"knipPackageMappings": {
|
|
53
|
+
"type": "array",
|
|
54
|
+
"items": {
|
|
55
|
+
"type": "object",
|
|
56
|
+
"required": ["sourceRoots", "packageRoot"],
|
|
57
|
+
"properties": {
|
|
58
|
+
"sourceRoots": {
|
|
59
|
+
"type": "array",
|
|
60
|
+
"minItems": 1,
|
|
61
|
+
"items": { "type": "string" }
|
|
62
|
+
},
|
|
63
|
+
"packageRoot": { "type": "string" }
|
|
64
|
+
},
|
|
65
|
+
"additionalProperties": false
|
|
66
|
+
},
|
|
67
|
+
"description": "Maps source trees to the package manifest that owns their dependencies when application sources live outside that package directory. Only imports found in those sources and declared by the mapped package count as usage."
|
|
68
|
+
},
|
|
69
|
+
"externalPrefixes": { "type": "array", "items": { "type": "string" } },
|
|
70
|
+
"renameExports": { "type": "boolean" },
|
|
71
|
+
"protectedIdentifiers": { "type": "array", "items": { "type": "string" } },
|
|
72
|
+
"enabledChecks": { "$ref": "#/$defs/checkToggles" },
|
|
73
|
+
"autofix": { "$ref": "#/$defs/autofixToggles" },
|
|
74
|
+
"documentation": {
|
|
75
|
+
"type": "object",
|
|
76
|
+
"properties": {
|
|
77
|
+
"commandRoots": {
|
|
78
|
+
"type": "array",
|
|
79
|
+
"items": { "type": "string" },
|
|
80
|
+
"description": "Markdown roots where fenced pnpm commands are checked for deprecated directory flags."
|
|
81
|
+
},
|
|
82
|
+
"cAuthors": {
|
|
83
|
+
"type": "object",
|
|
84
|
+
"additionalProperties": { "type": "string" },
|
|
85
|
+
"description": "Repository-relative C source directory prefixes mapped to required @author names."
|
|
86
|
+
},
|
|
87
|
+
"required": {
|
|
88
|
+
"type": "object",
|
|
89
|
+
"properties": {
|
|
90
|
+
"types": { "type": "boolean" },
|
|
91
|
+
"functions": {
|
|
92
|
+
"type": "boolean",
|
|
93
|
+
"default": true,
|
|
94
|
+
"description": "Require documentation for every named function, method, and constructor in configured source roots, including parameter and return documentation where applicable. Defaults to true for every supported language."
|
|
95
|
+
},
|
|
96
|
+
"exportedFunctions": {
|
|
97
|
+
"type": "boolean",
|
|
98
|
+
"description": "Require TSDoc for exported named functions, including substantive descriptions for every parameter."
|
|
99
|
+
},
|
|
100
|
+
"noInlineFunctions": { "type": "boolean" }
|
|
101
|
+
},
|
|
102
|
+
"additionalProperties": false
|
|
103
|
+
}
|
|
104
|
+
},
|
|
105
|
+
"additionalProperties": false
|
|
106
|
+
},
|
|
107
|
+
"tailwindCanonical": {
|
|
108
|
+
"type": "object",
|
|
109
|
+
"required": ["stylesheet"],
|
|
110
|
+
"properties": {
|
|
111
|
+
"stylesheet": { "type": "string" },
|
|
112
|
+
"sourceRoots": { "type": "array", "items": { "type": "string" } }
|
|
113
|
+
},
|
|
114
|
+
"additionalProperties": false
|
|
115
|
+
},
|
|
116
|
+
"security": {
|
|
117
|
+
"type": "object",
|
|
118
|
+
"properties": {
|
|
119
|
+
"forbiddenTerms": { "type": "array", "items": { "type": "string" } },
|
|
120
|
+
"forbiddenImports": { "type": "array", "items": { "type": "string" } },
|
|
121
|
+
"clientRoots": { "type": "array", "items": { "type": "string" } },
|
|
122
|
+
"runtimeRoots": {
|
|
123
|
+
"type": "array",
|
|
124
|
+
"items": { "type": "string" },
|
|
125
|
+
"description": "Repository-relative Node-only file paths or directory roots where process.env access is expected. Prefer this positive runtime boundary to the legacy allowProcessEnvRoots field."
|
|
126
|
+
},
|
|
127
|
+
"allowProcessEnvRoots": {
|
|
128
|
+
"type": "array",
|
|
129
|
+
"items": { "type": "string" },
|
|
130
|
+
"deprecated": true,
|
|
131
|
+
"description": "Compatibility alias for runtimeRoots."
|
|
132
|
+
}
|
|
133
|
+
},
|
|
134
|
+
"additionalProperties": false
|
|
135
|
+
},
|
|
136
|
+
"repeatedClasses": {
|
|
137
|
+
"type": "object",
|
|
138
|
+
"properties": {
|
|
139
|
+
"minimumCount": { "type": "number" },
|
|
140
|
+
"extensions": { "type": "array", "items": { "type": "string" } }
|
|
141
|
+
},
|
|
142
|
+
"additionalProperties": false
|
|
143
|
+
},
|
|
144
|
+
"regexDedup": {
|
|
145
|
+
"type": "object",
|
|
146
|
+
"properties": {
|
|
147
|
+
"minimumCount": { "type": "number" },
|
|
148
|
+
"extensions": { "type": "array", "items": { "type": "string" } },
|
|
149
|
+
"sharedModule": { "type": "string", "minLength": 1 },
|
|
150
|
+
"skippedDirectories": { "type": "array", "items": { "type": "string" } }
|
|
151
|
+
},
|
|
152
|
+
"additionalProperties": false
|
|
153
|
+
},
|
|
154
|
+
"uiPatterns": {
|
|
155
|
+
"type": "object",
|
|
156
|
+
"properties": {
|
|
157
|
+
"forbidden": { "type": "array", "items": { "type": "string" } },
|
|
158
|
+
"extensions": { "type": "array", "items": { "type": "string" } }
|
|
159
|
+
},
|
|
160
|
+
"additionalProperties": false
|
|
161
|
+
},
|
|
162
|
+
"performancePatterns": {
|
|
163
|
+
"type": "object",
|
|
164
|
+
"properties": {
|
|
165
|
+
"extensions": {
|
|
166
|
+
"type": "array",
|
|
167
|
+
"items": { "type": "string", "pattern": "^\\." }
|
|
168
|
+
},
|
|
169
|
+
"ignoredFiles": { "type": "array", "items": { "type": "string" } }
|
|
170
|
+
},
|
|
171
|
+
"additionalProperties": false,
|
|
172
|
+
"description": "Opt-in advisory scan for repeated linear collection lookups inside collection callbacks."
|
|
173
|
+
},
|
|
174
|
+
"uiRecommendations": {
|
|
175
|
+
"type": "object",
|
|
176
|
+
"properties": {
|
|
177
|
+
"rules": {
|
|
178
|
+
"type": "array",
|
|
179
|
+
"items": {
|
|
180
|
+
"type": "object",
|
|
181
|
+
"required": ["element", "component", "import"],
|
|
182
|
+
"properties": {
|
|
183
|
+
"element": { "type": "string", "pattern": "^[a-z][a-z0-9-]*$" },
|
|
184
|
+
"component": { "type": "string", "minLength": 1 },
|
|
185
|
+
"import": { "type": "string", "minLength": 1 },
|
|
186
|
+
"variant": { "type": "string", "minLength": 1 },
|
|
187
|
+
"types": { "type": "array", "items": { "type": "string" } },
|
|
188
|
+
"when": { "enum": ["always", "button-like", "text-link"] },
|
|
189
|
+
"reason": { "type": "string" }
|
|
190
|
+
},
|
|
191
|
+
"additionalProperties": false
|
|
192
|
+
}
|
|
193
|
+
},
|
|
194
|
+
"extensions": {
|
|
195
|
+
"type": "array",
|
|
196
|
+
"items": { "enum": [".astro", ".jsx", ".tsx"] }
|
|
197
|
+
},
|
|
198
|
+
"ignoredFiles": { "type": "array", "items": { "type": "string" } },
|
|
199
|
+
"ignoredDirectories": { "type": "array", "items": { "type": "string" } }
|
|
200
|
+
},
|
|
201
|
+
"additionalProperties": false
|
|
202
|
+
},
|
|
203
|
+
"github": {
|
|
204
|
+
"type": "object",
|
|
205
|
+
"properties": {
|
|
206
|
+
"repositories": {
|
|
207
|
+
"type": "array",
|
|
208
|
+
"uniqueItems": true,
|
|
209
|
+
"items": {
|
|
210
|
+
"type": "string",
|
|
211
|
+
"pattern": "^[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+$"
|
|
212
|
+
}
|
|
213
|
+
},
|
|
214
|
+
"requiredFeatures": {
|
|
215
|
+
"type": "array",
|
|
216
|
+
"uniqueItems": true,
|
|
217
|
+
"items": {
|
|
218
|
+
"enum": ["dependencyGraph", "dependabotAlerts", "malwareAlerts", "securityUpdates", "versionUpdates", "groupedUpdates", "secretScanning", "pushProtection", "codeScanning"]
|
|
219
|
+
}
|
|
220
|
+
}
|
|
221
|
+
},
|
|
222
|
+
"additionalProperties": false
|
|
223
|
+
},
|
|
224
|
+
"enabledCommands": {
|
|
225
|
+
"type": "object",
|
|
226
|
+
"additionalProperties": { "type": "boolean" }
|
|
227
|
+
},
|
|
228
|
+
"enabledRecommendations": {
|
|
229
|
+
"type": "object",
|
|
230
|
+
"additionalProperties": { "type": "boolean" }
|
|
231
|
+
},
|
|
232
|
+
"languageProfiles": {
|
|
233
|
+
"type": "array",
|
|
234
|
+
"uniqueItems": true,
|
|
235
|
+
"items": { "enum": ["c", "java", "python"] },
|
|
236
|
+
"description": "Optional native-language quality profiles. A selected profile enables its native checks. Without a selected profile, native documentation checks run only for extensions listed in extensions."
|
|
237
|
+
},
|
|
238
|
+
"qualityCommands": {
|
|
239
|
+
"$ref": "#/$defs/commands",
|
|
240
|
+
"description": "Commands selected for the quality run. Terra Quality owns phase order and test grouping; array order is preserved within ordinary phases and within each test group."
|
|
241
|
+
},
|
|
242
|
+
"recommendationCommands": { "$ref": "#/$defs/commands" },
|
|
243
|
+
"tsconfig": { "type": "string" },
|
|
244
|
+
"oneLineImports": { "type": "boolean" },
|
|
245
|
+
"prettierPrintWidth": { "type": "number" },
|
|
246
|
+
"lintRoots": { "type": "array", "items": { "type": "string" } },
|
|
247
|
+
"typecheckRoots": { "type": "array", "items": { "type": "string" } },
|
|
248
|
+
"typecheckExtensions": { "type": "array", "items": { "type": "string" } },
|
|
249
|
+
"typecheckCommand": {
|
|
250
|
+
"type": "object",
|
|
251
|
+
"required": ["command"],
|
|
252
|
+
"properties": {
|
|
253
|
+
"command": { "type": "string" },
|
|
254
|
+
"args": { "type": "array", "items": { "type": "string" } }
|
|
255
|
+
},
|
|
256
|
+
"additionalProperties": false
|
|
257
|
+
},
|
|
258
|
+
"loadTesting": {
|
|
259
|
+
"type": "object",
|
|
260
|
+
"properties": {
|
|
261
|
+
"enabled": { "type": "boolean" },
|
|
262
|
+
"defaultBudget": { "$ref": "#/$defs/loadBudget" },
|
|
263
|
+
"testBudgets": {
|
|
264
|
+
"type": "object",
|
|
265
|
+
"additionalProperties": { "$ref": "#/$defs/loadBudget" }
|
|
266
|
+
},
|
|
267
|
+
"operationBudgets": {
|
|
268
|
+
"type": "object",
|
|
269
|
+
"additionalProperties": { "$ref": "#/$defs/loadBudget" }
|
|
270
|
+
}
|
|
271
|
+
},
|
|
272
|
+
"additionalProperties": false
|
|
273
|
+
},
|
|
274
|
+
"tools": {
|
|
275
|
+
"type": "object",
|
|
276
|
+
"properties": {
|
|
277
|
+
"prettier": { "type": "string" },
|
|
278
|
+
"tsc": { "type": "string" },
|
|
279
|
+
"eslint": { "type": "string" },
|
|
280
|
+
"knip": { "type": "string" },
|
|
281
|
+
"clang": {
|
|
282
|
+
"type": "string",
|
|
283
|
+
"description": "Executable for C declaration documentation parsing; defaults to clang."
|
|
284
|
+
}
|
|
285
|
+
},
|
|
286
|
+
"additionalProperties": { "type": "string" }
|
|
287
|
+
}
|
|
288
|
+
},
|
|
289
|
+
"$defs": {
|
|
290
|
+
"checkToggles": {
|
|
291
|
+
"type": "object",
|
|
292
|
+
"properties": {
|
|
293
|
+
"document": { "type": "boolean" },
|
|
294
|
+
"format": { "type": "boolean" },
|
|
295
|
+
"import": { "type": "boolean" },
|
|
296
|
+
"name": { "type": "boolean" },
|
|
297
|
+
"forward": { "type": "boolean" },
|
|
298
|
+
"error-boundaries": {
|
|
299
|
+
"type": "boolean",
|
|
300
|
+
"const": true,
|
|
301
|
+
"description": "Mandatory check requiring React application render roots to use an error boundary. This check cannot be disabled."
|
|
302
|
+
},
|
|
303
|
+
"accessibility": {
|
|
304
|
+
"type": "boolean",
|
|
305
|
+
"description": "Opt-in check for source-evident accessible names and decorative inline SVG exposure on native JSX controls and explicit interactive roles."
|
|
306
|
+
},
|
|
307
|
+
"display-name": {
|
|
308
|
+
"type": "boolean",
|
|
309
|
+
"description": "Opt-in check for direct React forwardRef declarations without displayName."
|
|
310
|
+
},
|
|
311
|
+
"performance-patterns": {
|
|
312
|
+
"type": "boolean",
|
|
313
|
+
"description": "Reports configured syntax patterns that may repeat work in collection callbacks; advisory only."
|
|
314
|
+
},
|
|
315
|
+
"documented-commands": {
|
|
316
|
+
"type": "boolean",
|
|
317
|
+
"description": "Checks deprecated pnpm directory flags in configured Markdown shell fences."
|
|
318
|
+
},
|
|
319
|
+
"lint": { "type": "boolean" },
|
|
320
|
+
"knip": { "type": "boolean" },
|
|
321
|
+
"dead-code": { "type": "boolean" },
|
|
322
|
+
"type": { "type": "boolean" },
|
|
323
|
+
"recommend": { "type": "boolean" },
|
|
324
|
+
"command": { "type": "boolean" },
|
|
325
|
+
"diff": { "type": "boolean" },
|
|
326
|
+
"alias": { "type": "boolean" },
|
|
327
|
+
"security": { "type": "boolean" },
|
|
328
|
+
"repeated-classes": { "type": "boolean" },
|
|
329
|
+
"tailwind-canonical": { "type": "boolean" },
|
|
330
|
+
"regex-dedup": { "type": "boolean" },
|
|
331
|
+
"ui-patterns": { "type": "boolean" },
|
|
332
|
+
"ui-recommendations": { "type": "boolean" },
|
|
333
|
+
"github": { "type": "boolean" }
|
|
334
|
+
},
|
|
335
|
+
"additionalProperties": false
|
|
336
|
+
},
|
|
337
|
+
"autofixToggles": {
|
|
338
|
+
"type": "object",
|
|
339
|
+
"properties": {
|
|
340
|
+
"document": {
|
|
341
|
+
"type": "boolean",
|
|
342
|
+
"const": false,
|
|
343
|
+
"description": "Documentation content is authored after source and caller review; no comment-generation fixer is available."
|
|
344
|
+
},
|
|
345
|
+
"duplicateImports": {
|
|
346
|
+
"type": "boolean",
|
|
347
|
+
"description": "Removes only repeated, identical import declarations without comments when fixes are enabled."
|
|
348
|
+
},
|
|
349
|
+
"errorBoundaries": {
|
|
350
|
+
"type": "boolean",
|
|
351
|
+
"const": true,
|
|
352
|
+
"description": "Automatically wraps unguarded React render roots when Terra Quality runs with fixes enabled."
|
|
353
|
+
},
|
|
354
|
+
"accessibility": {
|
|
355
|
+
"type": "boolean",
|
|
356
|
+
"description": "Copies a literal title into aria-label or hides an unnamed inline SVG inside an already named control."
|
|
357
|
+
},
|
|
358
|
+
"displayName": {
|
|
359
|
+
"type": "boolean",
|
|
360
|
+
"description": "Adds a conventional displayName to a direct named forwardRef declaration."
|
|
361
|
+
},
|
|
362
|
+
"documentedCommands": {
|
|
363
|
+
"type": "boolean",
|
|
364
|
+
"description": "Rewrites pnpm -C and --prefix to the repository's canonical --dir flag in configured Markdown shell fences."
|
|
365
|
+
}
|
|
366
|
+
},
|
|
367
|
+
"additionalProperties": { "type": "boolean" }
|
|
368
|
+
},
|
|
369
|
+
"loadBudget": {
|
|
370
|
+
"type": "object",
|
|
371
|
+
"properties": {
|
|
372
|
+
"warnMs": { "type": "number", "minimum": 0 },
|
|
373
|
+
"failMs": { "type": "number", "minimum": 0 }
|
|
374
|
+
},
|
|
375
|
+
"additionalProperties": false,
|
|
376
|
+
"anyOf": [{ "required": ["warnMs"] }, { "required": ["failMs"] }]
|
|
377
|
+
},
|
|
378
|
+
"commands": {
|
|
379
|
+
"type": "array",
|
|
380
|
+
"items": {
|
|
381
|
+
"type": "object",
|
|
382
|
+
"required": ["name", "command"],
|
|
383
|
+
"properties": {
|
|
384
|
+
"name": { "type": "string", "pattern": "^[a-z][a-z0-9-]*$" },
|
|
385
|
+
"command": { "type": "string" },
|
|
386
|
+
"args": { "type": "array", "items": { "type": "string" } }
|
|
387
|
+
},
|
|
388
|
+
"additionalProperties": false
|
|
389
|
+
}
|
|
390
|
+
}
|
|
391
|
+
}
|
|
392
|
+
}
|