@lambdaschool/eslint-config

eslint

Eslint + Prettier configuration options to be shared across internal projects

Basic usage

npm i -D eslint @lambdaschool/eslint-config
echo 'module.exports = { extends: "@lambdaschool" };' > .eslintrc.js
echo "module.exports = require('@lambdaschool/eslint-config/.prettierrc.js');" > .prettierrc.js

Using with React

npm i -D eslint @lambdaschool/eslint-config
echo 'module.exports = { extends: "@lambdaschool/eslint-config/react" };' > .eslintrc.js
echo "module.exports = require('@lambdaschool/eslint-config/.preettierrc.js');" > .prettierrc.js

Using with Typescript

npm i -D eslint @lambdaschool/eslint-config
echo 'module.exports = { extends: "@lambdaschool/eslint-config/typescript" };' > .eslintrc.js
echo "module.exports = require('@lambdaschool/eslint-config/.preettierrc.js');" > .prettierrc.js

Development

npm i
npm test

There are test files that various linting rules can be tried out on. When adding rules, add to these files or create new ones to verify that the linting behavior is as desired.

Publishing

When ready to publish, follow these steps:

1. Verify that all PRs have been merged into the staging branch.
2. Open up a PR to merge the staging branch into the master branch. Typically the PR is named after the version that will be published, for example v2.1.0.
3. After reviewing the changes that will be merged into master, determine the appropriate version change, major, minor, or patch.
4. While on the staging branch locally, update the CHANGELOG.md file with an entry for the new version you're about to publish and commit your changes.
5. While still on the staging branch locally, version the project using npm version <semver> where <semver> is major, minor, or patch. For example: npm version patch.
6. git push your local staging branch up to origin.
7. When the PR has been reviewed and merged into master, the package will be published by CI after the tests pass.