@bmatei/eslint-builder-angular - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "@bmatei/eslint-builder-angular",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "ESLint builder for Angular.",
@@ -5,0 +5,0 @@ "author": "Bogdan Matei <[e-mail]>",

README.md

@@ -1,3 +0,39 @@
-# ESLint builder for Angular
 
-[![bfmatei](https://circleci.com/gh/bfmatei/eslint-builder-angular.svg?style=shield)](https://circleci.com/gh/bfmatei/eslint-builder-angular)
+# ESLint builder for Angular  
+Run [ESLint](https://eslint.org/) from Angular CLI.
+
+## Install
+1. Install ESLint: `npm install eslint --save-dev`
+2. Install the builder: `npm install @bmatei/stylelint-builder-angular --save-dev`
+3. Add the builder to `angular.json`:
+```
+"stylelint": {
+    "builder": "@speedy/build-angular:stylelint"
+}
+```
+4. Run stylelint: `ng run <project>:stylelint`
+
+## Available options
+Some options correspond to the ESLint config parameters. By default, these do not override any behavior in ESLint. 
+1. `cache`
+    - [Reference: cache](https://eslint.org/docs/developer-guide/nodejs-api#cliengine)
+2. `cacheLocation`
+    - [Reference: cacheLocation](https://eslint.org/docs/developer-guide/nodejs-api#cliengine)
+3. `configFile`
+    - [Reference: configFile](https://eslint.org/docs/developer-guide/nodejs-api#cliengine)
+4. `files`
+    - Array of glob patterns to be checked.
+    - Default: `["src/**/*.ts"]` 
+5. `fix`
+    - [Reference: fix](https://eslint.org/docs/developer-guide/nodejs-api#cliengine)
+6. `format`
+    - [Reference: format](https://eslint.org/docs/developer-guide/nodejs-api#cliengine)
+7. `force`
+    - Ignore any errors and warnings and return a success status.
+8. `reportUnusedDisableDirectives`
+    - [Reference: reportUnusedDisableDirectives](https://eslint.org/docs/developer-guide/nodejs-api#cliengine)
+9. `silent`
+    - Suppress any output from the builder.
+    - Default: `false`
+10. `useEslintrc`
+    - [Reference: useEslintrc](https://eslint.org/docs/developer-guide/nodejs-api#cliengine)  

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

13315

increased by11.5%

Number of lines in readme file

40

increased by900%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes