eslint-plugin-etc-misc 1.0.2 → 1.0.3

package/docs/rules/no-writeonly.md

@@ -18,9 +18,9 @@ Write-only properties hide state flow and make object behavior harder to debug.
 
 ```ts
 const state = {
-    set value(next: number) {
-        this._value = next;
-    },
+ set value(next: number) {
+  this._value = next;
+ },
 };
 ```
 
@@ -28,13 +28,13 @@ const state = {
 
 ```ts
 const state = {
-    _value: 0,
-    get value() {
-        return this._value;
-    },
-    set value(next: number) {
-        this._value = next;
-    },
+ _value: 0,
+ get value() {
+  return this._value;
+ },
+ set value(next: number) {
+  this._value = next;
+ },
 };
 ```
 
@@ -46,22 +46,22 @@ This rule forwards options and behavior to ESLint core `accessor-pairs`.
 
 ```ts
 class Box {
-    set value(next: number) {
-        this._value = next;
-    }
+ set value(next: number) {
+  this._value = next;
+ }
 }
 // ❌ reported
 
 class BoxFixed {
-    _value = 0;
+ _value = 0;
 
-    get value() {
-        return this._value;
-    }
+ get value() {
+  return this._value;
+ }
 
-    set value(next: number) {
-        this._value = next;
-    }
+ set value(next: number) {
+  this._value = next;
+ }
 }
 // ✅ valid
 ```
@@ -72,12 +72,12 @@ class BoxFixed {
 import etcMisc from "eslint-plugin-etc-misc";
 
 export default [
-    {
-        plugins: { "etc-misc": etcMisc },
-        rules: {
-            "etc-misc/no-writeonly": "error",
-        },
-    },
+ {
+  plugins: { "etc-misc": etcMisc },
+  rules: {
+   "etc-misc/no-writeonly": "error",
+  },
+ },
 ];
 ```
 

package/docs/rules/object-format.md

@@ -12,7 +12,7 @@ enforces single-line or multi-line formatting based on property count.
 For each object literal with at least two properties:
 
 - if property count is less than or equal to `maxProperties`, the object must be
-on a single line;
+  on a single line;
 - otherwise, the object must span multiple lines.
 
 ## Why this rule exists
@@ -33,8 +33,8 @@ const point = { x: 1, y: 2 };
 ```ts
 // default maxProperties: 1
 const point = {
-    x: 1,
-    y: 2,
+ x: 1,
+ y: 2,
 };
 ```
 
@@ -54,9 +54,9 @@ before enforcing as `error`.
 
 ```ts
 type Options = [
-    {
-        maxProperties?: number; // default: 1
-    },
+ {
+  maxProperties?: number; // default: 1
+ },
 ];
 ```
 
@@ -65,7 +65,7 @@ type Options = [
 ### Default configuration
 
 ```ts
-[{ maxProperties: 1 }]
+[{ maxProperties: 1 }];
 ```
 
 ## Additional examples
@@ -75,9 +75,9 @@ const pair = { left: 1, right: 2 };
 // ✅ valid when configured with { maxProperties: 2 }
 
 const tupleLike = {
-    first: 1,
-    second: 2,
-    third: 3,
+ first: 1,
+ second: 2,
+ third: 3,
 };
 // ✅ required when maxProperties is 2
 ```
@@ -88,12 +88,12 @@ const tupleLike = {
 import etcMisc from "eslint-plugin-etc-misc";
 
 export default [
-    {
-        plugins: { "etc-misc": etcMisc },
-        rules: {
-            "etc-misc/object-format": "error",
-        },
-    },
+ {
+  plugins: { "etc-misc": etcMisc },
+  rules: {
+   "etc-misc/object-format": "error",
+  },
+ },
 ];
 ```
 

package/docs/rules/only-export-name.md

@@ -46,7 +46,9 @@ export const value = 1;
 with options:
 
 ```ts
-{ names: ["value"] }
+{
+ names: ["value"];
+}
 ```
 
 ## Behavior and migration notes
@@ -60,7 +62,7 @@ explicitly allowed.
 
 ```ts
 type Options = {
-    names?: string[];
+ names?: string[];
 };
 ```
 
@@ -91,12 +93,12 @@ export { buildClient as client };
 import etcMisc from "eslint-plugin-etc-misc";
 
 export default [
-    {
-        plugins: { "etc-misc": etcMisc },
-        rules: {
-            "etc-misc/only-export-name": ["error", { names: ["value"] }],
-        },
-    },
+ {
+  plugins: { "etc-misc": etcMisc },
+  rules: {
+   "etc-misc/only-export-name": ["error", { names: ["value"] }],
+  },
+ },
 ];
 ```
 

package/docs/rules/overview.md

@@ -31,13 +31,14 @@ That is enough for TypeScript files (`**/*.{ts,tsx,mts,cts}`).
 
 ## Presets
 
-| Preset                              | Purpose                                                                |
-| ----------------------------------- | ---------------------------------------------------------------------- |
-| 🟡 `etcMisc.configs.recommended`        | Balanced starter preset for most projects.                             |
-| 🟠 `etcMisc.configs.strict`             | Same rule set as `recommended`, but every enabled rule is `error`.     |
-| 🔵 `etcMisc.configs.strictTypeChecked`  | `strict` plus additional non-deprecated type-aware rules at `error`.   |
-| 🔴 `etcMisc.configs.allStrict`          | Every non-deprecated plugin rule at `error` (deprecated rules stay `warn`). |
-| 🟣 `etcMisc.configs.all`                | Enables every rule exported by the plugin with metadata-derived severities. |
+| Preset                                 | Purpose                                                                     |
+| -------------------------------------- | --------------------------------------------------------------------------- |
+| 🟢 `etcMisc.configs.minimal`           | `recommended` minus the `typescript/prefer-readonly*` rules.                |
+| 🟡 `etcMisc.configs.recommended`       | Balanced starter preset for most projects.                                  |
+| 🟠 `etcMisc.configs.strict`            | Same rule set as `recommended`, but every enabled rule is `error`.          |
+| 🔵 `etcMisc.configs.strictTypeChecked` | `strict` plus additional non-deprecated type-aware rules at `error`.        |
+| 🔴 `etcMisc.configs.allStrict`         | Every non-deprecated plugin rule at `error` (deprecated rules stay `warn`). |
+| 🟣 `etcMisc.configs.all`               | Enables every rule exported by the plugin with metadata-derived severities. |
 
 ## Next steps
 

package/docs/rules/prefer-arrow-function-property.md

@@ -23,12 +23,12 @@ low-ambiguity style.
 
 ```ts
 const handlers = {
-    onClick() {
-        return "clicked";
-    },
-    onHover: function () {
-        return "hovered";
-    },
+ onClick() {
+  return "clicked";
+ },
+ onHover: function () {
+  return "hovered";
+ },
 };
 ```
 
@@ -36,11 +36,11 @@ const handlers = {
 
 ```ts
 const handlers = {
-    onClick: () => "clicked",
-    onHover: () => "hovered",
-    withThis(this: void) {
-        return "ok";
-    },
+ onClick: () => "clicked",
+ onHover: () => "hovered",
+ withThis(this: void) {
+  return "ok";
+ },
 };
 ```
 
@@ -56,17 +56,17 @@ uses method-style `this`, keep it as a method and annotate `this` explicitly.
 
 ```ts
 const formatter = {
-    prefix: "#",
-    format(this: { prefix: string }, value: number) {
-        return `${this.prefix}${value}`;
-    },
+ prefix: "#",
+ format(this: { prefix: string }, value: number) {
+  return `${this.prefix}${value}`;
+ },
 };
 // ✅ valid: explicit `this` parameter is allowed by this rule
 
 const formatter2 = {
-    format(value: number) {
-        return String(value);
-    },
+ format(value: number) {
+  return String(value);
+ },
 };
 // ❌ reported
 ```
@@ -77,12 +77,12 @@ const formatter2 = {
 import etcMisc from "eslint-plugin-etc-misc";
 
 export default [
-    {
-        plugins: { "etc-misc": etcMisc },
-        rules: {
-            "etc-misc/prefer-arrow-function-property": "error",
-        },
-    },
+ {
+  plugins: { "etc-misc": etcMisc },
+  rules: {
+   "etc-misc/prefer-arrow-function-property": "error",
+  },
+ },
 ];
 ```
 

package/docs/rules/prefer-const-require.md

@@ -22,7 +22,7 @@ makes migration toward ESM import style easier.
 
 ```ts
 function loadPath() {
-    return require("node:path");
+ return require("node:path");
 }
 ```
 
@@ -32,7 +32,7 @@ function loadPath() {
 const path = require("node:path");
 
 function loadPath() {
-    return path;
+ return path;
 }
 ```
 
@@ -60,12 +60,12 @@ logger.info(os.platform());
 import etcMisc from "eslint-plugin-etc-misc";
 
 export default [
-    {
-        plugins: { "etc-misc": etcMisc },
-        rules: {
-            "etc-misc/prefer-const-require": "error",
-        },
-    },
+ {
+  plugins: { "etc-misc": etcMisc },
+  rules: {
+   "etc-misc/prefer-const-require": "error",
+  },
+ },
 ];
 ```
 

package/docs/rules/prefer-includes.md

@@ -19,13 +19,22 @@ comparisons.
 ## ❌ Incorrect
 
 ```ts
-const hasValue = [1, 2, 3].indexOf(2) !== -1;
+const hasValue =
+ [
+  1,
+  2,
+  3,
+ ].indexOf(2) !== -1;
 ```
 
 ## ✅ Correct
 
 ```ts
-const hasValue = [1, 2, 3].includes(2);
+const hasValue = [
+ 1,
+ 2,
+ 3,
+].includes(2);
 ```
 
 ## Behavior and migration notes
@@ -53,12 +62,12 @@ const hasName2 = names.includes("alice");
 import etcMisc from "eslint-plugin-etc-misc";
 
 export default [
-    {
-        plugins: { "etc-misc": etcMisc },
-        rules: {
-            "etc-misc/prefer-includes": "error",
-        },
-    },
+ {
+  plugins: { "etc-misc": etcMisc },
+  rules: {
+   "etc-misc/prefer-includes": "error",
+  },
+ },
 ];
 ```
 

package/docs/rules/prefer-interface.md

@@ -22,8 +22,8 @@ For interface-compatible shapes, interfaces can provide clearer extension patter
 
 ```ts
 type Person = {
-    name: string;
-    age: number;
+ name: string;
+ age: number;
 };
 ```
 
@@ -35,14 +35,14 @@ type Comparator<T> = (left: T, right: T) => number;
 
 ```ts
 interface Person {
-    name: string;
-    age: number;
+ name: string;
+ age: number;
 }
 ```
 
 ```ts
 interface Comparator<T> {
-    (left: T, right: T): number;
+ (left: T, right: T): number;
 }
 ```
 
@@ -59,17 +59,17 @@ Use instead: [`@typescript-eslint/consistent-type-definitions`](https://typescri
 
 ```ts
 type Options = [
-    {
-        allowIntersection?: boolean;
-        allowLocal?: boolean;
-    }?,
+ {
+  allowIntersection?: boolean;
+  allowLocal?: boolean;
+ }?,
 ];
 ```
 
 ### Default configuration
 
 ```ts
-[{}]
+[{}];
 ```
 
 Effective behavior with defaults:
@@ -89,11 +89,11 @@ With `allowIntersection: false`:
 
 ```ts
 interface Name {
-    name: string;
+ name: string;
 }
 
 interface Age {
-    age: number;
+ age: number;
 }
 
 type User = Name & Age;
@@ -103,11 +103,11 @@ is converted to:
 
 ```ts
 interface Name {
-    name: string;
+ name: string;
 }
 
 interface Age {
-    age: number;
+ age: number;
 }
 
 interface User extends Name, Age {}
@@ -119,18 +119,18 @@ interface User extends Name, Age {}
 import etcMisc from "eslint-plugin-etc-misc";
 
 export default [
+ {
+  plugins: { "etc-misc": etcMisc },
+  rules: {
+   "etc-misc/prefer-interface": [
+    "error",
     {
-        plugins: { "etc-misc": etcMisc },
-        rules: {
-            "etc-misc/prefer-interface": [
-                "error",
-                {
-                    allowIntersection: false,
-                    allowLocal: true,
-                },
-            ],
-        },
+     allowIntersection: false,
+     allowLocal: true,
     },
+   ],
+  },
+ },
 ];
 ```
 

package/docs/rules/prefer-less-than.md

@@ -23,7 +23,7 @@ visually consistent across a codebase.
 const isValid = value > min;
 
 if (value >= min && value <= max) {
-    run();
+ run();
 }
 ```
 
@@ -33,7 +33,7 @@ if (value >= min && value <= max) {
 const isValid = min < value;
 
 if (min <= value && value <= max) {
-    run();
+ run();
 }
 ```
 
@@ -51,12 +51,12 @@ operator:
 
 ```ts
 if (score >= threshold) {
-    pass();
+ pass();
 }
 // ❌ reported and auto-fixable to `threshold <= score`
 
 if (threshold <= score) {
-    pass();
+ pass();
 }
 // ✅ valid
 ```
@@ -67,12 +67,12 @@ if (threshold <= score) {
 import etcMisc from "eslint-plugin-etc-misc";
 
 export default [
-    {
-        plugins: { "etc-misc": etcMisc },
-        rules: {
-            "etc-misc/prefer-less-than": "error",
-        },
-    },
+ {
+  plugins: { "etc-misc": etcMisc },
+  rules: {
+   "etc-misc/prefer-less-than": "error",
+  },
+ },
 ];
 ```
 

package/docs/rules/prefer-object-has-own.md

@@ -52,12 +52,12 @@ Object.hasOwn(config, "port");
 import etcMisc from "eslint-plugin-etc-misc";
 
 export default [
-    {
-        plugins: { "etc-misc": etcMisc },
-        rules: {
-            "etc-misc/prefer-object-has-own": "error",
-        },
-    },
+ {
+  plugins: { "etc-misc": etcMisc },
+  rules: {
+   "etc-misc/prefer-object-has-own": "error",
+  },
+ },
 ];
 ```
 

package/docs/rules/prefer-only-export.md

@@ -59,12 +59,12 @@ export default function main() {}
 import etcMisc from "eslint-plugin-etc-misc";
 
 export default [
-    {
-        plugins: { "etc-misc": etcMisc },
-        rules: {
-            "etc-misc/prefer-only-export": "error",
-        },
-    },
+ {
+  plugins: { "etc-misc": etcMisc },
+  rules: {
+   "etc-misc/prefer-only-export": "error",
+  },
+ },
 ];
 ```
 

package/docs/rules/presets/all-strict.md

@@ -10,7 +10,7 @@ surface.
 ## Config key
 
 ```ts
-etcMisc.configs.allStrict
+etcMisc.configs.allStrict;
 ```
 
 ## Flat Config example

package/docs/rules/presets/minimal.md

@@ -0,0 +1,44 @@
+---
+title: Minimal preset
+---
+
+# 🟢 Minimal
+
+Use this preset when you want the `recommended` baseline without the
+`typescript/prefer-readonly*` rules.
+
+## Config key
+
+```ts
+etcMisc.configs.minimal;
+```
+
+## Flat Config example
+
+```ts
+import etcMisc from "eslint-plugin-etc-misc";
+
+export default [etcMisc.configs.minimal];
+```
+
+## Rules in this preset
+
+- [`etc-misc/consistent-optional-props`](../consistent-optional-props.md) (R008)
+- [`etc-misc/no-assign-mutated-array`](../no-assign-mutated-array.md) (R016)
+- [`etc-misc/no-const-enum`](../no-const-enum.md) (R021)
+- [`etc-misc/no-implicit-any-catch`](../no-implicit-any-catch.md) (R026)
+- [`etc-misc/no-internal`](../no-internal.md) (R028)
+- [`etc-misc/no-t`](../no-t.md) (R043)
+- [`etc-misc/no-unnecessary-as-const`](../no-unnecessary-as-const.md) (R045)
+- [`etc-misc/no-unnecessary-break`](../no-unnecessary-break.md) (R046)
+- [`etc-misc/no-unnecessary-initialization`](../no-unnecessary-initialization.md) (R047)
+- [`etc-misc/no-unnecessary-template-literal`](../no-unnecessary-template-literal.md) (R048)
+- [`etc-misc/throw-error`](../throw-error.md) (R074)
+- [`etc-misc/typescript/no-boolean-literal-type`](../typescript-no-boolean-literal-type.md) (R085)
+- [`etc-misc/typescript/require-readonly-array-return-type`](../typescript-require-readonly-array-return-type.md) (R116)
+- [`etc-misc/typescript/require-this-void`](../typescript-require-this-void.md) (R130)
+
+## Adoption guidance
+
+Start here if you want a pragmatic baseline before adopting readonly-style
+constraints from `recommended`.

package/docs/rules/presets/recommended.md

@@ -9,7 +9,7 @@ Use this preset as the default onboarding path for most projects.
 ## Config key
 
 ```ts
-etcMisc.configs.recommended
+etcMisc.configs.recommended;
 ```
 
 ## Flat Config example
@@ -46,6 +46,8 @@ export default [etcMisc.configs.recommended];
 
 ## Adoption guidance
 
+If you don’t want readonly preference rules yet, start with minimal. Otherwise, start here for a balanced baseline of correctness and maintainability rules. This preset is designed to be a long-term baseline, so it includes some rules that may be initially noisy but are worth fixing early for long-term benefits.
+
 This preset now enables a wider "safe baseline" mix:
 
 - strong correctness rules as `error`

package/docs/rules/presets/strict-type-checked.md

@@ -10,7 +10,7 @@ rules that require TypeScript type information.
 ## Config key
 
 ```ts
-etcMisc.configs.strictTypeChecked
+etcMisc.configs.strictTypeChecked;
 ```
 
 ## Flat Config example

package/docs/rules/presets/strict.md

@@ -10,7 +10,7 @@ enforcement.
 ## Config key
 
 ```ts
-etcMisc.configs.strict
+etcMisc.configs.strict;
 ```
 
 ## Flat Config example