JoshuaKGoldberg / JoshuaKGoldberg/create-typescript-app
📝 Documentation: Update CJS/ESM dual-emit docs for bugs found in eslint-fix-utils
- Dominant language
- TypeScript
- Stars
- 1.4k
- Forks
- 89
- Avg merge
- 1m
- Merged PRs (30d)
- 3
Description
### Bug Report Checklist
- [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.
### Overview
Coming over from https://github.com/JoshuaKGoldberg/eslint-fix-utils/issues/7 -> https://github.com/JoshuaKGoldberg/eslint-fix-utils/pull/13: it looks like the docs in https://github.com/JoshuaKGoldberg/create-typescript-app/blob/c6714eeb02a5106eb5e4e4694f1e8b590444030d/docs/FAQs.md#how-can-i-add-dual-commonjs--ecmascript-modules-emit aren't quite enough. Whatever the resolution is to that issue -> PR, we'll want to note it here.
### Additional Info
~Marking as blocked until `eslint-fix-utils` is fixed.~ ✅
🎁
Contributor guide
Research direction
Start by reading the linked eslint-fix-utils issue 7 and pull request 13 to determine their resolution. Then update the dual CommonJS/ECMAScript modules emit section in docs/FAQs.md to document the relevant fix, and confirm the FAQ reflects the resolved behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- eslint, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100