Skip to content

Enforce asterisk-style unordered lists #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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

Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand All @@ -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`.

Expand Down
4 changes: 3 additions & 1 deletion style/accessibility.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,7 @@
"no-space-in-links": false,
"ol-prefix": "ordered",
"single-h1": true,
"ul-style": true
"ul-style": {
"style": "asterisk"
}
}
4 changes: 3 additions & 1 deletion test/usage.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down