@sarj/eslint-plugin 7.0.0 → 7.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/README.md +1 -0
  2. package/dist/index.cjs +537 -391
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.cts +16 -8
  5. package/dist/index.d.ts +16 -8
  6. package/dist/index.js +530 -384
  7. package/dist/index.js.map +1 -1
  8. package/package.json +1 -1
package/dist/index.d.cts CHANGED
@@ -1,13 +1,13 @@
1
1
  import * as _typescript_eslint_utils_ts_eslint from '@typescript-eslint/utils/ts-eslint';
2
2
 
3
3
  /**
4
- * @fileoverview no-type-member-comment-wall — an object type whose member comments mostly re-spell the members is a wall the reader pays for by the block.
4
+ * @fileoverview _comment-wall — the shared judgement behind the comment-VOLUME rules: a run of member comments that mostly re-spell their members is a wall.
5
5
  *
6
- * Examples: https://github.com/sarj-ai/standards/blob/main/packages/typescript/tests/rules/no-type-member-comment-wall.test.ts
7
- * Evidence: https://github.com/sarj-ai/standards/blob/main/docs/rules/no-type-member-comment-wall.md
6
+ * Evidence: https://github.com/sarj-ai/standards/blob/main/docs/rules/_comment-wall.md
8
7
  */
9
- /** Every threshold this rule applies; each is documented at `DEFAULTS`. */
10
- interface RuleOptions$3 {
8
+
9
+ /** Every threshold the wall rules apply; each is documented at `WALL_DEFAULTS`. */
10
+ interface WallOptions {
11
11
  readonly minCommentedMembers: number;
12
12
  readonly minCommentedRatio: number;
13
13
  readonly minRestatedRatio: number;
@@ -166,7 +166,10 @@ declare const rules: {
166
166
  "no-trailing-value-narration": _typescript_eslint_utils_ts_eslint.RuleModule<"narratesValue", readonly [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
167
167
  name: string;
168
168
  };
169
- "no-type-member-comment-wall": _typescript_eslint_utils_ts_eslint.RuleModule<"commentWall", readonly [Partial<RuleOptions$3>?], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
169
+ "no-declaration-comment-wall": _typescript_eslint_utils_ts_eslint.RuleModule<"commentWall", readonly [Partial<WallOptions>?], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
170
+ name: string;
171
+ };
172
+ "no-type-member-comment-wall": _typescript_eslint_utils_ts_eslint.RuleModule<"commentWall", readonly [Partial<WallOptions>?], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
170
173
  name: string;
171
174
  };
172
175
  "no-unnecessary-use-client": _typescript_eslint_utils_ts_eslint.RuleModule<"unnecessaryUseClient", readonly [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
@@ -279,6 +282,7 @@ declare const recommendedRules: {
279
282
  readonly "@sarj/no-string-concat-in-loop": "warn";
280
283
  readonly "@sarj/no-tautological-expect": "warn";
281
284
  readonly "@sarj/no-trailing-value-narration": "warn";
285
+ readonly "@sarj/no-declaration-comment-wall": "warn";
282
286
  readonly "@sarj/no-type-member-comment-wall": "warn";
283
287
  readonly "@sarj/no-unnecessary-use-client": "warn";
284
288
  readonly "@sarj/no-unsafe-mock-casting": "warn";
@@ -334,6 +338,7 @@ declare const strictRules: {
334
338
  readonly "@sarj/no-string-concat-in-loop": "error";
335
339
  readonly "@sarj/no-tautological-expect": "error";
336
340
  readonly "@sarj/no-trailing-value-narration": "error";
341
+ readonly "@sarj/no-declaration-comment-wall": "error";
337
342
  readonly "@sarj/no-type-member-comment-wall": "error";
338
343
  readonly "@sarj/no-unnecessary-use-client": "error";
339
344
  readonly "@sarj/no-unsafe-mock-casting": "error";
@@ -372,7 +377,7 @@ type FlatPreset = {
372
377
  declare const plugin: {
373
378
  meta: {
374
379
  readonly name: "@sarj/eslint-plugin";
375
- readonly version: "7.0.0";
380
+ readonly version: "7.1.0";
376
381
  };
377
382
  rules: {
378
383
  "jsdoc-restates-signature": RuleModule;
@@ -471,7 +476,10 @@ declare const plugin: {
471
476
  "no-trailing-value-narration": _typescript_eslint_utils_ts_eslint.RuleModule<"narratesValue", readonly [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
472
477
  name: string;
473
478
  };
474
- "no-type-member-comment-wall": _typescript_eslint_utils_ts_eslint.RuleModule<"commentWall", readonly [Partial<RuleOptions$3>?], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
479
+ "no-declaration-comment-wall": _typescript_eslint_utils_ts_eslint.RuleModule<"commentWall", readonly [Partial<WallOptions>?], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
480
+ name: string;
481
+ };
482
+ "no-type-member-comment-wall": _typescript_eslint_utils_ts_eslint.RuleModule<"commentWall", readonly [Partial<WallOptions>?], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
475
483
  name: string;
476
484
  };
477
485
  "no-unnecessary-use-client": _typescript_eslint_utils_ts_eslint.RuleModule<"unnecessaryUseClient", readonly [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
package/dist/index.d.ts CHANGED
@@ -1,13 +1,13 @@
1
1
  import * as _typescript_eslint_utils_ts_eslint from '@typescript-eslint/utils/ts-eslint';
2
2
 
3
3
  /**
4
- * @fileoverview no-type-member-comment-wall — an object type whose member comments mostly re-spell the members is a wall the reader pays for by the block.
4
+ * @fileoverview _comment-wall — the shared judgement behind the comment-VOLUME rules: a run of member comments that mostly re-spell their members is a wall.
5
5
  *
6
- * Examples: https://github.com/sarj-ai/standards/blob/main/packages/typescript/tests/rules/no-type-member-comment-wall.test.ts
7
- * Evidence: https://github.com/sarj-ai/standards/blob/main/docs/rules/no-type-member-comment-wall.md
6
+ * Evidence: https://github.com/sarj-ai/standards/blob/main/docs/rules/_comment-wall.md
8
7
  */
9
- /** Every threshold this rule applies; each is documented at `DEFAULTS`. */
10
- interface RuleOptions$3 {
8
+
9
+ /** Every threshold the wall rules apply; each is documented at `WALL_DEFAULTS`. */
10
+ interface WallOptions {
11
11
  readonly minCommentedMembers: number;
12
12
  readonly minCommentedRatio: number;
13
13
  readonly minRestatedRatio: number;
@@ -166,7 +166,10 @@ declare const rules: {
166
166
  "no-trailing-value-narration": _typescript_eslint_utils_ts_eslint.RuleModule<"narratesValue", readonly [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
167
167
  name: string;
168
168
  };
169
- "no-type-member-comment-wall": _typescript_eslint_utils_ts_eslint.RuleModule<"commentWall", readonly [Partial<RuleOptions$3>?], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
169
+ "no-declaration-comment-wall": _typescript_eslint_utils_ts_eslint.RuleModule<"commentWall", readonly [Partial<WallOptions>?], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
170
+ name: string;
171
+ };
172
+ "no-type-member-comment-wall": _typescript_eslint_utils_ts_eslint.RuleModule<"commentWall", readonly [Partial<WallOptions>?], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
170
173
  name: string;
171
174
  };
172
175
  "no-unnecessary-use-client": _typescript_eslint_utils_ts_eslint.RuleModule<"unnecessaryUseClient", readonly [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
@@ -279,6 +282,7 @@ declare const recommendedRules: {
279
282
  readonly "@sarj/no-string-concat-in-loop": "warn";
280
283
  readonly "@sarj/no-tautological-expect": "warn";
281
284
  readonly "@sarj/no-trailing-value-narration": "warn";
285
+ readonly "@sarj/no-declaration-comment-wall": "warn";
282
286
  readonly "@sarj/no-type-member-comment-wall": "warn";
283
287
  readonly "@sarj/no-unnecessary-use-client": "warn";
284
288
  readonly "@sarj/no-unsafe-mock-casting": "warn";
@@ -334,6 +338,7 @@ declare const strictRules: {
334
338
  readonly "@sarj/no-string-concat-in-loop": "error";
335
339
  readonly "@sarj/no-tautological-expect": "error";
336
340
  readonly "@sarj/no-trailing-value-narration": "error";
341
+ readonly "@sarj/no-declaration-comment-wall": "error";
337
342
  readonly "@sarj/no-type-member-comment-wall": "error";
338
343
  readonly "@sarj/no-unnecessary-use-client": "error";
339
344
  readonly "@sarj/no-unsafe-mock-casting": "error";
@@ -372,7 +377,7 @@ type FlatPreset = {
372
377
  declare const plugin: {
373
378
  meta: {
374
379
  readonly name: "@sarj/eslint-plugin";
375
- readonly version: "7.0.0";
380
+ readonly version: "7.1.0";
376
381
  };
377
382
  rules: {
378
383
  "jsdoc-restates-signature": RuleModule;
@@ -471,7 +476,10 @@ declare const plugin: {
471
476
  "no-trailing-value-narration": _typescript_eslint_utils_ts_eslint.RuleModule<"narratesValue", readonly [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
472
477
  name: string;
473
478
  };
474
- "no-type-member-comment-wall": _typescript_eslint_utils_ts_eslint.RuleModule<"commentWall", readonly [Partial<RuleOptions$3>?], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
479
+ "no-declaration-comment-wall": _typescript_eslint_utils_ts_eslint.RuleModule<"commentWall", readonly [Partial<WallOptions>?], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
480
+ name: string;
481
+ };
482
+ "no-type-member-comment-wall": _typescript_eslint_utils_ts_eslint.RuleModule<"commentWall", readonly [Partial<WallOptions>?], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
475
483
  name: string;
476
484
  };
477
485
  "no-unnecessary-use-client": _typescript_eslint_utils_ts_eslint.RuleModule<"unnecessaryUseClient", readonly [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {