Contributions are welcomed, but keep in mind this is eslint config designed specifically for Swellaby codebases so we wil reject any rule changes that conflict with our desired state.
Click the below links to create a new issue:
All that is needed to work with this repo is Node.js and your favorite editor or IDE, although we recommend VS Code.
To build and/or work on this project:
Clone the repo, change into the directory where you cloned the directory, and then run the developer setup script
git clone https://github.com/swellaby/eslint-config.git
cd eslint-config
npm run dev:setupSwellaby members should create a branch within the repository, make changes there, and then submit a PR.
Outside contributors should fork the repository, make changes in the fork, and then submit a PR.
Unit tests are written using Mocha utilizing Mocha's TDD interface.
The tests will be run as part of the npm build script and can also be run directly via the npm test script. The test results will be displayed in the console.
npm testIf you update any of the various eslint configurations, ensure you update the corresponding unit test(s) as well.
Unsurprisingly, this repo uses eslint for linting the source code. eslint is automatically run when you run the npm build script and when you make a commit. The eslint configuration file (.eslintrc.js) can be found in the root directory.
You can run eslint at any time by executing the npm lint script:
npm run lint