Skip to content

Commit 9b2b93c

Browse files
chore: Bump the all-dependencies group across 1 directory with 4 updates (#152)
* chore: Bump the all-dependencies group across 1 directory with 4 updates Bumps the all-dependencies group with 4 updates in the / directory: [eslint](https://github.com/eslint/eslint), [globals](https://github.com/sindresorhus/globals), [markdownlint](https://github.com/DavidAnson/markdownlint) and [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2). Updates `eslint` from 9.25.1 to 9.26.0 - [Release notes](https://github.com/eslint/eslint/releases) - [Changelog](https://github.com/eslint/eslint/blob/main/CHANGELOG.md) - [Commits](eslint/eslint@v9.25.1...v9.26.0) Updates `globals` from 16.0.0 to 16.1.0 - [Release notes](https://github.com/sindresorhus/globals/releases) - [Commits](sindresorhus/globals@v16.0.0...v16.1.0) Updates `markdownlint` from 0.37.4 to 0.38.0 - [Changelog](https://github.com/DavidAnson/markdownlint/blob/main/CHANGELOG.md) - [Commits](DavidAnson/markdownlint@v0.37.4...v0.38.0) Updates `markdownlint-cli2` from 0.17.2 to 0.18.0 - [Changelog](https://github.com/DavidAnson/markdownlint-cli2/blob/main/CHANGELOG.md) - [Commits](DavidAnson/markdownlint-cli2@v0.17.2...v0.18.0) --- updated-dependencies: - dependency-name: eslint dependency-version: 9.26.0 dependency-type: direct:development update-type: version-update:semver-minor dependency-group: all-dependencies - dependency-name: globals dependency-version: 16.1.0 dependency-type: direct:development update-type: version-update:semver-minor dependency-group: all-dependencies - dependency-name: markdownlint dependency-version: 0.38.0 dependency-type: direct:development update-type: version-update:semver-minor dependency-group: all-dependencies - dependency-name: markdownlint-cli2 dependency-version: 0.18.0 dependency-type: direct:development update-type: version-update:semver-minor dependency-group: all-dependencies ... Signed-off-by: dependabot[bot] <[email protected]> * Update `markdownlint-github` for new breaking change * Add `markdown-it` as a dependency to be safe --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Joyce Zhu <[email protected]>
1 parent 47d38ea commit 9b2b93c

File tree

6 files changed

+755
-117
lines changed

6 files changed

+755
-117
lines changed

.markdownlint-cli2.mjs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1+
import markdownIt from "markdown-it";
12
import { init } from "./index.js";
23

4+
const markdownItFactory = () => markdownIt({ html: true });
5+
36
const configOptions = await init({
47
default: false,
58
"heading-increment": true,
@@ -11,5 +14,6 @@ const configOptions = await init({
1114
const options = {
1215
config: configOptions,
1316
customRules: ["./index.js"],
17+
markdownItFactory,
1418
};
1519
export default options;

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,13 @@ See [`markdownlint` rules](https://github.com/DavidAnson/markdownlint#rules--ali
4747
4. Edit `.markdownlint-cli2.mjs` file to suit your needs. Start with
4848

4949
```js
50+
import markdownIt from "markdown-it"
5051
import configOptions, {init} from "@github/markdownlint-github"
52+
const markdownItFactory = () => markdownIt({ html: true })
5153
const options = {
5254
config: init(),
5355
customRules: ["@github/markdownlint-github"],
56+
markdownItFactory,
5457
outputFormatters: [
5558
[ "markdownlint-cli2-formatter-pretty", { "appendLink": true } ] // ensures the error message includes a link to the rule documentation
5659
]
@@ -62,13 +65,16 @@ See [`markdownlint` rules](https://github.com/DavidAnson/markdownlint#rules--ali
6265
This looks like:
6366
6467
```js
68+
import markdownIt from "markdown-it"
6569
import configOptions, {init} from "@github/markdownlint-github"
6670
const overriddenOptions = init({
6771
'fenced-code-language': false, // Custom overrides
6872
})
73+
const markdownItFactory = () => markdownIt({ html: true })
6974
const options = {
7075
config: overriddenOptions,
7176
customRules: ["@github/markdownlint-github"],
77+
markdownItFactory,
7278
outputFormatters: [
7379
[ "markdownlint-cli2-formatter-pretty", { "appendLink": true } ]
7480
]
@@ -96,9 +102,12 @@ The rule will need to be enabled in the configuration. For instance, if you intr
96102
97103
```js
98104
import configOptions, {init} from "@github/markdownlint-github"
105+
import markdownIt from "markdown-it"
106+
const markdownItFactory = () => markdownIt({ html: true })
99107
const options = init({
100108
"some-rule": true,
101109
customRules: ["@github/markdownlint-github", "some-rule.js"],
110+
markdownItFactory
102111
})
103112
export default options
104113
```

0 commit comments

Comments
 (0)