Naively Programmable Module
Miss any of our Open RFC calls?Watch the recordings here! »

@skyra/eslint-config

5.3.3 • Public • Published

@skyra/eslint-config

Shareable ESLint config for Skyra projects

Previously known as eslint-config-bamboo 🎋


Table of Contents


Status

GitHub npm npm

Bundle Sizes

npm bundle size npm bundle size

Social Media and Donations

Join Discord server Twitter Follow Twitter Follow Patreon Donate PayPal Donate

Installation

First install the Peer Dependencies

yarn add -D eslint typescript @typescript-eslint/parser @typescript-eslint/eslint-plugin

Then install @skyra/eslint-config

yarn add -D @skyra/eslint-config

Usage

ESLint config

Add the ESLint config to your package.json:

{
    "name": "my-project",
    // ...
    "eslintConfig": {
        "extends": "@skyra"
    }
}

Or to eslintrc.js or eslintrc.json:

{
    "extends": "@skyra"
}

Create tsconfig.eslint.json next to the eslint config file, for example with content:

{
    "extends": "./tsconfig.json",
    "include": ["src", "test"]
}

TypeScript config

You can use @skyra/eslint-config's tsconfig.json by extending it in yours:

{
    "extends": "@skyra/eslint-config"
}

All of its properties are defaulted for bleeding-edge TypeScript options, you may extend this to include your own configuration options as well.

Meta

License

Copyright © 2020, Skyra Project. Released under the MIT License.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request!

Buy us some doughnuts

Skyra Project is open source and always will be, even if we don't get donations. That said, we know there are amazing people who may still want to donate just to show their appreciation. Thanks you very much in advance!

We accept donations through Patreon, BitCoin, Ethereum, and Litecoin. You can use the buttoms below to donate through your method of choice.

Donate With QR Address
Patreon PatreonImage Click Here
PayPal PayPalImage Click Here
BitCoin BitcoinImage 3JNzCHMTFtxYFWBnVtDM9Tt34zFbKvdwco
Ethereum EthereumImage 0xcB5EDB76Bc9E389514F905D9680589004C00190c
Litecoin LitecoinImage MNVT1keYGMfGp7vWmcYjCS8ntU8LNvjnqM

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Antonio Román

💻 🤔 📆 ⚠️

Jeroen Claassens

💻 🤔 📆 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!

Install

npm i @skyra/eslint-config

DownloadsWeekly Downloads

318

Version

5.3.3

License

MIT

Unpacked Size

33.1 kB

Total Files

6

Last publish

Collaborators

  • avatar
  • avatar
  • avatar