{"_id":"@bcgov-elmsd/eslint-config","_rev":"4-6df2bee1cfe726ac6279aa3e9da67167","name":"@bcgov-elmsd/eslint-config","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@bcgov-elmsd/eslint-config","version":"1.0.0","description":"A modern ESLint configuration for JavaScript, TypeScript and React which includes the Airbnb style guide, jsx-a11y and Prettier.","keywords":["eslint","javascript","jsx-a11y","prettier","react","typescript"],"repository":{"type":"git","url":"git+https://github.com/bcgov/elmsd-nodejs.git","directory":"packages/eslint-config"},"license":"Apache-2.0","author":{"name":"Sid McLaughlin","email":"sid.mclaughlin@gov.bc.ca"},"main":"lib/index.js","devDependencies":{"@types/node":"^18.7.16","@types/react":"^18.0.18","@typescript-eslint/eslint-plugin":"^5.36.2","@typescript-eslint/parser":"^5.36.2","eslint":"^8.23.0","eslint-config-airbnb":"^19.0.4","eslint-config-airbnb-base":"^15.0.0","eslint-config-prettier":"^8.5.0","eslint-import-resolver-typescript":"^3.5.1","eslint-plugin-import":"^2.26.0","eslint-plugin-jest":"^27.0.2","eslint-plugin-jsx-a11y":"^6.6.1","eslint-plugin-prettier":"^4.2.1","eslint-plugin-react":"^7.31.7","eslint-plugin-react-hooks":"^4.6.0","prettier":"^2.7.1","prettier-plugin-packagejson":"^2.2.18","prop-types":"^15.8.1","react":"^18.2.0","typescript":"^4.8.3"},"peerDependencies":{"eslint":"^8.0.0","prettier":"^2.0.0","react":"^16.8.0 || ^17.0.0 || ^18.0.0","typescript":"^4.8.3"},"peerDependenciesMeta":{"react":{"optional":true},"typescript":{"optional":true}},"bugs":{"url":"https://github.com/bcgov/elmsd-nodejs/issues"},"homepage":"https://github.com/bcgov/elmsd-nodejs#readme","_id":"@bcgov-elmsd/eslint-config@1.0.0","_nodeVersion":"14.20.0","_npmVersion":"6.14.17","dist":{"integrity":"sha512-IBNkG+oSIwD0Wvn+HLAd+bEkX/+82FGfqMOPOoW5ejI3IkjKAvTwa0PcLmj7P6yoDP+hcmvcOSrNG+bSaXZuMA==","shasum":"b296502203fc553b59bb805c8a759c5bcd95ba1b","tarball":"https://registry.npmjs.org/@bcgov-elmsd/eslint-config/-/eslint-config-1.0.0.tgz","fileCount":14,"unpackedSize":21828,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCA8I7YyyY+8AxRfc6mP5hgNNk5Utfspby5q0PWzZLjdwIgLLfi5iw/Chj7BBuOsM3SdnhijC0F1huhCLPMR2cBJCY="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjLIdbACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoC4Q/9EMSVg01SDAcDSgLG4ayurj/9x8qi6JxZjNQqQwRL5zNa4/8u\r\nNYyG/r6Pj0oT4pxcvOPsksKl5puqByPI3zcwrQfl+2oxizZlLzJMGHUrudex\r\nMTQdROBbawNhOa1sG0C5t+/+hue/KmnAgIeGJpMXBUuuLg3xrElnJ4UJMpna\r\nI3USTXR7qhQsCUCAf8sbDR9ywqsHZHV/aoxyqQDmKEjRbjqhsrMlAvFITtme\r\nr059s9faNq9hy25YrTiKRrA17fzIuF3i9BS5uVjqIwiHwZbcqCJGK/+tcCu8\r\nThpkzoduYvBur4KS8Fz3wmBU/mxSctGNK6biqEuMGGRHrsI1HS/m1iTO+TFF\r\nnw6bYN1dzihwPa8VJc6dpyPgmt30KIdKM6gXr3I0X8ZOuP7VRb/Atvf1GODp\r\nLWC9rCoWa7yW1hE22BAVW27QvGlb0kFKRUvfTqKz0yM0Tt1NBovze/oAphPC\r\ntuz2sUNVroJ7SE3KTQjHOHqSFXR0PKSkgg4AMmR3Lg4in1g+Z/KJWOdb/QGR\r\ngfdLcp5ByUmFGN2I/gSRokN5NOvA7LwCHUIblpg17RTkYFfcEUGc3FHPBiE4\r\nk94pDFwjz/Al8xCIzUZFyZlzqOC+M2fPVfAPg+lMLlQRww9Gc83LBSGpA0B1\r\nzOSuYG83XfzAwB7UvMXqxSBS7nz/dq3hbpA=\r\n=Wxkw\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"sidmclaughlin","email":"sidmclaughlin@gmail.com"},"directories":{},"maintainers":[{"name":"sidmclaughlin","email":"sidmclaughlin@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/eslint-config_1.0.0_1663862619282_0.977678591654688"},"_hasShrinkwrap":false},"1.0.1":{"name":"@bcgov-elmsd/eslint-config","version":"1.0.1","description":"A modern ESLint configuration for JavaScript, TypeScript and React which includes the Airbnb style guide, jsx-a11y and Prettier.","keywords":["eslint","javascript","jsx-a11y","prettier","react","typescript"],"repository":{"type":"git","url":"git+https://github.com/bcgov/elmsd-nodejs.git","directory":"packages/eslint-config"},"license":"Apache-2.0","author":{"name":"Sid McLaughlin","email":"sid.mclaughlin@gov.bc.ca"},"main":"lib/index.js","dependencies":{"@typescript-eslint/eslint-plugin":"^5.36.2","@typescript-eslint/parser":"^5.36.2","eslint":"^8.23.0","eslint-config-airbnb":"^19.0.4","eslint-config-airbnb-base":"^15.0.0","eslint-config-prettier":"^8.5.0","eslint-import-resolver-typescript":"^3.5.1","eslint-plugin-import":"^2.26.0","eslint-plugin-jest":"^27.0.2","eslint-plugin-jsx-a11y":"^6.6.1","eslint-plugin-prettier":"^4.2.1","eslint-plugin-react":"^7.31.7","eslint-plugin-react-hooks":"^4.6.0","prettier":"^2.7.1","prettier-plugin-packagejson":"^2.2.18"},"devDependencies":{"@types/node":"^18.7.16","@types/react":"^18.0.18","prop-types":"^15.8.1","react":"^18.2.0","typescript":"^4.8.3"},"peerDependencies":{"eslint":"^8.0.0","prettier":"^2.0.0","react":"^16.8.0 || ^17.0.0 || ^18.0.0","typescript":"^4.8.3"},"peerDependenciesMeta":{"react":{"optional":true},"typescript":{"optional":true}},"bugs":{"url":"https://github.com/bcgov/elmsd-nodejs/issues"},"homepage":"https://github.com/bcgov/elmsd-nodejs#readme","_id":"@bcgov-elmsd/eslint-config@1.0.1","_nodeVersion":"14.20.0","_npmVersion":"6.14.17","dist":{"integrity":"sha512-Av5lb6D2RXFqhA1GsIWUNPmushhinhigxon4tN/x7xBgMob8Z8GVVQG1mDe9XkaQIjEpVQAFmDazlLHtWrloXg==","shasum":"7c9cdafb323a8028ca5fe1d0a8f9d5df326fdbf0","tarball":"https://registry.npmjs.org/@bcgov-elmsd/eslint-config/-/eslint-config-1.0.1.tgz","fileCount":14,"unpackedSize":22170,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIA4fjAnfmZhqj2anUfeYz0WmMmWjzimEliYGJKMbIcIfAiBHiHEpWLoZejjV6YIApSk0k0XDusF56zkFTddtCii8pQ=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjLI+OACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmp3cA//RjllUz8vHJb5Lp7rnAwkLaB7qcKngQAJyVzPTdMOQCQ4QOCC\r\nAAOVwgzBZG4th04NG3AI0+ThbC51e/3Hf1T/ztx0R+Abatw/U14h8Yxq/Vvv\r\n8nZzvJgtSCYvoS3UZheyB5K3O9gThnFYbX3sWkkMspy3/xAO5Z/fwVe+F+Ls\r\n+jr9rrwa2XAXpcq7BEg7lfG22HuMkfO3vFK19+iEZQ7plEMcefiViJyH8ZCt\r\nqFCi/iJI8Tca0dONi6I+VdpszWJot6rq5hAKDppMKahI3R5ZCg9Z/HJFuD/Q\r\nDqKLLu3ZfOJnfAk8UlidptbKIqkc/d+3yWMtRag1lYyMXe/s2h8J9IgyFd/j\r\ne02UFW9dnJqq1UjIgKdP9smV+EaHQoxCmt+PUyKZjz+h8LF+/OnAlKe44aBQ\r\nqlX08jJRJYVKKPwNSuiVwcgr0RLQDXztqUqDIfx/d6/GS/GGD/fhzyhqeWfw\r\nCFcQ3tMEtK1wal+J5aAW9XI8GJ+ELZUfHxfW4apUmFHyrcgxNq8tkCYo5ZHa\r\nJRQNFv5flHyZTIEctRtdLYZ3QI8eHmY7fZcbz0Kpi72bYQ38jQFkMLIRz9Kn\r\nnMEq6wau/FZje8WTgr/9J/MoTrC19Qm8/p4OAykqQyniNC85TcPWAYG20zml\r\nP/pnBnzdPBDcuPn1Kb8dfoU7ehJSq0cW/wM=\r\n=PR3R\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"sidmclaughlin","email":"sidmclaughlin@gmail.com"},"directories":{},"maintainers":[{"name":"sidmclaughlin","email":"sidmclaughlin@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/eslint-config_1.0.1_1663864717729_0.5388026329799733"},"_hasShrinkwrap":false}},"time":{"created":"2022-09-22T16:03:39.185Z","1.0.0":"2022-09-22T16:03:39.774Z","modified":"2023-03-21T16:29:50.027Z","1.0.1":"2022-09-22T16:38:38.026Z"},"maintainers":[{"email":"brian.d.pham@gov.bc.ca","name":"npham49"},{"email":"rafa@solorzanoc.com","name":"rafasdc"}],"description":"A modern ESLint configuration for JavaScript, TypeScript and React which includes the Airbnb style guide, jsx-a11y and Prettier.","homepage":"https://github.com/bcgov/elmsd-nodejs#readme","keywords":["eslint","javascript","jsx-a11y","prettier","react","typescript"],"repository":{"type":"git","url":"git+https://github.com/bcgov/elmsd-nodejs.git","directory":"packages/eslint-config"},"author":{"name":"Sid McLaughlin","email":"sid.mclaughlin@gov.bc.ca"},"bugs":{"url":"https://github.com/bcgov/elmsd-nodejs/issues"},"license":"Apache-2.0","readme":"# @bcgov-elmsd/eslint-config\n\nA modern [ESLint](https://eslint.org) configuration for [JavaScript](https://ecma-international.org/publications-and-standards/standards/ecma-262), [TypeScript](https://www.typescriptlang.org) and [React](https://reactjs.org) which includes the [Airbnb style guide](https://github.com/airbnb/javascript), [jsx-a11y]() and [Prettier](https://www.npmjs.com/package/eslint-plugin-prettier).\n\n## A bit of context\n\nIt's always a bit time consuming to create or maintain different [ESlint](https://eslint.org/) configurations that works with different languages and libraries such as [TypeScript](https://www.typescriptlang.org/) and [React](https://reactjs.org/). The goal of this package is to have different configurations that just work out-of-the-box and that are constantly kept up-to-date.\n\n## Getting Started\n\nInstalling this package is has as easy has any other packages. Simply use your favorite package manager. You'll need to install the required peer dependencies and than this package.\n\n### Install ESlint and Prettier peer dependencies\n\nInstall [ESlint](https://eslint.org/) and [Prettier](https://prettier.io/).\n\n```sh\nnpm install eslint@8 --save-dev\nnpm install prettier@2 --save-dev --save-exact\n```\n\nIf you use [TypeScript](https://www.typescriptlang.org/) or [React](https://reactjs.org/) you'll also need to install them, but let's assume they're already installed. Have a look at the `peerDependencies` field in the package.json to know which one we support.\n\n### Install @bcgov-elmsd/eslint-config\n\n```sh\nnpm install @bcgov-elmsd/eslint-config --save-dev\n```\n\n### Setup the configuration file\n\nUsing the [JavaScript file format](https://eslint.org/docs/user-guide/configuring/ßconfiguration-files#configuration-file-formats) supported by [ESlint](https://eslint.org/), you'll need to add `\"@bcgov-elmsd/eslint-config\"` in the `\"extends\"` value of the configuration. Here's an example using a `.eslintrc.js` file.\n\n#### Using the full configuration with JavaScript, TypeScript and React\n\n```js\nmodule.exports = {\n    extends: [\"@bcgov-elmsd/eslint-config\"]\n}\n```\n\n#### JavaScript config\n\n```js\nmodule.exports = {\n    extends: [\"@bcgov-elmsd/eslint-config/js\"]\n}\n```\n\n#### JavaScript with React config\n\n```js\nmodule.exports = {\n    extends: [\"@bcgov-elmsd/eslint-config/js\", \"@bcgov-elmsd/eslint-config/jsx\"]\n}\n```\n\n#### TypeScript config\n\n```js\nmodule.exports = {\n    extends: [\"@bcgov-elmsd/eslint-config/ts\"]\n}\n```\n\n#### TypeScript with React config\n\n```js\nmodule.exports = {\n    extends: [\"@bcgov-elmsd/eslint-config/ts\", \"@bcgov-elmsd/eslint-config/tsx\"]\n}\n```\n\n### Enhance configuration file (optional)\n\nTo add custom [Prettier](https://prettier.io/) rules to the mix, create a `.prettierrc.js` file with the following content. See a list of [supported options](https://prettier.io/docs/en/options.html) should the following not work for you.\n\n```js\nmodule.exports = {\n    printWidth: 150,\n    semi: false,\n    singleQuote: false,\n    tabWidth: 4,\n    useTabs: false,\n    trailingComma: \"none\"\n}\n```\n\nTo see errors when code does not conform to your Prettier config, add the following to your `.eslintrc.js` file.\n\n```js\nconst prettierConfig = require(\"./.prettierrc\")\n\nmodule.exports = {\n    ...\n    rules: {\n        \"prettier/prettier\": [\"error\", prettierConfig]\n    }\n}\n```\n\nVoilà! Your project now uses a linter.\n\n## References\n\n_Heavily_ inspired by [eslint-config-100terres](https://github.com/100terres/eslint-config).\n\n## License\n\n```\nCopyright 2022 Province of British Columbia\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n```\n","readmeFilename":"README.md"}