@skyra/eslint-config

Shareable ESLint config for Skyra projects

Previously known as eslint-config-bamboo 🎋

---

Table of Contents

• Installation
• Usage
  • ESLint config
  • TypeScript config
• Meta
  • License
  • Contributing
  • Buy us some doughnuts
  • Contributors ✨

---

Status

Bundle Sizes

Social Media and Donations

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 buttons below to donate through your method of choice.

Donate With	QR	Address
Patreon		Click Here
PayPal		Click Here
BitCoin		3JNzCHMTFtxYFWBnVtDM9Tt34zFbKvdwco
Ethereum		0xcB5EDB76Bc9E389514F905D9680589004C00190c
Litecoin		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!