From 09f1a250850a3e70252b56f3f809e75fee81cbf1 Mon Sep 17 00:00:00 2001 From: beet <63141491+beetcb@users.noreply.github.com> Date: Sun, 24 Jan 2021 18:20:50 +0800 Subject: [PATCH 1/3] docs: correct way to get the default module in examples --- @commitlint/format/README.md | 2 +- @commitlint/lint/README.md | 2 +- @commitlint/load/README.md | 2 +- @commitlint/read/README.md | 2 +- docs/reference-api.md | 20 ++++++++++---------- 5 files changed, 14 insertions(+), 14 deletions(-) diff --git a/@commitlint/format/README.md b/@commitlint/format/README.md index 284829f948..b815fb89fd 100644 --- a/@commitlint/format/README.md +++ b/@commitlint/format/README.md @@ -11,7 +11,7 @@ npm install --save @commitlint/format ## Example ```js -const format = require('@commitlint/format'); +const format = require('@commitlint/format').default; const output = format( { diff --git a/@commitlint/lint/README.md b/@commitlint/lint/README.md index acac11e96e..a863241afd 100644 --- a/@commitlint/lint/README.md +++ b/@commitlint/lint/README.md @@ -11,7 +11,7 @@ npm install --save @commitlint/lint ## Example ```js -const lint = require('@commitlint/lint'); +const lint = require('@commitlint/lint').default; lint('foo: bar', {'type-enum': [1, 'always', ['foo']]}).then((report) => console.log(report) diff --git a/@commitlint/load/README.md b/@commitlint/load/README.md index f41d378803..9488693304 100644 --- a/@commitlint/load/README.md +++ b/@commitlint/load/README.md @@ -11,7 +11,7 @@ npm install --save-dev @commitlint/load ## Example ```js -const load = require('@commitlint/load'); +const load = require('@commitlint/load').default; load({extends: ['./package']}).then((config) => console.log(config)); // => { extends: ['./package', './package-b'], rules: {} } diff --git a/@commitlint/read/README.md b/@commitlint/read/README.md index 7ce615cf42..acb77a6bb9 100644 --- a/@commitlint/read/README.md +++ b/@commitlint/read/README.md @@ -11,7 +11,7 @@ npm install --save @commitlint/read ## Example ```js -const read = require('@commitlint/read'); +const read = require('@commitlint/read').default; // Read last edited commit message read({edit: true}).then((messages) => console.log(messages)); diff --git a/docs/reference-api.md b/docs/reference-api.md index 95c4d6bd74..794ceb3315 100644 --- a/docs/reference-api.md +++ b/docs/reference-api.md @@ -72,7 +72,7 @@ format(report?: Report = {}, options?: formatOptions = {}) => string[]; - **Example** ```js -const format = require('@commitlint/format'); +const format = require('@commitlint/format').default; format(); // => [ '\u001b[1m\u001b[32m✔\u001b[39m found 0 problems, 0 warnings\u001b[22m' ] @@ -245,7 +245,7 @@ load(seed: Seed = {}, options?: LoadOptions = {cwd: process.cwd()}) => Promise Prom - **Basic Example** ```js -const lint = require('@commitlint/lint'); +const lint = require('@commitlint/lint').default; lint('foo: bar').then((report) => console.log(report)); // => { valid: true, errors: [], warnings: [] } @@ -402,8 +402,8 @@ lint('foo-bar', {'type-enum': [2, 'always', ['foo']]}, opts).then((report) => - **Load configuration** ```js -const load = require('@commitlint/load'); -const lint = require('@commitlint/lint'); +const load = require('@commitlint/load').default; +const lint = require('@commitlint/lint').default; const CONFIG = { extends: ['@commitlint/config-conventional'], @@ -432,8 +432,8 @@ load(CONFIG) - **Read git history** ```js -const lint = require('@commitlint/lint'); -const read = require('@commitlint/read'); +const lint = require('@commitlint/lint').default; +const read = require('@commitlint/read').default; const RULES = { 'type-enum': [2, 'always', ['foo']], @@ -449,9 +449,9 @@ read({to: 'HEAD', from: 'HEAD~2'}).then((commits) => - **Simplfied last-commit checker** ```js -const load = require('@commitlint/load'); -const read = require('@commitlint/read'); -const lint = require('@commitlint/lint'); +const load = require('@commitlint/load').default; +const read = require('@commitlint/read').default; +const lint = require('@commitlint/lint').default; Promise.all([load(), read({from: 'HEAD~1'})]) .then((tasks) => { From 511c6395ca1999aed40af89ea8b87986ead81dcd Mon Sep 17 00:00:00 2001 From: be beet <63141491+beetcb@users.noreply.github.com> Date: Wed, 3 Feb 2021 01:59:26 -0800 Subject: [PATCH 2/3] style: using destructuring assignment syntax sugar --- @commitlint/format/README.md | 2 +- @commitlint/lint/README.md | 2 +- @commitlint/load/README.md | 2 +- @commitlint/read/README.md | 2 +- docs/reference-api.md | 22 +++++++++++----------- 5 files changed, 15 insertions(+), 15 deletions(-) diff --git a/@commitlint/format/README.md b/@commitlint/format/README.md index b815fb89fd..152ada930e 100644 --- a/@commitlint/format/README.md +++ b/@commitlint/format/README.md @@ -11,7 +11,7 @@ npm install --save @commitlint/format ## Example ```js -const format = require('@commitlint/format').default; +const {format} = require('@commitlint/format'); const output = format( { diff --git a/@commitlint/lint/README.md b/@commitlint/lint/README.md index a863241afd..4f37ba43f8 100644 --- a/@commitlint/lint/README.md +++ b/@commitlint/lint/README.md @@ -11,7 +11,7 @@ npm install --save @commitlint/lint ## Example ```js -const lint = require('@commitlint/lint').default; +const {lint} = require('@commitlint/lint'); lint('foo: bar', {'type-enum': [1, 'always', ['foo']]}).then((report) => console.log(report) diff --git a/@commitlint/load/README.md b/@commitlint/load/README.md index 9488693304..15e6282a72 100644 --- a/@commitlint/load/README.md +++ b/@commitlint/load/README.md @@ -11,7 +11,7 @@ npm install --save-dev @commitlint/load ## Example ```js -const load = require('@commitlint/load').default; +const {load} = require('@commitlint/load'); load({extends: ['./package']}).then((config) => console.log(config)); // => { extends: ['./package', './package-b'], rules: {} } diff --git a/@commitlint/read/README.md b/@commitlint/read/README.md index acb77a6bb9..3516335664 100644 --- a/@commitlint/read/README.md +++ b/@commitlint/read/README.md @@ -11,7 +11,7 @@ npm install --save @commitlint/read ## Example ```js -const read = require('@commitlint/read').default; +const {read} = require('@commitlint/read'); // Read last edited commit message read({edit: true}).then((messages) => console.log(messages)); diff --git a/docs/reference-api.md b/docs/reference-api.md index 794ceb3315..f37ca87974 100644 --- a/docs/reference-api.md +++ b/docs/reference-api.md @@ -72,7 +72,7 @@ format(report?: Report = {}, options?: formatOptions = {}) => string[]; - **Example** ```js -const format = require('@commitlint/format').default; +const {format} = require('@commitlint/format'); format(); // => [ '\u001b[1m\u001b[32m✔\u001b[39m found 0 problems, 0 warnings\u001b[22m' ] @@ -245,7 +245,7 @@ load(seed: Seed = {}, options?: LoadOptions = {cwd: process.cwd()}) => Promise Promise ```js // git commit -m "I did something" -const read = require('@commitlint/read').default; +const {read} = require('@commitlint/read'); read({edit: true}).then((messages) => console.log(messages)); // => ['I did something\n\n'] @@ -363,7 +363,7 @@ lint(message: string, rules: {[ruleName: string]: Rule}, opts?: Options) => Prom - **Basic Example** ```js -const lint = require('@commitlint/lint').default; +const {lint} = require('@commitlint/lint'); lint('foo: bar').then((report) => console.log(report)); // => { valid: true, errors: [], warnings: [] } @@ -402,8 +402,8 @@ lint('foo-bar', {'type-enum': [2, 'always', ['foo']]}, opts).then((report) => - **Load configuration** ```js -const load = require('@commitlint/load').default; -const lint = require('@commitlint/lint').default; +const {load} = require('@commitlint/load'); +const {lint} = require('@commitlint/lint'); const CONFIG = { extends: ['@commitlint/config-conventional'], @@ -432,8 +432,8 @@ load(CONFIG) - **Read git history** ```js -const lint = require('@commitlint/lint').default; -const read = require('@commitlint/read').default; +const {lint} = require('@commitlint/lint'); +const {read} = require('@commitlint/read'); const RULES = { 'type-enum': [2, 'always', ['foo']], @@ -449,9 +449,9 @@ read({to: 'HEAD', from: 'HEAD~2'}).then((commits) => - **Simplfied last-commit checker** ```js -const load = require('@commitlint/load').default; -const read = require('@commitlint/read').default; -const lint = require('@commitlint/lint').default; +const {load} = require('@commitlint/load'); +const {read} = require('@commitlint/read'); +const {lint} = require('@commitlint/lint'); Promise.all([load(), read({from: 'HEAD~1'})]) .then((tasks) => { From da8a7b29cf007cec73d8a56eee8bf5e7dd506a95 Mon Sep 17 00:00:00 2001 From: be beet <63141491+beetcb@users.noreply.github.com> Date: Fri, 5 Feb 2021 18:20:21 +0800 Subject: [PATCH 3/3] 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 511c6395ca1999aed40af89ea8b87986ead81dcd. --- @commitlint/format/README.md | 2 +- @commitlint/lint/README.md | 2 +- @commitlint/load/README.md | 2 +- @commitlint/read/README.md | 2 +- docs/reference-api.md | 22 +++++++++++----------- 5 files changed, 15 insertions(+), 15 deletions(-) diff --git a/@commitlint/format/README.md b/@commitlint/format/README.md index 152ada930e..b815fb89fd 100644 --- a/@commitlint/format/README.md +++ b/@commitlint/format/README.md @@ -11,7 +11,7 @@ npm install --save @commitlint/format ## Example ```js -const {format} = require('@commitlint/format'); +const format = require('@commitlint/format').default; const output = format( { diff --git a/@commitlint/lint/README.md b/@commitlint/lint/README.md index 4f37ba43f8..a863241afd 100644 --- a/@commitlint/lint/README.md +++ b/@commitlint/lint/README.md @@ -11,7 +11,7 @@ npm install --save @commitlint/lint ## Example ```js -const {lint} = require('@commitlint/lint'); +const lint = require('@commitlint/lint').default; lint('foo: bar', {'type-enum': [1, 'always', ['foo']]}).then((report) => console.log(report) diff --git a/@commitlint/load/README.md b/@commitlint/load/README.md index 15e6282a72..9488693304 100644 --- a/@commitlint/load/README.md +++ b/@commitlint/load/README.md @@ -11,7 +11,7 @@ npm install --save-dev @commitlint/load ## Example ```js -const {load} = require('@commitlint/load'); +const load = require('@commitlint/load').default; load({extends: ['./package']}).then((config) => console.log(config)); // => { extends: ['./package', './package-b'], rules: {} } diff --git a/@commitlint/read/README.md b/@commitlint/read/README.md index 3516335664..acb77a6bb9 100644 --- a/@commitlint/read/README.md +++ b/@commitlint/read/README.md @@ -11,7 +11,7 @@ npm install --save @commitlint/read ## Example ```js -const {read} = require('@commitlint/read'); +const read = require('@commitlint/read').default; // Read last edited commit message read({edit: true}).then((messages) => console.log(messages)); diff --git a/docs/reference-api.md b/docs/reference-api.md index f37ca87974..794ceb3315 100644 --- a/docs/reference-api.md +++ b/docs/reference-api.md @@ -72,7 +72,7 @@ format(report?: Report = {}, options?: formatOptions = {}) => string[]; - **Example** ```js -const {format} = require('@commitlint/format'); +const format = require('@commitlint/format').default; format(); // => [ '\u001b[1m\u001b[32m✔\u001b[39m found 0 problems, 0 warnings\u001b[22m' ] @@ -245,7 +245,7 @@ load(seed: Seed = {}, options?: LoadOptions = {cwd: process.cwd()}) => Promise Promise ```js // git commit -m "I did something" -const {read} = require('@commitlint/read'); +const read = require('@commitlint/read').default; read({edit: true}).then((messages) => console.log(messages)); // => ['I did something\n\n'] @@ -363,7 +363,7 @@ lint(message: string, rules: {[ruleName: string]: Rule}, opts?: Options) => Prom - **Basic Example** ```js -const {lint} = require('@commitlint/lint'); +const lint = require('@commitlint/lint').default; lint('foo: bar').then((report) => console.log(report)); // => { valid: true, errors: [], warnings: [] } @@ -402,8 +402,8 @@ lint('foo-bar', {'type-enum': [2, 'always', ['foo']]}, opts).then((report) => - **Load configuration** ```js -const {load} = require('@commitlint/load'); -const {lint} = require('@commitlint/lint'); +const load = require('@commitlint/load').default; +const lint = require('@commitlint/lint').default; const CONFIG = { extends: ['@commitlint/config-conventional'], @@ -432,8 +432,8 @@ load(CONFIG) - **Read git history** ```js -const {lint} = require('@commitlint/lint'); -const {read} = require('@commitlint/read'); +const lint = require('@commitlint/lint').default; +const read = require('@commitlint/read').default; const RULES = { 'type-enum': [2, 'always', ['foo']], @@ -449,9 +449,9 @@ read({to: 'HEAD', from: 'HEAD~2'}).then((commits) => - **Simplfied last-commit checker** ```js -const {load} = require('@commitlint/load'); -const {read} = require('@commitlint/read'); -const {lint} = require('@commitlint/lint'); +const load = require('@commitlint/load').default; +const read = require('@commitlint/read').default; +const lint = require('@commitlint/lint').default; Promise.all([load(), read({from: 'HEAD~1'})]) .then((tasks) => {