@hi8u/eslint-config
ESLint and Prettier config for awesome projects
Install
$ yarn add -D eslint @hi8u/eslint-config
Usage
For Typescript projects
// .eslintrc.js
module.exports = {
extends: ['@hi8u/eslint-config/typescript', '@hi8u/eslint-config/prettier'],
};
For Next.js + Tailwind CSS + Typescript projects
// .eslintrc.js
const { defaultIgnorePatterns } = require('@hi8u/eslint-config/config');
module.exports = {
ignorePatterns: [...defaultIgnorePatterns, '.next'],
extends: [
'@hi8u/eslint-config/typescript',
'@hi8u/eslint-config/tailwindcss',
'next/core-web-vitals',
'@hi8u/eslint-config/prettier',
],
rules: {
'@next/next/no-img-element': 'off',
},
};
For React + Typescript projects
// .eslintrc.js
module.exports = {
extends: ['@hi8u/eslint-config/typescript', '@hi8u/eslint-config/react', '@hi8u/eslint-config/prettier'],
};
Note:
@hi8u/eslint-config/prettier
must be set at the end to disable any conflicting rules.
Supported configs
Name | Config |
---|---|
Typescript | @hi8u/eslint-config/typescript |
Prettier | @hi8u/eslint-config/prettier |
Tailwind CSS | @hi8u/eslint-config/tailwindcss |
Storybook | @hi8u/eslint-config/storybook |
React | @hi8u/eslint-config/react |
Prettier integration
Create a prettier.config.js
file in the root of your project's directory.
// prettier.config.js
const { prettierConfig } = require('@hi8u/eslint-config/config');
module.exports = prettierConfig;