This commit is contained in:
parent
afd450705a
commit
20db8a9d56
40
README.md
40
README.md
@ -4,6 +4,14 @@ This repository is the NPM package for ESLINT configuration of IO-Projects TypeS
|
||||
|
||||
## Installation
|
||||
|
||||
Add the registery to your `.npmrc` file:
|
||||
|
||||
```bash
|
||||
@ioprojects:registry=https://git.endmove.eu/api/packages/IO-ProjectsOfficial/npm/
|
||||
```
|
||||
|
||||
Install the package:
|
||||
|
||||
```bash
|
||||
# with yarn
|
||||
yarn add -D @io-projects/eslint-config
|
||||
@ -11,3 +19,35 @@ yarn add -D @io-projects/eslint-config
|
||||
# with npm
|
||||
npm install --save-dev @io-projects/eslint-config
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Add the following to your `.eslintrc.js` file:
|
||||
|
||||
```js
|
||||
module.exports = {
|
||||
extends: [
|
||||
'@io-projects/eslint-config'
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
**Or**
|
||||
|
||||
Add the following to your `.eslintrc.json` file:
|
||||
|
||||
```json
|
||||
{
|
||||
"extends": [
|
||||
"@io-projects/eslint-config"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
**Or**
|
||||
|
||||
Add the following to your `.eslintrc.cjs` file:
|
||||
|
||||
```js
|
||||
module.exports = require('@ioprojects/ui-eslint-base');
|
||||
```
|
||||
|
4
package-lock.json
generated
4
package-lock.json
generated
@ -1,11 +1,11 @@
|
||||
{
|
||||
"name": "@ioprojects/ui-eslint-base",
|
||||
"name": "@ioprojects/eslint-config",
|
||||
"version": "1.0.4",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "@ioprojects/ui-eslint-base",
|
||||
"name": "@ioprojects/eslint-config",
|
||||
"version": "1.0.4",
|
||||
"license": "SEE LICENSE FILE",
|
||||
"dependencies": {
|
||||
|
@ -1,5 +1,5 @@
|
||||
{
|
||||
"name": "@endmove/eslint-config",
|
||||
"name": "@ioprojects/eslint-config",
|
||||
"version": "1.0.4",
|
||||
"description": "NPM package for ESLINT configuration of IO-Projects TypeScript front-end projects",
|
||||
"author": "IO-Projects <contact@io-projects.com>",
|
||||
|
Loading…
Reference in New Issue
Block a user