@ethlete/eslint-plugin 0.1.0-next.0 → 0.1.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.1.0-next.1
+
+### Patch Changes
+
+- [`6ec51b4`](https://github.com/ethlete-io/ethdk/commit/6ec51b49497ba53bf34ec0aabcf519957ba0e412) Thanks [@TomTomB](https://github.com/TomTomB)! - Fix plugin not including js files
+
 ## 0.1.0-next.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethlete/eslint-plugin",
-  "version": "0.1.0-next.0",
+  "version": "0.1.0-next.1",
   "license": "MIT",
   "type": "commonjs",
   "main": "./src/index.js",
@@ -9,6 +9,5 @@
     "@typescript-eslint/eslint-plugin": ">=8.0.0",
     "eslint": ">=9.0.0",
     "tslib": "2.8.1"
-  },
-  "types": "./src/index.d.ts"
-}
+  }
+}

package/src/configs/recommended.js

@@ -0,0 +1,362 @@
+// @ts-check
+'use strict';
+
+/**
+ * Flat config entries for TypeScript files.
+ * Covers all lintable rules from the Ethlete styleguide.
+ *
+ * @type {import('eslint').Linter.Config}
+ */
+const recommendedTs = {
+  files: ['**/*.ts'],
+  plugins: {
+    // The plugin itself is injected by the caller (see index.js)
+  },
+  rules: {
+    // ── TypeScript ──────────────────────────────────────────────────────────
+
+    // No interface — use type
+    '@typescript-eslint/consistent-type-definitions': ['error', 'type'],
+
+    // No any
+    '@typescript-eslint/no-explicit-any': 'error',
+
+    // No declared-but-never-read variables, parameters, or imports
+    // Args prefixed with _ are exempt (intentionally unused callback params)
+    'no-unused-vars': 'off', // disabled in favour of the TS-aware version below
+    '@typescript-eslint/no-unused-vars': [
+      'error',
+      {
+        vars: 'all',
+        args: 'all',
+        argsIgnorePattern: '^_',
+        caughtErrors: 'all',
+        caughtErrorsIgnorePattern: '^_',
+        ignoreRestSiblings: true,
+      },
+    ],
+
+    // ── Naming & formatting ─────────────────────────────────────────────────
+
+    // No var
+    'no-var': 'error',
+
+    // No unnecessary let — default to const
+    'prefer-const': 'error',
+
+    // Never declare multiple variables in one statement
+    'one-var': ['error', 'never'],
+
+    // Always === / !==
+    eqeqeq: ['error', 'always'],
+
+    // Max two function parameters
+    'max-params': ['error', 2],
+
+    // No _ or # prefixes; enforce camelCase / PascalCase / UPPER_CASE
+    '@typescript-eslint/naming-convention': [
+      'error',
+      {
+        selector: 'default',
+        leadingUnderscore: 'forbid',
+        trailingUnderscore: 'forbid',
+        format: null,
+      },
+      // Allow any format for object literal properties that require quotes
+      // (e.g. Angular host binding keys: '[class.foo]', '(click)', '[attr.aria-label]')
+      {
+        selector: 'objectLiteralProperty',
+        modifiers: ['requiresQuotes'],
+        format: null,
+      },
+      {
+        selector: ['variable', 'parameter', 'property', 'parameterProperty', 'accessor'],
+        leadingUnderscore: 'forbid',
+        trailingUnderscore: 'forbid',
+        format: ['camelCase', 'UPPER_CASE', 'PascalCase'],
+      },
+      {
+        selector: 'typeLike',
+        leadingUnderscore: 'forbid',
+        trailingUnderscore: 'forbid',
+        format: ['PascalCase'],
+      },
+      // Generic type parameters must be T-prefixed: TValue, TResult — never bare T
+      {
+        selector: 'typeParameter',
+        leadingUnderscore: 'forbid',
+        trailingUnderscore: 'forbid',
+        prefix: ['T'],
+        format: ['PascalCase'],
+      },
+      {
+        selector: 'enumMember',
+        leadingUnderscore: 'forbid',
+        trailingUnderscore: 'forbid',
+        format: ['UPPER_CASE', 'PascalCase'],
+      },
+    ],
+
+    // ── Banned syntax ───────────────────────────────────────────────────────
+
+    'no-restricted-syntax': [
+      'error',
+      // No enum — use const object + derived union type
+      {
+        selector: 'TSEnumDeclaration',
+        message: 'No enums. Use a const object + derived union type instead.',
+      },
+      // No standalone function declarations / expressions — use arrow functions
+      {
+        selector: 'FunctionDeclaration',
+        message: 'No function declarations. Use arrow functions instead.',
+      },
+      {
+        selector: "FunctionExpression:not([parent.type='Property']):not([parent.type='MethodDefinition'])",
+        message: 'No function expressions outside of object methods or class methods. Use arrow functions.',
+      },
+      // No arrow properties in classes — use regular methods
+      {
+        selector: 'PropertyDefinition > ArrowFunctionExpression',
+        message: 'No arrow function properties in classes. Use regular methods.',
+      },
+      // No async/await — use RxJS
+      {
+        selector: 'FunctionDeclaration[async=true]',
+        message: 'No async/await. Use RxJS for all async operations.',
+      },
+      {
+        selector: 'ArrowFunctionExpression[async=true]',
+        message: 'No async/await. Use RxJS for all async operations.',
+      },
+      {
+        selector: 'FunctionExpression[async=true]',
+        message: 'No async/await. Use RxJS for all async operations.',
+      },
+      // No public keyword on class members
+      {
+        selector: "MethodDefinition[accessibility='public']",
+        message: 'No public keyword on class members.',
+      },
+      // No static class members
+      {
+        selector: 'MethodDefinition[static=true]',
+        message: 'No static class members.',
+      },
+      {
+        selector: 'PropertyDefinition[static=true]',
+        message: 'No static class members.',
+      },
+      // No # prefix — use private keyword
+      {
+        selector: "PropertyDefinition[key.type='PrivateIdentifier']",
+        message: 'No # prefix on class members. Use the private keyword instead.',
+      },
+      {
+        selector: "MethodDefinition[key.type='PrivateIdentifier']",
+        message: 'No # prefix on class members. Use the private keyword instead.',
+      },
+      // No constructor injection — use inject()
+      {
+        selector: 'TSParameterProperty[accessibility]',
+        message: 'No constructor injection. Use inject() instead.',
+      },
+      // No legacy Angular lifecycle hooks
+      {
+        selector:
+          'MethodDefinition[key.name=/^ngOnChanges$|^ngAfterViewInit$|^ngAfterContentInit$|^ngAfterContentChecked$|^ngAfterViewChecked$|^ngDoCheck$/]',
+        message:
+          'No legacy Angular lifecycle hooks. Use afterNextRender, inject(DestroyRef).onDestroy, or constructor-based effects instead.',
+      },
+      // No @Injectable — use createRootProvider / createProvider from @ethlete/core
+      {
+        selector: "Decorator[expression.callee.name='Injectable'], Decorator[expression.name='Injectable']",
+        message: 'No @Injectable services. Use createRootProvider / createProvider from @ethlete/core instead.',
+      },
+      // No route guards — handle access control inside the component itself
+      {
+        selector:
+          'TSClassImplements > Identifier.expression[name=/^CanActivate$|^CanDeactivate$|^CanActivateChild$|^CanMatch$|^CanLoad$/]',
+        message: 'No route guards. Handle access control inside the component itself.',
+      },
+      // No route resolvers — use the query library to fetch data
+      {
+        selector: "TSClassImplements > Identifier.expression[name='Resolve']",
+        message: 'No route resolvers. Use the query library to fetch data instead.',
+      },
+      // No barrel imports — import directly from the source file
+      {
+        selector: 'ImportDeclaration[source.value=/(^|[/])index$/]',
+        message:
+          'No barrel imports (index files). Import directly from the source file to avoid breaking lazy loading.',
+      },
+    ],
+
+    // ── Native DOM globals ──────────────────────────────────────────────────
+
+    // No direct document/window access — use inject(DOCUMENT) / inject(WINDOW) instead
+    'no-restricted-globals': [
+      'error',
+      {
+        name: 'document',
+        message: "Use inject(DOCUMENT) from '@angular/common' instead of the global document.",
+      },
+      {
+        name: 'window',
+        message: 'Avoid accessing the global window directly. Use platform detection or a dedicated injection token.',
+      },
+    ],
+
+    // ── Custom plugin rules ─────────────────────────────────────────────────
+
+    // No inject(X).member chaining — assign to a const first
+    'ethlete/no-inject-chain': 'error',
+
+    // No public properties except explicit injected external APIs
+    'ethlete/no-public-property': 'error',
+
+    // No explicit trivial return types TypeScript can infer
+    'ethlete/no-trivial-return-type': 'error',
+
+    // Empty line required before return in multi-statement if-blocks (guard clauses)
+    'ethlete/guard-return-newline': 'error',
+
+    // No code in subscribe() callbacks — use tap() instead
+    'ethlete/no-subscribe-with-body': 'error',
+
+    // Observable variables/properties must end with $
+    'ethlete/require-dollar-suffix': 'error',
+
+    // No .subscribe() inside a .pipe() callback
+    'ethlete/no-subscribe-in-pipe': 'error',
+
+    // No .subscribe() inside effect() or computed()
+    'ethlete/no-rxjs-in-effect': 'error',
+
+    // No readonly on reactive class properties (signals, inputs, computed, inject, etc.)
+    'ethlete/no-readonly-signal': 'error',
+
+    // No SCREAMING_CASE variable names inside function bodies
+    'ethlete/no-screaming-case-local': 'error',
+
+    // Prefer RxJS timer/interval/fromEvent over setTimeout/setInterval/addEventListener
+    'ethlete/prefer-rxjs-timer': 'error',
+
+    // Prefer linkedSignal over signal + .set() inside effect()
+    'ethlete/prefer-linked-signal': 'warn',
+
+    // No trivial wrapper methods that only forward all args to another call
+    'ethlete/no-trivial-wrapper-method': 'error',
+
+    // No direct DOM manipulation — use injectRenderer() from @ethlete/core instead
+    'ethlete/no-direct-dom-manipulation': 'error',
+
+    // No raw IntersectionObserver / MutationObserver / ResizeObserver — use @ethlete/core signal utils
+    'ethlete/no-native-observers': 'error',
+
+    // Prefer injectViewportSize() over window.innerWidth / innerHeight / outerWidth / outerHeight
+    'ethlete/prefer-viewport-size': 'warn',
+
+    // Prefer injectMediaQueryIsMatched() / injectBreakpointIsMatched() etc. over .matchMedia()
+    'ethlete/prefer-match-media': 'error',
+
+    // Prefer signalElementDimensions() / signalHostElementDimensions() in reactive contexts
+    'ethlete/prefer-element-dimensions': 'warn',
+
+    // Prefer signalElementScrollState() / signalHostElementScrollState() in reactive contexts
+    'ethlete/prefer-scroll-state': 'warn',
+
+    // No `import type { Foo }` or `import { type Foo }` — use regular value imports
+    'ethlete/no-type-only-import': 'error',
+
+    // No legacy Angular decorators — use signal-based APIs (input, output, viewChild, etc.)
+    // and host: {} bindings (instead of @HostBinding / @HostListener)
+    'ethlete/no-legacy-angular-decorators': 'error',
+
+    // No Angular Title/Meta services — use @ethlete/core SEO utilities instead
+    // (injectTitleBinding, injectMetaBinding, injectLinkBinding, etc.)
+    'ethlete/no-angular-seo-services': 'error',
+
+    // No JSON.parse(JSON.stringify()), structuredClone, or lodash cloneDeep / isEqual
+    // — use clone() / equal() from '@ethlete/core' instead
+    'ethlete/prefer-clone-equal': 'error',
+
+    // No direct document.cookie access
+    // — use getCookie / setCookie / hasCookie / deleteCookie from '@ethlete/core' instead
+    'ethlete/no-document-cookie': 'error',
+
+    // Injected providers must be private by default, and protected only when
+    // referenced from an Angular template or host binding.
+    'ethlete/inject-member-accessibility': 'error',
+
+    // No ActivatedRoute (fully replaced by inject* router utilities from @ethlete/core)
+    // No inject(Router) for state reading — use injectUrl/injectRoute/injectQueryParam etc.
+    'ethlete/no-angular-router-api': 'warn',
+
+    // No window.location.* reads for URL state — use injectUrl/injectRoute/injectQueryParam etc.
+    // No new URLSearchParams(window.location.search) — use injectQueryParams()
+    'ethlete/no-window-location': 'warn',
+
+    // No inject(LOCALE_ID) — use injectLocale() from '@ethlete/core'
+    'ethlete/no-locale-id': 'error',
+
+    // No class members that are pure aliases for a nested property of another member
+    // — widen the accessibility of the source member instead
+    'ethlete/no-member-alias': 'error',
+
+    // No declared-but-never-read private/protected class members
+    'ethlete/no-unused-class-member': 'error',
+
+    // No direct DOM query methods (querySelector, getElementById, etc.)
+    // — use viewChild() / viewChildren() or contentChild() / contentChildren() instead
+    'ethlete/no-dom-query': 'error',
+
+    // ── Angular outputs ─────────────────────────────────────────────────────
+
+    // No on-prefixed outputs (onSelectDate → selectDate)
+    '@angular-eslint/no-output-on-prefix': 'error',
+
+    // No outputs named after native DOM events (change, click, etc.)
+    '@angular-eslint/no-output-native': 'error',
+
+    // ── Angular components ──────────────────────────────────────────────────
+
+    // Always use ChangeDetectionStrategy.OnPush
+    '@angular-eslint/prefer-on-push-component-change-detection': 'error',
+
+    // Always use ViewEncapsulation.None (angular-eslint's use-component-view-encapsulation does the
+    // opposite — it disallows None, so we use our own custom rule instead)
+    'ethlete/require-view-encapsulation-none': 'error',
+
+    // Keep Angular @Component / @Directive metadata in a consistent order
+    'ethlete/angular-decorator-property-order': 'error',
+
+    // Prefer shorthand hostDirectives entries and keep extended host directive configs ordered
+    'ethlete/prefer-concise-angular-host-directives': 'error',
+
+    // Prefer concise Angular style metadata when there is only one entry
+    'ethlete/prefer-concise-angular-style-metadata': 'error',
+
+    // No logic in pipe transform — assign to an external utility function instead
+    'ethlete/no-pipe-logic': 'error',
+
+    // Routing components must use paths containing "-view" and class names ending in "ViewComponent"
+    'ethlete/enforce-routing-view-naming': 'error',
+  },
+};
+
+/**
+ * Flat config entries for Angular HTML template files.
+ * @type {import('eslint').Linter.Config}
+ */
+const recommendedTemplate = {
+  files: ['**/*.html'],
+  rules: {
+    // No $any() in templates
+    '@angular-eslint/template/no-any': 'error',
+    // Prefer plain attribute over unnecessary property binding for static strings: etIcon="foo" not [etIcon]="'foo'"
+    '@angular-eslint/template/prefer-static-string-properties': 'error',
+  },
+};
+
+module.exports = { recommendedTs, recommendedTemplate };

