@vonage/eslint-config 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +54 -0
- package/package.json +14 -6
package/README.md
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# Vonage Eslint Configuration
|
|
2
|
+
|
|
3
|
+
<img src="https://developer.nexmo.com/images/logos/vbc-logo.svg" height="48px" alt="Vonage" />
|
|
4
|
+
|
|
5
|
+
This is the Vonage JWT SDK for Node.js. This package helps create JWT tokens to use with [Vonage APIs](https://www.vonage.com/).
|
|
6
|
+
|
|
7
|
+
For full API documentation refer to [developer.vonage.com](https://developer.vonage.com/).
|
|
8
|
+
|
|
9
|
+
* [Installation](#installation)
|
|
10
|
+
* [Usage](#usage)
|
|
11
|
+
* [Testing](#testing)
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
|
|
15
|
+
### With NPM
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npm i -D @vonage/eslint-config
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
### With Yarn
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
yarn add @vonage/eslint-config --dev
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Usage
|
|
28
|
+
|
|
29
|
+
There are number of configurations that you can use based on the application.
|
|
30
|
+
|
|
31
|
+
Each configuration extends the base rules.
|
|
32
|
+
|
|
33
|
+
```js
|
|
34
|
+
// eslint.config.js
|
|
35
|
+
|
|
36
|
+
import vonage from '@vonage/eslint-config';
|
|
37
|
+
|
|
38
|
+
export default [
|
|
39
|
+
// Include all base rules for all JS projects
|
|
40
|
+
...vonage.configs.base,
|
|
41
|
+
|
|
42
|
+
// Include all base rules for all TypeScript projects
|
|
43
|
+
...vonage.configs.typescript,
|
|
44
|
+
|
|
45
|
+
// Include all base rules for all Jest projects
|
|
46
|
+
...vonage.configs.jest,
|
|
47
|
+
|
|
48
|
+
// Include all base rules for all Node projects
|
|
49
|
+
...vonage.configs.node,
|
|
50
|
+
];
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
*Note* currently this is only for Node.js projects. Web projects are expected to
|
|
54
|
+
be added in the future.
|
package/package.json
CHANGED
|
@@ -1,17 +1,25 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vonage/eslint-config",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "ESLint rules for Vonage",
|
|
5
|
-
"
|
|
6
|
-
"
|
|
7
|
-
|
|
8
|
-
|
|
5
|
+
"homepage": "https://github.com/Vonage-Community/vonage-eslint-config#readme",
|
|
6
|
+
"bugs": {
|
|
7
|
+
"url": "https://github.com/Vonage-Community/vonage-eslint-config/issues"
|
|
8
|
+
},
|
|
9
|
+
"repository": {
|
|
10
|
+
"type": "git",
|
|
11
|
+
"url": "git+https://github.com/Vonage-Community/vonage-eslint-config.git"
|
|
9
12
|
},
|
|
10
|
-
"author": "",
|
|
11
13
|
"license": "Apache-2.0",
|
|
14
|
+
"author": "",
|
|
15
|
+
"type": "module",
|
|
16
|
+
"main": "lib/index.js",
|
|
12
17
|
"files": [
|
|
13
18
|
"src"
|
|
14
19
|
],
|
|
20
|
+
"scripts": {
|
|
21
|
+
"lint": "eslint ."
|
|
22
|
+
},
|
|
15
23
|
"dependencies": {
|
|
16
24
|
"@eslint/js": "9.3.0",
|
|
17
25
|
"@stylistic/eslint-plugin": "2.1.0",
|