@darraghor/eslint-plugin-nestjs-typed 6.1.0 → 6.1.1

package/README.md

@@ -4,9 +4,23 @@
 ![size](https://badgen.net/bundlephobia/minzip/@darraghor/eslint-plugin-nestjs-typed?color=cyan)
 ![types](https://badgen.net/npm/types/@darraghor/eslint-plugin-nestjs-typed?color=blue)
 
+# NestJS Eslint Plugin
+
+If you use NestJs (https://nestjs.com/) these ESLint rules will help you to prevent common bugs and issues in NestJs applications.
+
+Skip to [How to configure](#to-configure) but if you have issues come back and read this whole document.
+
+## Support this plugin
+
+If you use this plugin in commercial setting consider submitting PRs on work time. It saves your business money, so it makes your business money!
+
+If you really want to support me directly you can use https://www.buymeacoffee.com/darraghor
+
+But please, just submit PRs to help all NestJS devs. This is the way.
+
 ## A note on versions
 
-- Version `6.x` supports Eslint version `>=9.x` and typescript eslint parser `^8`
+- Version `6.x` supports Eslint version `>=9.x` and typescript eslint parser `^7` and `^8`
 - Version `5.x` supports Eslint version `>=8.x` and typescript eslint parser `^7` and `^8`
 - Version `4.x` supports Eslint version `>=8.x` and typescript eslint parser `^6`
 - Version `3.x` supports Eslint version `>=8.x` and typescript eslint parser `^5`
@@ -163,20 +177,15 @@ For ESlint 8 I export the old style config in the "classicConfig" export.
 
 I believe it would work something like this...
 
-````ts
-import {
-    classicPlugin,
-} from "@darraghor/eslint-plugin-nestjs-typed";
-
+```ts
+import {classicPlugin} from "@darraghor/eslint-plugin-nestjs-typed";
 
 module.exports = {
-    plugins: [
-        classicPlugin,
-    ],
+    plugins: [classicPlugin],
 };
-
 ```
 
+## Injectables rule scans everything
 
 Note: the injectables test scans your whole project. It's best to filter out ts things that don't matter - use `filterFromPaths` configuration setting for this. See the rule documentation for more info.
 
@@ -186,11 +195,14 @@ Note: You can easily turn off all the swagger rules if you don't use swagger by
 
 ```ts
 // all the other config
-    extends: ["plugin:@darraghor/nestjs-typed/recommended",
-    "plugin:@darraghor/nestjs-typed/no-swagger"
+    extends: [
+       "plugin:@darraghor/nestjs-typed/recommended",
+       "plugin:@darraghor/nestjs-typed/no-swagger"
     ],
  // more config
-````
+```
+
+## Disabling a rule
 
 Disable a single rule with the full name e.g. in your eslint configuration...
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@darraghor/eslint-plugin-nestjs-typed",
-    "version": "6.1.0",
+    "version": "6.1.1",
     "description": "Eslint rules for nestjs projects",
     "scripts": {
         "clean": "rm -Rf ./dist/",