Skip to content

Commit

Permalink
Test fixes, begin to clean up
Browse files Browse the repository at this point in the history
  • Loading branch information
JoyceZhu committed Jan 17, 2025
1 parent 239b15a commit db5cd52
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 8 deletions.
10 changes: 8 additions & 2 deletions .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,14 @@
"plugins": ["github"],
"extends": ["plugin:github/recommended"],
"rules": {
"import/no-commonjs": "off",
"filenames/match-regex": "off",
"i18n-text/no-en": "off"
"i18n-text/no-en": "off",
"import/extensions": ["error", { "js": "ignorePackages"}],
"import/no-unresolved": [
"error",
{
"ignore": ["^markdownlint/.+"]
}
]
}
}
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ See [`markdownlint` rules](https://github.com/DavidAnson/markdownlint#rules--ali

**Important**: We support the use of `markdownlint` through [`markdownlint-cli2`](https://github.com/DavidAnson/markdownlint-cli2) instead of `markdownlint-cli` for compatibility with the [`vscode-markdownlint`](https://github.com/DavidAnson/vscode-markdownlint) plugin.

1. Create a `.markdownlint-cli2.cjs` file in the root of your repository.
1. Create a `.markdownlint-cli2.mjs` file in the root of your repository.

```bash
touch .markdownlint-cli2.cjs
touch .markdownlint-cli2.mjs
```

2. Install packages.
Expand All @@ -44,7 +44,7 @@ See [`markdownlint` rules](https://github.com/DavidAnson/markdownlint#rules--ali
}
```

4. Edit `.markdownlint-cli2.cjs` file to suit your needs. Start with
4. Edit `.markdownlint-cli2.mjs` file to suit your needs. Start with

```js
const options = require('@github/markdownlint-github').init()
Expand All @@ -57,7 +57,7 @@ See [`markdownlint` rules](https://github.com/DavidAnson/markdownlint#rules--ali
}
```
Or, you can also pass in configuration options that you wish to override the default. Read more at [Customizing configurations](#customizing-configurations).
Or, you can also pass in configuration options that you wish to override the default. Read more at [Customizing configurations](#customizing-configurations).
This looks like:
```js
Expand Down
2 changes: 0 additions & 2 deletions src/rules/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@ import { noEmptyStringAltRule } from "./no-empty-alt-text.js";
import { noGenericLinkTextRule } from "./no-generic-link-text.js";
import { altTextRule } from "./no-default-alt-text.js";

// export default { noEmptyStringAltRule, noGenericLinkTextRule, altTextRule };

export const githubMarkdownLint = [
altTextRule,
noGenericLinkTextRule,
Expand Down

0 comments on commit db5cd52

Please sign in to comment.