eslint-plugin-etc-misc 1.0.1

package/docs/rules/array-type.md

@@ -0,0 +1,82 @@
+# array-type
+
+Enforce a consistent array type syntax.
+
+## Targeted pattern scope
+
+This rule targets TypeScript array type annotations.
+
+## What this rule reports
+
+This rule reports array types that do not match the configured style.
+
+## Why this rule exists
+
+Mixing `Array<T>` and `T[]` makes signatures harder to scan and causes avoidable
+style churn.
+
+## ❌ Incorrect
+
+```ts
+type Values = Array<string>;
+```
+
+## ✅ Correct
+
+```ts
+type Values = string[];
+```
+
+## Behavior and migration notes
+
+This rule forwards options and behavior to `@typescript-eslint/array-type`.
+
+- **Lifecycle:** Deprecated and frozen.
+- **Deprecated since:** `v1.0.0`
+- **Available until:** `v2.0.0`
+- **Use instead:** [`@typescript-eslint/array-type`](https://typescript-eslint.io/rules/array-type)
+
+## Additional examples
+
+```ts
+// with default @typescript-eslint/array-type options
+type Values = Array<string>;
+// ❌ reported
+
+type ValuesFixed = string[];
+// ✅ valid
+```
+
+## ESLint flat config example
+
+```ts
+import etcMisc from "eslint-plugin-etc-misc";
+
+export default [
+    {
+        plugins: { "etc-misc": etcMisc },
+        rules: {
+            "etc-misc/array-type": "error",
+        },
+    },
+];
+```
+
+## When not to use it
+
+Disable this rule if your project intentionally allows mixed array type styles.
+
+## Package documentation
+
+- [eslint-plugin-etc-misc README](https://github.com/Nick2bad4u/eslint-plugin-etc-misc#readme)
+
+> **Rule catalog ID:** R001
+
+## Further reading
+
+- [typescript-eslint: `array-type`](https://typescript-eslint.io/rules/array-type)
+
+## Adoption resources
+
+- Start at warning level in CI, then move to error after cleanup.
+- Use focused codemods/autofix batches per package or directory.

package/docs/rules/class-match-filename.md

@@ -0,0 +1,95 @@
+# class-match-filename
+
+Require class declarations to match the current filename.
+
+## Targeted pattern scope
+
+This rule checks **named class declarations** and compares each class name to the
+current filename stem.
+
+It targets top-level class declarations in these forms:
+
+- `class Name {}`
+- `export class Name {}`
+- `export default class Name {}`
+
+Class expressions are not targeted.
+
+## What this rule reports
+
+This rule reports class declarations whose identifier does not exactly match the source filename stem.
+
+## Why this rule exists
+
+Aligning class names with file names improves discoverability and reduces rename
+drift during refactors.
+
+## ❌ Incorrect
+
+```ts
+// filename: UserService.ts
+export class AccountService {}
+```
+
+## ✅ Correct
+
+```ts
+// filename: UserService.ts
+export class UserService {}
+```
+
+## Behavior and migration notes
+
+This rule reports only and does not provide an autofix.
+
+Migration requires renaming either the class identifier or the file stem.
+
+### Options
+
+This rule has no options.
+
+## Additional examples
+
+```ts
+// filename: user-service.ts
+export default class UserService {}
+// ❌ reported (filename stem is "user-service")
+
+// filename: UserService.ts
+export default class UserService {}
+// ✅ valid
+```
+
+## ESLint flat config example
+
+```ts
+import etcMisc from "eslint-plugin-etc-misc";
+
+export default [
+    {
+        plugins: { "etc-misc": etcMisc },
+        rules: {
+            "etc-misc/class-match-filename": "error",
+        },
+    },
+];
+```
+
+## When not to use it
+
+Disable this rule if your project intentionally allows class names that do not mirror file names.
+
+## Package documentation
+
+- [eslint-plugin-etc-misc README](https://github.com/Nick2bad4u/eslint-plugin-etc-misc#readme)
+
+> **Rule catalog ID:** R002
+
+## Further reading
+
+- [TypeScript Handbook: Classes](https://www.typescriptlang.org/docs/handbook/2/classes.html)
+
+## Adoption resources
+
+- Start at warning level in CI, then move to error after cleanup.
+- Use focused codemods/autofix batches per package or directory.

package/docs/rules/comment-spacing.md

@@ -0,0 +1,131 @@
+# comment-spacing
+
+Enforce consistent blank-line spacing after comments.
+
+## Targeted pattern scope
+
+This rule inspects every comment in the file and measures the number of blank
+lines between the comment end and the next non-comment token.
+
+Expected spacing is content-aware:
+
+- **Line comments** (`// ...`) → no blank line after the comment.
+- **Single-line block comments** (`/* ... */`) → no blank line after the
+  comment.
+- **Multiline block comments** (`/* ...\n... */`) → exactly one blank line
+  after the comment.
+- **ESLint directive block comments** (for example `/* eslint-disable */`) → no
+  blank line after the comment.
+
+## What this rule reports
+
+This rule reports comments whose trailing blank-line spacing does not match the
+expected spacing model above.
+
+The rule is auto-fixable and rewrites only the whitespace between the comment
+and the next token.
+
+## Why this rule exists
+
+Inconsistent spacing after comments makes scan-reading harder and causes noisy
+diffs. A deterministic spacing rule keeps comment blocks visually consistent
+across contributors and editors.
+
+## ❌ Incorrect
+
+```ts
+/*
+ * Renders the profile panel.
+ */
+const renderProfile = () => {
+    // ...
+};
+```
+
+```ts
+// Validate and normalize input.
+
+const normalize = (value: string) => value.trim();
+```
+
+## ✅ Correct
+
+```ts
+/*
+ * Renders the profile panel.
+ */
+
+const renderProfile = () => {
+    // ...
+};
+```
+
+```ts
+// Validate and normalize input.
+const normalize = (value: string) => value.trim();
+```
+
+## Behavior and migration notes
+
+This rule is autofixable (`fixable: "whitespace"`) and rewrites only the
+whitespace between a comment and the next token.
+
+Use `--fix-dry-run` in CI first if you want to preview spacing churn before
+mass-apply.
+
+### Options
+
+This rule has no options.
+
+## Additional examples
+
+```ts
+/* eslint-disable no-console */
+const run = () => {
+    console.log("allowed here");
+};
+```
+
+```ts
+/*
+ * This multiline explanation is intentionally separated
+ * from the code it introduces.
+ */
+
+const createTask = () => ({ id: crypto.randomUUID() });
+```
+
+## ESLint flat config example
+
+```ts
+import etcMisc from "eslint-plugin-etc-misc";
+
+export default [
+    {
+        plugins: { "etc-misc": etcMisc },
+        rules: {
+            "etc-misc/comment-spacing": "error",
+        },
+    },
+];
+```
+
+## When not to use it
+
+Disable this rule if your formatter or style guide intentionally uses different
+post-comment spacing conventions.
+
+## Package documentation
+
+- [eslint-plugin-etc-misc README](https://github.com/Nick2bad4u/eslint-plugin-etc-misc#readme)
+
+> **Rule catalog ID:** R003
+
+## Further reading
+
+- [ESLint: `spaced-comment`](https://eslint.org/docs/latest/rules/spaced-comment)
+
+## Adoption resources
+
+- Start at warning level in CI, then move to error after cleanup.
+- Use focused codemods/autofix batches per package or directory.

package/docs/rules/consistent-empty-lines.md

@@ -0,0 +1,104 @@
+# consistent-empty-lines
+
+Enforce configured empty-line consistency between selected nodes.
+
+## Targeted pattern scope
+
+This rule operates on the full file text and checks for runs of empty lines.
+
+It allows:
+
+- zero empty lines, or
+- exactly one empty line between non-empty lines.
+
+It reports when it finds **two or more consecutive empty lines**.
+
+## What this rule reports
+
+This rule reports files containing consecutive blank-line runs longer than one
+line.
+
+An autofix is provided and collapses each run to a single blank line.
+
+## Why this rule exists
+
+Extra vertical whitespace often accumulates during edits and merge conflict
+resolution. Enforcing a single-blank-line maximum keeps files visually dense and
+reduces noisy formatting diffs.
+
+## ❌ Incorrect
+
+```ts
+const first = 1;
+
+
+const second = 2;
+```
+
+## ✅ Correct
+
+```ts
+const first = 1;
+
+const second = 2;
+```
+
+## Behavior and migration notes
+
+This rule is fully autofixable (`fixable: "whitespace"`).
+
+Recommended rollout:
+
+1. Run once with `--fix-dry-run` to estimate churn.
+2. Apply autofix in a dedicated formatting PR.
+3. Enable as `error` to keep the baseline clean.
+
+### Options
+
+This rule has no options.
+
+## Additional examples
+
+```ts
+function run(): void {
+    stepOne();
+
+    stepTwo();
+}
+```
+
+## ESLint flat config example
+
+```ts
+import etcMisc from "eslint-plugin-etc-misc";
+
+export default [
+    {
+        plugins: { "etc-misc": etcMisc },
+        rules: {
+            "etc-misc/consistent-empty-lines": "error",
+        },
+    },
+];
+```
+
+## When not to use it
+
+Disable this rule if your style guide intentionally allows multiple blank lines
+for sectioning or if another formatter already controls vertical spacing exactly
+as desired.
+
+## Package documentation
+
+- [eslint-plugin-etc-misc README](https://github.com/Nick2bad4u/eslint-plugin-etc-misc#readme)
+
+> **Rule catalog ID:** R004
+
+## Further reading
+
+- [ESLint: `no-multiple-empty-lines`](https://eslint.org/docs/latest/rules/no-multiple-empty-lines)
+
+## Adoption resources
+
+- Start at warning level in CI, then move to error after cleanup.
+- Use focused codemods/autofix batches per package or directory.

package/docs/rules/consistent-enum-members.md

@@ -0,0 +1,112 @@
+# consistent-enum-members
+
+Enforce consistent enum member naming/value casing.
+
+## Targeted pattern scope
+
+This rule analyzes TypeScript `TSEnumMember` nodes and validates naming for:
+
+- enum member identifiers (for example `ACTIVE_USER`), and
+- string literal member values when provided.
+
+It enforces SCREAMING_SNAKE_CASE in both places.
+
+## What this rule reports
+
+This rule reports enum members when **neither** of these matches
+SCREAMING_SNAKE_CASE:
+
+- the member identifier name, or
+- the string literal initializer value.
+
+In other words, the current implementation accepts a member if either side is
+already SCREAMING_SNAKE_CASE.
+
+## Why this rule exists
+
+Enums often feed API payloads, persistence layers, and feature flags. Mixed
+casing (`camelCase`, `PascalCase`, kebab-case) creates drift between modules.
+Standardizing enum casing lowers conversion glue and helps grepability.
+
+## ❌ Incorrect
+
+```ts
+enum Status {
+    pendingApproval = "PENDING_APPROVAL",
+    ACTIVE_USER = "active_user",
+}
+```
+
+## ✅ Correct
+
+```ts
+enum Status {
+    PENDING_APPROVAL = "PENDING_APPROVAL",
+    ACTIVE_USER = "ACTIVE_USER",
+}
+```
+
+## Behavior and migration notes
+
+This rule reports only and does not provide an autofix.
+
+### Options
+
+This rule has no options.
+
+## Additional examples
+
+```ts
+enum EventType {
+    USER_CREATED,
+    USER_DELETED,
+}
+```
+
+```ts
+enum Permission {
+    READ_ONLY = "READ_ONLY",
+    READ_WRITE = "READ_WRITE",
+}
+```
+
+```ts
+enum Partial {
+    USER_CREATED = "user_created",
+}
+// ✅ currently accepted (name matches SCREAMING_SNAKE_CASE)
+
+## ESLint flat config example
+
+```ts
+import etcMisc from "eslint-plugin-etc-misc";
+
+export default [
+    {
+        plugins: { "etc-misc": etcMisc },
+        rules: {
+            "etc-misc/consistent-enum-members": "error",
+        },
+    },
+];
+```
+
+## When not to use it
+
+Disable this rule if your project intentionally uses enum names/values that must
+mirror external schemas with different casing requirements.
+
+## Package documentation
+
+- [eslint-plugin-etc-misc README](https://github.com/Nick2bad4u/eslint-plugin-etc-misc#readme)
+
+> **Rule catalog ID:** R005
+
+## Further reading
+
+- [TypeScript handbook: `enum`s](https://www.typescriptlang.org/docs/handbook/enums.html)
+
+## Adoption resources
+
+- Start at warning level in CI, then move to error after cleanup.
+- Use focused codemods/autofix batches per package or directory.

package/docs/rules/consistent-filename.md

@@ -0,0 +1,116 @@
+# consistent-filename
+
+Enforce filename casing consistency.
+
+## Targeted pattern scope
+
+This rule validates the current file’s stem (filename without extension) against
+one configured casing format.
+
+## What this rule reports
+
+This rule reports a file when its stem is not already in the configured casing.
+
+Supported casing formats:
+
+- `camelCase`
+- `kebab-case` (default)
+- `PascalCase`
+
+## Why this rule exists
+
+Consistent file naming reduces navigation friction and prevents style drift
+across packages.
+
+## ❌ Incorrect
+
+```ts
+// filename: user_service.ts
+export const value = 1;
+// ❌ with default format "kebab-case"
+```
+
+## ✅ Correct
+
+```ts
+// filename: user-service.ts
+export const value = 1;
+```
+
+## Deprecated
+
+- **Lifecycle:** Deprecated and frozen.
+- **Deprecated since:** `v1.0.0`
+- **Available until:** `v2.0.0`
+- **Use instead:** [`unicorn/filename-case`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/filename-case.md)
+
+## Behavior and migration notes
+
+This rule is deprecated in favor of `unicorn/filename-case`.
+
+It reports only and does not provide an autofix.
+
+### Options
+
+```ts
+type Options = [
+    {
+        format?: "camelCase" | "kebab-case" | "PascalCase";
+    },
+];
+```
+
+Default:
+
+```ts
+{ format: "kebab-case" }
+```
+
+### Status
+
+Use the **Deprecated** section above for lifecycle details.
+
+## Additional examples
+
+```ts
+// filename: dataLoader.ts
+// ✅ valid with { format: "camelCase" }
+
+// filename: DataLoader.ts
+// ✅ valid with { format: "PascalCase" }
+```
+
+## ESLint flat config example
+
+```ts
+import etcMisc from "eslint-plugin-etc-misc";
+
+export default [
+    {
+        plugins: { "etc-misc": etcMisc },
+        rules: {
+            "etc-misc/consistent-filename": "error",
+        },
+    },
+];
+```
+
+## When not to use it
+
+Disable this rule if your repository intentionally mixes naming styles by
+directory or if you are already standardizing on `unicorn/filename-case`.
+
+## Package documentation
+
+- [eslint-plugin-etc-misc README](https://github.com/Nick2bad4u/eslint-plugin-etc-misc#readme)
+
+> **Rule catalog ID:** R006
+
+## Further reading
+
+- [eslint-plugin-unicorn: filename-case](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/filename-case.md)
+
+## Adoption resources
+
+- Start at warning level in CI, then move to error after cleanup.
+- Use focused codemods/autofix batches per package or directory.