@simplysm/lint 13.0.100 → 14.0.4

package/README.md

@@ -1,6 +1,6 @@
 # @simplysm/lint
 
-Simplysm package - Lint configuration (ESLint). Provides an ESLint plugin with custom rules and a recommended flat config for TypeScript, SolidJS, and Tailwind CSS projects.
+Shared ESLint plugin and recommended configuration for Simplysm projects.
 
 ## Installation
 
@@ -10,62 +10,89 @@ npm install @simplysm/lint
 
 ## Entrypoints
 
-This package has two entrypoints:
+### `@simplysm/lint/eslint-plugin`
 
-| Entrypoint | Import Path | Description |
-|------------|-------------|-------------|
-| ESLint Plugin | `@simplysm/lint/eslint-plugin` | Custom ESLint rules |
-| Recommended Config | `@simplysm/lint/eslint-recommended` | Full recommended flat config |
+ESLint plugin providing 7 custom rules for Angular/TypeScript projects.
 
-## API Overview
+```typescript
+import plugin from "@simplysm/lint/eslint-plugin";
+```
 
-### ESLint Plugin (`@simplysm/lint/eslint-plugin`)
+Default export: `{ rules: { ... } }`
 
-Default export is an ESLint plugin object with `rules`:
+#### Rules
 
 | Rule | Type | Fixable | Description |
-|------|------|---------|-------------|
-| `no-hard-private` | problem | Yes | Enforces TypeScript `private _` style instead of hard private fields (`#`). Auto-fixes `#field` to `private _field` and `this.#field` to `this._field`. |
-| `no-subpath-imports-from-simplysm` | problem | Yes | Prohibits `src` subpath imports from `@simplysm/*` packages (e.g., `@simplysm/pkg/src/x` is prohibited). Auto-fixes to package root import. |
-| `ts-no-throw-not-implemented-error` | suggestion | No | Warns about `NotImplementedError` usage from `@simplysm/core-common`. Detects named, aliased, and namespace imports. |
+|---|---|---|---|
+| `ng-template-no-todo-comments` | problem | no | Warn on TODO comments inside Angular HTML templates |
+| `ng-template-sd-require-binding-attrs` | problem | yes | Disallow non-whitelisted plain attributes on `sd-*` prefixed components; require Angular property bindings instead |
+| `no-hard-private` | problem | yes | Disallow ES hard private fields (`#field`); require TypeScript `private _field` style instead |
+| `no-subpath-imports-from-simplysm` | problem | yes | Disallow importing from `@simplysm/*/src/*` subpaths (use package entrypoints) |
+| `ts-no-throw-not-implemented-error` | suggestion | no | Warn on `NotImplementedError` usage (indicates unfinished implementation) |
+| `ts-no-unused-injects` | problem | yes | Disallow unused Angular `inject()` fields |
+| `ts-no-unused-protected-readonly` | problem | yes | Disallow unused `protected readonly` fields in Angular components |
 
-### Recommended Config (`@simplysm/lint/eslint-recommended`)
+### `@simplysm/lint/eslint-recommended`
 
-Default export is a full ESLint flat config array that includes:
+Pre-configured ESLint flat config for Simplysm projects.
 
-- **Global ignores**: `node_modules`, `dist`, dotfiles, underscore-prefixed directories
-- **JS/JSX rules**: Common rules + unused imports + import dependency checks + custom `@simplysm` rules
-- **TS/TSX rules**: TypeScript-specific rules (strict boolean expressions, no floating promises, prefer readonly, etc.) + all JS rules
-- **Test overrides**: Relaxed rules for `tests/` and `tests-e2e/` directories (allows console, no extraneous deps check)
-- **SolidJS rules**: No destructure, components-return-once, no-innerhtml, prefer-for, etc.
-- **Tailwind CSS rules**: Classnames order, enforces shorthand, no contradicting classname, no custom classname
+```typescript
+import recommended from "@simplysm/lint/eslint-recommended";
+```
 
-#### Included Plugins
+Default export: a complete ESLint flat config array (from `tseslint.config()`).
 
-| Plugin | Prefix | Purpose |
-|--------|--------|---------|
-| `@typescript-eslint` | `@typescript-eslint/` | TypeScript type-aware linting |
-| `@simplysm` (this package) | `@simplysm/` | Custom Simplysm rules |
-| `eslint-plugin-import` | `import/` | Import/export validation |
-| `eslint-plugin-unused-imports` | `unused-imports/` | Auto-remove unused imports |
-| `eslint-plugin-solid` | `solid/` | SolidJS best practices |
-| `eslint-plugin-tailwindcss` | `tailwindcss/` | Tailwind CSS class validation |
+#### Included Configurations
 
