Getting Started

Configurations

The provided configuration contains shared ESLint rules for typescript projects across Caspeco.

• Vanilla Configuration - For vanilla Typescript projects
• React Configuration - For React based projects

NPM Package

Available at @caspeco/eslint-config.

Plugins

• Caspeco

Contributing

Please run npm install before any other commands below.

Release

Publish

• Go to Github Releases
• Click "Draft a new release"
• Enter the version that you'd like to release, skip the v prefix.
• Publish

You can ignore the version in the package.json file, that is only used when you're publishing manually to NPM, e.g. a preview version.

Publish a preview to NPM

npm --ignore-scripts publish --access public --tag next

This step requires you to be a collaborator on the NPM package.

Documentation

Documentation is available in the docs/ folder and can be previewed with:

npm run docs:preview

Tests

Tests are located in the __tests__ directory. There are fixtures available for each config to represent a more representative test scenario.

npm run test

Verification

Prettier

npm run prettier:check

Type checks

npm run tsc

Credit

Based on the work of Chainsafe: eslint-config