@futdevpro/dynamo-eslint 1.20.3 → 1.20.6

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 (125) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +304 -304
  3. package/build/plugin/rules/ts/no-as-cast.d.ts.map +1 -1
  4. package/build/plugin/rules/ts/no-as-cast.js +43 -0
  5. package/build/plugin/rules/ts/no-as-cast.js.map +1 -1
  6. package/package.json +14 -7
  7. package/.c8rc.json +0 -26
  8. package/.cursor/rules/__assistant_guide.mdc +0 -30
  9. package/.cursor/rules/__main.mdc +0 -64
  10. package/.cursor/rules/_ag_backend-structure.mdc +0 -86
  11. package/.cursor/rules/_ag_backend.mdc +0 -16
  12. package/.cursor/rules/_ag_debug.mdc +0 -8
  13. package/.cursor/rules/_ag_documentation_writing_rules.mdc +0 -372
  14. package/.cursor/rules/_ag_file-refactoring.mdc +0 -113
  15. package/.cursor/rules/_ag_fixes_rules.mdc +0 -6
  16. package/.cursor/rules/_ag_frontend-structure.mdc +0 -87
  17. package/.cursor/rules/_ag_frontend.mdc +0 -40
  18. package/.cursor/rules/_ag_import-rules.mdc +0 -45
  19. package/.cursor/rules/_ag_naming.mdc +0 -116
  20. package/.cursor/rules/_ag_running_commands.mdc +0 -5
  21. package/.cursor/rules/_ag_server-controller.mdc +0 -6
  22. package/.cursor/rules/_ag_should-be.mdc +0 -7
  23. package/.cursor/rules/_ag_swearing.mdc +0 -47
  24. package/.cursor/rules/ai_development_guide.md +0 -61
  25. package/.cursor/rules/ai_directives.md +0 -114
  26. package/.cursor/rules/cursor-rules.md +0 -160
  27. package/.cursor/rules/default-command.mdc +0 -465
  28. package/.cursor/rules/error_code_pattern.md +0 -40
  29. package/.cursor/rules/saved rule mcp server use.md +0 -16
  30. package/.dynamo/pipeline.cicd.config.json +0 -184
  31. package/.dynamo/version-bump.config.json +0 -5
  32. package/.eslintrc.json +0 -4
  33. package/.github/workflows/main.yml +0 -436
  34. package/.husky/pre-commit +0 -2
  35. package/.vscode/settings.json +0 -11
  36. package/__documentations/2026-04-18-ccap-review-integration.md +0 -173
  37. package/__documentations/2026-08-18-bfr-ctm-005-eslint9-validator-report.md +0 -45
  38. package/__documentations/2026-08-22-angular-20-phase2-release.md +0 -83
  39. package/eslint.config.js +0 -15
  40. package/pnpm-workspace.yaml +0 -2
  41. package/samples/.vscode/settings.json +0 -13
  42. package/samples/base/.eslintrc.json +0 -6
  43. package/samples/base/eslint.config.js +0 -3
  44. package/samples/fsm/.eslintrc.json +0 -4
  45. package/samples/fsm/eslint.config.js +0 -3
  46. package/samples/ngx/.eslintrc.json +0 -6
  47. package/samples/ngx/eslint.config.js +0 -3
  48. package/samples/ngx-package/.eslintrc.json +0 -4
  49. package/samples/ngx-package/eslint.config.js +0 -3
  50. package/samples/nts/.eslintrc.json +0 -6
  51. package/samples/nts/eslint.config.js +0 -3
  52. package/samples/nts-package/.eslintrc.json +0 -4
  53. package/samples/nts-package/eslint.config.js +0 -3
  54. package/samples/package.json.example +0 -22
  55. package/samples/poc-sample.ts +0 -38
  56. package/samples/poc-violations.ts +0 -54
  57. package/scripts/run-coverage-tests.js +0 -24
  58. package/spec/support/helpers/ts-node-helper.js +0 -9
  59. package/spec/support/jasmine.coverage.json +0 -23
  60. package/spec/support/jasmine.json +0 -24
  61. package/src/configs/angular20-compatibility.spec.ts +0 -73
  62. package/src/configs/base.ts +0 -156
  63. package/src/configs/fsm.ts +0 -10
  64. package/src/configs/ngx-package.ts +0 -10
  65. package/src/configs/ngx.ts +0 -93
  66. package/src/configs/nts-package.ts +0 -20
  67. package/src/configs/nts.ts +0 -34
  68. package/src/index.ts +0 -4
  69. package/src/plugin/index.ts +0 -86
  70. package/src/plugin/rules/angular/angular-for-track-logic.spec.ts +0 -44
  71. package/src/plugin/rules/angular/angular-for-track-logic.ts +0 -88
  72. package/src/plugin/rules/angular/effect-signal-loop.spec.ts +0 -89
  73. package/src/plugin/rules/angular/effect-signal-loop.ts +0 -125
  74. package/src/plugin/rules/angular/no-async-ngoninit.spec.ts +0 -50
  75. package/src/plugin/rules/angular/no-async-ngoninit.ts +0 -43
  76. package/src/plugin/rules/angular/no-component-direct-api.spec.ts +0 -78
  77. package/src/plugin/rules/angular/no-component-direct-api.ts +0 -82
  78. package/src/plugin/rules/angular/no-method-call-in-template.spec.ts +0 -63
  79. package/src/plugin/rules/angular/no-method-call-in-template.ts +0 -89
  80. package/src/plugin/rules/angular/no-ngfor-directive.spec.ts +0 -44
  81. package/src/plugin/rules/angular/no-ngfor-directive.ts +0 -62
  82. package/src/plugin/rules/angular/no-ngif-directive.spec.ts +0 -44
  83. package/src/plugin/rules/angular/no-ngif-directive.ts +0 -62
  84. package/src/plugin/rules/explicit-types.spec.ts +0 -190
  85. package/src/plugin/rules/explicit-types.ts +0 -186
  86. package/src/plugin/rules/import/import-order.spec.ts +0 -219
  87. package/src/plugin/rules/import/import-order.ts +0 -197
  88. package/src/plugin/rules/import/no-import-type.spec.ts +0 -69
  89. package/src/plugin/rules/import/no-import-type.ts +0 -46
  90. package/src/plugin/rules/import/no-js-import.spec.ts +0 -82
  91. package/src/plugin/rules/import/no-js-import.ts +0 -45
  92. package/src/plugin/rules/naming-patterns.spec.ts +0 -189
  93. package/src/plugin/rules/naming-patterns.ts +0 -426
  94. package/src/plugin/rules/no-getter-logic.spec.ts +0 -591
  95. package/src/plugin/rules/no-getter-logic.ts +0 -220
  96. package/src/plugin/rules/prefer-enum-over-string-union.spec.ts +0 -583
  97. package/src/plugin/rules/prefer-enum-over-string-union.ts +0 -333
  98. package/src/plugin/rules/prefer-interface-over-duplicate-types.spec.ts +0 -404
  99. package/src/plugin/rules/prefer-interface-over-duplicate-types.ts +0 -314
  100. package/src/plugin/rules/require-jsdoc-description.spec.ts +0 -779
  101. package/src/plugin/rules/require-jsdoc-description.ts +0 -572
  102. package/src/plugin/rules/require-test-description-prefix.spec.ts +0 -459
  103. package/src/plugin/rules/require-test-description-prefix.ts +0 -154
  104. package/src/plugin/rules/ts/data-model-extends.spec.ts +0 -84
  105. package/src/plugin/rules/ts/data-model-extends.ts +0 -100
  106. package/src/plugin/rules/ts/no-any-type.spec.ts +0 -28
  107. package/src/plugin/rules/ts/no-any-type.ts +0 -36
  108. package/src/plugin/rules/ts/no-as-cast.spec.ts +0 -51
  109. package/src/plugin/rules/ts/no-as-cast.ts +0 -51
  110. package/src/plugin/rules/ts/no-dynamic-imports.spec.ts +0 -54
  111. package/src/plugin/rules/ts/no-dynamic-imports.ts +0 -49
  112. package/src/plugin/rules/ts/no-native-browser-dialogs.spec.ts +0 -54
  113. package/src/plugin/rules/ts/no-native-browser-dialogs.ts +0 -84
  114. package/src/plugin/rules/ts/no-plain-function-export.spec.ts +0 -72
  115. package/src/plugin/rules/ts/no-plain-function-export.ts +0 -73
  116. package/src/plugin/rules/ts/one-export-per-file.spec.ts +0 -64
  117. package/src/plugin/rules/ts/one-export-per-file.ts +0 -77
  118. package/src/scripts/dynamo-fix.ts +0 -172
  119. package/src/scripts/eslintrc-audit.ts +0 -116
  120. package/src/scripts/fix-return-types.spec.ts +0 -65
  121. package/src/scripts/fix-return-types.ts +0 -289
  122. package/src/scripts/validate-imports.ts +0 -292
  123. package/src/scripts/validate-naming.ts +0 -213
  124. package/src/scripts/validator-cli.integration.spec.ts +0 -99
  125. package/tsconfig.json +0 -32
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) Future Development Program Ltd. (HU)
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,317 +1,317 @@
1
- # @futdevpro/dynamo-eslint
2
-
3
- Shared ESLint presets, custom Dynamo rules, and validation tools for FutDevPro TypeScript projects. This package provides standardized linting configurations optimized for **lint-on-save** functionality across different project types.
4
-
5
- ## 🚀 Quick Start
6
-
7
- ### Installation
8
-
9
- ```bash
10
- npm install --save-dev @futdevpro/dynamo-eslint
11
- ```
12
-
13
- ### Required Peer Dependencies
14
-
15
- ```bash
1
+ # @futdevpro/dynamo-eslint
2
+
3
+ Shared ESLint presets, custom Dynamo rules, and validation tools for FutDevPro TypeScript projects. This package provides standardized linting configurations optimized for **lint-on-save** functionality across different project types.
4
+
5
+ ## 🚀 Quick Start
6
+
7
+ ### Installation
8
+
9
+ ```bash
10
+ npm install --save-dev @futdevpro/dynamo-eslint
11
+ ```
12
+
13
+ ### Required Peer Dependencies
14
+
15
+ ```bash
16
16
  npm install --save-dev \