-## Usage Examples
+- `angular-eslint` template recommended + accessibility
+- `typescript-eslint` recommended rules
+- `eslint-plugin-import` (extraneous dependency checking)
+- `eslint-plugin-unused-imports` (auto-remove unused imports)
+- All 7 `@simplysm/lint/eslint-plugin` rules
 
-### Use the recommended config
+#### Key Rules Enabled
 
-```typescript
-// eslint.config.ts
+- `eqeqeq` (always, null-ignore)
+- `no-console` (error in .ts files)
+- `@typescript-eslint/require-await`, `await-thenable`, `no-floating-promises`
+- `@typescript-eslint/strict-boolean-expressions` (nullable boolean/object allowed)
+- `@typescript-eslint/prefer-readonly`
+- `@typescript-eslint/no-unnecessary-condition`
+- Bans `Buffer`, `events`, `eventemitter3` imports
+- Test files (`**/tests/**/*.ts`): relaxes `no-console`, `import/no-extraneous-dependencies`, `ts-no-throw-not-implemented-error`
+
+#### File Patterns
+
+| Pattern | Applied Rules |
+|---|---|
+| `**/*.js`, `**/*.mjs`, `**/*.cjs` | Common rules + import checks + unused imports + no-hard-private + no-subpath-imports |
+| `**/*.ts` | Full TypeScript rules + Angular rules + all custom rules |
+| `**/*.html` | Angular template rules (no-todo-comments, sd-require-binding-attrs) |
+| `**/tests/**/*.ts` | Relaxed rules (no-console off, extraneous deps off) |
+
+#### Ignored Patterns
+
+- `**/node_modules/**`
+- `**/dist/**`
+- `**/.*/**`
+- `**/_*/**`
+
+## Usage
+
+### eslint.config.js
+
+```javascript
 import recommended from "@simplysm/lint/eslint-recommended";
 
-export default recommended;
+export default [
+  ...recommended,
+  // add project-specific overrides here
+];
 ```
 
-### Use the plugin with custom rules
+### Use plugin rules individually
 
-```typescript
-// eslint.config.ts
+```javascript
 import plugin from "@simplysm/lint/eslint-plugin";
 
 export default [
@@ -73,8 +100,7 @@ export default [
     plugins: { "@simplysm": plugin },
     rules: {
       "@simplysm/no-hard-private": "error",
-      "@simplysm/no-subpath-imports-from-simplysm": "error",
-      "@simplysm/ts-no-throw-not-implemented-error": "warn",
+      "@simplysm/ts-no-unused-injects": "error",
     },
   },
 ];

package/dist/eslint-plugin.d.ts

@@ -1,5 +1,11 @@
 declare const _default: {
     rules: {
+        "ng-template-no-todo-comments": import("@typescript-eslint/utils/ts-eslint").RuleModule<"noTodo", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
+            name: string;
+        };
+        "ng-template-sd-require-binding-attrs": import("@typescript-eslint/utils/ts-eslint").RuleModule<"requireBindingForAttribute", [import("./rules/ng-template-sd-require-binding-attrs").RuleOptions], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
+            name: string;
+        };
         "no-hard-private": import("@typescript-eslint/utils/ts-eslint").RuleModule<"preferSoftPrivate" | "nameConflict", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
             name: string;
         };
@@ -9,6 +15,12 @@ declare const _default: {
         "ts-no-throw-not-implemented-error": import("@typescript-eslint/utils/ts-eslint").RuleModule<"noThrowNotImplementedError", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
             name: string;
         };
+        "ts-no-unused-injects": import("@typescript-eslint/utils/ts-eslint").RuleModule<"unusedInject", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
+            name: string;
+        };
+        "ts-no-unused-protected-readonly": import("@typescript-eslint/utils/ts-eslint").RuleModule<"unusedField", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
+            name: string;
+        };
     };
 };
 export default _default;

package/dist/eslint-plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"eslint-plugin.d.ts","sourceRoot":"","sources":["../src/eslint-plugin.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAIA,wBAME"}
+{"version":3,"file":"eslint-plugin.d.ts","sourceRoot":"","sources":["../src/eslint-plugin.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAQA,wBAUE"}

package/dist/eslint-plugin.js

@@ -1,14 +1,19 @@
+import ngTemplateNoTodoComments from "./rules/ng-template-no-todo-comments.js";
+import ngTemplateSdRequireBindingAttrs from "./rules/ng-template-sd-require-binding-attrs.js";
 import noHardPrivate from "./rules/no-hard-private.js";
 import noSubpathImportsFromSimplysm from "./rules/no-subpath-imports-from-simplysm.js";
 import tsNoThrowNotImplementedError from "./rules/ts-no-throw-not-implemented-error.js";
-var eslint_plugin_default = {
-  rules: {
-    "no-hard-private": noHardPrivate,
-    "no-subpath-imports-from-simplysm": noSubpathImportsFromSimplysm,
-    "ts-no-throw-not-implemented-error": tsNoThrowNotImplementedError
-  }
+import tsNoUnusedInjects from "./rules/ts-no-unused-injects.js";
+import tsNoUnusedProtectedReadonly from "./rules/ts-no-unused-protected-readonly.js";
+export default {
+    rules: {
+        "ng-template-no-todo-comments": ngTemplateNoTodoComments,
+        "ng-template-sd-require-binding-attrs": ngTemplateSdRequireBindingAttrs,
+        "no-hard-private": noHardPrivate,
+        "no-subpath-imports-from-simplysm": noSubpathImportsFromSimplysm,
+        "ts-no-throw-not-implemented-error": tsNoThrowNotImplementedError,
+        "ts-no-unused-injects": tsNoUnusedInjects,
+        "ts-no-unused-protected-readonly": tsNoUnusedProtectedReadonly,
+    },
 };
-export {
-  eslint_plugin_default as default
-};
-//# sourceMappingURL=eslint-plugin.js.map
+//# sourceMappingURL=eslint-plugin.js.map

package/dist/eslint-plugin.js.map

@@ -1,6 +1 @@
-{
-  "version": 3,
-  "sources": ["../src/eslint-plugin.ts"],
-  "mappings": "AAAA,OAAO,mBAAmB;AAC1B,OAAO,kCAAkC;AACzC,OAAO,kCAAkC;AAEzC,IAAO,wBAAQ;AAAA,EACb,OAAO;AAAA,IACL,mBAAmB;AAAA,IACnB,oCAAoC;AAAA,IACpC,qCAAqC;AAAA,EACvC;AACF;",
-  "names": []
-}
+{"version":3,"file":"eslint-plugin.js","sourceRoot":"","sources":["../src/eslint-plugin.ts"],"names":[],"mappings":"AAAA,OAAO,wBAAwB,MAAM,sCAAsC,CAAC;AAC5E,OAAO,+BAA+B,MAAM,8CAA8C,CAAC;AAC3F,OAAO,aAAa,MAAM,yBAAyB,CAAC;AACpD,OAAO,4BAA4B,MAAM,0CAA0C,CAAC;AACpF,OAAO,4BAA4B,MAAM,2CAA2C,CAAC;AACrF,OAAO,iBAAiB,MAAM,8BAA8B,CAAC;AAC7D,OAAO,2BAA2B,MAAM,yCAAyC,CAAC;AAElF,eAAe;IACb,KAAK,EAAE;QACL,8BAA8B,EAAE,wBAAwB;QACxD,sCAAsC,EAAE,+BAA+B;QACvE,iBAAiB,EAAE,aAAa;QAChC,kCAAkC,EAAE,4BAA4B;QAChE,mCAAmC,EAAE,4BAA4B;QACjE,sBAAsB,EAAE,iBAAiB;QACzC,iCAAiC,EAAE,2BAA2B;KAC/D;CACF,CAAC"}

package/dist/eslint-recommended.d.ts

@@ -1,3 +1,4 @@
-declare const _default: import("eslint/config").Config[];
+import { type FlatConfig } from "typescript-eslint";
+declare const _default: FlatConfig.ConfigArray;
 export default _default;
 //# sourceMappingURL=eslint-recommended.d.ts.map

package/dist/eslint-recommended.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"eslint-recommended.d.ts","sourceRoot":"","sources":["../src/eslint-recommended.ts"],"names":[],"mappings":";AA+EA,wBA6MG"}
+{"version":3,"file":"eslint-recommended.d.ts","sourceRoot":"","sources":["../src/eslint-recommended.ts"],"names":[],"mappings":"AAAA,OAAiB,EAAE,KAAK,UAAU,EAAE,MAAM,mBAAmB,CAAC;;AA2D9D,wBAwJE"}