From f1607a6b6ca2001dc453aa2fa9cc5f9b2775d2e6 Mon Sep 17 00:00:00 2001 From: Ian Sanders Date: Tue, 25 Apr 2023 19:51:20 +0000 Subject: [PATCH 1/3] Enforce asterisk-style unordered lists --- style/accessibility.json | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/style/accessibility.json b/style/accessibility.json index 683d4c2..046af54 100644 --- a/style/accessibility.json +++ b/style/accessibility.json @@ -8,5 +8,7 @@ "no-space-in-links": false, "ol-prefix": "ordered", "single-h1": true, - "ul-style": true + "ul-style": { + "style": "asterisk" + } } From 9c556848154aa80739d0de29f2bb35832201e53a Mon Sep 17 00:00:00 2001 From: Ian Sanders Date: Tue, 25 Apr 2023 20:00:12 +0000 Subject: [PATCH 2/3] Update affected project documentation --- CONTRIBUTING.md | 8 ++++---- README.md | 14 +++++++------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 110984a..031b9c3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,8 +6,8 @@ Thank you for your interest in contributing. Depending on your needs, you may have one of two development paths: -- via integrating with an existing usage (ideal for modifying the interface of our rules) -- via unit testing (ideal for adding a new rule) +* via integrating with an existing usage (ideal for modifying the interface of our rules) +* via unit testing (ideal for adding a new rule) For that reason we've included two paths to develop. Feel free to use either, or both. @@ -32,8 +32,8 @@ It may be useful to work on this in tandem with a codebase that uses the rules. If you go to the `node_modules` directory in your codebase and try to navigate into the package, you'll notice that whatever changes you make in your local development directory will be reflected in the codebase. 3. Reset symlinks at any time by reversing the steps via `npm unlink`. - - in your codebase: `npm unlink @github/markdownlint-github` - - in this directory: `npm unlink` + * in your codebase: `npm unlink @github/markdownlint-github` + * in this directory: `npm unlink` ### Unit and Interface Testing diff --git a/README.md b/README.md index 2b7193a..5614270 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,8 @@ See opinions codified in [index.js](./index.js). The following are custom rules defined in this plugin. -- [**GH001** _no-default-alt-text_](./docs/rules/GH001-no-default-alt-text.md) -- [**GH002** _no-generic-link-text_](./docs/rules/GH002-no-generic-link-text.md) +* [**GH001** _no-default-alt-text_](./docs/rules/GH001-no-default-alt-text.md) +* [**GH002** _no-generic-link-text_](./docs/rules/GH002-no-generic-link-text.md) See [`markdownlint` rules](https://github.com/DavidAnson/markdownlint#rules--aliases) for documentation on rules pulled in from `markdownlint`. @@ -29,11 +29,11 @@ See [`markdownlint` rules](https://github.com/DavidAnson/markdownlint#rules--ali 2. Install packages. - - ```bash - npm install -D markdownlint-cli2 # if updating existing package, check for updates - npm install -D @github/markdownlint-github [--@github:registry=https://registry.npmjs.org] - npm install -D markdownlint-cli2-formatter-pretty - ``` + ```bash + npm install -D markdownlint-cli2 # if updating existing package, check for updates + npm install -D @github/markdownlint-github [--@github:registry=https://registry.npmjs.org] + npm install -D markdownlint-cli2-formatter-pretty + ``` 3. Add/modify your linting script in `package.json`. From ddd010e3c743e364d0f6a473d4e10a8bfb230d86 Mon Sep 17 00:00:00 2001 From: Ian Sanders Date: Wed, 26 Apr 2023 13:41:00 +0000 Subject: [PATCH 3/3] Fix test options --- test/usage.test.js | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/test/usage.test.js b/test/usage.test.js index 1d3fa4b..6a0d0ea 100644 --- a/test/usage.test.js +++ b/test/usage.test.js @@ -19,7 +19,9 @@ describe("usage", () => { "no-emphasis-as-header": true, "no-heading-increment": true, "no-generic-link-text": true, - "ul-style": true, + "ul-style": { + style: "asterisk", + }, default: true, "no-inline-html": false, "no-bare-urls": false,