Skip to content

docs: replace 'Options.md' with 'CLI.md' and 'Configuration Files.md' #1986

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 4 commits into from
Mar 17, 2025

Conversation

JoshuaKGoldberg
Copy link
Owner

@JoshuaKGoldberg JoshuaKGoldberg commented Mar 17, 2025

PR Checklist

Overview

Splits the existing Options.md into two docs:

  • CLI.md: describing the common case of running npx create-typescript-app
  • Configuration Files.md: describing the less-common case of using a create-typescript-app.config.js

Includes tests that each option is mentioned between the two of them.

🎁

Copy link

codecov bot commented Mar 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.11%. Comparing base (907fe76) to head (2d03a91).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1986      +/-   ##
==========================================
- Coverage   99.11%   99.11%   -0.01%     
==========================================
  Files          93       93              
  Lines        4070     4061       -9     
  Branches      231      232       +1     
==========================================
- Hits         4034     4025       -9     
  Misses         36       36              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@JoshuaKGoldberg JoshuaKGoldberg merged commit 20ab241 into main Mar 17, 2025
12 checks passed
@JoshuaKGoldberg JoshuaKGoldberg deleted the cli-and-config-file-docs branch March 17, 2025 19:22
Copy link

🎉 This is included in version v2.6.1 🎉

The release is available on:

Cheers! 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🛠 Tooling: Add unit test that every option and/or piece of tooling is mentioned in docs
1 participant