17
17
  eslint@~9.39.5 \
18
18
  typescript@5.9.3 \
19
19
  typescript-eslint@~8.67.0
20
- ```
21
-
20
+ ```
21
+
22
22
  For Angular projects, also install:
23
- ```bash
23
+ ```bash
24
24
  npm install --save-dev \
25
25
  angular-eslint@~20.7.0
26
26
  ```
27
27
 
28
28
  `angular-eslint` is an optional peer for Node-only consumers and is required when loading the `ngx` or
29
29
  `ngx-package` preset.
30
-
31
- ## 📋 Available Presets
32
-
33
- ### 1. **base** - Core TypeScript Rules
34
- Generic TypeScript projects with browser environment.
35
-
36
- ```javascript
37
- const baseConfig = require('@futdevpro/dynamo-eslint/base');
38
-
39
- module.exports = baseConfig;
40
- ```
41
-
42
- **Features:**
43
- - Browser environment
44
- - 1000 line limit
45
- - All Dynamo custom rules enabled
46
- - Explicit return types required
47
-
48
- ### 2. **nts** - Node TypeScript Projects
49
- Node.js TypeScript applications and services.
50
-
51
- ```javascript
52
- const ntsConfig = require('@futdevpro/dynamo-eslint/nts');
53
-
54
- module.exports = ntsConfig;
55
- ```
56
-
57
- **Features:**
58
- - Node environment
59
- - 1500 line limit (extended for server code)
60
- - Module source type
61
- - All base rules + Node-specific optimizations
62
-
63
- ### 3. **ngx** - Angular Projects
64
- Angular applications with component and template linting.
65
-
66
- ```javascript
67
- const ngxConfig = require('@futdevpro/dynamo-eslint/ngx');
68
-
69
- module.exports = ngxConfig;
70
- ```
71
-
72
- **Features:**
73
- - Angular ESLint integration
74
- - Browser environment
75
- - Component and template linting
76
- - Angular-specific rules
77
-
78
- ### 4. **fsm** - Full Stack Module
79
- Full-stack TypeScript modules (same as base).
80
-
81
- ```javascript
82
- const fsmConfig = require('@futdevpro/dynamo-eslint/fsm');
83
-
84
- module.exports = fsmConfig;
85
- ```
86
-
87
- ### 5. **nts-package** - Node TypeScript Packages
88
- NPM packages and libraries built with TypeScript.
89
-
90
- ```javascript
91
- const ntsPackageConfig = require('@futdevpro/dynamo-eslint/nts-package');
92
-
93
- module.exports = ntsPackageConfig;
94
- ```
95
-
96
- **Features:**
97
- - Relaxed `@typescript-eslint/ban-types` and `no-explicit-any` rules
98
- - Optimized for package development
99
- - Extended line limits for library code
100
-
101
- ### 6. **ngx-package** - Angular Packages
102
- Angular libraries and packages.
103
-
104
- ```javascript
105
- const ngxPackageConfig = require('@futdevpro/dynamo-eslint/ngx-package');
106
-
107
- module.exports = ngxPackageConfig;
108
- ```
109
-
110
- ## ⚙️ Lint-on-Save Configuration
111
-
112
- **Critical: Configure ESLint to run ONLY on save, not on type!**
113
-
114
- ### VSCode/Cursor Settings
115
-
116
- Create `.vscode/settings.json` in your project root:
117
-
118
- ```json
119
- {
120
- "eslint.run": "onSave",
121
- "eslint.workingDirectories": [{ "mode": "auto" }],
122
- "editor.codeActionsOnSave": {
123
- "source.fixAll.eslint": "explicit"
124
- },
125
- "eslint.validate": [
126
- "javascript",
127
- "typescript"
128
- ]
129
- }
130
- ```
131
-
132
- ### Workspace vs User Settings
133
-
134
- - **Workspace settings** (`.vscode/settings.json`): Apply only to current project
135
- - **User settings**: Apply globally to all projects
136
-
137
- For team consistency, use workspace settings.
138
-
139
- ### Multi-Root Workspace Configuration
140
-
141
- For workspaces with multiple projects:
142
-
143
- ```json
144
- {
145
- "eslint.run": "onSave",
146
- "eslint.workingDirectories": [
147
- { "mode": "auto" },
148
- { "directory": "./packages/package-a" },
149
- { "directory": "./packages/package-b" }
150
- ],
151
- "editor.codeActionsOnSave": {
152
- "source.fixAll.eslint": "explicit"
153
- }
154
- }
155
- ```
156
-
157
- ## 🔧 Custom Dynamo Rules
158
-
159
- This package includes custom ESLint rules for Dynamo conventions:
160
-
161
- ### Import Rules
162
- - **`@futdevpro/dynamo/import-order`**: Enforces consistent import ordering
163
- - **`@futdevpro/dynamo/no-import-type`**: Forbids TypeScript `import type` syntax
164
- - **`@futdevpro/dynamo/no-js-import`**: Prevents importing `.js` files in TypeScript
165
-
166
- ### Naming Rules
167
- - **`@futdevpro/dynamo/naming-patterns`**: Enforces DyFM naming conventions
168
-
169
- ### Type Rules
170
- - **`@futdevpro/dynamo/explicit-types`**: Enforces explicit type annotations on all TypeScript declarations (functions, variables, parameters, class properties, destructuring)
171
-
172
- ## 🛠️ CLI Validation Tools
173
-
174
- Use these commands to validate your codebase:
175
-
176
- ```bash
177
- # Validate import ordering across all TypeScript files
178
- dynamo-validate-imports
179
-
180
- # Validate naming conventions across all TypeScript files
181
- dynamo-validate-naming
182
-
183
- # Audit ESLint configurations for duplicate rules
184
- dynamo-eslintrc-audit
185
-
186
- # Run comprehensive fixes
187
- dynamo-fix
188
-
189
- # Fix missing type annotations (functions, variables, parameters, class properties)
190
- dynamo-fix-return-types
191
- ```
192
-
193
- ### NPM Scripts Integration
194
-
195
- Add to your `package.json`:
196
-
197
- ```json
198
- {
199
- "scripts": {
200
- "lint": "eslint src --ext .ts",
201
- "lint:fix": "eslint src --ext .ts --fix",
202
- "validate:imports": "dynamo-validate-imports",
203
- "validate:naming": "dynamo-validate-naming",
204
- "audit:eslintrc": "dynamo-eslintrc-audit",
205
- "fix": "dynamo-fix",
206
- "fix:types": "dynamo-fix-return-types"
207
- }
208
- }
209
- ```
210
-
211
- ## 🔄 Migration from Manual Configs
212
-
213
- ### Quick Migration Checklist
214
-
215
- 1. **Install the package and peer dependencies**
216
- 2. **Replace your `.eslintrc.json`** with the appropriate preset
217
- 3. **Configure lint-on-save** in VSCode/Cursor settings
218
- 4. **Run validation tools** to check for issues
219
- 5. **Update CI/CD** to use the new configuration
220
-
221
- ### Common Migration Issues
222
-
223
- - **Peer dependency conflicts**: Ensure all peer dependencies are installed
224
- - **Working directory issues**: Use `"eslint.workingDirectories": [{ "mode": "auto" }]`
225
- - **Rule conflicts**: The presets handle most conflicts automatically
226
-
227
- > 📖 **Detailed Migration Guide**: See [Migration Guide](./docs/migration.md) for step-by-step instructions.
228
-
229
- ## 🐛 Troubleshooting
230
-
231
- ### Lint-on-Save Not Working
232
-
233
- 1. **Check ESLint is running on save only:**
234
- ```json
235
- {
236
- "eslint.run": "onSave" // NOT "onType"
237
- }
238
- ```
239
-
240
- 2. **Verify working directories:**
241
- ```json
242
- {
243
- "eslint.workingDirectories": [{ "mode": "auto" }]
244
- }
245
- ```
246
-
247
- 3. **Check file associations:**
248
- ```json
249
- {
250
- "eslint.validate": ["javascript", "typescript"]
251
- }
252
- ```
253
-
254
- ### Peer Dependency Issues
255
-
256
- Ensure all peer dependencies are installed with compatible versions:
257
-
258
- ```bash
30
+
31
+ ## 📋 Available Presets
32
+
33
+ ### 1. **base** - Core TypeScript Rules
34
+ Generic TypeScript projects with browser environment.
35
+
36
+ ```javascript
37
+ const baseConfig = require('@futdevpro/dynamo-eslint/base');
38
+
39
+ module.exports = baseConfig;
40
+ ```
41
+
42
+ **Features:**
43
+ - Browser environment
44
+ - 1000 line limit
45
+ - All Dynamo custom rules enabled
46
+ - Explicit return types required
47
+
48
+ ### 2. **nts** - Node TypeScript Projects
49
+ Node.js TypeScript applications and services.
50
+
51
+ ```javascript
52
+ const ntsConfig = require('@futdevpro/dynamo-eslint/nts');
53
+
54
+ module.exports = ntsConfig;
55
+ ```
56
+
57
+ **Features:**
58
+ - Node environment
59
+ - 1500 line limit (extended for server code)
60
+ - Module source type
61
+ - All base rules + Node-specific optimizations
62
+
63
+ ### 3. **ngx** - Angular Projects
64
+ Angular applications with component and template linting.
65
+
66
+ ```javascript
67
+ const ngxConfig = require('@futdevpro/dynamo-eslint/ngx');
68
+
69
+ module.exports = ngxConfig;
70
+ ```
71
+
72
+ **Features:**
73
+ - Angular ESLint integration
74
+ - Browser environment
75
+ - Component and template linting
76
+ - Angular-specific rules
77
+
78
+ ### 4. **fsm** - Full Stack Module
79
+ Full-stack TypeScript modules (same as base).
80
+
81
+ ```javascript
82
+ const fsmConfig = require('@futdevpro/dynamo-eslint/fsm');
83
+
84
+ module.exports = fsmConfig;
85
+ ```
86
+
87
+ ### 5. **nts-package** - Node TypeScript Packages
88
+ NPM packages and libraries built with TypeScript.
89
+
90
+ ```javascript
91
+ const ntsPackageConfig = require('@futdevpro/dynamo-eslint/nts-package');
92
+
93
+ module.exports = ntsPackageConfig;
94
+ ```
95
+
96
+ **Features:**
97
+ - Relaxed `@typescript-eslint/ban-types` and `no-explicit-any` rules
98
+ - Optimized for package development
99
+ - Extended line limits for library code
100
+
101
+ ### 6. **ngx-package** - Angular Packages
102
+ Angular libraries and packages.
103
+
104
+ ```javascript
105
+ const ngxPackageConfig = require('@futdevpro/dynamo-eslint/ngx-package');
106
+
107
+ module.exports = ngxPackageConfig;
108
+ ```
109
+
110
+ ## ⚙️ Lint-on-Save Configuration
111
+
112
+ **Critical: Configure ESLint to run ONLY on save, not on type!**
113
+
114
+ ### VSCode/Cursor Settings
115
+
116
+ Create `.vscode/settings.json` in your project root:
117
+
118
+ ```json
119
+ {
120
+ "eslint.run": "onSave",
121
+ "eslint.workingDirectories": [{ "mode": "auto" }],
122
+ "editor.codeActionsOnSave": {
123
+ "source.fixAll.eslint": "explicit"
124
+ },
125
+ "eslint.validate": [
126
+ "javascript",
127
+ "typescript"
128
+ ]
129
+ }
130
+ ```
131
+
132
+ ### Workspace vs User Settings
133
+
134
+ - **Workspace settings** (`.vscode/settings.json`): Apply only to current project
135
+ - **User settings**: Apply globally to all projects
136
+
137
+ For team consistency, use workspace settings.
138
+
139
+ ### Multi-Root Workspace Configuration
140
+
141
+ For workspaces with multiple projects:
142
+
143
+ ```json
144
+ {
145
+ "eslint.run": "onSave",
146
+ "eslint.workingDirectories": [
147
+ { "mode": "auto" },
148
+ { "directory": "./packages/package-a" },
149
+ { "directory": "./packages/package-b" }
150
+ ],
151
+ "editor.codeActionsOnSave": {
152
+ "source.fixAll.eslint": "explicit"
153
+ }
154
+ }
155
+ ```
156
+
157
+ ## 🔧 Custom Dynamo Rules
158
+
159
+ This package includes custom ESLint rules for Dynamo conventions:
160
+
161
+ ### Import Rules
162
+ - **`@futdevpro/dynamo/import-order`**: Enforces consistent import ordering
163
+ - **`@futdevpro/dynamo/no-import-type`**: Forbids TypeScript `import type` syntax
164
+ - **`@futdevpro/dynamo/no-js-import`**: Prevents importing `.js` files in TypeScript
165
+
166
+ ### Naming Rules
167
+ - **`@futdevpro/dynamo/naming-patterns`**: Enforces DyFM naming conventions
168
+
169
+ ### Type Rules
170
+ - **`@futdevpro/dynamo/explicit-types`**: Enforces explicit type annotations on all TypeScript declarations (functions, variables, parameters, class properties, destructuring)
171
+
172
+ ## 🛠️ CLI Validation Tools
173
+
174
+ Use these commands to validate your codebase:
175
+
176
+ ```bash
177
+ # Validate import ordering across all TypeScript files
178
+ dynamo-validate-imports
179
+
180
+ # Validate naming conventions across all TypeScript files
181
+ dynamo-validate-naming
182
+
183
+ # Audit ESLint configurations for duplicate rules
184
+ dynamo-eslintrc-audit
185
+
186
+ # Run comprehensive fixes
187
+ dynamo-fix
188
+
189
+ # Fix missing type annotations (functions, variables, parameters, class properties)
190
+ dynamo-fix-return-types
191
+ ```
192
+
193
+ ### NPM Scripts Integration
194
+
195
+ Add to your `package.json`:
196
+
197
+ ```json
198
+ {
199
+ "scripts": {
200
+ "lint": "eslint src --ext .ts",
201
+ "lint:fix": "eslint src --ext .ts --fix",
202
+ "validate:imports": "dynamo-validate-imports",
203
+ "validate:naming": "dynamo-validate-naming",
204
+ "audit:eslintrc": "dynamo-eslintrc-audit",
205
+ "fix": "dynamo-fix",
206
+ "fix:types": "dynamo-fix-return-types"
207
+ }
208
+ }
209
+ ```
210
+
211
+ ## 🔄 Migration from Manual Configs
212
+
213
+ ### Quick Migration Checklist
214
+
215
+ 1. **Install the package and peer dependencies**
216
+ 2. **Replace your `.eslintrc.json`** with the appropriate preset
217
+ 3. **Configure lint-on-save** in VSCode/Cursor settings
218
+ 4. **Run validation tools** to check for issues
219
+ 5. **Update CI/CD** to use the new configuration
220
+
221
+ ### Common Migration Issues
222
+
223
+ - **Peer dependency conflicts**: Ensure all peer dependencies are installed
224
+ - **Working directory issues**: Use `"eslint.workingDirectories": [{ "mode": "auto" }]`
225
+ - **Rule conflicts**: The presets handle most conflicts automatically
226
+
227
+ > 📖 **Detailed Migration Guide**: See [Migration Guide](./docs/migration.md) for step-by-step instructions.
228
+
229
+ ## 🐛 Troubleshooting
230
+
231
+ ### Lint-on-Save Not Working
232
+
233
+ 1. **Check ESLint is running on save only:**
234
+ ```json
235
+ {
236
+ "eslint.run": "onSave" // NOT "onType"
237
+ }
238
+ ```
239
+
240
+ 2. **Verify working directories:**
241
+ ```json
242
+ {
243
+ "eslint.workingDirectories": [{ "mode": "auto" }]
244
+ }
245
+ ```
246
+
247
+ 3. **Check file associations:**
248
+ ```json
249
+ {
250
+ "eslint.validate": ["javascript", "typescript"]
251
+ }
252
+ ```
253
+
254
+ ### Peer Dependency Issues
255
+
256
+ Ensure all peer dependencies are installed with compatible versions:
257
+
258
+ ```bash
259
259
  npm ls typescript-eslint angular-eslint eslint typescript
260
- ```
261
-
262
- ### ESLint v9 Flat Config
263
-
264
- This package now uses ESLint v9 flat config format (`eslint.config.js`) for all exported presets. The package itself also uses flat config for self-linting.
265
-
266
- ## 📁 Examples
267
-
268
- Reference implementations are available in the `samples/` directory:
269
-
270
- - `samples/base/eslint.config.js` - Base preset example
271
- - `samples/nts/eslint.config.js` - Node TypeScript example
272
- - `samples/ngx/eslint.config.js` - Angular example
273
- - `samples/fsm/eslint.config.js` - Full Stack Module example
274
- - `samples/nts-package/eslint.config.js` - Node TypeScript Package example
275
- - `samples/ngx-package/eslint.config.js` - Angular Package example
276
-
277
- ## 🔧 Recent Fixes
278
-
279
- ### TypeScript AST Transformation Context Fix
280
-
281
- The `dynamo-fix-return-types` script includes a fix for TypeScript AST transformation context issues. This resolves compilation errors when using `ts.visitEachChild()` by properly providing the `TransformationContext` parameter:
282
-
283
- ```typescript
284
- // Fixed implementation
285
- return ts.visitEachChild(node, visit, {} as ts.TransformationContext);
286
- ```
287
-
288
- This ensures compatibility with TypeScript's AST transformation APIs.
289
-
290
- ### Enhanced Type Annotation Fixing
291
-
292
- The `dynamo-fix-return-types` script now handles comprehensive type annotation fixing:
293
-
294
- - **Function declarations**: Adds return type annotations
295
- - **Arrow functions**: Adds return type annotations
296
- - **Variable declarations**: Adds type annotations based on initializer types
297
- - **Function parameters**: Adds parameter type annotations
298
- - **Class properties**: Adds property type annotations
299
-
300
- The script uses TypeScript's type checker to infer appropriate types and automatically adds them to your code.
301
-
302
- ## 📚 Self-Linting
303
-
304
- This package uses its own presets and rules for self-linting. The ESLint v9 flat config is in `eslint.config.js` and demonstrates advanced configuration patterns.
305
-
306
- ## 🏗️ Architecture
307
-
308
- - **Presets**: Standardized rule configurations for different project types
309
- - **Custom Rules**: Dynamo-specific linting rules for import order and naming
310
- - **CLI Tools**: Validation and fixing utilities
311
- - **TypeScript Integration**: Full TypeScript AST transformation support
312
-
313
- ---
314
-
315
- **Maintained by**: Future Development Program Ltd.
316
- **License**: ISC
260
+ ```
261
+
262
+ ### ESLint v9 Flat Config
263
+
264
+ This package now uses ESLint v9 flat config format (`eslint.config.js`) for all exported presets. The package itself also uses flat config for self-linting.
265
+
266
+ ## 📁 Examples
267
+
268
+ Reference implementations are available in the `samples/` directory:
269
+
270
+ - `samples/base/eslint.config.js` - Base preset example
271
+ - `samples/nts/eslint.config.js` - Node TypeScript example
272
+ - `samples/ngx/eslint.config.js` - Angular example
273
+ - `samples/fsm/eslint.config.js` - Full Stack Module example
274
+ - `samples/nts-package/eslint.config.js` - Node TypeScript Package example
275
+ - `samples/ngx-package/eslint.config.js` - Angular Package example
276
+
277
+ ## 🔧 Recent Fixes
278
+
279
+ ### TypeScript AST Transformation Context Fix
280
+
281
+ The `dynamo-fix-return-types` script includes a fix for TypeScript AST transformation context issues. This resolves compilation errors when using `ts.visitEachChild()` by properly providing the `TransformationContext` parameter:
282
+
283
+ ```typescript
284
+ // Fixed implementation
285
+ return ts.visitEachChild(node, visit, {} as ts.TransformationContext);
286
+ ```
287
+
288
+ This ensures compatibility with TypeScript's AST transformation APIs.
289
+
290
+ ### Enhanced Type Annotation Fixing
291
+
292
+ The `dynamo-fix-return-types` script now handles comprehensive type annotation fixing:
293
+
294
+ - **Function declarations**: Adds return type annotations
295
+ - **Arrow functions**: Adds return type annotations
296
+ - **Variable declarations**: Adds type annotations based on initializer types
297
+ - **Function parameters**: Adds parameter type annotations
298
+ - **Class properties**: Adds property type annotations
299
+
300
+ The script uses TypeScript's type checker to infer appropriate types and automatically adds them to your code.
301
+
302
+ ## 📚 Self-Linting
303
+
304
+ This package uses its own presets and rules for self-linting. The ESLint v9 flat config is in `eslint.config.js` and demonstrates advanced configuration patterns.
305
+
306
+ ## 🏗️ Architecture
307
+
308
+ - **Presets**: Standardized rule configurations for different project types
309
+ - **Custom Rules**: Dynamo-specific linting rules for import order and naming
310
+ - **CLI Tools**: Validation and fixing utilities
311
+ - **TypeScript Integration**: Full TypeScript AST transformation support
312
+
313
+ ---
314
+
315
+ **Maintained by**: Future Development Program Ltd.
316
+ **License**: ISC
317
317
  **Version**: 1.20.3
@@ -1 +1 @@
1
- {"version":3,"file":"no-as-cast.d.ts","sourceRoot":"","sources":["../../../../src/plugin/rules/ts/no-as-cast.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B;;;;GAIG;AACH,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAyChB,CAAC;AAEF,eAAe,IAAI,CAAC"}
1
+ {"version":3,"file":"no-as-cast.d.ts","sourceRoot":"","sources":["../../../../src/plugin/rules/ts/no-as-cast.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAiD9B;;;;GAIG;AACH,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UA6ChB,CAAC;AAEF,eAAe,IAAI,CAAC"}