eslint-plugin-powerbi-visuals

ESLint rules and extensions for Power BI Visuals projects

Usage no npm install needed!

<script type="module">
  import eslintPluginPowerbiVisuals from 'https://cdn.skypack.dev/eslint-plugin-powerbi-visuals';
</script>

README

Microsoft Power BI Custom Visuals ESLint Plugin

npm version npm

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

How To Use

  1. Install ES Lint packages
npm install eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin --saveDev
  1. Install eslint-plugin-pbivisuals package
npm install eslint-plugin-powerbi-visuals --saveDev
  1. Create .eslintrc.js file with the following content
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: {}
};
  1. Create .eslintignore file with the following content
node_modules
dist
coverage
test
.eslintrc.js
karma.conf.ts
test.webpack.config.js
  1. Add a script into package.json
"eslint": "npx eslint . --ext .js,.jsx,.ts,.tsx"
  1. Run linter
npm run eslint