Initial commit

Author: phhien203

.github/workflows/build.yml

@@ -0,0 +1,26 @@
+name: build
+
+on: [pull_request, push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [14.x]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Install dependencies
+        run: yarn --frozen-lockfile
+      - name: Format check
+        run: yarn format:check
+      - name: Unit Testing
+        run: yarn test
+        env:
+          CI: true

.gitignore

@@ -0,0 +1,91 @@
+
+# Created by https://www.gitignore.io/api/node
+# Edit at https://www.gitignore.io/?templates=node
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# End of https://www.gitignore.io/api/node
+
+lib/
+.DS_Store
+.idea/

.prettierignore

@@ -0,0 +1,5 @@
+lib/
+__snapshots__/
+coverage/
+node_modules/
+*.png

.prettierrc.yml

@@ -0,0 +1,7 @@
+trailingComma: all
+tabWidth: 2
+semi: true
+singleQuote: false
+bracketSpacing: true
+printWidth: 80
+arrowParens: avoid

LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright 2022 Pham Huu Hien
+
+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.

README.md

@@ -0,0 +1,26 @@
+# Custom ESLint rules for Angular projects
+
+## What's this?
+
+This is a repository containing custom ESLint rules for Angular projects
+
+## Rules included
+
+`destroy-service-provider`: When using `DestroyService` to automatically unsubscribe from an observable, this service MUST be provided in Component/Directive class providers in order for the Service to work properly. This rule ensures the DestroyService is always provided in the `providers` array of the Component or Directive.
+
+## Usage
+
+Edit your eslint config file as follow
+
+```json
+{
+  "plugins": ["ngx-eslint"],
+  "rules": {
+    "ngx-eslint/destroy-service-provider": "error"
+  }
+}
+```
+
+## LICENSE
+
+MIT

package.json

@@ -0,0 +1,69 @@
+{
+  "name": "eslint-plugin-ngx-eslint",
+  "version": "1.0.0",
+  "description": "Custom ESLint rules for Angular projects",
+  "main": "lib/index.js",
+  "scripts": {
+    "clean": "rimraf lib",
+    "prebuild": "rimraf node_modules/@types/eslint/node_modules/@types/estree",
+    "build": "tsc",
+    "prettier": "prettier \"*.{js,json,yml,yaml,md}\" \"src/**/*\"",
+    "format": "yarn prettier --write",
+    "format:check": "yarn prettier --check",
+    "test": "jest",
+    "prepublish": "npm run clean && npm run build"
+  },
+  "repository": "https://github.com/phhien203/eslint-plugin-ngx-eslint",
+  "files": [
+    "LICENSE",
+    "README.md",
+    "package.json",
+    "lib"
+  ],
+  "keywords": [
+    "eslint",
+    "typescript",
+    "angular custom eslint",
+    "ngx-eslint"
+  ],
+  "author": "Pham Huu Hien",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/eslint": "8.4.2",
+    "@types/estree": "0.0.51",
+    "@types/node": "16.11.33",
+    "@typescript-eslint/parser": "5.21.0",
+    "eslint": "8.15.0",
+    "husky": "7.0.4",
+    "jest": "28.1.0",
+    "prettier": "2.6.2",
+    "pretty-quick": "3.1.3",
+    "rimraf": "3.0.2",
+    "ts-jest": "28.0.2",
+    "typescript": "4.6.4"
+  },
+  "peerDependencies": {
+    "eslint": "^4.0.0 || ^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0"
+  },
+  "jest": {
+    "globals": {
+      "ts-jest": {
+        "diagnostics": false
+      }
+    },
+    "transform": {
+      "^.+\\.ts$": "ts-jest"
+    },
+    "testRegex": "(src/.*\\.test)\\.ts$",
+    "testPathIgnorePatterns": [
+      "/node_modules/",
+      "\\.d\\.ts$",
+      "lib/.*"
+    ],
+    "moduleFileExtensions": [
+      "js",
+      "ts",
+      "json"
+    ]
+  }
+}

renovate.json

@@ -0,0 +1,3 @@
+{
+  "extends": ["config:base"]
+}

src/index.ts

@@ -0,0 +1,7 @@
+import destroyServiceProvider from "./rules/destroy-service-provider";
+
+export = {
+  rules: {
+    "destroy-service-provider": destroyServiceProvider,
+  },
+};

src/rules/destroy-service-provider.test.ts

@@ -0,0 +1,78 @@
+import { RuleTester } from "eslint";
+
+import rule from "./destroy-service-provider";
+
+const tester = new RuleTester({
+  parser: require.resolve("@typescript-eslint/parser"),
+  parserOptions: { ecmaVersion: 2015 },
+});
+
+tester.run("destroy-service-provider", rule, {
+  valid: [
+    {
+      code: `
+        @Component({
+          selector: 'my-orgs',
+          templateUrl: './welcome.component.html',
+          styleUrls: ['./welcome.component.scss'],
+          providers: [DestroyService]
+        })
+        export class WelcomeComponent implements OnInit {
+          constructor(
+            private destroy$: DestroyService,
+          ) {}
+        }`,
+    },
+    {
+      code: `
+        @Directive({
+          selector: 'my-directive',
+          providers: [DestroyService]
+        })
+        export class MyDirective implements OnInit {
+          constructor(
+            private destroy$: DestroyService,
+          ) {}
+        }`,
+    },
+  ],
+  invalid: [
+    {
+      code: `
+        @Component({
+          selector: 'my-orgs',
+          templateUrl: './welcome.component.html',
+          styleUrls: ['./welcome.component.scss'],
+          providers: []
+        })
+        export class WelcomeComponent implements OnInit {
+          constructor(
+            private destroy$: DestroyService,
+          ) {}
+        }`,
+      errors: [
+        {
+          message:
+            "Please provide DestroyService in Component class providers.",
+        },
+      ],
+    },
+    {
+      code: `
+        @Directive({
+          selector: 'my-directive',
+        })
+        export class MyDirective implements OnInit {
+          constructor(
+            private destroy$: DestroyService,
+          ) {}
+        }`,
+      errors: [
+        {
+          message:
+            "Please provide DestroyService in Directive class providers.",
+        },
+      ],
+    },
+  ],
+});