https://github.com/tulipretail/eslint-config

ESLint Rules for writing JavaScript at Tulip :tulip:
https://github.com/tulipretail/eslint-config

eslint eslint-config javascript

Last synced: 23 days ago
JSON representation

ESLint Rules for writing JavaScript at Tulip :tulip:

• Host: GitHub
• URL: https://github.com/tulipretail/eslint-config
• Owner: tulipretail
• Created: 2018-08-10T13:13:09.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-08-10T13:40:26.000Z (over 6 years ago)
• Last Synced: 2024-12-17T11:48:57.462Z (about 1 month ago)
• Topics: eslint, eslint-config, javascript
• Language: JavaScript
• Homepage:
• Size: 4.38 MB
• Stars: 1
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


	



This package provides a set of rules for ESLint to be used in your editor of choice. To install, simply run:

```bash

npm i -D @tulipjs/eslint-config

```

In your `.eslintrc` file, the most simple setup is as follows:

```json

{

	"extends": "@tulipjs"

}

```

## Contributing

If you come across a rule you think should be changed, you can open an Issue or Pull Request in this repo to start a discussion. Link to the official docs for the rule in question on [ESLint's site](https://eslint.org/) and make your case! This is meant to be a living document and it should evolve over time. Run `npm run test` to make sure you didn't add any ESLint errors to this repo.

### Branch Naming

Since editing the lint config might not relate to a task or user story, give your branch a descriptive name, perhaps after the rule in question. 

## Editor Setup

Once your project has a valid `.eslintrc` file, you editor needs to know how and when you'd like it to be used. Most editors should be able to work quickly while you type (with a throttle). Below are some examples.

- [SublimeLinter](http://sublimelinter.com/) - Install via Package Control in Sublime.