Skip to content

Commit c71b2d6

Browse files
authored
Enforce asterisk-style unordered lists (#41)
* Enforce asterisk-style unordered lists * Update affected project documentation * Fix test options
1 parent 37bdbda commit c71b2d6

File tree

4 files changed

+17
-13
lines changed

4 files changed

+17
-13
lines changed

CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Thank you for your interest in contributing.
66

77
Depending on your needs, you may have one of two development paths:
88

9-
- via integrating with an existing usage (ideal for modifying the interface of our rules)
10-
- via unit testing (ideal for adding a new rule)
9+
* via integrating with an existing usage (ideal for modifying the interface of our rules)
10+
* via unit testing (ideal for adding a new rule)
1111

1212
For that reason we've included two paths to develop. Feel free to use either, or both.
1313

@@ -32,8 +32,8 @@ It may be useful to work on this in tandem with a codebase that uses the rules.
3232
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.
3333
3434
3. Reset symlinks at any time by reversing the steps via `npm unlink`.
35-
- in your codebase: `npm unlink @github/markdownlint-github`
36-
- in this directory: `npm unlink`
35+
* in your codebase: `npm unlink @github/markdownlint-github`
36+
* in this directory: `npm unlink`
3737
3838
### Unit and Interface Testing
3939

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ See opinions codified in [index.js](./index.js).
1212

1313
The following are custom rules defined in this plugin.
1414

15-
- [**GH001** _no-default-alt-text_](./docs/rules/GH001-no-default-alt-text.md)
16-
- [**GH002** _no-generic-link-text_](./docs/rules/GH002-no-generic-link-text.md)
15+
* [**GH001** _no-default-alt-text_](./docs/rules/GH001-no-default-alt-text.md)
16+
* [**GH002** _no-generic-link-text_](./docs/rules/GH002-no-generic-link-text.md)
1717

1818
See [`markdownlint` rules](https://github.com/DavidAnson/markdownlint#rules--aliases) for documentation on rules pulled in from `markdownlint`.
1919

@@ -29,11 +29,11 @@ See [`markdownlint` rules](https://github.com/DavidAnson/markdownlint#rules--ali
2929

3030
2. Install packages.
3131

32-
- ```bash
33-
npm install -D markdownlint-cli2 # if updating existing package, check for updates
34-
npm install -D @github/markdownlint-github [--@github:registry=https://registry.npmjs.org]
35-
npm install -D markdownlint-cli2-formatter-pretty
36-
```
32+
```bash
33+
npm install -D markdownlint-cli2 # if updating existing package, check for updates
34+
npm install -D @github/markdownlint-github [--@github:registry=https://registry.npmjs.org]
35+
npm install -D markdownlint-cli2-formatter-pretty
36+
```
3737

3838
3. Add/modify your linting script in `package.json`.
3939

style/accessibility.json

+3-1
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,7 @@
88
"no-space-in-links": false,
99
"ol-prefix": "ordered",
1010
"single-h1": true,
11-
"ul-style": true
11+
"ul-style": {
12+
"style": "asterisk"
13+
}
1214
}

test/usage.test.js

+3-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,9 @@ describe("usage", () => {
1919
"no-emphasis-as-header": true,
2020
"no-heading-increment": true,
2121
"no-generic-link-text": true,
22-
"ul-style": true,
22+
"ul-style": {
23+
style: "asterisk",
24+
},
2325
default: true,
2426
"no-inline-html": false,
2527
"no-bare-urls": false,

0 commit comments

Comments
 (0)