[pve-eslint.git] / eslint / docs / README.md

# ESLint Documentation

## Run Locally

```shell
npm start
```

## Scripts

To update the links data file, run this from the root folder (not the `docs` folder):

```shell
npm run docs:update-links
```

To lint JS files, run this from the root folder (not the `docs` folder):

```shell
npm run lint:docsjs
```

To autofix JS files, run this from the root folder (not the `docs` folder):

```shell
npm run fix:docsjs
```
Commit	Line	Data
8f9d1d4d	1	# ESLint Documentation
eb39fafa	2
8f9d1d4d	3	## Run Locally
eb39fafa	4
8f9d1d4d DC	5	```shell
	6	npm start
	7	```
eb39fafa	8
8f9d1d4d	9	## Scripts
eb39fafa	10
8f9d1d4d	11	To update the links data file, run this from the root folder (not the `docs` folder):
eb39fafa	12
8f9d1d4d DC	13	```shell
	14	npm run docs:update-links
	15	```
eb39fafa	16
8f9d1d4d	17	To lint JS files, run this from the root folder (not the `docs` folder):
eb39fafa	18
8f9d1d4d DC	19	```shell
	20	npm run lint:docsjs
	21	```
	22
	23	To autofix JS files, run this from the root folder (not the `docs` folder):
	24
	25	```shell
	26	npm run fix:docsjs
	27	```