Skip to content

Commit b12abb8

Browse files
authored
docs: correct way to get the default module in examples (conventional-changelog#2425)
* docs: correct way to get the default module in examples * style: using destructuring assignment syntax sugar * Revert "style: using destructuring assignment syntax sugar" fix(syntax): CommonJS can't require default entry using this syntax sugar, so revert it This reverts commit 511c639.
1 parent d982dc2 commit b12abb8

File tree

5 files changed

+14
-14
lines changed

5 files changed

+14
-14
lines changed

@commitlint/format/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ npm install --save @commitlint/format
1111
## Example
1212

1313
```js
14-
const format = require('@commitlint/format');
14+
const format = require('@commitlint/format').default;
1515

1616
const output = format(
1717
{

@commitlint/lint/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ npm install --save @commitlint/lint
1111
## Example
1212

1313
```js
14-
const lint = require('@commitlint/lint');
14+
const lint = require('@commitlint/lint').default;
1515

1616
lint('foo: bar', {'type-enum': [1, 'always', ['foo']]}).then((report) =>
1717
console.log(report)

@commitlint/load/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ npm install --save-dev @commitlint/load
1111
## Example
1212

1313
```js
14-
const load = require('@commitlint/load');
14+
const load = require('@commitlint/load').default;
1515

1616
load({extends: ['./package']}).then((config) => console.log(config));
1717
// => { extends: ['./package', './package-b'], rules: {} }

@commitlint/read/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ npm install --save @commitlint/read
1111
## Example
1212

1313
```js
14-
const read = require('@commitlint/read');
14+
const read = require('@commitlint/read').default;
1515

1616
// Read last edited commit message
1717
read({edit: true}).then((messages) => console.log(messages));

docs/reference-api.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ format(report?: Report = {}, options?: formatOptions = {}) => string[];
7272
- **Example**
7373

7474
```js
75-
const format = require('@commitlint/format');
75+
const format = require('@commitlint/format').default;
7676

7777
format(); // => [ '\u001b[1m\u001b[32m✔\u001b[39m found 0 problems, 0 warnings\u001b[22m' ]
7878

@@ -245,7 +245,7 @@ load(seed: Seed = {}, options?: LoadOptions = {cwd: process.cwd()}) => Promise<C
245245
- **Example**
246246

247247
```js
248-
const load = require('@commitlint/load');
248+
const load = require('@commitlint/load').default;
249249

250250
load({
251251
rules: {
@@ -363,7 +363,7 @@ lint(message: string, rules: {[ruleName: string]: Rule}, opts?: Options) => Prom
363363
- **Basic Example**
364364

365365
```js
366-
const lint = require('@commitlint/lint');
366+
const lint = require('@commitlint/lint').default;
367367

368368
lint('foo: bar').then((report) => console.log(report));
369369
// => { valid: true, errors: [], warnings: [] }
@@ -402,8 +402,8 @@ lint('foo-bar', {'type-enum': [2, 'always', ['foo']]}, opts).then((report) =>
402402
- **Load configuration**
403403

404404
```js
405-
const load = require('@commitlint/load');
406-
const lint = require('@commitlint/lint');
405+
const load = require('@commitlint/load').default;
406+
const lint = require('@commitlint/lint').default;
407407

408408
const CONFIG = {
409409
extends: ['@commitlint/config-conventional'],
@@ -432,8 +432,8 @@ load(CONFIG)
432432
- **Read git history**
433433

434434
```js
435-
const lint = require('@commitlint/lint');
436-
const read = require('@commitlint/read');
435+
const lint = require('@commitlint/lint').default;
436+
const read = require('@commitlint/read').default;
437437

438438
const RULES = {
439439
'type-enum': [2, 'always', ['foo']],
@@ -449,9 +449,9 @@ read({to: 'HEAD', from: 'HEAD~2'}).then((commits) =>
449449
- **Simplfied last-commit checker**
450450

451451
```js
452-
const load = require('@commitlint/load');
453-
const read = require('@commitlint/read');
454-
const lint = require('@commitlint/lint');
452+
const load = require('@commitlint/load').default;
453+
const read = require('@commitlint/read').default;
454+
const lint = require('@commitlint/lint').default;
455455

456456
Promise.all([load(), read({from: 'HEAD~1'})])
457457
.then((tasks) => {

0 commit comments

Comments
 (0)