kieranpotts-eslint-config

This project is archived and no longer maintained.

This repository encapsulates the code and configuration for an ESLint configuration that I use to enforce consistent coding styles and conventions across my JavaScript/TypeScript projects.

Documentation

The following documentation covers the development and maintenance of this package. For API documentation and other usage instructions, see the README of the published package in the NPM registry.

Testing

A combination of automated and manual testing is recommended, before publishing package updates.

Run npm run test from the repository root to run the automated tests. The tests work as follows:

• The test fixtures in the test/_/fixtures/* directories contain example code for each ESLint rule.

• Each test fixture is linted using the ESLint configuration from the src directory.

• The tests verify the output of the linter against the expected output.

You can also manually install the updated ESLint configuration into another JavaScript/TypeScript project. The easiest way to do this is to use npm link from the other project, passing a relative path back to the src directory of this repository. Example:

npm install ../path/to/eslint-config/src

The package will be installed as a symlink in the node_modules directory of the other project, and therefore any changes made to the ESLint configuration will be updated in the other project immediately – no npm update required.

Publishing

Publishing package updates to the NPM registry is currently a manual process. The following steps should be followed to publish a new version of the package:

1. Change to the src directory.

2. Manually update the version number in the package.json file. Review the other contents of the src directory. There is no build step, so the contents of the src directory are published as-is.

3. Follow the instructions to authenticate your NPM account.

For more guidance, see NPM’s documentation on creating and publishing unscoped public packages.

Review the package update at npmjs.com/package/kieranpotts-eslint-config..

---

Copyright © 2020-present Kieran Potts and contributors, MIT license