@nodecraft/eslint-config

Nodecraft base JS ESLint config

Usage no npm install needed!

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

README

@nodecraft/eslint-config

Actions Status

This package is modeled heavily off of Airbnb's base config. A huge thanks to their team.

Usage

We export our standard ESLint configuration.

Our default export contains all of our ESLint rules, including ECMAScript 6+. It requires eslint, eslint-plugin-node, eslint-plugin-json & eslint-plugin-unicorn & eslint-plugin-vue.

  1. Install the correct versions of each package, which are listed by the command:
npm info "@nodecraft/eslint-config@latest" peerDependencies

If using npm 5+, use this shortcut:

npx install-peerdeps --dev @nodecraft/eslint-config
  1. Add "extends": "@nodecraft" to your .eslintrc

Vue.js

If your application uses Vue.js 3.x, also add @nodecraft/eslint-config/vue3 to your extends array to inherit our Vue rules. If using Vue.js 2.x, add @nodecraft/eslint-config/vue.

Also add @nodecraft/eslint-config/vue-a11y for our Vue Accessibility rules (compatible with both Vue.js 3 and Vue.js 2.