package/src/index.js

@@ -0,0 +1,116 @@
+// @ts-check
+'use strict';
+
+const noInjectChain = require('./rules/no-inject-chain');
+const noTrivialReturnType = require('./rules/no-trivial-return-type');
+const noSubscribeInPipe = require('./rules/no-subscribe-in-pipe');
+const noRxjsInEffect = require('./rules/no-rxjs-in-effect');
+const noReadonlySignal = require('./rules/no-readonly-signal');
+const noScreamingCaseLocal = require('./rules/no-screaming-case-local');
+const preferRxjsTimer = require('./rules/prefer-rxjs-timer');
+const preferLinkedSignal = require('./rules/prefer-linked-signal');
+const noTrivialWrapperMethod = require('./rules/no-trivial-wrapper-method');
+const noDirectDomManipulation = require('./rules/no-direct-dom-manipulation');
+const noNativeObservers = require('./rules/no-native-observers');
+const preferViewportSize = require('./rules/prefer-viewport-size');
+const preferMatchMedia = require('./rules/prefer-match-media');
+const preferElementDimensions = require('./rules/prefer-element-dimensions');
+const preferScrollState = require('./rules/prefer-scroll-state');
+const noTypeOnlyImport = require('./rules/no-type-only-import');
+const guardReturnNewline = require('./rules/guard-return-newline');
+const noSubscribeWithBody = require('./rules/no-subscribe-with-body');
+const requireDollarSuffix = require('./rules/require-dollar-suffix');
+const noPipeLogic = require('./rules/no-pipe-logic');
+const enforceRoutingViewNaming = require('./rules/enforce-routing-view-naming');
+const requireViewEncapsulationNone = require('./rules/require-view-encapsulation-none');
+const noLegacyAngularDecorators = require('./rules/no-legacy-angular-decorators');
+const noAngularSeoServices = require('./rules/no-angular-seo-services');
+const preferCloneEqual = require('./rules/prefer-clone-equal');
+const noDocumentCookie = require('./rules/no-document-cookie');
+const injectMemberAccessibility = require('./rules/inject-member-accessibility');
+const noPublicProperty = require('./rules/no-public-property');
+const noAngularRouterApi = require('./rules/no-angular-router-api');
+const noWindowLocation = require('./rules/no-window-location');
+const noLocaleId = require('./rules/no-locale-id');
+const noMemberAlias = require('./rules/no-member-alias');
+const noUnusedClassMember = require('./rules/no-unused-class-member');
+const noDomQuery = require('./rules/no-dom-query');
+const angularDecoratorPropertyOrder = require('./rules/angular-decorator-property-order');
+const preferConciseAngularHostDirectives = require('./rules/prefer-concise-angular-host-directives');
+const preferConciseAngularStyleMetadata = require('./rules/prefer-concise-angular-style-metadata');
+const { recommendedTs, recommendedTemplate } = require('./configs/recommended');
+
+/** @type {import('eslint').ESLint.Plugin} */
+const plugin = {
+  meta: {
+    name: '@ethlete/eslint-plugin',
+    version: '0.0.1',
+  },
+  rules: {
+    'no-inject-chain': noInjectChain,
+    'no-trivial-return-type': noTrivialReturnType,
+    'no-subscribe-in-pipe': noSubscribeInPipe,
+    'no-rxjs-in-effect': noRxjsInEffect,
+    'no-readonly-signal': noReadonlySignal,
+    'no-screaming-case-local': noScreamingCaseLocal,
+    'prefer-rxjs-timer': preferRxjsTimer,
+    'prefer-linked-signal': preferLinkedSignal,
+    'no-trivial-wrapper-method': noTrivialWrapperMethod,
+    'no-direct-dom-manipulation': noDirectDomManipulation,
+    'no-native-observers': noNativeObservers,
+    'prefer-viewport-size': preferViewportSize,
+    'prefer-match-media': preferMatchMedia,
+    'prefer-element-dimensions': preferElementDimensions,
+    'prefer-scroll-state': preferScrollState,
+    'no-type-only-import': noTypeOnlyImport,
+    'guard-return-newline': guardReturnNewline,
+    'no-subscribe-with-body': noSubscribeWithBody,
+    'require-dollar-suffix': requireDollarSuffix,
+    'no-pipe-logic': noPipeLogic,
+    'enforce-routing-view-naming': enforceRoutingViewNaming,
+    'require-view-encapsulation-none': requireViewEncapsulationNone,
+    'no-legacy-angular-decorators': noLegacyAngularDecorators,
+    'no-angular-seo-services': noAngularSeoServices,
+    'prefer-clone-equal': preferCloneEqual,
+    'no-document-cookie': noDocumentCookie,
+    'inject-member-accessibility': injectMemberAccessibility,
+    'no-public-property': noPublicProperty,
+    'no-angular-router-api': noAngularRouterApi,
+    'no-window-location': noWindowLocation,
+    'no-locale-id': noLocaleId,
+    'no-member-alias': noMemberAlias,
+    'no-unused-class-member': noUnusedClassMember,
+    'no-dom-query': noDomQuery,
+    'angular-decorator-property-order': angularDecoratorPropertyOrder,
+    'prefer-concise-angular-host-directives': preferConciseAngularHostDirectives,
+    'prefer-concise-angular-style-metadata': preferConciseAngularStyleMetadata,
+  },
+};
+
+// Inject the plugin reference into the configs so consumers don't have to
+/** @type {import('eslint').Linter.Config} */
+const recommendedTsWithPlugin = {
+  ...recommendedTs,
+  plugins: { ethlete: plugin },
+};
+
+/** @type {import('eslint').Linter.Config} */
+const recommendedTemplateWithPlugin = {
+  ...recommendedTemplate,
+};
+
+const configs = {
+  /** TypeScript rules (merged into a files: ['**\/*.ts'] block) */
+  recommendedTs: recommendedTsWithPlugin,
+  /** Angular template rules (merged into a files: ['**\/*.html'] block) */
+  recommendedTemplate: recommendedTemplateWithPlugin,
+  /**
+   * Both together as a flat array — the most common usage:
+   *   export default [...baseConfig, ...ethlete.configs.recommended]
+   */
+  recommended: [recommendedTsWithPlugin, recommendedTemplateWithPlugin],
+};
+
+const ethletePlugin = { ...plugin, configs };
+
+module.exports = ethletePlugin;