@webpieces/eslint-rules 0.0.1

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.
@@ -0,0 +1,5 @@
1
+ # Exception Documentation Not Found
2
+
3
+ Template file not found at: /Users/deanhiller/openclaw/personal/webpieces-ts30/packages/tooling/eslint-plugin/templates/webpieces.exceptions.md
4
+
5
+ Please ensure @webpieces/dev-config is properly installed.
@@ -0,0 +1,146 @@
1
+ # AI Agent Instructions: File Too Long
2
+
3
+ **READ THIS FILE to fix files that are too long**
4
+
5
+ ## Core Principle
6
+ Files should contain a SINGLE COHESIVE UNIT.
7
+ - One class per file (Java convention)
8
+ - If class is too large, extract child responsibilities
9
+ - Use dependency injection to compose functionality
10
+
11
+ ## Command: Reduce File Size
12
+
13
+ ### Step 1: Check for Multiple Classes
14
+ If the file contains multiple classes, **SEPARATE each class into its own file**.
15
+
16
+ ```typescript
17
+ // BAD: UserController.ts (multiple classes)
18
+ export class UserController { /* ... */ }
19
+ export class UserValidator { /* ... */ }
20
+ export class UserNotifier { /* ... */ }
21
+
22
+ // GOOD: Three separate files
23
+ // UserController.ts
24
+ export class UserController { /* ... */ }
25
+
26
+ // UserValidator.ts
27
+ export class UserValidator { /* ... */ }
28
+
29
+ // UserNotifier.ts
30
+ export class UserNotifier { /* ... */ }
31
+ ```
32
+
33
+ ### Step 2: Extract Child Responsibilities (if single class is too large)
34
+
35
+ #### Pattern: Create New Service Class with Dependency Injection
36
+
37
+ ```typescript
38
+ // BAD: UserController.ts (800 lines, single class)
39
+ @provideSingleton()
40
+ @Controller()
41
+ export class UserController {
42
+ // 200 lines: CRUD operations
43
+ // 300 lines: validation logic
44
+ // 200 lines: notification logic
45
+ // 100 lines: analytics logic
46
+ }
47
+
48
+ // GOOD: Extract validation service
49
+ // 1. Create UserValidationService.ts
50
+ @provideSingleton()
51
+ export class UserValidationService {
52
+ validateUserData(data: UserData): ValidationResult {
53
+ // 300 lines of validation logic moved here
54
+ }
55
+
56
+ validateEmail(email: string): boolean { /* ... */ }
57
+ validatePassword(password: string): boolean { /* ... */ }
58
+ }
59
+
60
+ // 2. Inject into UserController.ts
61
+ @provideSingleton()
62
+ @Controller()
63
+ export class UserController {
64
+ constructor(
65
+ @inject(TYPES.UserValidationService)
66
+ private validator: UserValidationService
67
+ ) {}
68
+
69
+ async createUser(data: UserData): Promise<User> {
70
+ const validation = this.validator.validateUserData(data);
71
+ if (!validation.isValid) {
72
+ throw new ValidationError(validation.errors);
73
+ }
74
+ // ... rest of logic
75
+ }
76
+ }
77
+ ```
78
+
79
+ ## AI Agent Action Steps
80
+
81
+ 1. **ANALYZE** the file structure:
82
+ - Count classes (if >1, separate immediately)
83
+ - Identify logical responsibilities within single class
84
+
85
+ 2. **IDENTIFY** "child code" to extract:
86
+ - Validation logic -> ValidationService
87
+ - Notification logic -> NotificationService
88
+ - Data transformation -> TransformerService
89
+ - External API calls -> ApiService
90
+ - Business rules -> RulesEngine
91
+
92
+ 3. **CREATE** new service file(s):
93
+ - Start with temporary name: `XXXX.ts` or `ChildService.ts`
94
+ - Add `@provideSingleton()` decorator
95
+ - Move child methods to new class
96
+
97
+ 4. **UPDATE** dependency injection:
98
+ - Add to `TYPES` constants (if using symbol-based DI)
99
+ - Inject new service into original class constructor
100
+ - Replace direct method calls with `this.serviceName.method()`
101
+
102
+ 5. **RENAME** extracted file:
103
+ - Read the extracted code to understand its purpose
104
+ - Rename `XXXX.ts` to logical name (e.g., `UserValidationService.ts`)
105
+
106
+ 6. **VERIFY** file sizes:
107
+ - Original file should now be <700 lines
108
+ - Each extracted file should be <700 lines
109
+ - If still too large, extract more services
110
+
111
+ ## Examples of Child Responsibilities to Extract
112
+
113
+ | If File Contains | Extract To | Pattern |
114
+ |-----------------|------------|---------|
115
+ | Validation logic (200+ lines) | `XValidator.ts` or `XValidationService.ts` | Singleton service |
116
+ | Notification logic (150+ lines) | `XNotifier.ts` or `XNotificationService.ts` | Singleton service |
117
+ | Data transformation (200+ lines) | `XTransformer.ts` | Singleton service |
118
+ | External API calls (200+ lines) | `XApiClient.ts` | Singleton service |
119
+ | Complex business rules (300+ lines) | `XRulesEngine.ts` | Singleton service |
120
+ | Database queries (200+ lines) | `XRepository.ts` | Singleton service |
121
+
122
+ ## WebPieces Dependency Injection Pattern
123
+
124
+ ```typescript
125
+ // 1. Define service with @provideSingleton
126
+ import { provideSingleton } from '@webpieces/http-routing';
127
+
128
+ @provideSingleton()
129
+ export class MyService {
130
+ doSomething(): void { /* ... */ }
131
+ }
132
+
133
+ // 2. Inject into consumer
134
+ import { inject } from 'inversify';
135
+ import { TYPES } from './types';
136
+
137
+ @provideSingleton()
138
+ @Controller()
139
+ export class MyController {
140
+ constructor(
141
+ @inject(TYPES.MyService) private service: MyService
142
+ ) {}
143
+ }
144
+ ```
145
+
146
+ Remember: Find the "child code" and pull it down into a new class. Once moved, the code's purpose becomes clear, making it easy to rename to a logical name.
@@ -0,0 +1,97 @@
1
+ # AI Agent Instructions: Method Too Long
2
+
3
+ **READ THIS FILE to fix methods that are too long**
4
+
5
+ ## Core Principle
6
+ Every method should read like a TABLE OF CONTENTS of a book.
7
+ - Each method call is a "chapter"
8
+ - When you dive into a method, you find another table of contents
9
+ - Keeping methods under 70 lines is achievable with proper extraction
10
+
11
+ ## Command: Extract Code into Named Methods
12
+
13
+ ### Pattern 1: Extract Loop Bodies
14
+ ```typescript
15
+ // BAD: 50 lines embedded in loop
16
+ for (const order of orders) {
17
+ // 20 lines of validation logic
18
+ // 15 lines of processing logic
19
+ // 10 lines of notification logic
20
+ }
21
+
22
+ // GOOD: Extracted to named methods
23
+ for (const order of orders) {
24
+ validateOrder(order);
25
+ processOrderItems(order);
26
+ sendNotifications(order);
27
+ }
28
+ ```
29
+
30
+ ### Pattern 2: Try-Catch Wrapper for Exception Handling
31
+ ```typescript
32
+ // GOOD: Separates success path from error handling
33
+ async function handleRequest(req: Request): Promise<Response> {
34
+ // eslint-disable-next-line @webpieces/no-unmanaged-exceptions
35
+ try {
36
+ return await executeRequest(req);
37
+ } catch (err: unknown) {
38
+ const error = toError(err);
39
+ return createErrorResponse(error);
40
+ }
41
+ }
42
+ ```
43
+
44
+ ### Pattern 3: Sequential Method Calls (Table of Contents)
45
+ ```typescript
46
+ // GOOD: Self-documenting steps
47
+ function processOrder(order: Order): void {
48
+ validateOrderData(order);
49
+ calculateTotals(order);
50
+ applyDiscounts(order);
51
+ processPayment(order);
52
+ updateInventory(order);
53
+ sendConfirmation(order);
54
+ }
55
+ ```
56
+
57
+ ### Pattern 4: Separate Data Object Creation
58
+ ```typescript
59
+ // BAD: 15 lines of inline object creation
60
+ doSomething({ field1: ..., field2: ..., field3: ..., /* 15 more fields */ });
61
+
62
+ // GOOD: Extract to factory method
63
+ const request = createRequestObject(data);
64
+ doSomething(request);
65
+ ```
66
+
67
+ ### Pattern 5: Extract Inline Logic to Named Functions
68
+ ```typescript
69
+ // BAD: Complex inline logic
70
+ if (user.role === 'admin' && user.permissions.includes('write') && !user.suspended) {
71
+ // 30 lines of admin logic
72
+ }
73
+
74
+ // GOOD: Extract to named methods
75
+ if (isAdminWithWriteAccess(user)) {
76
+ performAdminOperation(user);
77
+ }
78
+ ```
79
+
80
+ ## AI Agent Action Steps
81
+
82
+ 1. **IDENTIFY** the long method in the error message
83
+ 2. **READ** the method to understand its logical sections
84
+ 3. **EXTRACT** logical units into separate methods with descriptive names
85
+ 4. **REPLACE** inline code with method calls
86
+ 5. **VERIFY** each extracted method is <70 lines
87
+ 6. **TEST** that functionality remains unchanged
88
+
89
+ ## Examples of "Logical Units" to Extract
90
+ - Validation logic -> `validateX()`
91
+ - Data transformation -> `transformXToY()`
92
+ - API calls -> `fetchXFromApi()`
93
+ - Object creation -> `createX()`
94
+ - Loop bodies -> `processItem()`
95
+ - Error handling -> `handleXError()`
96
+
97
+ Remember: Methods should read like a table of contents. Each line should be a "chapter title" (method call) that describes what happens, not how it happens.
package/LICENSE ADDED
@@ -0,0 +1,373 @@
1
+ Mozilla Public License Version 2.0
2
+ ==================================
3
+
4
+ 1. Definitions
5
+ --------------
6
+
7
+ 1.1. "Contributor"
8
+ means each individual or legal entity that creates, contributes to
9
+ the creation of, or owns Covered Software.
10
+
11
+ 1.2. "Contributor Version"
12
+ means the combination of the Contributions of others (if any) used
13
+ by a Contributor and that particular Contributor's Contribution.
14
+
15
+ 1.3. "Contribution"
16
+ means Covered Software of a particular Contributor.
17
+
18
+ 1.4. "Covered Software"
19
+ means Source Code Form to which the initial Contributor has attached
20
+ the notice in Exhibit A, the Executable Form of such Source Code
21
+ Form, and Modifications of such Source Code Form, in each case
22
+ including portions thereof.
23
+
24
+ 1.5. "Incompatible With Secondary Licenses"
25
+ means
26
+
27
+ (a) that the initial Contributor has attached the notice described
28
+ in Exhibit B to the Covered Software; or
29
+
30
+ (b) that the Covered Software was made available under the terms of
31
+ version 1.1 or earlier of the License, but not also under the
32
+ terms of a Secondary License.
33
+
34
+ 1.6. "Executable Form"
35
+ means any form of the work other than Source Code Form.
36
+
37
+ 1.7. "Larger Work"
38
+ means a work that combines Covered Software with other material, in
39
+ a separate file or files, that is not Covered Software.
40
+
41
+ 1.8. "License"
42
+ means this document.
43
+
44
+ 1.9. "Licensable"
45
+ means having the right to grant, to the maximum extent possible,
46
+ whether at the time of the initial grant or subsequently, any and
47
+ all of the rights conveyed by this License.
48
+
49
+ 1.10. "Modifications"
50
+ means any of the following:
51
+
52
+ (a) any file in Source Code Form that results from an addition to,
53
+ deletion from, or modification of the contents of Covered
54
+ Software; or
55
+
56
+ (b) any new file in Source Code Form that contains any Covered
57
+ Software.
58
+
59
+ 1.11. "Patent Claims" of a Contributor
60
+ means any patent claim(s), including without limitation, method,
61
+ process, and apparatus claims, in any patent Licensable by such
62
+ Contributor that would be infringed, but for the grant of the
63
+ License, by the making, using, selling, offering for sale, having
64
+ made, import, or transfer of either its Contributions or its
65
+ Contributor Version.
66
+
67
+ 1.12. "Secondary License"
68
+ means either the GNU General Public License, Version 2.0, the GNU
69
+ Lesser General Public License, Version 2.1, the GNU Affero General
70
+ Public License, Version 3.0, or any later versions of those
71
+ licenses.
72
+
73
+ 1.13. "Source Code Form"
74
+ means the form of the work preferred for making modifications.
75
+
76
+ 1.14. "You" (or "Your")
77
+ means an individual or a legal entity exercising rights under this
78
+ License. For legal entities, "You" includes any entity that
79
+ controls, is controlled by, or is under common control with You. For
80
+ purposes of this definition, "control" means (a) the power, direct
81
+ or indirect, to cause the direction or management of such entity,
82
+ whether by contract or otherwise, or (b) ownership of more than
83
+ fifty percent (50%) of the outstanding shares or beneficial
84
+ ownership of such entity.
85
+
86
+ 2. License Grants and Conditions
87
+ --------------------------------
88
+
89
+ 2.1. Grants
90
+
91
+ Each Contributor hereby grants You a world-wide, royalty-free,
92
+ non-exclusive license:
93
+
94
+ (a) under intellectual property rights (other than patent or trademark)
95
+ Licensable by such Contributor to use, reproduce, make available,
96
+ modify, display, perform, distribute, and otherwise exploit its
97
+ Contributions, either on an unmodified basis, with Modifications, or
98
+ as part of a Larger Work; and
99
+
100
+ (b) under Patent Claims of such Contributor to make, use, sell, offer
101
+ for sale, have made, import, and otherwise transfer either its
102
+ Contributions or its Contributor Version.
103
+
104
+ 2.2. Effective Date
105
+
106
+ The licenses granted in Section 2.1 with respect to any Contribution
107
+ become effective for each Contribution on the date the Contributor first
108
+ distributes such Contribution.
109
+
110
+ 2.3. Limitations on Grant Scope
111
+
112
+ The licenses granted in this Section 2 are the only rights granted under
113
+ this License. No additional rights or licenses will be implied from the
114
+ distribution or licensing of Covered Software under this License.
115
+ Notwithstanding Section 2.1(b) above, no patent license is granted by a
116
+ Contributor:
117
+
118
+ (a) for any code that a Contributor has removed from Covered Software;
119
+ or
120
+
121
+ (b) for infringements caused by: (i) Your and any other third party's
122
+ modifications of Covered Software, or (ii) the combination of its
123
+ Contributions with other software (except as part of its Contributor
124
+ Version); or
125
+
126
+ (c) under Patent Claims infringed by Covered Software in the absence of
127
+ its Contributions.
128
+
129
+ This License does not grant any rights in the trademarks, service marks,
130
+ or logos of any Contributor (except as may be necessary to comply with
131
+ the notice requirements in Section 3.4).
132
+
133
+ 2.4. Subsequent Licenses
134
+
135
+ No Contributor makes additional grants as a result of Your choice to
136
+ distribute the Covered Software under a subsequent version of this
137
+ License (see Section 10.2) or under the terms of a Secondary License (if
138
+ permitted under the terms of Section 3.3).
139
+
140
+ 2.5. Representation
141
+
142
+ Each Contributor represents that the Contributor believes its
143
+ Contributions are its original creation(s) or it has sufficient rights
144
+ to grant the rights to its Contributions conveyed by this License.
145
+
146
+ 2.6. Fair Use
147
+
148
+ This License is not intended to limit any rights You have under
149
+ applicable copyright doctrines of fair use, fair dealing, or other
150
+ equivalents.
151
+
152
+ 2.7. Conditions
153
+
154
+ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
155
+ in Section 2.1.
156
+
157
+ 3. Responsibilities
158
+ -------------------
159
+
160
+ 3.1. Distribution of Source Form
161
+
162
+ All distribution of Covered Software in Source Code Form, including any
163
+ Modifications that You create or to which You contribute, must be under
164
+ the terms of this License. You must inform recipients that the Source
165
+ Code Form of the Covered Software is governed by the terms of this
166
+ License, and how they can obtain a copy of this License. You may not
167
+ attempt to alter or restrict the recipients' rights in the Source Code
168
+ Form.
169
+
170
+ 3.2. Distribution of Executable Form
171
+
172
+ If You distribute Covered Software in Executable Form then:
173
+
174
+ (a) such Covered Software must also be made available in Source Code
175
+ Form, as described in Section 3.1, and You must inform recipients of
176
+ the Executable Form how they can obtain a copy of such Source Code
177
+ Form by reasonable means in a timely manner, at a charge no more
178
+ than the cost of distribution to the recipient; and
179
+
180
+ (b) You may distribute such Executable Form under the terms of this
181
+ License, or sublicense it under different terms, provided that the
182
+ license for the Executable Form does not attempt to limit or alter
183
+ the recipients' rights in the Source Code Form under this License.
184
+
185
+ 3.3. Distribution of a Larger Work
186
+
187
+ You may create and distribute a Larger Work under terms of Your choice,
188
+ provided that You also comply with the requirements of this License for
189
+ the Covered Software. If the Larger Work is a combination of Covered
190
+ Software with a work governed by one or more Secondary Licenses, and the
191
+ Covered Software is not Incompatible With Secondary Licenses, this
192
+ License permits You to additionally distribute such Covered Software
193
+ under the terms of such Secondary License(s), so that the recipient of
194
+ the Larger Work may, at their option, further distribute the Covered
195
+ Software under the terms of either this License or such Secondary
196
+ License(s).
197
+
198
+ 3.4. Notices
199
+
200
+ You may not remove or alter the substance of any license notices
201
+ (including copyright notices, patent notices, disclaimers of warranty,
202
+ or limitations of liability) contained within the Source Code Form of
203
+ the Covered Software, except that You may alter any license notices to
204
+ the extent required to remedy known factual inaccuracies.
205
+
206
+ 3.5. Application of Additional Terms
207
+
208
+ You may choose to offer, and to charge a fee for, warranty, support,
209
+ indemnity or liability obligations to one or more recipients of Covered
210
+ Software. However, You may do so only on Your own behalf, and not on
211
+ behalf of any Contributor. You must make it absolutely clear that any
212
+ such warranty, support, indemnity, or liability obligation is offered by
213
+ You alone, and You hereby agree to indemnify every Contributor for any
214
+ liability incurred by such Contributor as a result of warranty, support,
215
+ indemnity or liability terms You offer. You may include additional
216
+ disclaimers of warranty and limitations of liability specific to any
217
+ jurisdiction.
218
+
219
+ 4. Inability to Comply Due to Statute or Regulation
220
+ ---------------------------------------------------
221
+
222
+ If it is impossible for You to comply with any of the terms of this
223
+ License with respect to some or all of the Covered Software due to
224
+ statute, judicial order, or regulation then You must: (a) comply with
225
+ the terms of this License to the maximum extent possible; and (b)
226
+ describe the limitations and the code they affect. Such description must
227
+ be placed in a text file included with all distributions of the Covered
228
+ Software under this License. Except to the extent prohibited by statute
229
+ or regulation, such description must be sufficiently detailed for a
230
+ recipient of ordinary skill to be able to understand it.
231
+
232
+ 5. Termination
233
+ --------------
234
+
235
+ 5.1. The rights granted under this License will terminate automatically
236
+ if You fail to comply with any of its terms. However, if You become
237
+ compliant, then the rights granted under this License from a particular
238
+ Contributor are reinstated (a) provisionally, unless and until such
239
+ Contributor explicitly and finally terminates Your grants, and (b) on an
240
+ ongoing basis, if such Contributor fails to notify You of the
241
+ non-compliance by some reasonable means prior to 60 days after You have
242
+ come back into compliance. Moreover, Your grants from a particular
243
+ Contributor are reinstated on an ongoing basis if such Contributor
244
+ notifies You of the non-compliance by some reasonable means, this is the
245
+ first time You have received notice of non-compliance with this License
246
+ from such Contributor, and You become compliant prior to 30 days after
247
+ Your receipt of the notice.
248
+
249
+ 5.2. If You initiate litigation against any entity by asserting a patent
250
+ infringement claim (excluding declaratory judgment actions,
251
+ counter-claims, and cross-claims) alleging that a Contributor Version
252
+ directly or indirectly infringes any patent, then the rights granted to
253
+ You by any and all Contributors for the Covered Software under Section
254
+ 2.1 of this License shall terminate.
255
+
256
+ 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
257
+ end user license agreements (excluding distributors and resellers) which
258
+ have been validly granted by You or Your distributors under this License
259
+ prior to termination shall survive termination.
260
+
261
+ ************************************************************************
262
+ * *
263
+ * 6. Disclaimer of Warranty *
264
+ * ------------------------- *
265
+ * *
266
+ * Covered Software is provided under this License on an "as is" *
267
+ * basis, without warranty of any kind, either expressed, implied, or *
268
+ * statutory, including, without limitation, warranties that the *
269
+ * Covered Software is free of defects, merchantable, fit for a *
270
+ * particular purpose or non-infringing. The entire risk as to the *
271
+ * quality and performance of the Covered Software is with You. *
272
+ * Should any Covered Software prove defective in any respect, You *
273
+ * (not any Contributor) assume the cost of any necessary servicing, *
274
+ * repair, or correction. This disclaimer of warranty constitutes an *
275
+ * essential part of this License. No use of any Covered Software is *
276
+ * authorized under this License except under this disclaimer. *
277
+ * *
278
+ ************************************************************************
279
+
280
+ ************************************************************************
281
+ * *
282
+ * 7. Limitation of Liability *
283
+ * -------------------------- *
284
+ * *
285
+ * Under no circumstances and under no legal theory, whether tort *
286
+ * (including negligence), contract, or otherwise, shall any *
287
+ * Contributor, or anyone who distributes Covered Software as *
288
+ * permitted above, be liable to You for any direct, indirect, *
289
+ * special, incidental, or consequential damages of any character *
290
+ * including, without limitation, damages for lost profits, loss of *
291
+ * goodwill, work stoppage, computer failure or malfunction, or any *
292
+ * and all other commercial damages or losses, even if such party *
293
+ * shall have been informed of the possibility of such damages. This *
294
+ * limitation of liability shall not apply to liability for death or *
295
+ * personal injury resulting from such party's negligence to the *
296
+ * extent applicable law prohibits such limitation. Some *
297
+ * jurisdictions do not allow the exclusion or limitation of *
298
+ * incidental or consequential damages, so this exclusion and *
299
+ * limitation may not apply to You. *
300
+ * *
301
+ ************************************************************************
302
+
303
+ 8. Litigation
304
+ -------------
305
+
306
+ Any litigation relating to this License may be brought only in the
307
+ courts of a jurisdiction where the defendant maintains its principal
308
+ place of business and such litigation shall be governed by laws of that
309
+ jurisdiction, without reference to its conflict-of-law provisions.
310
+ Nothing in this Section shall prevent a party's ability to bring
311
+ cross-claims or counter-claims.
312
+
313
+ 9. Miscellaneous
314
+ ----------------
315
+
316
+ This License represents the complete agreement concerning the subject
317
+ matter hereof. If any provision of this License is held to be
318
+ unenforceable, such provision shall be reformed only to the extent
319
+ necessary to make it enforceable. Any law or regulation which provides
320
+ that the language of a contract shall be construed against the drafter
321
+ shall not be used to construe this License against a Contributor.
322
+
323
+ 10. Versions of the License
324
+ ---------------------------
325
+
326
+ 10.1. New Versions
327
+
328
+ Mozilla Foundation is the license steward. Except as provided in Section
329
+ 10.3, no one other than the license steward has the right to modify or
330
+ publish new versions of this License. Each version will be given a
331
+ distinguishing version number.
332
+
333
+ 10.2. Effect of New Versions
334
+
335
+ You may distribute the Covered Software under the terms of the version
336
+ of the License under which You originally received the Covered Software,
337
+ or under the terms of any subsequent version published by the license
338
+ steward.
339
+
340
+ 10.3. Modified Versions
341
+
342
+ If you create software not governed by this License, and you want to
343
+ create a new license for such software, you may create and use a
344
+ modified version of this License if you rename the license and remove
345
+ any references to the name of the license steward (except to note that
346
+ such modified license differs from this License).
347
+
348
+ 10.4. Distributing Source Code Form that is Incompatible With Secondary
349
+ Licenses
350
+
351
+ If You choose to distribute Source Code Form that is Incompatible With
352
+ Secondary Licenses under the terms of this version of the License, the
353
+ notice described in Exhibit B of this License must be attached.
354
+
355
+ Exhibit A - Source Code Form License Notice
356
+ -------------------------------------------
357
+
358
+ This Source Code Form is subject to the terms of the Mozilla Public
359
+ License, v. 2.0. If a copy of the MPL was not distributed with this
360
+ file, You can obtain one at https://mozilla.org/MPL/2.0/.
361
+
362
+ If it is not possible or desirable to put the notice in a particular
363
+ file, then You may include the notice in a location (such as a LICENSE
364
+ file in a relevant directory) where a recipient would be likely to look
365
+ for such a notice.
366
+
367
+ You may add additional accurate notices of copyright ownership.
368
+
369
+ Exhibit B - "Incompatible With Secondary Licenses" Notice
370
+ ---------------------------------------------------------
371
+
372
+ This Source Code Form is "Incompatible With Secondary Licenses", as
373
+ defined by the Mozilla Public License, v. 2.0.
package/README.md ADDED
@@ -0,0 +1,14 @@
1
+ # @webpieces/eslint-rules
2
+
3
+ ESLint rules for WebPieces code patterns and architecture enforcement.
4
+
5
+ ## Rules
6
+
7
+ - `catch-error-pattern` - Enforce toError() usage in catch blocks
8
+ - `no-unmanaged-exceptions` - Discourage try-catch outside tests
9
+ - `max-method-lines` - Enforce maximum method length
10
+ - `max-file-lines` - Enforce maximum file length
11
+ - `enforce-architecture` - Enforce architecture dependency boundaries
12
+ - `no-json-property-primitive-type` - Ban @JsonProperty({ type: String/Number/Boolean })
13
+ - `require-typed-template` - Require [templateClassType] on ng-template with let- variables (Angular)
14
+ - `no-mat-cell-def` - Ban *matCellDef/*matHeaderCellDef — use div-grid tables (Angular)
package/jest.config.ts ADDED
@@ -0,0 +1,16 @@
1
+ export default {
2
+ displayName: 'eslint-rules',
3
+ preset: '../../../jest.preset.js',
4
+ testEnvironment: 'node',
5
+ transform: {
6
+ '^.+\\.[tj]s$': [
7
+ 'ts-jest',
8
+ {
9
+ tsconfig: '<rootDir>/tsconfig.spec.json',
10
+ },
11
+ ],
12
+ },
13
+ moduleFileExtensions: ['ts', 'js', 'html'],
14
+ testMatch: ['**/*.test.ts', '**/*.spec.ts'],
15
+ coverageDirectory: '../../../coverage/packages/tooling/eslint-rules',
16
+ };
package/package.json ADDED
@@ -0,0 +1,20 @@
1
+ {
2
+ "name": "@webpieces/eslint-rules",
3
+ "version": "0.0.1",
4
+ "description": "ESLint rules for WebPieces code patterns and architecture enforcement",
5
+ "type": "commonjs",
6
+ "main": "./src/index.js",
7
+ "author": "Dean Hiller",
8
+ "license": "Apache-2.0",
9
+ "repository": {
10
+ "type": "git",
11
+ "url": "https://github.com/deanhiller/webpieces-ts.git",
12
+ "directory": "packages/tooling/eslint-rules"
13
+ },
14
+ "peerDependencies": {
15
+ "eslint": ">=8.0.0"
16
+ },
17
+ "publishConfig": {
18
+ "access": "public"
19
+ }
20
+ }