@sarj/eslint-plugin 5.0.0 → 5.1.0

package/dist/index.d.cts

@@ -1,5 +1,35 @@
 import * as _typescript_eslint_utils_ts_eslint from '@typescript-eslint/utils/ts-eslint';
 
+/**
+ * @fileoverview An object type whose member comments mostly re-spell the
+ * members' own names and types — the VOLUME arm of the comment family, judged
+ * once per TYPE rather than once per comment.
+ *
+ *     interface SapCredentials {
+ *       // Database host.
+ *       host?: string;
+ *       // Database host port.
+ *       port?: number;
+ *       // Database username.
+ *       username?: string;
+ *     }
+ *
+ * `jsdoc-restates-signature` needs every content word covered, so it deletes
+ * the first row and cannot touch the second. That is the right verdict for one
+ * line and the wrong one for ten, so the unit of judgement here is the type.
+ *
+ * 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
+ */
+
+/** Every threshold this rule applies; each is documented at `DEFAULTS`. */
+interface RuleOptions$3 {
+    readonly minCommentedMembers: number;
+    readonly minCommentedRatio: number;
+    readonly minRestatedRatio: number;
+    readonly maxNovelWords: number;
+}
+
 /**
  * @fileoverview Keep modules that are stateless by design free of private
  * storage.
@@ -389,6 +419,9 @@ declare const rules: {
     "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> & {
+        name: string;
+    };
     "no-tautological-expect": _typescript_eslint_utils_ts_eslint.RuleModule<"tautologicalComparison" | "tautologicalMatcher", readonly [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
@@ -563,6 +596,9 @@ declare const plugin: {
         "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> & {
+            name: string;
+        };
         "no-tautological-expect": _typescript_eslint_utils_ts_eslint.RuleModule<"tautologicalComparison" | "tautologicalMatcher", readonly [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
@@ -625,6 +661,7 @@ declare const plugin: {
                 "@sarj/no-restated-comment": string;
                 "@sarj/jsdoc-restates-signature": string;
                 "@sarj/trailing-value-narration": string;
+                "@sarj/no-type-member-comment-wall": string;
                 "@sarj/no-tautological-expect": string;
                 "@sarj/require-interface-for-injected-service": string;
                 "@sarj/prefer-non-nullable-collection": string;
@@ -680,6 +717,7 @@ declare const plugin: {
                 "@sarj/no-restated-comment": string;
                 "@sarj/jsdoc-restates-signature": string;
                 "@sarj/trailing-value-narration": string;
+                "@sarj/no-type-member-comment-wall": string;
                 "@sarj/no-tautological-expect": string;
                 "@sarj/require-interface-for-injected-service": string;
                 "@sarj/prefer-non-nullable-collection": string;

package/dist/index.d.ts

@@ -1,5 +1,35 @@
 import * as _typescript_eslint_utils_ts_eslint from '@typescript-eslint/utils/ts-eslint';
 
+/**
+ * @fileoverview An object type whose member comments mostly re-spell the
+ * members' own names and types — the VOLUME arm of the comment family, judged
+ * once per TYPE rather than once per comment.
+ *
+ *     interface SapCredentials {
+ *       // Database host.
+ *       host?: string;
+ *       // Database host port.
+ *       port?: number;
+ *       // Database username.
+ *       username?: string;
+ *     }
+ *
+ * `jsdoc-restates-signature` needs every content word covered, so it deletes
+ * the first row and cannot touch the second. That is the right verdict for one
+ * line and the wrong one for ten, so the unit of judgement here is the type.
+ *
+ * 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
+ */
+
+/** Every threshold this rule applies; each is documented at `DEFAULTS`. */
+interface RuleOptions$3 {
+    readonly minCommentedMembers: number;
+    readonly minCommentedRatio: number;
+    readonly minRestatedRatio: number;
+    readonly maxNovelWords: number;
+}
+
 /**
  * @fileoverview Keep modules that are stateless by design free of private
  * storage.
@@ -389,6 +419,9 @@ declare const rules: {
     "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> & {
+        name: string;
+    };
     "no-tautological-expect": _typescript_eslint_utils_ts_eslint.RuleModule<"tautologicalComparison" | "tautologicalMatcher", readonly [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
@@ -563,6 +596,9 @@ declare const plugin: {
         "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> & {
+            name: string;
+        };
         "no-tautological-expect": _typescript_eslint_utils_ts_eslint.RuleModule<"tautologicalComparison" | "tautologicalMatcher", readonly [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
@@ -625,6 +661,7 @@ declare const plugin: {
                 "@sarj/no-restated-comment": string;
                 "@sarj/jsdoc-restates-signature": string;
                 "@sarj/trailing-value-narration": string;
+                "@sarj/no-type-member-comment-wall": string;
                 "@sarj/no-tautological-expect": string;
                 "@sarj/require-interface-for-injected-service": string;
                 "@sarj/prefer-non-nullable-collection": string;
@@ -680,6 +717,7 @@ declare const plugin: {
                 "@sarj/no-restated-comment": string;
                 "@sarj/jsdoc-restates-signature": string;
                 "@sarj/trailing-value-narration": string;
+                "@sarj/no-type-member-comment-wall": string;
                 "@sarj/no-tautological-expect": string;
                 "@sarj/require-interface-for-injected-service": string;
                 "@sarj/prefer-non-nullable-collection": string;