JoshuaKGoldberg / JoshuaKGoldberg/create-typescript-app

🐛 Bug: CI-only `lint:docs` failure in `blockESLintPlugin` repository

Open
#2,197 0 comments 0 reactions 0 assignees View on GitHub
status: accepting prs type: bug
Dominant language
TypeScript
Stars
1.4k
Forks
89
Avg merge
1m
Merged PRs (30d)
3

Description

### Bug Report Checklist

- [x] I have tried restarting my IDE and the issue persists.
- [x] I have pulled the latest `main` branch of the repository.
- [x] I have [searched for related issues](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aissue) and found none that matched my issue.

### Expected

https://github.com/bingo-examples/eslint-plugin-cta-example was generated with roughly:

```shell
npx create-typescript-app --preset everything --add-eslint-plugin --exclude-example-files --directory eslint-plugin-cta-example --title eslint-plugin-cta-example --description "Example ESLint plugin built with create-typescript-app. 🔌"
```

It should pass all package scripts locally and in CI once all repository tokens are populated.

### Actual

`lint:docs` is failing only in CI. Example from https://github.com/bingo-examples/eslint-plugin-cta-example/actions/runs/14361036702/job/40262335756:

```plaintext
> eslint-doc-generator --check

Please run eslint-doc-generator. A rule doc is out-of-date: docs/rules/enums.md
- Expected
+ Received

# enums

- 💼 This rule is enabled in the ✅ `recommended` config.
-

Please run eslint-doc-generator. The rules table in README.md is out-of-date.
- Expected
+ Received

@@ -3[9](https://github.com/bingo-examples/eslint-plugin-cta-example/actions/runs/14361036702/job/40262335756#step:5:10),16 +39,13 @@

These are all set to `"error"` in the recommended config:

- 💼 Configurations enabled in.\
- ✅ Set in the `recommended` configuration.
-
- | Name | Description | 💼 |
- | :--------------------------- | :------------------------------ | :-- |
- | [enums](docs/rules/enums.md) | Avoid using TypeScript's enums. | ✅ |
+ | Name | Description |
+ | :--------------------------- | :------------------------------ |
+ | [enums](docs/rules/enums.md) | Avoid using TypeScript's enums. |

## Development
```

### Additional Info

I don't know why this is happening. The package does build in CI with `pnpm build --no-dts` before running `pnpm lint:docs`. I've even tried a fresh clone of the repo locally - no reproducible complaints.

🎁

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.