Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Documentation Missing for Shorthand Commands -p / -v / -b

Open
#2,978 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
58/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
typescript
Domain
documentation

Research direction

Open the Compiler Options page linked in the issue and check how command-line options are presented. Document the -p, -v, and -b aliases for --project, --version, and --build, or link to existing documentation; done means readers can find all three shorthand commands there.

Written by the indexing model from the issue text.

Description

Page URL: Compiler Options

Issue:

Documentation for tsc command is completely lacking shorthand versions:

  • -p alias for --project
  • -v alias for --version
  • -b alias for --build

(Or, if this information does exist somewhere in the docs, it needs to at least be linked on the affected page.)

I understand you would prefer a PR instead as this doesn't seem that critical (although I think any completely lacking documentation is pretty critical. I see the -p / --p option used everywhere, but had to look in the source to confirm what it did). I'm extremely busy currently, but I'll happily make a PR for this as soon as I have some time, with which I'll tie in and close this issue.

Dominant language
TypeScript
Stars
2.6k
Forks
1.5k
Avg merge
2d 12h
Merged PRs (30d)
8

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from microsoft/TypeScript-Website

All issues in microsoft/TypeScript-Website

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.