eslint-plugin-powerbi-visuals - npm Package Compare versions

Comparing version 0.8.0 to 0.8.1

package.json

 {
     "name": "eslint-plugin-powerbi-visuals",
-    "version": "0.8.0",
+    "version": "0.8.1",
     "description": "ESLint rules and extensions for Power BI Visuals projects",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -0,4 +1,4 @@
+# Microsoft Power BI Custom Visuals ESLint Plugin
+[![npm version](https://img.shields.io/npm/v/eslint-plugin-powerbi-visuals.svg)](https://www.npmjs.com/package/eslint-plugin-powerbi-visuals) [![npm](https://img.shields.io/npm/dm/eslint-plugin-powerbi-visuals.svg)](https://www.npmjs.com/package/eslint-plugin-powerbi-visuals)
 
-# Contributing
-
 This project welcomes contributions and suggestions.  Most contributions require you to agree to a
@@ -15,1 +15,58 @@ Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
 contact [[e-mail]](mailto:[e-mail]) with any additional questions or comments.
+
+# How To Use
+
+1. Install ES Lint packages
+```javascript
+npm install eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin --saveDev
+ ```
+
+2. Install `eslint-plugin-pbivisuals` package
+```javascript
+npm install eslint-plugin-powerbi-visuals --saveDev
+```
+
+3. Create `.eslintrc.js` file with the following content
+```javascript
+module.exports = {
+	env: {
+	    "browser": true,
+	    "es6": true,
+	    "es2017": true
+	},
+	root: true,
+	parser: "@typescript-eslint/parser",
+	parserOptions: {
+	    project: "tsconfig.json",
+	    tsconfigRootDir: ".",
+	},
+	plugins: [
+	    "powerbi-visuals"
+	],
+	extends: [
+	    "plugin:powerbi-visuals/recommended"
+	],
+	rules: {}
+};
+```
+
+4. Create `.eslintignore` file with the following content
+```javascript
+node_modules
+dist
+coverage
+test
+.eslintrc.js
+karma.conf.ts
+test.webpack.config.js
+```
+
+5. Add a script into `package.json`
+```javascript
+"eslint": "npx eslint . --ext .js,.jsx,.ts,.tsx"
+```
+
+6. Run linter
+```javascript
+npm run eslint
+```

No alert changes

Improved metrics

Total package byte prevSize

20248

7.18%

Number of lines in readme file

72

380%

No dependency changes