Skip to content

Commit 5acf5f1

Browse files
committed
Rename package to @digitalbazaar/eslint-config.
**BREAKING**: Rename NPM package from `eslint-config-digitalbazaar` to `@digitalbazaar/eslint-config`.
1 parent 735b537 commit 5acf5f1

File tree

7 files changed

+42
-31
lines changed

7 files changed

+42
-31
lines changed

CHANGELOG.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
# eslint-config-digitalbazaar ChangeLog
1+
# @digitalbazaar/eslint-config ChangeLog
22

33
### 6.0.0 - 2025-08-xx
44

55
### Changed
6+
- **BREAKING**: Rename NPM package from `eslint-config-digitalbazaar` to
7+
`@digitalbazaar/eslint-config`.
68
- **BREAKING**: Update to `eslint@9`.
79
- Please see the migration notes below.
810
- Comments and suggestions welcome for how best to adapt to the rules that

README.md

Lines changed: 34 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
## eslint-config-digitalbazaar
1+
# Digital Bazaar ESLint Configs _(@digitalbazaar/eslint-config)_
22

33
This package provides eslint rules used by Digital Bazaar as a set of extendable shared configs.
44

55
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.
1111

1212
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.
1818

1919
## Installation
2020

@@ -24,7 +24,7 @@ Requires:
2424
If you do not have eslint installed:
2525
```
2626
npm i -D eslint
27-
npm i -D eslint-config-digitalbazaar
27+
npm i -D @digitalbazaar/eslint-config
2828
```
2929

3030
To start an eslint config file:
@@ -33,7 +33,7 @@ npx eslint --init
3333
```
3434
or rename a template from the templates dir
3535
```
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
3737
```
3838

3939
## Usage
@@ -43,7 +43,7 @@ Config files can use the simple array syntax or the `defineConfig` syntax
4343

4444
Example `eslint.config.js` root setup:
4545
```js
46-
import config from 'eslint-config-digitalbazaar/recommended'
46+
import config from '@digitalbazaar/eslint-config/recommended'
4747

4848
export default [
4949
...config
@@ -67,8 +67,8 @@ npm i -D eslint-plugin-import
6767

6868
Example `eslint.config.js` import setup:
6969
```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'
7272

7373
export default [
7474
...config,
@@ -88,8 +88,8 @@ npm i -D eslint-plugin-jsdoc
8888

8989
Example `eslint.config.js` JSDoc setup:
9090
```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'
9393

9494
export default [
9595
...config,
@@ -108,8 +108,8 @@ npm i -D eslint-plugin-unicorn
108108

109109
Example `eslint.config.js` ESM setup:
110110
```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'
113113

114114
export default [
115115
...config,
@@ -127,7 +127,7 @@ npm i -D eslint-plugin-vue
127127
Example `eslint.config.js` Vue setup:
128128
```js
129129
import config from 'eslint-config-myconfig'
130-
import vue3Config from 'eslint-config-digitalbazaar/vue3'
130+
import vue3Config from '@digitalbazaar/eslint-config/vue3'
131131

132132
export default [
133133
...config,
@@ -142,9 +142,9 @@ files](https://eslint.vuejs.org/user-guide/#running-eslint-from-the-command-line
142142

143143
The core rules do not depend on each other and are composable:
144144
```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'
148148

149149
export default [
150150
...config,
@@ -171,7 +171,7 @@ npm i -D eslint-plugin-unicorn
171171

172172
Rules:
173173
```js
174-
import config from 'eslint-config-digitalbazaar'
174+
import config from '@digitalbazaar/eslint-config'
175175

176176
export default [
177177
...config,
@@ -182,3 +182,12 @@ export default [
182182
}
183183
];
184184
```
185+
186+
## Commercial Support
187+
188+
Commercial support for this package is available upon request from
189+
Digital Bazaar: [email protected]
190+
191+
## License
192+
193+
[New BSD License (3-clause)](LICENSE) (c) Digital Bazaar, Inc.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "eslint-config-digitalbazaar",
2+
"name": "@digitalbazaar/eslint-config",
33
"version": "5.2.1-0",
44
"description": "Digital Bazaar's eslint rules",
55
"type": "module",

templates/browser.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import config from 'eslint-config-digitalbazaar/browser-recommended';
1+
import config from '@digitalbazaar/eslint-config/browser-recommended';
22

33
export default [
44
...config

templates/node.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import config from 'eslint-config-digitalbazaar/node-recommended';
1+
import config from '@digitalbazaar/eslint-config/node-recommended';
22

33
export default [
44
...config

templates/universal.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import config from 'eslint-config-digitalbazaar/universal-recommended';
1+
import config from '@digitalbazaar/eslint-config/universal-recommended';
22

33
export default [
44
...config

templates/vue3.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import config from 'eslint-config-digitalbazaar/vue3-recommended';
1+
import config from '@digitalbazaar/eslint-config/vue3-recommended';
22

33
export default [
44
...config

0 commit comments

Comments
 (0)