# eslint-config-akkadu > Eslint config for Akkadu's Javascript coding standards Latest version **1.1.5** (published 2020-12-22) · MIT license · 0 weekly downloads ## Install ```sh npm install eslint-config-akkadu pnpm add eslint-config-akkadu yarn add eslint-config-akkadu bun add eslint-config-akkadu ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.1.5 | | Published | 2020-12-22 | | First published | 2020-12-21 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 21 | | Unpacked size | 18.7 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | JT Houk | | Maintainers | tneminen | | Keywords | eslint, eslintconfig | ## Links - npm: https://www.npmjs.com/package/eslint-config-akkadu - npm.io page: https://npm.io/package/eslint-config-akkadu ## Dependencies (21) - [eslint](https://npm.io/package/eslint.md) ^7.16.0 - [tslint](https://npm.io/package/tslint.md) ^6.0.0 - [prettier](https://npm.io/package/prettier.md) ^2.2.1 - [stylelint](https://npm.io/package/stylelint.md) ^13.2.0 - [markdownlint](https://npm.io/package/markdownlint.md) ^0.19.0 - [stylelint-scss](https://npm.io/package/stylelint-scss.md) ^3.14.2 - [stylelint-order](https://npm.io/package/stylelint-order.md) ^4.0.0 - [eslint-plugin-jsx](https://npm.io/package/eslint-plugin-jsx.md) ^0.1.0 - [eslint-plugin-vue](https://npm.io/package/eslint-plugin-vue.md) ^6.2.1 - [stylelint-prettier](https://npm.io/package/stylelint-prettier.md) ^1.1.2 - [eslint-plugin-react](https://npm.io/package/eslint-plugin-react.md) ^7.21.5 - [eslint-config-airbnb](https://npm.io/package/eslint-config-airbnb.md) ^18.2.1 - [eslint-plugin-import](https://npm.io/package/eslint-plugin-import.md) ^2.22.1 - [eslint-config-prettier](https://npm.io/package/eslint-config-prettier.md) ^7.1.0 - [eslint-plugin-jsx-a11y](https://npm.io/package/eslint-plugin-jsx-a11y.md) ^6.4.1 - [eslint-plugin-prettier](https://npm.io/package/eslint-plugin-prettier.md) ^3.3.0 - [tslint-config-prettier](https://npm.io/package/tslint-config-prettier.md) ^1.18.0 - [tslint-plugin-prettier](https://npm.io/package/tslint-plugin-prettier.md) ^2.1.0 - [eslint-plugin-react-hooks](https://npm.io/package/eslint-plugin-react-hooks.md) ^4.2.0 - [stylelint-config-standard](https://npm.io/package/stylelint-config-standard.md) ^20.0.0 - [stylelint-config-sass-guidelines](https://npm.io/package/stylelint-config-sass-guidelines.md) ^7.0.0 ## Alternatives - [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads - [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads - [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads - [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads - [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads ## Recent versions - 1.1.5 (latest) — 2020-12-22 - 1.1.4 — 2020-12-22 - 1.1.3 — 2020-12-21 - 1.1.0 — 2020-12-21 ## README # [![Akkadu][akkadu-logo]][akkadu-url] Eslint Config [![NPM Total Downloads][npm-shield]][npm-url] [![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![Language grade: JavaScript][lgtm-shield]][lgtm-url] [![FOSSA Status][fossa-shield]][fossa-url] ![Version][version-shield] [![Maintenance][maintenance-shield]][maintenance-url] [![David Dependencies Status][david-dm-shield]][david-dm-url] [![styled with prettier][prettier-shield]][prettier-url] [![LinkedIn][linkedin-shield]][linkedin-url] Get started on Javascript projects at Akkadu much quicker by using this template repository. [Explore the docs »](https://github.com/Akkadu/eslint-config-akkadu) [View Demo](https://github.com/Akkadu/eslint-config-akkadu) • [Report Bug](https://github.com/Akkadu/eslint-config-akkadu/issues) • [Request Feature](https://github.com/Akkadu/eslint-config-akkadu/issues) ## Table of Contents - [About The Project](#about-the-project) - [Built With](#built-with) - [Getting Started](#getting-started) - [Prerequisites](#prerequisites) - [Installation](#installation) - [Usage](#usage) - [Roadmap](#roadmap) - [Edge Cases Addressed](#edge-cases-addressed) - [Contributing](#contributing) - [Author](#author) - [Dependencies](#dependencies) - [Acknowledgements](#acknowledgements) ## About The Project This is Akkadu's living Javascript linting standard. It's created and maintained by the core Akkadu Tech Force and designed to enforce more readable and efficient code. ### Built With These are the major linting plugins integrated with our own linting rules. * [Airbnb Eslint Config](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb) * [Prettier](https://prettier.io/) ## Getting Started This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps. ### Prerequisites * yarn ```sh npm install yarn@latest -g ``` ### Installation 1. Clone the repo 2. Get the .env keys from techforce@akkadu-team.com ```sh git clone https://github.com/Akkadu/eslint-config-akkadu.git ``` 3. Install NPM packages ```sh yarn install ``` ## Usage ```sh yarn add -D prettier eslint-config-akkadu ``` .eslintrc ```json { "extends": ["eslint-config-akkadu"] } ``` ## Roadmap See the [open issues](https://github.com/Akkadu/eslint-config-akkadu/issues) for a list of proposed features (and known issues) ### Edge Cases Addressed `eslint-config-akkadu` also adds a few rules that have had some problems in the recent past. These are the kinds of problems that may be inconsistent in occurence and will probably prop up as your dependency versions change: 1. **`babel-eslint` template literal indentation** ([`babel/babel-eslint` issue #799](https://github.com/babel/babel-eslint/issues/799#issuecomment-651954838)) Depending your current version of `babel-eslint` or `@babel/parser`, the following ESlint error may present itself in places that use template literals in code: ```bash TypeError: Cannot read property 'range' of null ``` This was fixed by adding the following snippet to the indent rule: _Source: [babel/babel-eslint#799 (comment)](https://github.com/babel/babel-eslint/issues/799#issuecomment-651954838)_ ```json { "rules": { "indent": [ "error", 2, { "SwitchCase": 1, "ignoredNodes": [ "TemplateLiteral" ] } ], "template-curly-spacing": 0 } } ``` This issue will be resolved by future versions of Babel. We can remove if from the config then. ## Contributing Want to make a change? Any contributions you make are **greatly appreciated**. 1. Clone the repo 2. Create your Feature Branch (`gco -b release/my-project`) 3. Commit your Changes (`git commit -m 'add: small addition'`) 4. Push to the Branch (`git push origin release/my-project`) 5. Open a Pull Request ## Author 👤 **JT Houk ** * Website: [jt.houk.space](https://jt.houk.space/) * Twitter: [@HoukasaurusRex](https://twitter.com/HoukasaurusRex) * Github: [@HoukasaurusRex](https://github.com/HoukasaurusRex) * LinkedIn: [@JT Houk](https://linkedin.com/in/jt-houk) ## Dependencies [![FOSSA Status][fossa-scan]][fossa-url] ## Acknowledgements * [Best README Template](https://github.com/othneildrew/Best-README-Template/blob/master/README.md) * [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet) * [Img Shields](https://shields.io) [akkadu-logo]: https://res.cloudinary.com/jthouk/image/upload/e_improve,w_30,h_30/v1570345513/Logos/akkadu-logo-white-simple.png [akkadu-url]: https://akkadu.com [npm-shield]: https://img.shields.io/npm/dt/eslint-config-akkadu.svg [npm-url]: https://www.npmjs.com/package/eslint-config-akkadu [contributors-shield]: https://img.shields.io/github/contributors/Akkadu/eslint-config-akkadu.svg?style=flat-square [contributors-url]: https://github.com/Akkadu/eslint-config-akkadu/graphs/contributors [forks-shield]: https://img.shields.io/github/forks/Akkadu/eslint-config-akkadu.svg?style=flat-square [forks-url]: https://github.com/Akkadu/eslint-config-akkadu/network/members [stars-shield]: https://img.shields.io/github/stars/Akkadu/eslint-config-akkadu.svg?style=flat-square [stars-url]: https://github.com/Akkadu/eslint-config-akkadu/stargazers [issues-shield]: https://img.shields.io/github/issues/Akkadu/eslint-config-akkadu.svg?style=flat-square [issues-url]: https://github.com/Akkadu/eslint-config-akkadu/issues [license-shield]: https://img.shields.io/github/license/Akkadu/eslint-config-akkadu.svg?style=flat-square [license-url]: https://github.com/Akkadu/eslint-config-akkadu/blob/master/LICENSE.txt [lgtm-shield]: https://img.shields.io/lgtm/grade/javascript/g/akkadu/eslint-config-akkadu.svg?logo=lgtm&logoWidth=18 [lgtm-url]: https://lgtm.com/projects/g/akkadu/eslint-config-akkadu/context:javascript [fossa-shield]: https://app.fossa.com/api/projects/git%2Bgithub.com%2FAkkadu%2Feslint-config-akkadu.svg?type=shield [fossa-url]: https://app.fossa.com/projects/git%2Bgithub.com%2FAkkadu%2Feslint-config-akkadu?ref=badge_shield [fossa-scan]: https://app.fossa.com/api/projects/git%2Bgithub.com%2FAkkadu%2Feslint-config-akkadu.svg?type=large [version-shield]: https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000 [maintenance-shield]: https://img.shields.io/badge/Maintained%3F-yes-green.svg [maintenance-url]: https://github.com/Akkadu/eslint-config-akkadu/graphs/commit-activity [david-dm-shield]: https://david-dm.org/akkadu/eslint-config-akkadu.svg [david-dm-url]: https://david-dm.org/akkadu/eslint-config-akkadu [prettier-shield]: https://img.shields.io/badge/styled_with-prettier-ff69b4.svg [prettier-url]: https://github.com/prettier/prettier [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555 [linkedin-url]: https://www.linkedin.com/company/akkadu/ [product-screenshot]: https://raw.githubusercontent.com/ritaly/README-cheatsheet/master/img/screenshot.png --- _Source: https://npm.io/package/eslint-config-akkadu · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._