eslint-config-playvs v3.0.1
eslint-config-playvs
Take 2 minutes to absorb this readme.
Updating This Package
When dependencies go out of date, use yarn upgrade-interactive --latest
and upgrade all of them. Then in package.json
, (1) copy the dependencies to peerDependencies and (2) bump the version number. Next, commit your work and publish to master. Finally, run yarn publish
--keep the new version number.
Installation
Run the following commands at the root of your project:
yarn add eslint-config-playvs
yarn add --dev @typescript-eslint/eslint-plugin eslint eslint-config-airbnb eslint-config-prettier eslint-plugin-import eslint-plugin-jest eslint-plugin-jsx-a11y eslint-plugin-prettier eslint-plugin-react prettier typescript
Then create the following files:
// filename: ./.eslintrc.js
module.exports = {
env: {
browser: true, // XXX: if your project runs in the browser
jest: true, // XXX: if your project runs uses jest
node: true, // XXX: if your project runs on node
},
extends: ['playvs'],
}
// filename: ./prettier.config.js
module.exports = require('eslint-config-playvs/prettier.config')
Add a linting script like the following to your package.json
file:
"lint": "eslint src --ext js,jsx,ts,tsx",
Then run yarn lint
and see what the results are. Find a file with linting errors and hit CMD+s
. Does it lint and prettify the file? If not, you may have made a mistake.
Please correct any errors in these instructions.
Webpack Aliasing
If you'd like to add webpack aliasing make the following changes:
(for compilation)
// filename: ./webpack.config.js
...
resolve: {
...
alias: {
Pages: path.resolve(__dirname, 'src/pages/'),
},
extensions: [...config.resolve.extensions, '.ts', '.tsx'],
},
...
(for linting)
// filename: ./.eslintrc.js
...
settings: {
'import/resolver': {
alias: {
map: [['Pages', './src/pages']],
extensions: ['.js', '.jsx', '.ts', '.tsx'],
},
},
},
...
The result:
import { Home } from 'Pages'
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago