{"bugs":{"url":"https://github.com/amilajack/eslint-plugin-flowtype-errors/issues"},"dist":{"shasum":"3d65697b509b6c56bbae7c667efb34f0447035e3","tarball":"https://registry.npmjs.org/eslint-plugin-flowtype-errors/-/eslint-plugin-flowtype-errors-3.5.1-0.tgz","fileCount":13,"integrity":"sha512-i355WzpF4hXjJSzz8QUldurdm6XMBNWdEMe3Lirg7NyZ9efzELGbOEgPeIL89fM3GxI4sU8eZLwO0yycUi2hGg==","signatures":[{"sig":"MEUCIELSuoxBwIaHLNRoTaxtoYRgDLbbZXXuOuh/QyFxpv23AiEAxFxpj85FJX221zO+tjIRJWJW+QmG1r90ljJ/f0wZw/o=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":27927},"jest":{"testEnvironment":"node"},"main":"index.js","name":"eslint-plugin-flowtype-errors","files":["index.js","dist"],"author":{"name":"Amila Welihinda"},"readme":"eslint-plugin-flowtype-errors\n=============================\n\n[![Build Status](https://travis-ci.org/amilajack/eslint-plugin-flowtype-errors.svg?branch=master)](https://travis-ci.org/amilajack/eslint-plugin-flowtype-errors)\n[![Build status](https://ci.appveyor.com/api/projects/status/ag1pm0a914bed8c8/branch/master?svg=true)](https://ci.appveyor.com/project/amilajack/eslint-plugin-flowtype-errors/branch/master)\n[![NPM version](https://badge.fury.io/js/eslint-plugin-flowtype-errors.svg)](http://badge.fury.io/js/eslint-plugin-flowtype-errors)\n[![Dependency Status](https://img.shields.io/david/amilajack/eslint-plugin-flowtype-errors.svg)](https://david-dm.org/amilajack/eslint-plugin-flowtype-errors)\n[![npm](https://img.shields.io/npm/dm/eslint-plugin-flowtype-errors.svg)](https://npm-stat.com/charts.html?package=eslint-plugin-flowtype-errors)\n\n## Demo\n![ESLint Flow Demo](https://github.com/amilajack/eslint-plugin-flowtype-errors/blob/master/flow-demo.gif?raw=true)\n\n*NOTE:* This demo is using Atom and the packages `linter`, `linter-eslint`, `language-babel`\n\n## Why?\n* **Lower barrier:** Any editor that has ESLint support now supports Flow 🎉\n* **Less editor configuration:** No need to change your entire workflow to incorporate flow. No multiple-linters-per-file nonsense.\n* **Simple:** Its literally just an ESLint rule! Just install the dependency, add a flowconfig, and you're good to go!\n\n## Getting Started\nThis guide assumes that you have installed eslint, babel, babel-plugin-transform-flow-strip-types and configured flow. Check out the [from-scratch guide](https://github.com/amilajack/eslint-plugin-flowtype-errors/wiki/Getting-Started) for the full guide on getting started.\n\n⚠️ Make sure the 64-bit version of your texteditor/IDE. For atom, [see this comment](https://github.com/amilajack/eslint-plugin-flowtype-errors/issues/40#issuecomment-275983387)\n\n**Step 1. Install**\n\n```bash\nnpm install --save-dev eslint-plugin-flowtype-errors\n```\n\n**Step 2. Configure**\n\nAdd this line to the 'rules' section of your `.eslintrc` to report flow errors.\n```js\n\"flowtype-errors/show-errors\": 2\n```\n\nAdd this line to the 'rules' section of your `.eslintrc` to report flow warnings.\n```js\n\"flowtype-errors/show-warnings\": 1\n```\nNote that flow won't report warnings unless you add this setting to your `.flowconfig`:\n```toml\n[options]\ninclude_warnings=true\n```\n\nAdd this line to the 'rules' section of your `.eslintrc` to enforce a minimum percentage of flow coverage per file (optional). Here's an example of enforcing a converage of at least 50%:\n```js\n\"flowtype-errors/enforce-min-coverage\": [2, 50]\n```\n\nAdd this line to the 'plugins' section of your `.eslintrc`\n```js\n\"flowtype-errors\"\n```\n\nAdd the `@flow` pragma to files that you want to lint\nAlso make sure that your `.flowconfig` is in the root of your project directory\n```js\n/**\n * @flow\n */\n```\n\n**Step 3. Settings (optional)**\n\nAdd this line to the 'settings' section of your `.eslintrc` if your `.flowconfig` file is located in a different folder than the execution path of eslint.\n```js\n\"settings\": {\n  \"flowtype-errors\": {\n    \"flowDir\": \"./myDir\"\n  }\n},\n```\n\nRun `eslint` and and you're all set!\n\n## CI Configuration\n**Flow is supported on all OS's except Windows 32bit. Add [this line](https://github.com/amilajack/eslint-plugin-flowtype-errors/blob/master/appveyor.yml#L12) to appveyor to make tests run properly.**\n\n## Editor Configuration\n### Atom\n```bash\napm install linter linter-eslint language-babel\n```\n\n### Sublime\n* https://github.com/SublimeLinter/SublimeLinter3\n* https://github.com/roadhump/SublimeLinter-eslint\n* https://github.com/babel/babel-sublime\n\n### Others\nhttp://eslint.org/docs/user-guide/integrations#editors\n\n## Planned Implementations\n* Add more extensive tests\n* Allow passing arguments to flow binary\n* Run flow minimal amount of times for faster linting\n* Custom formatting of flow error messages\n* Enable rules to allow and disallow specific flow errors\n\n## Related flow tools:\n* [flow-runtime](https://github.com/codemix/flow-runtime)\n* [eslint-plugin-flowtype](https://github.com/gajus/eslint-plugin-flowtype)\n","engines":{"npm":">=5.x","node":">=4.x"},"license":"MIT","scripts":{"flow":"flow","lint":"eslint --cache --format=node_modules/eslint-formatter-pretty .","spec":"npm run build && jest test/format.spec.js","test":"flow && npm run lint && npm run spec","build":"cross-env NODE_ENV=production babel src --out-dir dist","prettier":"prettier --single-quote --write \"./src/*.js\"","spec-win":"npm run build && jest","preversion":"npm run build"},"_npmUser":{"name":"amilajack","email":"amilajack@gmail.com"},"homepage":"https://github.com/amilajack/eslint-plugin-flowtype-errors#readme","keywords":["eslint","flow","plugin","errors"],"repository":{"url":"git+https://github.com/amilajack/eslint-plugin-flowtype-errors.git","type":"git"},"description":"Retrieve Flow errors as ESLint errors.","directories":{},"licenseText":"MIT License\n\nCopyright (c) 2016 Amila Welihinda\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","maintainers":[{"name":"amilajack","email":"amilajack@gmail.com"},{"name":"jdmota","email":"jdmota@outlook.pt"}],"dependencies":{"slash":"^1.0.0","babel-runtime":"^6.26.0"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"chai":"^4.1.2","eslint":"4.12.1","flow-bin":"^0.66.0","jest-cli":"^21.2.1","prettier":"^1.9.1","babel-cli":"^6.26.0","cross-env":"^5.1.1","babel-jest":"^21.2.0","cross-spawn":"^5.1.0","babel-eslint":"^8.0.3","babel-register":"^6.26.0","babel-preset-env":"^1.6.1","babel-preset-flow":"^6.23.0","eslint-plugin-vue":"^2.1.0","eslint-plugin-html":"^4.0.1","regenerator-runtime":"^0.11.0","babel-preset-stage-0":"^6.24.1","eslint-nibble-ignore":"^3.0.0","eslint-plugin-import":"^2.8.0","eslint-config-prettier":"^2.9.0","eslint-plugin-flowtype":"^2.46.1","eslint-plugin-prettier":"^2.3.1","eslint-formatter-pretty":"^1.3.0","eslint-config-airbnb-base":"^12.1.0","babel-plugin-transform-runtime":"^6.23.0","babel-plugin-add-module-exports":"^0.2.1","babel-plugin-transform-flow-strip-types":"^6.22.0"},"peerDependencies":{"eslint":">=4.0.0","flow-bin":">=0.66.0"},"_npmOperationalInternal":{"tmp":"tmp/eslint-plugin-flowtype-errors_3.5.1-0_1519857934203_0.48752126607748236","host":"s3://npm-registry-packages"},"_id":"eslint-plugin-flowtype-errors@3.5.1-0","version":"3.5.1-0"}