eslint-config-bamboo

eslint-config-bamboo 🎋

Install

# Install Dependencies
$ yarn add -D eslint typescript @typescript-eslint/parser @typescript-eslint/eslint-plugin

# Install eslint-config-bamboo
$ yarn add -D eslint-config-bamboo

Usage

ESLint config

Add the ESLint config to your package.json:

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

Or to eslintrc.js or eslintrc.json:

{
	"extends": "bamboo"
}

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 eslint-config-bamboo's tsconfig.json by extending it in yours:

{
	"extends": "eslint-config-bamboo"
}

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

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!

Author

eslint-config-bamboo © kyranet, released under the MIT License. Authored and maintained by kyranet.

Github kyranet - Twitter @kyranet_