scode-eslint-config/README.md

44 lines
743 B
Markdown
Raw Normal View History

2020-01-18 22:37:39 +01:00
# Sapphirecode ESLint configuration
Javascript coding standard used by Sapphirecode
## Installation
to install this module you have to add the following line to your .npmrc
```npmrc
@scode:registry=https://npm.scode.ovh
```
then install the module and eslint
```sh
npm i --save-dev @scode/eslint-config eslint
```
then create a file named .eslintrc.js with the following contents.
it is a basic configuration, it can be customized to your preferences.
```js
module.exports = {
env: {
commonjs: true,
es6: true,
node: true
},
extends: [
'@scode'
],
globals: {
Atomics: 'readonly',
SharedArrayBuffer: 'readonly'
},
parserOptions: {
ecmaVersion: 2018
}
}
```
after that you can run eslint.