@jkba/eslint-config-angular 1.0.0 → 1.1.0

package/README.md

@@ -1,18 +1,29 @@
 # eslint-config-angular
 
+![](https://img.shields.io/npm/dt/@jkba/eslint-config-angular?logo=npm)
+
+
 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
-```
+npm i -D \
+  prettier \
+  @angular-eslint/eslint-plugin \
+  @angular-eslint/eslint-plugin-template \
+  @angular-eslint/template-parser \
+  @typescript-eslint/eslint-plugin \
+  @typescript-eslint/parser \
+  eslint-plugin-import \
+  eslint-config-prettier \
+  eslint-plugin-prettier \
+  eslint-plugin-rxjs \
+  eslint-plugin-rxjs-angular \
+  eslint-import-resolver-typescript \
+  @jkba/eslint-config-angular
 
-```sh
-npm i -D @jkba/eslint-config-angular
 ```
 
 
@@ -20,7 +31,7 @@ npm i -D @jkba/eslint-config-angular
 
 Extend your eslint configuration with `"@jkba/angular"`:
 
-```javascript
+```js
 // .eslintrc.json
 
 {
@@ -39,14 +50,50 @@ module.exports = require('@jkba/eslint-config-angular/prettier.config');
 
 ### Modifying rules
 
-> :warning: Work in Progress
+Modify (add/disable/override) specific rules via the `rules` property:
+
+```js
+// .eslintrc.json
+
+{
+  "extends": [ "@jkba/angular" ],
+  "rules": {
+    "@typescript-eslint/prefer-nullish-coalescing": "off", // Requires the `strictNullChecks` compiler option to be turned on to function correctly.
+    "@typescript-eslint/no-unnecessary-condition": "off", // Requires the `strictNullChecks` compiler option to be turned on to function correctly.
+    "@angular-eslint/template/click-events-have-key-events": "off", // Accessibility is not supported on this project
+    "@angular-eslint/template/interactive-supports-focus": "off", // Accessibility is not supported on this project
+  }
+}
+```
+
+or using the `overrides` property:
+
+```js
+// .eslintrc.json
+
+{
+  "extends": [ "@jkba/angular" ],
+  "overrides": [
+    {
+      "files": [ "*.html" ],
+      "parserOptions": { "parser": "@angular-eslint/template-parser" },
+      "rules": {
+        "@angular-eslint/template/i18n": "off" // i18n is not supported on this project
+      }
+    }
+  ]
+}
+```
+
+Reference [Overriding Settings from Shareable Configs](https://eslint.org/docs/latest/extend/shareable-configs#overriding-settings-from-shareable-configs).
 
 
 ## Build
 
-> :warning: Work in Progress
+Use `npm link` and then `npm link @jkba/eslint-config-angular` in your project.
+PRs are welcome but keep in mind this is an opinionated configuration. 
 
-Refer to https://eslint.org/docs/latest/extend/shareable-configs.
+Reference [Share Configurations](https://eslint.org/docs/latest/extend/shareable-configs).
 
 
 ## License

package/eslint.config.js

@@ -24,7 +24,7 @@ module.exports = {
         // This rule might intentionally disable some rules declared above due to conflicts
         'plugin:prettier/recommended',
       ],
-      plugins: ['@typescript-eslint', '@angular-eslint', 'rxjs', 'rxjs-angular'],
+      plugins: ['@typescript-eslint', '@angular-eslint', 'rxjs', 'rxjs-angular', 'import'],
       settings: {
         // Reference https://www.npmjs.com/package/eslint-plugin-import
         'import/resolver': {
@@ -79,7 +79,13 @@ module.exports = {
         'import/order': [
           'error',
           {
-            'groups': ['builtin', 'external', 'parent', 'sibling', 'index'],
+            'groups': [
+              ['builtin', 'external'],
+              'internal',
+              'parent',
+              'sibling',
+              'index',
+            ],          
             'newlines-between': 'always',
             'alphabetize': {
               'order': 'asc',
@@ -87,6 +93,9 @@ module.exports = {
             }
           }
         ],
+        'import/no-useless-path-segments': ['error', { noUselessIndex: true }],
+        // 'import/no-deprecated': 'error', // Throws false-positive for RxJS,
+        'import/no-self-import': 'error',
       },
     },
     {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jkba/eslint-config-angular",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Opinionated ESLint config for Angular projects",
   "main": "index.js",
   "scripts": {
@@ -31,20 +31,19 @@
   },
   "homepage": "https://github.com/jmeinlschmidt/eslint-config-angular#readme",
   "peerDependencies": {
+    "@angular-eslint/eslint-plugin": ">=16",
+    "@angular-eslint/eslint-plugin-template": ">=16",
+    "@angular-eslint/template-parser": ">=16",
+    "@typescript-eslint/eslint-plugin": ">=6",
+    "@typescript-eslint/parser": ">=6",
     "eslint": ">=8",
+    "eslint-config-prettier": ">=8",
+    "eslint-plugin-import": ">=2.27.0",
+    "eslint-plugin-prettier": ">=5",
+    "eslint-plugin-rxjs": ">=5",
+    "eslint-plugin-rxjs-angular": ">=2",
+    "eslint-import-resolver-typescript": ">= 3.5.5",
     "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"
   }
 }