eslint-config-hypothesis

A base ESLint configuration for Hypothesis projects

Usage no npm install needed!

<script type="module">
  import eslintConfigHypothesis from 'https://cdn.skypack.dev/eslint-config-hypothesis';
</script>

README

eslint-config-hypothesis

A shareable ESLint configuration for Hypothesis frontend projects.

To use it:

  1. Add eslint-config-hypothesis as a dependency to your project

  2. Add the config's peer dependencies (see peerDependencies in package.json) to your project's dependencies

  3. Add an ESLint config file to the repository which extends the "hypothesis" config. For example, a .eslintrc file with the following content:

    {
  "extends": ["hypothesis"]
}

Rule notes

  • All rules from eslint:recommended are enabled
  • All rules are configured to produce errors and not warnings. This is based on the principle that an issue is either worth fixing or should be ignored, and warnings just add noise
  • The config assumes that you are using mocha for tests and React/Preact for any interactive UI
  • Code formatting rules that are obsoleted by automated formatters are disabled. You should use Prettier to auto-format code.