eslint-plugin-nextfriday 1.7.0 → 1.8.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # eslint-plugin-nextfriday
 
+## 1.8.0
+
+### Minor Changes
+
+- [#43](https://github.com/next-friday/eslint-plugin-nextfriday/pull/43) [`2fbee6d`](https://github.com/next-friday/eslint-plugin-nextfriday/commit/2fbee6df84009954cb99674bcdb1cb1cca3be4e6) Thanks [@nextfridaydeveloper](https://github.com/nextfridaydeveloper)! - feat(rules): add no-lazy-identifiers rule
+
+  Added a new rule `no-lazy-identifiers` that detects and disallows lazy variable names:
+  - Repeated characters (3+): `xxx`, `aaa`, `zzz`
+  - Keyboard sequences (4+): `asdf`, `qwerty`, `hjkl`, `zxcv`
+
 ## 1.7.0
 
 ### Minor Changes

package/README.md

@@ -61,6 +61,7 @@ export default [
     rules: {
       // Variable Naming
       "nextfriday/no-single-char-variables": "error",
+      "nextfriday/no-lazy-identifiers": "error",
       "nextfriday/boolean-naming-prefix": "error",
 
       // File Naming
@@ -133,6 +134,7 @@ module.exports = {
 | Rule                                                               | Description                                                           | Fixable |
 | ------------------------------------------------------------------ | --------------------------------------------------------------------- | ------- |
 | [no-single-char-variables](docs/rules/NO_SINGLE_CHAR_VARIABLES.md) | Disallow single character variable names (e.g., `d`, `u`, `l`)        | ❌      |
+| [no-lazy-identifiers](docs/rules/NO_LAZY_IDENTIFIERS.md)           | Disallow lazy identifiers like `xxx`, `asdf`, `qwerty`                | ❌      |
 | [boolean-naming-prefix](docs/rules/BOOLEAN_NAMING_PREFIX.md)       | Enforce boolean variables to have prefix (is, has, should, can, etc.) | ❌      |
 
 ### File Naming Rules
@@ -187,14 +189,14 @@ module.exports = {
 
 | Preset               | Severity | Base Rules | JSX Rules | Total Rules |
 | -------------------- | -------- | ---------- | --------- | ----------- |
-| `base`               | warn     | 16         | 0         | 16          |
-| `base/recommended`   | error    | 16         | 0         | 16          |
-| `react`              | warn     | 16         | 7         | 23          |
-| `react/recommended`  | error    | 16         | 7         | 23          |
-| `nextjs`             | warn     | 16         | 7         | 23          |
-| `nextjs/recommended` | error    | 16         | 7         | 23          |
+| `base`               | warn     | 17         | 0         | 17          |
+| `base/recommended`   | error    | 17         | 0         | 17          |
+| `react`              | warn     | 17         | 7         | 24          |
+| `react/recommended`  | error    | 17         | 7         | 24          |
+| `nextjs`             | warn     | 17         | 7         | 24          |
+| `nextjs/recommended` | error    | 17         | 7         | 24          |
 
-### Base Configuration Rules (16 rules)
+### Base Configuration Rules (17 rules)
 
 Included in `base`, `base/recommended`, and all other presets:
 
@@ -206,7 +208,7 @@ Included in `base`, `base/recommended`, and all other presets:
 - `nextfriday/no-direct-date`
 - `nextfriday/no-emoji`
 - `nextfriday/no-env-fallback`
-- `nextfriday/require-explicit-return-type`
+- `nextfriday/no-lazy-identifiers`
 - `nextfriday/no-logic-in-params`
 - `nextfriday/no-single-char-variables`
 - `nextfriday/prefer-destructuring-params`
@@ -214,6 +216,7 @@ Included in `base`, `base/recommended`, and all other presets:
 - `nextfriday/prefer-import-type`
 - `nextfriday/prefer-named-param-types`
 - `nextfriday/prefer-react-import-types`
+- `nextfriday/require-explicit-return-type`
 
 ### JSX Rules (7 rules)
 

package/docs/rules/NO_LAZY_IDENTIFIERS.md

@@ -0,0 +1,106 @@
+# no-lazy-identifiers
+
+Disallow lazy, meaningless variable names that hurt code readability.
+
+## Rule Details
+
+This rule enforces meaningful variable names by detecting and disallowing lazy identifiers. It uses pattern-based detection to find repeated characters and keyboard sequences.
+
+**Incorrect** code for this rule:
+
+```typescript
+const xxx = "value";
+const yyy = 123;
+const zzz = true;
+const aaa = [];
+
+const asdf = "keyboard pattern";
+const qwerty = "another pattern";
+
+function xxx() {
+  return 1;
+}
+
+const fn = (xxx) => xxx * 2;
+
+class aaaa {}
+
+const { xxx } = obj;
+const [aaa, bbb] = array;
+```
+
+**Correct** code for this rule:
+
+```typescript
+const userName = "john";
+const itemCount = 123;
+const isActive = true;
+const items = [];
+
+const keyboardType = "mechanical";
+const inputLayout = "us";
+
+function calculateTotal() {
+  return 1;
+}
+
+const double = (value) => value * 2;
+
+class UserService {}
+
+const { name } = obj;
+const [first, second] = array;
+```
+
+## Detection Patterns
+
+The rule detects two types of lazy patterns:
+
+### Repeated Characters (3+)
+
+Variables with 3 or more consecutive identical characters:
+
+- `xxx`, `aaa`, `zzz`, `qqqq`, `aaaa`
+
+### Keyboard Sequences (4+)
+
+Variables containing 4 or more consecutive keyboard row characters:
+
+- `asdf`, `qwerty`, `zxcv`, `hjkl`, `1234`
+- Also detects reversed sequences: `fdsa`, `lkjh`
+- Detects sequences embedded in names: `myAsdfVar`
+
+## Exceptions
+
+### Short Identifiers
+
+Identifiers shorter than 3 characters are ignored (use `no-single-char-variables` for those).
+
+### Underscore-Prefixed
+
+Variables starting with `_` are allowed (commonly used for unused variables):
+
+```typescript
+const _unused = getValue();
+```
+
+## Benefits
+
+- **Readable code**: Meaningful names make code self-documenting
+- **Maintainability**: Other developers can understand the purpose of variables
+- **Professionalism**: Clean code reflects well on the team
+- **Debugging**: Clear names make debugging easier
+
+## When Not To Use
+
+- In test files where placeholder data is acceptable
+- When working with legacy code that would be disruptive to change
+
+## Configuration
+
+This rule has no configuration options.
+
+## Related Rules
+
+- [no-single-char-variables](./NO_SINGLE_CHAR_VARIABLES.md) - Disallows single character variable names
+- [boolean-naming-prefix](./BOOLEAN_NAMING_PREFIX.md) - Enforces naming conventions for boolean variables