@jkba/eslint-config-angular 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Jakub Meinlschmidt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,55 @@
+# eslint-config-angular
+
+Opinionated ESLint config for Angular projects
+
+
+## Installation
+
+For some unknown weird reason, following dependencies have to be installed in your project as well. (https://github.com/jmeinlschmidt/eslint-config-angular/issues/5)
+
+```sh
+npm i -D eslint-plugin-rxjs eslint-plugin-rxjs-angular
+```
+
+```sh
+npm i -D @jkba/eslint-config-angular
+```
+
+
+## Usage
+
+Extend your eslint configuration with `"@jkba/angular"`:
+
+```javascript
+// .eslintrc.json
+
+{
+  "extends": [ "@jkba/angular" ]
+}
+```
+
+Create prettier configuration file:
+
+```javascript
+// prettier.config.js
+
+module.exports = require('@jkba/eslint-config-angular/prettier.config');
+```
+
+
+### Modifying rules
+
+> :warning: Work in Progress
+
+
+## Build
+
+> :warning: Work in Progress
+
+Refer to https://eslint.org/docs/latest/extend/shareable-configs.
+
+
+## License
+
+This project is licensed under [MIT License](http://opensource.org/licenses/MIT/).
+For the full text of the license, see the [LICENSE](LICENSE) file.

package/eslint.config.js

@@ -0,0 +1,123 @@
+module.exports = {
+  overrides: [
+    {
+      files: [
+        '*.ts'
+      ],
+      parser: '@typescript-eslint/parser',
+      parserOptions: {
+        ecmaVersion: 2019,
+        project: './tsconfig.json',
+        sourceType: 'module',
+      },
+      extends: [
+        'eslint:recommended',
+        'plugin:@typescript-eslint/stylistic-type-checked',
+        'plugin:@typescript-eslint/strict-type-checked',
+        'plugin:@angular-eslint/recommended',
+        'plugin:@angular-eslint/template/process-inline-templates',
+        'plugin:rxjs/recommended', // For some unknown weird reason, this plugin needs to be installed in child project as well.
+        'plugin:import/recommended',
+        'plugin:import/typescript',
+
+        // Prettier rule must always be the very last!
+        // This rule might intentionally disable some rules declared above due to conflicts
+        'plugin:prettier/recommended',
+      ],
+      plugins: ['@typescript-eslint', '@angular-eslint', 'rxjs', 'rxjs-angular'],
+      settings: {
+        // Reference https://www.npmjs.com/package/eslint-plugin-import
+        'import/resolver': {
+          // You will also need to install and configure the TypeScript resolver
+          // See also https://github.com/import-js/eslint-import-resolver-typescript#configuration
+          'typescript': true,
+          'node': true,
+        }
+      },
+      rules: {
+        'no-warning-comments': [ 'error', { 'terms': ['todo', 'fixme'], 'location': 'anywhere' } ],
+        'no-console': 'error',
+
+        /**
+         * Declaration sort is handled by import/order rule.
+         * This rule handles order within {}-brackets only.
+         */
+        'sort-imports': [ 'error', { 'ignoreDeclarationSort': true }],
+
+        'rxjs-angular/prefer-async-pipe': 'error',
+        'rxjs-angular/prefer-composition': 'error',
+        'rxjs-angular/prefer-takeuntil': 'error',
+        
+        '@typescript-eslint/unbound-method': ['error', { ignoreStatic: true }], // Ignore `Validators.required` etc.
+        '@typescript-eslint/no-confusing-void-expression': 'off', // I just simply disagree with this rule
+        '@typescript-eslint/explicit-member-accessibility': [
+          'error', { 'overrides': { 'constructors': 'no-public' } }
+        ],
+        
+        '@angular-eslint/sort-ngmodule-metadata-arrays': 'error',
+        '@angular-eslint/prefer-on-push-component-change-detection': 'error',
+        '@angular-eslint/use-component-view-encapsulation': 'warn', // For me, it is only a suggestion
+        '@angular-eslint/prefer-output-readonly': 'error', // TODO: Not working (does nothing)
+        '@angular-eslint/contextual-decorator': 'error',
+        '@angular-eslint/component-max-inline-declarations': [ 'error', { 'template': 20 } ],
+        '@angular-eslint/contextual-decorator': 'error',
+        '@angular-eslint/no-attribute-decorator': 'error',
+        '@angular-eslint/no-conflicting-lifecycle': 'error',
+        '@angular-eslint/no-empty-lifecycle-method': 'error',
+        '@angular-eslint/no-forward-ref': 'warn', // For me, it is only a suggestion
+        '@angular-eslint/no-input-prefix': 'error',
+        '@angular-eslint/no-lifecycle-call': 'error',
+        '@angular-eslint/no-pipe-impure': 'error',
+        '@angular-eslint/no-queries-metadata-property': 'error',
+        '@angular-eslint/prefer-standalone-component': 'error',
+        '@angular-eslint/relative-url-prefix': 'error',
+        // '@angular-eslint/require-localize-metadata': 'error', // TODO: Error
+        '@angular-eslint/use-component-selector': 'error',
+        
+        'import/no-absolute-path': 'error',
+        'import/newline-after-import': [ 'error', { 'count': 1 } ],
+        'import/order': [
+          'error',
+          {
+            'groups': ['builtin', 'external', 'parent', 'sibling', 'index'],
+            'newlines-between': 'always',
+            'alphabetize': {
+              'order': 'asc',
+              'caseInsensitive': true
+            }
+          }
+        ],
+      },
+    },
+    {
+      files: [
+        '*.html'
+      ],
+      parser: '@angular-eslint/template-parser',
+      extends: [
+        'plugin:@angular-eslint/template/accessibility',
+        'plugin:@angular-eslint/template/recommended',
+
+        // Prettier rule must always be the very last!
+        // This rule might intentionally disable some rules declared above due to conflicts
+        'plugin:prettier/recommended',
+      ],
+      plugins: ['@angular-eslint/template'],
+      rules: {
+        // '@angular-eslint/template/attributes-order': 'error', // TODO: Bug present (https://github.com/angular-eslint/angular-eslint/issues/1456)
+        '@angular-eslint/template/button-has-type': 'warn', // For me, it is only a suggestion
+        '@angular-eslint/template/no-inline-styles': 'warn', // For me, it is only a suggestion
+        '@angular-eslint/template/conditional-complexity': [
+          'error', { 'maxComplexity': 3 } // Max 3 is enough, create derived variable with proper naming
+        ],
+        '@angular-eslint/template/i18n': 'error',
+        '@angular-eslint/template/no-any': 'error',
+        '@angular-eslint/template/no-call-expression': 'error',
+        '@angular-eslint/template/no-duplicate-attributes': 'error',
+        '@angular-eslint/template/no-interpolation-in-attributes': 'error',
+        '@angular-eslint/template/prefer-self-closing-tags': 'error',
+        '@angular-eslint/template/use-track-by-function': 'error'
+      }
+    },
+  ],
+}

package/index.js

@@ -0,0 +1,3 @@
+const eslintconfig = require('./eslint.config.js');
+
+module.exports = eslintconfig;

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@jkba/eslint-config-angular",
+  "version": "1.0.0",
+  "description": "Opinionated ESLint config for Angular projects",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jmeinlschmidt/eslint-config-angular.git"
+  },
+  "keywords": [
+    "eslint",
+    "eslintconfig",
+    "angular",
+    "lint"
+  ],
+  "files": [
+    "LICENSE",
+    "README.md",
+    "eslint.config.js",
+    "index.js",
+    "package.json",
+    "prettier.config.js"
+  ],
+  "author": "Jakub Meinlschmidt",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/jmeinlschmidt/eslint-config-angular/issues"
+  },
+  "homepage": "https://github.com/jmeinlschmidt/eslint-config-angular#readme",
+  "peerDependencies": {
+    "eslint": ">=8",
+    "prettier": ">=3",
+    "rxjs": ">=7",
+    "typescript": ">=4"
+  },
+  "dependencies": {
+    "@angular-eslint/eslint-plugin": "^16.0.0",
+    "@angular-eslint/eslint-plugin-template": "^16.0.0",
+    "@angular-eslint/template-parser": "^16.0.0",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-prettier": "^5.0.0",
+    "eslint-plugin-rxjs": "^5.0.3",
+    "eslint-plugin-rxjs-angular": "^2.0.1"
+  }
+}

package/prettier.config.js

@@ -0,0 +1,11 @@
+module.exports = {
+  singleQuote: true,
+  tabWidth: 2,
+  bracketSameLine: true,
+  useTabs: false,
+  trailingComma: 'all',
+  semi: true,
+  bracketSpacing: true,
+  printWidth: 100,
+  arrowParens: 'always',
+}