1
- ## eslint-config-digitalbazaar
1
+ # Digital Bazaar ESLint Configs _ ( @ digitalbazaar/ eslint-config) _
2
2
3
3
This package provides eslint rules used by Digital Bazaar as a set of extendable shared configs.
4
4
5
5
There are various core rule sets:
6
- - ` eslint-config-digitalbazaar ` : Base rules for both node and browser code.
7
- - ` eslint-config-digitalbazaar /import ` : Rules for es6 imports in the browser and node code.
8
- - ` eslint-config-digitalbazaar /jsdoc ` : Rules for JSDoc for both node and browser code.
9
- - ` eslint-config-digitalbazaar /module ` : Rules for modules for both node and browser code.
10
- - ` eslint-config-digitalbazaar /vue3 ` : Rules for Vue 3 code.
6
+ - ` @digitalbazaar/ eslint-config` : Base rules for both node and browser code.
7
+ - ` @digitalbazaar/ eslint-config/import` : Rules for es6 imports in the browser and node code.
8
+ - ` @digitalbazaar/ eslint-config/jsdoc` : Rules for JSDoc for both node and browser code.
9
+ - ` @digitalbazaar/ eslint-config/module` : Rules for modules for both node and browser code.
10
+ - ` @digitalbazaar/ eslint-config/vue3` : Rules for Vue 3 code.
11
11
12
12
For common use cases, there are recommended configs, that load the core rules:
13
- - ` eslint-config-digitalbazaar /browser-recommended ` : Recommended rules for projects targeting web browsers.
14
- - ` eslint-config-digitalbazaar /node-recommended ` : Recommended rules for projects targeting node.
15
- - ` eslint-config-digitalbazaar /recommended ` : Common recommended rules.
16
- - ` eslint-config-digitalbazaar /universal-recommended ` : Recommended rules for projects targeting node and web browsers.
17
- - ` eslint-config-digitalbazaar /vue3-recommended ` : Recommended rules for projects targeting Vue 3.
13
+ - ` @digitalbazaar/ eslint-config/browser-recommended` : Recommended rules for projects targeting web browsers.
14
+ - ` @digitalbazaar/ eslint-config/node-recommended` : Recommended rules for projects targeting node.
15
+ - ` @digitalbazaar/ eslint-config/recommended` : Common recommended rules.
16
+ - ` @digitalbazaar/ eslint-config/universal-recommended` : Recommended rules for projects targeting node and web browsers.
17
+ - ` @digitalbazaar/ eslint-config/vue3-recommended` : Recommended rules for projects targeting Vue 3.
18
18
19
19
## Installation
20
20
@@ -24,7 +24,7 @@ Requires:
24
24
If you do not have eslint installed:
25
25
```
26
26
npm i -D eslint
27
- npm i -D eslint-config-digitalbazaar
27
+ npm i -D @digitalbazaar/ eslint-config
28
28
```
29
29
30
30
To start an eslint config file:
@@ -33,7 +33,7 @@ npx eslint --init
33
33
```
34
34
or rename a template from the templates dir
35
35
```
36
- cp node_modules/eslint-config-digitalbazaar /templates/node-recommended.js ./eslint.config.js
36
+ cp node_modules/@digitalbazaar/ eslint-config/templates/node-recommended.js ./eslint.config.js
37
37
```
38
38
39
39
## Usage
@@ -43,7 +43,7 @@ Config files can use the simple array syntax or the `defineConfig` syntax
43
43
44
44
Example ` eslint.config.js ` root setup:
45
45
``` js
46
- import config from ' eslint-config-digitalbazaar /recommended'
46
+ import config from ' @digitalbazaar/ eslint-config/recommended'
47
47
48
48
export default [
49
49
... config
@@ -67,8 +67,8 @@ npm i -D eslint-plugin-import
67
67
68
68
Example ` eslint.config.js ` import setup:
69
69
``` js
70
- import config from ' eslint-config-digitalbazaar /recommended'
71
- import importConfig from ' eslint-config-digitalbazaar /import'
70
+ import config from ' @digitalbazaar/ eslint-config/recommended'
71
+ import importConfig from ' @digitalbazaar/ eslint-config/import'
72
72
73
73
export default [
74
74
... config,
@@ -88,8 +88,8 @@ npm i -D eslint-plugin-jsdoc
88
88
89
89
Example ` eslint.config.js ` JSDoc setup:
90
90
``` js
91
- import config from ' eslint-config-digitalbazaar '
92
- import jsdocConfig from ' eslint-config-digitalbazaar /jsdoc'
91
+ import config from ' @digitalbazaar/ eslint-config'
92
+ import jsdocConfig from ' @digitalbazaar/ eslint-config/jsdoc'
93
93
94
94
export default [
95
95
... config,
@@ -108,8 +108,8 @@ npm i -D eslint-plugin-unicorn
108
108
109
109
Example ` eslint.config.js ` ESM setup:
110
110
``` js
111
- import config from ' eslint-config-digitalbazaar '
112
- import moduleConfig from ' eslint-config-digitalbazaar /module'
111
+ import config from ' @digitalbazaar/ eslint-config'
112
+ import moduleConfig from ' @digitalbazaar/ eslint-config/module'
113
113
114
114
export default [
115
115
... config,
@@ -127,7 +127,7 @@ npm i -D eslint-plugin-vue
127
127
Example ` eslint.config.js ` Vue setup:
128
128
``` js
129
129
import config from ' eslint-config-myconfig'
130
- import vue3Config from ' eslint-config-digitalbazaar /vue3'
130
+ import vue3Config from ' @digitalbazaar/ eslint-config/vue3'
131
131
132
132
export default [
133
133
... config,
@@ -142,9 +142,9 @@ files](https://eslint.vuejs.org/user-guide/#running-eslint-from-the-command-line
142
142
143
143
The core rules do not depend on each other and are composable:
144
144
``` js
145
- import config from ' eslint-config-digitalbazaar '
146
- import jsdocConfig from ' eslint-config-digitalbazaar /jsdoc'
147
- import vue3Config from ' eslint-config-digitalbazaar /vue3'
145
+ import config from ' @digitalbazaar/ eslint-config'
146
+ import jsdocConfig from ' @digitalbazaar/ eslint-config/jsdoc'
147
+ import vue3Config from ' @digitalbazaar/ eslint-config/vue3'
148
148
149
149
export default [
150
150
... config,
@@ -171,7 +171,7 @@ npm i -D eslint-plugin-unicorn
171
171
172
172
Rules:
173
173
``` js
174
- import config from ' eslint-config-digitalbazaar '
174
+ import config from ' @digitalbazaar/ eslint-config'
175
175
176
176
export default [
177
177
... config,
@@ -182,3 +182,12 @@ export default [
182
182
}
183
183
];
184
184
```
185
+
186
+ ## Commercial Support
187
+
188
+ Commercial support for this package is available upon request from
189
+
190
+
191
+ ## License
192
+
193
+ [ New BSD License (3-clause)] ( LICENSE ) (c) Digital Bazaar, Inc.
0 commit comments