Skip to content

Commit 1dd9763

Browse files
feat: remove Markdownlint (#2298)
<!-- 👋 Hi, thanks for sending a PR to create-typescript-app! Please fill out all fields below and make sure each item is true and [x] checked. Otherwise we may not be able to review your PR. --> ## PR Checklist - [x] Addresses an existing open issue: fixes #1926 - [x] That issue was marked as [`status: accepting prs`](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22) - [x] Steps in [CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/CONTRIBUTING.md) were taken ## Overview Now that `@eslint/markdown` is linting Markdown files and `prettier-plugin-sentences-per-line` additionally formats them, there's no more need for Markdownlint in this template. This PR completely deletes `markdownlint`/`markdownlint-cli`, and adds removal addons to `blockESLintMarkdown`. This reduces the count of root-level files by two: `.markdownlint.json` and `.markdownlintignore`! 🎁
1 parent 05470dd commit 1dd9763

24 files changed

+16
-758
lines changed

.github/DEVELOPMENT.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@ Each should be shown in VS Code, and can be run manually on the command-line:
5252

5353
- `pnpm lint` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints JavaScript and TypeScript source files
5454
- `pnpm lint:knip` ([knip](https://github.com/webpro/knip)): Detects unused files, dependencies, and code exports
55-
- `pnpm lint:md` ([Markdownlint](https://github.com/DavidAnson/markdownlint)): Checks Markdown source files
5655
- `pnpm lint:packages` ([pnpm dedupe --check](https://pnpm.io/cli/dedupe)): Checks for unnecessarily duplicated packages in the `pnpm-lock.yml` file
5756
- `pnpm lint:spelling` ([cspell](https://cspell.org)): Spell checks across all source files
5857

.github/workflows/ci.yml

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,6 @@ jobs:
3030
- uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5
3131
- uses: ./.github/actions/prepare
3232
- run: pnpm lint:knip
33-
lint_markdown:
34-
name: Lint Markdown
35-
runs-on: ubuntu-latest
36-
steps:
37-
- uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5
38-
- uses: ./.github/actions/prepare
39-
- run: pnpm lint:md
4033
lint_packages:
4134
name: Lint Packages
4235
runs-on: ubuntu-latest

.markdownlint.json

Lines changed: 0 additions & 6 deletions
This file was deleted.

.markdownlintignore

Lines changed: 0 additions & 4 deletions
This file was deleted.

.vscode/extensions.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
{
22
"recommendations": [
3-
"DavidAnson.vscode-markdownlint",
43
"dbaeumer.vscode-eslint",
54
"esbenp.prettier-vscode",
65
"streetsidesoftware.code-spell-checker",

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,6 @@ Thanks! 🎁
6666
<!-- spellchecker: disable -->
6767
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
6868
<!-- prettier-ignore-start -->
69-
<!-- markdownlint-disable -->
7069
<table>
7170
<tbody>
7271
<tr>
@@ -144,7 +143,6 @@ Thanks! 🎁
144143
</tbody>
145144
</table>
146145

147-
<!-- markdownlint-restore -->
148146
<!-- prettier-ignore-end -->
149147

150148
<!-- ALL-CONTRIBUTORS-LIST:END -->

docs/Blocks.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@ This table summarizes each block and which base levels they're included in:
3333
| Gitignore | `--add-gitignore`, `--exclude-gitignore` | ✔️ || 💯 |
3434
| Knip | `--add-knip`, `--exclude-knip` | | | 💯 |
3535
| Main | `--add-main`, `--exclude-main` | ✔️ || 💯 |
36-
| Markdownlint | `--add-markdownlint`, `--exclude-markdownlint` | | | 💯 |
3736
| MIT License | `--add-mit-license`, `--exclude-mit-license` | ✔️ || 💯 |
3837
| ncc | `--add-ncc`, `--exclude-ncc` | | | |
3938
| nvmrc | `--add-nvmrc`, `--exclude-nvmrc` | | | 💯 |
@@ -251,7 +250,6 @@ Using the _"everything"_ level will gain you comprehensive, strict coverage of a
251250
- [Lint ESLint](#lint-eslint)
252251
- [Lint JSDoc](#lint-jsdoc)
253252
- [Lint JSON](#lint-json)
254-
- [Lint MD](#lint-md)
255253
- [Lint Package JSON](#lint-package-json)
256254
- [Lint Packages](#lint-packages)
257255
- [Lint Perfectionist](#lint-perfectionist)
@@ -274,16 +272,6 @@ Using the _"everything"_ level will gain you comprehensive, strict coverage of a
274272

275273
[`eslint-plugin-jsonc`](https://github.com/ota-meshi/eslint-plugin-jsonc): Adds linting for `.json` and `.jsonc` files.
276274

277-
### Lint MD
278-
279-
[**Markdownlint**](https://github.com/DavidAnson/markdownlint): Linting for Markdown code.
280-
281-
```shell
282-
pnpm lint:md
283-
```
284-
285-
> This is a separate linter from ESLint, but will likely eventually be switched to an ESLint plugin ([#567](https://github.com/JoshuaKGoldberg/create-typescript-app/issues/567)).
286-
287275
### Lint Package JSON
288276

289277
[`eslint-plugin-package-json`](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json): Linting for `package.json` files.

package.json

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@
2222
"format": "prettier .",
2323
"lint": "eslint . --max-warnings 0",
2424
"lint:knip": "knip",
25-
"lint:md": "markdownlint \"**/*.md\" \".github/**/*.md\"",
2625
"lint:packages": "pnpm dedupe --check",
2726
"lint:spelling": "cspell \"**\" \".github/**/*\"",
2827
"prepare": "husky",
@@ -99,8 +98,6 @@
9998
"husky": "9.1.7",
10099
"knip": "5.71.0",
101100
"lint-staged": "16.2.7",
102-
"markdownlint": "0.39.0",
103-
"markdownlint-cli": "0.46.0",
104101
"prettier": "3.7.3",
105102
"prettier-plugin-curly": "0.4.1",
106103
"prettier-plugin-packagejson": "2.5.20",

0 commit comments

Comments
 (0)