@futdevpro/dynamo-eslint 1.15.22 → 1.15.28
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/.c8rc.json +26 -26
- package/.cursor/rules/__assistant_guide.mdc +30 -30
- package/.cursor/rules/__main.mdc +64 -64
- package/.cursor/rules/_ag_backend-structure.mdc +85 -85
- package/.cursor/rules/_ag_backend.mdc +16 -16
- package/.cursor/rules/_ag_debug.mdc +7 -7
- package/.cursor/rules/_ag_documentation_writing_rules.mdc +372 -372
- package/.cursor/rules/_ag_file-refactoring.mdc +113 -113
- package/.cursor/rules/_ag_fixes_rules.mdc +5 -5
- package/.cursor/rules/_ag_frontend-structure.mdc +86 -86
- package/.cursor/rules/_ag_frontend.mdc +39 -39
- package/.cursor/rules/_ag_import-rules.mdc +44 -44
- package/.cursor/rules/_ag_naming.mdc +115 -115
- package/.cursor/rules/_ag_running_commands.mdc +4 -4
- package/.cursor/rules/_ag_server-controller.mdc +5 -5
- package/.cursor/rules/_ag_should-be.mdc +6 -6
- package/.cursor/rules/_ag_swearing.mdc +47 -47
- package/.cursor/rules/ai_development_guide.md +60 -60
- package/.cursor/rules/ai_directives.md +114 -114
- package/.cursor/rules/cursor-rules.md +160 -160
- package/.cursor/rules/default-command.mdc +464 -464
- package/.cursor/rules/error_code_pattern.md +39 -39
- package/.cursor/rules/saved rule mcp server use.md +15 -15
- package/.dynamo/pipeline.cicd.config.json +184 -184
- package/.dynamo/version-bump.config.json +5 -5
- package/.eslintrc.json +4 -4
- package/.github/workflows/main.yml +436 -436
- package/.husky/pre-commit +2 -2
- package/.vscode/settings.json +11 -11
- package/README.md +319 -319
- package/__documentations/2026-04-18-ccap-review-integration.md +173 -173
- package/__documentations/2026-08-18-bfr-ctm-005-eslint9-validator-report.md +45 -0
- package/build/configs/base.d.ts +9 -9
- package/build/configs/base.js +150 -150
- package/build/configs/fsm.d.ts +1 -1
- package/build/configs/fsm.js +7 -7
- package/build/configs/ngx-package.d.ts +1 -1
- package/build/configs/ngx-package.js +7 -7
- package/build/configs/ngx.d.ts +4 -4
- package/build/configs/ngx.js +91 -91
- package/build/configs/nts-package.d.ts +1 -1
- package/build/configs/nts-package.js +17 -17
- package/build/configs/nts.d.ts +1 -1
- package/build/configs/nts.js +31 -31
- package/build/index.d.ts +1 -1
- package/build/index.js +2 -2
- package/build/plugin/index.d.ts +52 -52
- package/build/plugin/index.js +80 -80
- package/build/plugin/rules/angular/angular-for-track-logic.d.ts +7 -7
- package/build/plugin/rules/angular/angular-for-track-logic.js +81 -81
- package/build/plugin/rules/angular/effect-signal-loop.d.ts +9 -9
- package/build/plugin/rules/angular/effect-signal-loop.js +112 -112
- package/build/plugin/rules/angular/no-async-ngoninit.d.ts +8 -8
- package/build/plugin/rules/angular/no-async-ngoninit.js +42 -42
- package/build/plugin/rules/angular/no-component-direct-api.d.ts +9 -9
- package/build/plugin/rules/angular/no-component-direct-api.js +75 -75
- package/build/plugin/rules/angular/no-method-call-in-template.d.ts +8 -8
- package/build/plugin/rules/angular/no-method-call-in-template.js +79 -79
- package/build/plugin/rules/angular/no-ngfor-directive.d.ts +7 -7
- package/build/plugin/rules/angular/no-ngfor-directive.js +59 -59
- package/build/plugin/rules/angular/no-ngif-directive.d.ts +7 -7
- package/build/plugin/rules/angular/no-ngif-directive.js +59 -59
- package/build/plugin/rules/explicit-types.d.ts +3 -3
- package/build/plugin/rules/explicit-types.js +178 -178
- package/build/plugin/rules/import/import-order.d.ts +3 -3
- package/build/plugin/rules/import/import-order.js +154 -154
- package/build/plugin/rules/import/no-import-type.d.ts +3 -3
- package/build/plugin/rules/import/no-import-type.js +45 -45
- package/build/plugin/rules/import/no-js-import.d.ts +3 -3
- package/build/plugin/rules/import/no-js-import.js +40 -40
- package/build/plugin/rules/naming-patterns.d.ts +7 -7
- package/build/plugin/rules/naming-patterns.d.ts.map +1 -1
- package/build/plugin/rules/naming-patterns.js +366 -350
- package/build/plugin/rules/naming-patterns.js.map +1 -1
- package/build/plugin/rules/no-getter-logic.d.ts +3 -3
- package/build/plugin/rules/no-getter-logic.js +194 -194
- package/build/plugin/rules/prefer-enum-over-string-union.d.ts +3 -3
- package/build/plugin/rules/prefer-enum-over-string-union.js +289 -289
- package/build/plugin/rules/prefer-interface-over-duplicate-types.d.ts +3 -3
- package/build/plugin/rules/prefer-interface-over-duplicate-types.js +264 -264
- package/build/plugin/rules/require-jsdoc-description.d.ts +3 -3
- package/build/plugin/rules/require-jsdoc-description.js +496 -496
- package/build/plugin/rules/require-test-description-prefix.d.ts +3 -3
- package/build/plugin/rules/require-test-description-prefix.js +135 -135
- package/build/plugin/rules/ts/data-model-extends.d.ts +8 -8
- package/build/plugin/rules/ts/data-model-extends.js +94 -94
- package/build/plugin/rules/ts/no-any-type.d.ts +8 -8
- package/build/plugin/rules/ts/no-any-type.js +36 -36
- package/build/plugin/rules/ts/no-as-cast.d.ts +8 -8
- package/build/plugin/rules/ts/no-as-cast.js +49 -49
- package/build/plugin/rules/ts/no-dynamic-imports.d.ts +8 -8
- package/build/plugin/rules/ts/no-dynamic-imports.js +50 -50
- package/build/plugin/rules/ts/no-native-browser-dialogs.d.ts +8 -8
- package/build/plugin/rules/ts/no-native-browser-dialogs.js +78 -78
- package/build/plugin/rules/ts/no-plain-function-export.d.ts +9 -9
- package/build/plugin/rules/ts/no-plain-function-export.js +69 -69
- package/build/plugin/rules/ts/one-export-per-file.d.ts +8 -8
- package/build/plugin/rules/ts/one-export-per-file.js +73 -73
- package/build/scripts/dynamo-fix.d.ts +26 -26
- package/build/scripts/dynamo-fix.js +146 -146
- package/build/scripts/dynamo-fix.js.map +1 -1
- package/build/scripts/eslintrc-audit.d.ts +26 -26
- package/build/scripts/eslintrc-audit.js +100 -100
- package/build/scripts/fix-return-types.d.ts +74 -74
- package/build/scripts/fix-return-types.js +226 -226
- package/build/scripts/validate-imports.d.ts +26 -26
- package/build/scripts/validate-imports.js +157 -137
- package/build/scripts/validate-imports.js.map +1 -1
- package/build/scripts/validate-naming.d.ts +26 -26
- package/build/scripts/validate-naming.js +157 -123
- package/build/scripts/validate-naming.js.map +1 -1
- package/eslint.config.js +15 -15
- package/package.json +105 -105
- package/samples/.vscode/settings.json +13 -13
- package/samples/base/.eslintrc.json +6 -6
- package/samples/base/eslint.config.js +3 -3
- package/samples/fsm/.eslintrc.json +4 -4
- package/samples/fsm/eslint.config.js +3 -3
- package/samples/ngx/.eslintrc.json +6 -6
- package/samples/ngx/eslint.config.js +3 -3
- package/samples/ngx-package/.eslintrc.json +4 -4
- package/samples/ngx-package/eslint.config.js +3 -3
- package/samples/nts/.eslintrc.json +6 -6
- package/samples/nts/eslint.config.js +3 -3
- package/samples/nts-package/.eslintrc.json +4 -4
- package/samples/nts-package/eslint.config.js +3 -3
- package/samples/package.json.example +26 -26
- package/samples/poc-sample.ts +38 -38
- package/samples/poc-violations.ts +54 -54
- package/scripts/run-coverage-tests.js +24 -24
- package/spec/support/helpers/ts-node-helper.js +9 -9
- package/spec/support/jasmine.coverage.json +23 -23
- package/spec/support/jasmine.json +24 -24
- package/src/configs/base.ts +157 -157
- package/src/configs/fsm.ts +10 -10
- package/src/configs/ngx-package.ts +10 -10
- package/src/configs/ngx.ts +96 -96
- package/src/configs/nts-package.ts +20 -20
- package/src/configs/nts.ts +34 -34
- package/src/index.ts +4 -4
- package/src/plugin/index.ts +86 -86
- package/src/plugin/rules/angular/angular-for-track-logic.spec.ts +44 -44
- package/src/plugin/rules/angular/angular-for-track-logic.ts +88 -88
- package/src/plugin/rules/angular/effect-signal-loop.spec.ts +89 -89
- package/src/plugin/rules/angular/effect-signal-loop.ts +125 -125
- package/src/plugin/rules/angular/no-async-ngoninit.spec.ts +50 -50
- package/src/plugin/rules/angular/no-async-ngoninit.ts +43 -43
- package/src/plugin/rules/angular/no-component-direct-api.spec.ts +78 -78
- package/src/plugin/rules/angular/no-component-direct-api.ts +82 -82
- package/src/plugin/rules/angular/no-method-call-in-template.spec.ts +63 -63
- package/src/plugin/rules/angular/no-method-call-in-template.ts +89 -89
- package/src/plugin/rules/angular/no-ngfor-directive.spec.ts +44 -44
- package/src/plugin/rules/angular/no-ngfor-directive.ts +62 -62
- package/src/plugin/rules/angular/no-ngif-directive.spec.ts +44 -44
- package/src/plugin/rules/angular/no-ngif-directive.ts +62 -62
- package/src/plugin/rules/explicit-types.spec.ts +190 -190
- package/src/plugin/rules/explicit-types.ts +186 -186
- package/src/plugin/rules/import/import-order.spec.ts +219 -219
- package/src/plugin/rules/import/import-order.ts +197 -197
- package/src/plugin/rules/import/no-import-type.spec.ts +69 -69
- package/src/plugin/rules/import/no-import-type.ts +46 -46
- package/src/plugin/rules/import/no-js-import.spec.ts +82 -82
- package/src/plugin/rules/import/no-js-import.ts +45 -45
- package/src/plugin/rules/naming-patterns.spec.ts +189 -127
- package/src/plugin/rules/naming-patterns.ts +426 -408
- package/src/plugin/rules/no-getter-logic.spec.ts +591 -591
- package/src/plugin/rules/no-getter-logic.ts +220 -220
- package/src/plugin/rules/prefer-enum-over-string-union.spec.ts +583 -583
- package/src/plugin/rules/prefer-enum-over-string-union.ts +333 -333
- package/src/plugin/rules/prefer-interface-over-duplicate-types.spec.ts +404 -404
- package/src/plugin/rules/prefer-interface-over-duplicate-types.ts +314 -314
- package/src/plugin/rules/require-jsdoc-description.spec.ts +779 -779
- package/src/plugin/rules/require-jsdoc-description.ts +572 -572
- package/src/plugin/rules/require-test-description-prefix.spec.ts +459 -459
- package/src/plugin/rules/require-test-description-prefix.ts +154 -154
- package/src/plugin/rules/ts/data-model-extends.spec.ts +84 -84
- package/src/plugin/rules/ts/data-model-extends.ts +100 -100
- package/src/plugin/rules/ts/no-any-type.spec.ts +28 -28
- package/src/plugin/rules/ts/no-any-type.ts +36 -36
- package/src/plugin/rules/ts/no-as-cast.spec.ts +51 -51
- package/src/plugin/rules/ts/no-as-cast.ts +51 -51
- package/src/plugin/rules/ts/no-dynamic-imports.spec.ts +54 -54
- package/src/plugin/rules/ts/no-dynamic-imports.ts +49 -49
- package/src/plugin/rules/ts/no-native-browser-dialogs.spec.ts +54 -54
- package/src/plugin/rules/ts/no-native-browser-dialogs.ts +84 -84
- package/src/plugin/rules/ts/no-plain-function-export.spec.ts +72 -72
- package/src/plugin/rules/ts/no-plain-function-export.ts +73 -73
- package/src/plugin/rules/ts/one-export-per-file.spec.ts +64 -64
- package/src/plugin/rules/ts/one-export-per-file.ts +77 -77
- package/src/scripts/dynamo-fix.ts +172 -172
- package/src/scripts/eslintrc-audit.ts +116 -116
- package/src/scripts/fix-return-types.spec.ts +65 -65
- package/src/scripts/fix-return-types.ts +288 -288
- package/src/scripts/validate-imports.ts +278 -249
- package/src/scripts/validate-naming.ts +204 -176
- package/src/scripts/validator-cli.integration.spec.ts +96 -0
- package/tsconfig.json +31 -31
|
@@ -1,101 +1,101 @@
|
|
|
1
|
-
#!/usr/bin/env node
|
|
2
|
-
"use strict";
|
|
3
|
-
/**
|
|
4
|
-
* @fileoverview ESLint Configuration Audit Script
|
|
5
|
-
*
|
|
6
|
-
* This script analyzes ESLint configuration files (.eslintrc.json) across the project
|
|
7
|
-
* to provide statistics on rule usage. It helps identify commonly used rules and
|
|
8
|
-
* potential configuration inconsistencies.
|
|
9
|
-
*
|
|
10
|
-
* @usage
|
|
11
|
-
* ```bash
|
|
12
|
-
* dynamo-eslintrc-audit
|
|
13
|
-
* ```
|
|
14
|
-
*
|
|
15
|
-
* @example
|
|
16
|
-
* ```bash
|
|
17
|
-
* # Audit all ESLint configurations in the project
|
|
18
|
-
* npx dynamo-eslintrc-audit
|
|
19
|
-
*
|
|
20
|
-
* # Or run via npm script
|
|
21
|
-
* npm run audit:eslintrc
|
|
22
|
-
* ```
|
|
23
|
-
*
|
|
24
|
-
* @author Future Development Program Ltd.
|
|
25
|
-
* @version 1.14.3
|
|
26
|
-
*/
|
|
27
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
28
|
-
const tslib_1 = require("tslib");
|
|
29
|
-
const fast_glob_1 = tslib_1.__importDefault(require("fast-glob"));
|
|
30
|
-
const fs_1 = require("fs");
|
|
31
|
-
/**
|
|
32
|
-
* Safely parses a JSON file and returns the parsed object or null if parsing fails
|
|
33
|
-
*
|
|
34
|
-
* @param jsonPath - Path to the JSON file to parse
|
|
35
|
-
* @returns Parsed JSON object or null if parsing fails
|
|
36
|
-
*
|
|
37
|
-
* @example
|
|
38
|
-
* ```typescript
|
|
39
|
-
* const config = safeParse('./.eslintrc.json');
|
|
40
|
-
* if (config) {
|
|
41
|
-
* console.log('Rules:', Object.keys(config.rules || {}));
|
|
42
|
-
* }
|
|
43
|
-
* ```
|
|
44
|
-
*/
|
|
45
|
-
function safeParse(jsonPath) {
|
|
46
|
-
try {
|
|
47
|
-
const content = (0, fs_1.readFileSync)(jsonPath, 'utf8');
|
|
48
|
-
return JSON.parse(content);
|
|
49
|
-
}
|
|
50
|
-
catch {
|
|
51
|
-
// Return null for any parsing errors (malformed JSON, file not found, etc.)
|
|
52
|
-
return null;
|
|
53
|
-
}
|
|
54
|
-
}
|
|
55
|
-
/**
|
|
56
|
-
* Main function that analyzes ESLint configuration files and generates rule usage statistics
|
|
57
|
-
*
|
|
58
|
-
* Scans for all .eslintrc.json files in the project, extracts rule configurations,
|
|
59
|
-
* and provides a sorted table of the most commonly used rules.
|
|
60
|
-
*
|
|
61
|
-
* @returns Promise that resolves when analysis is complete
|
|
62
|
-
*
|
|
63
|
-
* @example
|
|
64
|
-
* ```typescript
|
|
65
|
-
* // The function will output a table like:
|
|
66
|
-
* // ┌─────────┬─────────────────────────┬───────┐
|
|
67
|
-
* // │ (index) │ rule │ count │
|
|
68
|
-
* // ├─────────┼─────────────────────────┼───────┤
|
|
69
|
-
* // │ 0 │ 'no-unused-vars' │ 5 │
|
|
70
|
-
* // │ 1 │ 'semi' │ 4 │
|
|
71
|
-
* // └─────────┴─────────────────────────┴───────┘
|
|
72
|
-
* ```
|
|
73
|
-
*/
|
|
74
|
-
async function main() {
|
|
75
|
-
// Find all ESLint configuration files, excluding node_modules
|
|
76
|
-
const files = await (0, fast_glob_1.default)(['**/.eslintrc.json'], { ignore: ['**/node_modules/**'] });
|
|
77
|
-
const ruleCounts = {};
|
|
78
|
-
const total = files.length;
|
|
79
|
-
// Process each configuration file
|
|
80
|
-
for (const p of files) {
|
|
81
|
-
const cfg = safeParse(p);
|
|
82
|
-
// Skip files without rules configuration
|
|
83
|
-
if (!cfg?.rules)
|
|
84
|
-
continue;
|
|
85
|
-
// Count each rule occurrence
|
|
86
|
-
for (const key of Object.keys(cfg.rules)) {
|
|
87
|
-
ruleCounts[key] = (ruleCounts[key] ?? 0) + 1;
|
|
88
|
-
}
|
|
89
|
-
}
|
|
90
|
-
// Sort rules by usage count (most used first)
|
|
91
|
-
const entries = Object.entries(ruleCounts).sort((a, b) => b[1] - a[1]);
|
|
92
|
-
// Display results
|
|
93
|
-
console.log(`[dynamo-eslintrc-audit] analyzed ${total} files`);
|
|
94
|
-
console.table(entries.slice(0, 50).map(([rule, count]) => ({ rule, count })));
|
|
95
|
-
}
|
|
96
|
-
// Execute the main function and handle any errors
|
|
97
|
-
main().catch((err) => {
|
|
98
|
-
console.error(err);
|
|
99
|
-
process.exit(1);
|
|
100
|
-
});
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
"use strict";
|
|
3
|
+
/**
|
|
4
|
+
* @fileoverview ESLint Configuration Audit Script
|
|
5
|
+
*
|
|
6
|
+
* This script analyzes ESLint configuration files (.eslintrc.json) across the project
|
|
7
|
+
* to provide statistics on rule usage. It helps identify commonly used rules and
|
|
8
|
+
* potential configuration inconsistencies.
|
|
9
|
+
*
|
|
10
|
+
* @usage
|
|
11
|
+
* ```bash
|
|
12
|
+
* dynamo-eslintrc-audit
|
|
13
|
+
* ```
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* ```bash
|
|
17
|
+
* # Audit all ESLint configurations in the project
|
|
18
|
+
* npx dynamo-eslintrc-audit
|
|
19
|
+
*
|
|
20
|
+
* # Or run via npm script
|
|
21
|
+
* npm run audit:eslintrc
|
|
22
|
+
* ```
|
|
23
|
+
*
|
|
24
|
+
* @author Future Development Program Ltd.
|
|
25
|
+
* @version 1.14.3
|
|
26
|
+
*/
|
|
27
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
28
|
+
const tslib_1 = require("tslib");
|
|
29
|
+
const fast_glob_1 = tslib_1.__importDefault(require("fast-glob"));
|
|
30
|
+
const fs_1 = require("fs");
|
|
31
|
+
/**
|
|
32
|
+
* Safely parses a JSON file and returns the parsed object or null if parsing fails
|
|
33
|
+
*
|
|
34
|
+
* @param jsonPath - Path to the JSON file to parse
|
|
35
|
+
* @returns Parsed JSON object or null if parsing fails
|
|
36
|
+
*
|
|
37
|
+
* @example
|
|
38
|
+
* ```typescript
|
|
39
|
+
* const config = safeParse('./.eslintrc.json');
|
|
40
|
+
* if (config) {
|
|
41
|
+
* console.log('Rules:', Object.keys(config.rules || {}));
|
|
42
|
+
* }
|
|
43
|
+
* ```
|
|
44
|
+
*/
|
|
45
|
+
function safeParse(jsonPath) {
|
|
46
|
+
try {
|
|
47
|
+
const content = (0, fs_1.readFileSync)(jsonPath, 'utf8');
|
|
48
|
+
return JSON.parse(content);
|
|
49
|
+
}
|
|
50
|
+
catch {
|
|
51
|
+
// Return null for any parsing errors (malformed JSON, file not found, etc.)
|
|
52
|
+
return null;
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Main function that analyzes ESLint configuration files and generates rule usage statistics
|
|
57
|
+
*
|
|
58
|
+
* Scans for all .eslintrc.json files in the project, extracts rule configurations,
|
|
59
|
+
* and provides a sorted table of the most commonly used rules.
|
|
60
|
+
*
|
|
61
|
+
* @returns Promise that resolves when analysis is complete
|
|
62
|
+
*
|
|
63
|
+
* @example
|
|
64
|
+
* ```typescript
|
|
65
|
+
* // The function will output a table like:
|
|
66
|
+
* // ┌─────────┬─────────────────────────┬───────┐
|
|
67
|
+
* // │ (index) │ rule │ count │
|
|
68
|
+
* // ├─────────┼─────────────────────────┼───────┤
|
|
69
|
+
* // │ 0 │ 'no-unused-vars' │ 5 │
|
|
70
|
+
* // │ 1 │ 'semi' │ 4 │
|
|
71
|
+
* // └─────────┴─────────────────────────┴───────┘
|
|
72
|
+
* ```
|
|
73
|
+
*/
|
|
74
|
+
async function main() {
|
|
75
|
+
// Find all ESLint configuration files, excluding node_modules
|
|
76
|
+
const files = await (0, fast_glob_1.default)(['**/.eslintrc.json'], { ignore: ['**/node_modules/**'] });
|
|
77
|
+
const ruleCounts = {};
|
|
78
|
+
const total = files.length;
|
|
79
|
+
// Process each configuration file
|
|
80
|
+
for (const p of files) {
|
|
81
|
+
const cfg = safeParse(p);
|
|
82
|
+
// Skip files without rules configuration
|
|
83
|
+
if (!cfg?.rules)
|
|
84
|
+
continue;
|
|
85
|
+
// Count each rule occurrence
|
|
86
|
+
for (const key of Object.keys(cfg.rules)) {
|
|
87
|
+
ruleCounts[key] = (ruleCounts[key] ?? 0) + 1;
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
// Sort rules by usage count (most used first)
|
|
91
|
+
const entries = Object.entries(ruleCounts).sort((a, b) => b[1] - a[1]);
|
|
92
|
+
// Display results
|
|
93
|
+
console.log(`[dynamo-eslintrc-audit] analyzed ${total} files`);
|
|
94
|
+
console.table(entries.slice(0, 50).map(([rule, count]) => ({ rule, count })));
|
|
95
|
+
}
|
|
96
|
+
// Execute the main function and handle any errors
|
|
97
|
+
main().catch((err) => {
|
|
98
|
+
console.error(err);
|
|
99
|
+
process.exit(1);
|
|
100
|
+
});
|
|
101
101
|
//# sourceMappingURL=eslintrc-audit.js.map
|
|
@@ -1,75 +1,75 @@
|
|
|
1
|
-
#!/usr/bin/env node
|
|
2
|
-
/**
|
|
3
|
-
* @fileoverview TypeScript Type Annotation Fix Script
|
|
4
|
-
*
|
|
5
|
-
* This script uses TypeScript's AST (Abstract Syntax Tree) to automatically add
|
|
6
|
-
* type annotations to functions and arrow functions. It analyzes TypeScript files,
|
|
7
|
-
* infers return types using the TypeScript compiler, and adds explicit type
|
|
8
|
-
* annotations where missing.
|
|
9
|
-
*
|
|
10
|
-
* @usage
|
|
11
|
-
* ```bash
|
|
12
|
-
* dynamo-fix-return-types
|
|
13
|
-
* ```
|
|
14
|
-
*
|
|
15
|
-
* @example
|
|
16
|
-
* ```bash
|
|
17
|
-
* # Fix type annotations in all TypeScript files
|
|
18
|
-
* npx dynamo-fix-return-types
|
|
19
|
-
*
|
|
20
|
-
* # Or run via npm script
|
|
21
|
-
* npm run fix:types
|
|
22
|
-
* ```
|
|
23
|
-
*
|
|
24
|
-
* @author Future Development Program Ltd.
|
|
25
|
-
* @version 1.14.3
|
|
26
|
-
*/
|
|
27
|
-
import * as ts from 'typescript';
|
|
28
|
-
/**
|
|
29
|
-
* Result of fixing type annotations in a single file
|
|
30
|
-
*/
|
|
31
|
-
interface FixResult {
|
|
32
|
-
/** Path to the file that was processed */
|
|
33
|
-
file: string;
|
|
34
|
-
/** Whether the file was actually modified */
|
|
35
|
-
fixed: boolean;
|
|
36
|
-
/** Number of type annotations added to the file */
|
|
37
|
-
changes: number;
|
|
38
|
-
}
|
|
39
|
-
/**
|
|
40
|
-
* Egy `checker.typeToString(...)`-bol jovo TIPUS-STRING-et valodi `ts.TypeNode`-da
|
|
41
|
-
* alakit ugy, hogy egy eldobhato `type __T = <typeString>;` forrast parse-ol es
|
|
42
|
-
* kiszedi belole a TypeNode-ot.
|
|
43
|
-
*
|
|
44
|
-
* MIERT: a regi megoldas `ts.factory.createTypeReferenceNode(typeString)`-et hivott,
|
|
45
|
-
* ami CSAK bare identifier-t (entity-name-et) fogad el. Egy generic/union/stb.
|
|
46
|
-
* tipus-string (pl. `Record<string, unknown>`) eseten ez tort node-ot epitett, amit
|
|
47
|
-
* a printer csonka `Record`-kent (type-argumentumok nelkul) emittalt — ami EGYSZERRE
|
|
48
|
-
* tsc-hiba ES uj lint-hiba, igy egyetlen fix-futas 0 → 1+ lint-szamot regresszalt.
|
|
49
|
-
* A `typeToString` mindig syntactically valid TS tipus-syntaxot ad vissza, ezert a
|
|
50
|
-
* `type __T = …;` parse-olas minden esetre korrekt TypeNode-ot allit elo.
|
|
51
|
-
*
|
|
52
|
-
* BAIL-OUT: ha a tipus nem alakithato biztonsagos node-da — pl. inline
|
|
53
|
-
* `import("/abs/path").Foo` format tartalmaz, ami abszolut path-t szivarogtatna a
|
|
54
|
-
* fajlba —, `undefined`-et adunk vissza. A hivo ilyenkor KIHAGYJA az annotaciot:
|
|
55
|
-
* jobb annotalatlanul hagyni (marad a figyelmeztetes), mint tort kodot irni.
|
|
56
|
-
*/
|
|
57
|
-
declare function buildTypeNodeFromString(typeString: string): ts.TypeNode | undefined;
|
|
58
|
-
/**
|
|
59
|
-
* Adds type annotations to functions and arrow functions in a TypeScript file
|
|
60
|
-
*
|
|
61
|
-
* Uses TypeScript's compiler API to analyze the file, infer return types,
|
|
62
|
-
* and automatically add explicit type annotations where missing.
|
|
63
|
-
*
|
|
64
|
-
* @param filePath - Path to the TypeScript file to process
|
|
65
|
-
* @returns FixResult object containing statistics about the changes made
|
|
66
|
-
*
|
|
67
|
-
* @example
|
|
68
|
-
* ```typescript
|
|
69
|
-
* const result = addTypesToFile('./src/utils.ts');
|
|
70
|
-
* console.log(`Added ${result.changes} type annotations to ${result.file}`);
|
|
71
|
-
* ```
|
|
72
|
-
*/
|
|
73
|
-
declare function addTypesToFile(filePath: string): FixResult;
|
|
74
|
-
export { buildTypeNodeFromString, addTypesToFile };
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
/**
|
|
3
|
+
* @fileoverview TypeScript Type Annotation Fix Script
|
|
4
|
+
*
|
|
5
|
+
* This script uses TypeScript's AST (Abstract Syntax Tree) to automatically add
|
|
6
|
+
* type annotations to functions and arrow functions. It analyzes TypeScript files,
|
|
7
|
+
* infers return types using the TypeScript compiler, and adds explicit type
|
|
8
|
+
* annotations where missing.
|
|
9
|
+
*
|
|
10
|
+
* @usage
|
|
11
|
+
* ```bash
|
|
12
|
+
* dynamo-fix-return-types
|
|
13
|
+
* ```
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* ```bash
|
|
17
|
+
* # Fix type annotations in all TypeScript files
|
|
18
|
+
* npx dynamo-fix-return-types
|
|
19
|
+
*
|
|
20
|
+
* # Or run via npm script
|
|
21
|
+
* npm run fix:types
|
|
22
|
+
* ```
|
|
23
|
+
*
|
|
24
|
+
* @author Future Development Program Ltd.
|
|
25
|
+
* @version 1.14.3
|
|
26
|
+
*/
|
|
27
|
+
import * as ts from 'typescript';
|
|
28
|
+
/**
|
|
29
|
+
* Result of fixing type annotations in a single file
|
|
30
|
+
*/
|
|
31
|
+
interface FixResult {
|
|
32
|
+
/** Path to the file that was processed */
|
|
33
|
+
file: string;
|
|
34
|
+
/** Whether the file was actually modified */
|
|
35
|
+
fixed: boolean;
|
|
36
|
+
/** Number of type annotations added to the file */
|
|
37
|
+
changes: number;
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Egy `checker.typeToString(...)`-bol jovo TIPUS-STRING-et valodi `ts.TypeNode`-da
|
|
41
|
+
* alakit ugy, hogy egy eldobhato `type __T = <typeString>;` forrast parse-ol es
|
|
42
|
+
* kiszedi belole a TypeNode-ot.
|
|
43
|
+
*
|
|
44
|
+
* MIERT: a regi megoldas `ts.factory.createTypeReferenceNode(typeString)`-et hivott,
|
|
45
|
+
* ami CSAK bare identifier-t (entity-name-et) fogad el. Egy generic/union/stb.
|
|
46
|
+
* tipus-string (pl. `Record<string, unknown>`) eseten ez tort node-ot epitett, amit
|
|
47
|
+
* a printer csonka `Record`-kent (type-argumentumok nelkul) emittalt — ami EGYSZERRE
|
|
48
|
+
* tsc-hiba ES uj lint-hiba, igy egyetlen fix-futas 0 → 1+ lint-szamot regresszalt.
|
|
49
|
+
* A `typeToString` mindig syntactically valid TS tipus-syntaxot ad vissza, ezert a
|
|
50
|
+
* `type __T = …;` parse-olas minden esetre korrekt TypeNode-ot allit elo.
|
|
51
|
+
*
|
|
52
|
+
* BAIL-OUT: ha a tipus nem alakithato biztonsagos node-da — pl. inline
|
|
53
|
+
* `import("/abs/path").Foo` format tartalmaz, ami abszolut path-t szivarogtatna a
|
|
54
|
+
* fajlba —, `undefined`-et adunk vissza. A hivo ilyenkor KIHAGYJA az annotaciot:
|
|
55
|
+
* jobb annotalatlanul hagyni (marad a figyelmeztetes), mint tort kodot irni.
|
|
56
|
+
*/
|
|
57
|
+
declare function buildTypeNodeFromString(typeString: string): ts.TypeNode | undefined;
|
|
58
|
+
/**
|
|
59
|
+
* Adds type annotations to functions and arrow functions in a TypeScript file
|
|
60
|
+
*
|
|
61
|
+
* Uses TypeScript's compiler API to analyze the file, infer return types,
|
|
62
|
+
* and automatically add explicit type annotations where missing.
|
|
63
|
+
*
|
|
64
|
+
* @param filePath - Path to the TypeScript file to process
|
|
65
|
+
* @returns FixResult object containing statistics about the changes made
|
|
66
|
+
*
|
|
67
|
+
* @example
|
|
68
|
+
* ```typescript
|
|
69
|
+
* const result = addTypesToFile('./src/utils.ts');
|
|
70
|
+
* console.log(`Added ${result.changes} type annotations to ${result.file}`);
|
|
71
|
+
* ```
|
|
72
|
+
*/
|
|
73
|
+
declare function addTypesToFile(filePath: string): FixResult;
|
|
74
|
+
export { buildTypeNodeFromString, addTypesToFile };
|
|
75
75
|
//# sourceMappingURL=fix-return-types.d.ts.map
|