@sarj/eslint-plugin 7.0.0 → 8.0.0

package/dist/index.d.cts

@@ -1,13 +1,27 @@
 import * as _typescript_eslint_utils_ts_eslint from '@typescript-eslint/utils/ts-eslint';
 
 /**
- * @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.
+ * @fileoverview _retired — a withdrawn rule name is burned, not recycled, because a consumer's `eslint-disable` comment or suppressions entry still names it.
  *
- * Examples: https://github.com/sarj-ai/standards/blob/main/packages/typescript/tests/rules/no-type-member-comment-wall.test.ts
- * Evidence: https://github.com/sarj-ai/standards/blob/main/docs/rules/no-type-member-comment-wall.md
+ * Evidence: https://github.com/sarj-ai/standards/blob/main/docs/rules/_retired.md
  */
-/** Every threshold this rule applies; each is documented at `DEFAULTS`. */
-interface RuleOptions$3 {
+/** Why a name was withdrawn, and in which release. */
+interface RetiredRule {
+    /** The plugin version whose release removed the rule. */
+    readonly removedIn: string;
+    /** One line a consumer can act on: why it went, and what (if anything) replaced it. */
+    readonly reason: string;
+}
+declare const retiredRules: Readonly<Record<string, RetiredRule>>;
+
+/**
+ * @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.
+ *
+ * Evidence: https://github.com/sarj-ai/standards/blob/main/docs/rules/_comment-wall.md
+ */
+
+/** Every threshold the wall rules apply; each is documented at `WALL_DEFAULTS`. */
+interface WallOptions {
     readonly minCommentedMembers: number;
     readonly minCommentedRatio: number;
     readonly minRestatedRatio: number;
@@ -166,7 +180,10 @@ declare const rules: {
     "no-trailing-value-narration": _typescript_eslint_utils_ts_eslint.RuleModule<"narratesValue", readonly [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
-    "no-type-member-comment-wall": _typescript_eslint_utils_ts_eslint.RuleModule<"commentWall", readonly [Partial<RuleOptions$3>?], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+    "no-declaration-comment-wall": _typescript_eslint_utils_ts_eslint.RuleModule<"commentWall", readonly [Partial<WallOptions>?], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        name: string;
+    };
+    "no-type-member-comment-wall": _typescript_eslint_utils_ts_eslint.RuleModule<"commentWall", readonly [Partial<WallOptions>?], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
     "no-unnecessary-use-client": _typescript_eslint_utils_ts_eslint.RuleModule<"unnecessaryUseClient", readonly [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
@@ -279,6 +296,7 @@ declare const recommendedRules: {
     readonly "@sarj/no-string-concat-in-loop": "warn";
     readonly "@sarj/no-tautological-expect": "warn";
     readonly "@sarj/no-trailing-value-narration": "warn";
+    readonly "@sarj/no-declaration-comment-wall": "warn";
     readonly "@sarj/no-type-member-comment-wall": "warn";
     readonly "@sarj/no-unnecessary-use-client": "warn";
     readonly "@sarj/no-unsafe-mock-casting": "warn";
@@ -334,6 +352,7 @@ declare const strictRules: {
     readonly "@sarj/no-string-concat-in-loop": "error";
     readonly "@sarj/no-tautological-expect": "error";
     readonly "@sarj/no-trailing-value-narration": "error";
+    readonly "@sarj/no-declaration-comment-wall": "error";
     readonly "@sarj/no-type-member-comment-wall": "error";
     readonly "@sarj/no-unnecessary-use-client": "error";
     readonly "@sarj/no-unsafe-mock-casting": "error";
@@ -372,7 +391,7 @@ type FlatPreset = {
 declare const plugin: {
     meta: {
         readonly name: "@sarj/eslint-plugin";
-        readonly version: "7.0.0";
+        readonly version: "8.0.0";
     };
     rules: {
         "jsdoc-restates-signature": RuleModule;
@@ -471,7 +490,10 @@ declare const plugin: {
         "no-trailing-value-narration": _typescript_eslint_utils_ts_eslint.RuleModule<"narratesValue", readonly [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
-        "no-type-member-comment-wall": _typescript_eslint_utils_ts_eslint.RuleModule<"commentWall", readonly [Partial<RuleOptions$3>?], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        "no-declaration-comment-wall": _typescript_eslint_utils_ts_eslint.RuleModule<"commentWall", readonly [Partial<WallOptions>?], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+            name: string;
+        };
+        "no-type-member-comment-wall": _typescript_eslint_utils_ts_eslint.RuleModule<"commentWall", readonly [Partial<WallOptions>?], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
         "no-unnecessary-use-client": _typescript_eslint_utils_ts_eslint.RuleModule<"unnecessaryUseClient", readonly [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
@@ -557,10 +579,11 @@ declare const plugin: {
             name: string;
         };
     };
+    retiredRules: Readonly<Record<string, RetiredRule>>;
     configs: {
         recommended: FlatPreset;
         strict: FlatPreset;
     };
 };
 
-export { plugin as default, recommendedRules, renamedRules, rules, strictRules };
+export { type RetiredRule, plugin as default, recommendedRules, renamedRules, retiredRules, rules, strictRules };

package/dist/index.d.ts

@@ -1,13 +1,27 @@
 import * as _typescript_eslint_utils_ts_eslint from '@typescript-eslint/utils/ts-eslint';
 
 /**
- * @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.
+ * @fileoverview _retired — a withdrawn rule name is burned, not recycled, because a consumer's `eslint-disable` comment or suppressions entry still names it.
  *
- * Examples: https://github.com/sarj-ai/standards/blob/main/packages/typescript/tests/rules/no-type-member-comment-wall.test.ts
- * Evidence: https://github.com/sarj-ai/standards/blob/main/docs/rules/no-type-member-comment-wall.md
+ * Evidence: https://github.com/sarj-ai/standards/blob/main/docs/rules/_retired.md
  */
-/** Every threshold this rule applies; each is documented at `DEFAULTS`. */
-interface RuleOptions$3 {
+/** Why a name was withdrawn, and in which release. */
+interface RetiredRule {
+    /** The plugin version whose release removed the rule. */
+    readonly removedIn: string;
+    /** One line a consumer can act on: why it went, and what (if anything) replaced it. */
+    readonly reason: string;
+}
+declare const retiredRules: Readonly<Record<string, RetiredRule>>;
+
+/**
+ * @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.
+ *
+ * Evidence: https://github.com/sarj-ai/standards/blob/main/docs/rules/_comment-wall.md
+ */
+
+/** Every threshold the wall rules apply; each is documented at `WALL_DEFAULTS`. */
+interface WallOptions {
     readonly minCommentedMembers: number;
     readonly minCommentedRatio: number;
     readonly minRestatedRatio: number;
@@ -166,7 +180,10 @@ declare const rules: {
     "no-trailing-value-narration": _typescript_eslint_utils_ts_eslint.RuleModule<"narratesValue", readonly [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
-    "no-type-member-comment-wall": _typescript_eslint_utils_ts_eslint.RuleModule<"commentWall", readonly [Partial<RuleOptions$3>?], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+    "no-declaration-comment-wall": _typescript_eslint_utils_ts_eslint.RuleModule<"commentWall", readonly [Partial<WallOptions>?], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        name: string;
+    };
+    "no-type-member-comment-wall": _typescript_eslint_utils_ts_eslint.RuleModule<"commentWall", readonly [Partial<WallOptions>?], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
     "no-unnecessary-use-client": _typescript_eslint_utils_ts_eslint.RuleModule<"unnecessaryUseClient", readonly [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
@@ -279,6 +296,7 @@ declare const recommendedRules: {
     readonly "@sarj/no-string-concat-in-loop": "warn";
     readonly "@sarj/no-tautological-expect": "warn";
     readonly "@sarj/no-trailing-value-narration": "warn";
+    readonly "@sarj/no-declaration-comment-wall": "warn";
     readonly "@sarj/no-type-member-comment-wall": "warn";
     readonly "@sarj/no-unnecessary-use-client": "warn";
     readonly "@sarj/no-unsafe-mock-casting": "warn";
@@ -334,6 +352,7 @@ declare const strictRules: {
     readonly "@sarj/no-string-concat-in-loop": "error";
     readonly "@sarj/no-tautological-expect": "error";
     readonly "@sarj/no-trailing-value-narration": "error";
+    readonly "@sarj/no-declaration-comment-wall": "error";
     readonly "@sarj/no-type-member-comment-wall": "error";
     readonly "@sarj/no-unnecessary-use-client": "error";
     readonly "@sarj/no-unsafe-mock-casting": "error";
@@ -372,7 +391,7 @@ type FlatPreset = {
 declare const plugin: {
     meta: {
         readonly name: "@sarj/eslint-plugin";
-        readonly version: "7.0.0";
+        readonly version: "8.0.0";
     };
     rules: {
         "jsdoc-restates-signature": RuleModule;
@@ -471,7 +490,10 @@ declare const plugin: {
         "no-trailing-value-narration": _typescript_eslint_utils_ts_eslint.RuleModule<"narratesValue", readonly [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
-        "no-type-member-comment-wall": _typescript_eslint_utils_ts_eslint.RuleModule<"commentWall", readonly [Partial<RuleOptions$3>?], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        "no-declaration-comment-wall": _typescript_eslint_utils_ts_eslint.RuleModule<"commentWall", readonly [Partial<WallOptions>?], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+            name: string;
+        };
+        "no-type-member-comment-wall": _typescript_eslint_utils_ts_eslint.RuleModule<"commentWall", readonly [Partial<WallOptions>?], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
         "no-unnecessary-use-client": _typescript_eslint_utils_ts_eslint.RuleModule<"unnecessaryUseClient", readonly [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
@@ -557,10 +579,11 @@ declare const plugin: {
             name: string;
         };
     };
+    retiredRules: Readonly<Record<string, RetiredRule>>;
     configs: {
         recommended: FlatPreset;
         strict: FlatPreset;
     };
 };
 
-export { plugin as default, recommendedRules, renamedRules, rules, strictRules };
+export { type RetiredRule, plugin as default, recommendedRules, renamedRules, retiredRules, rules, strictRules };