Skip to content
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

docs: clarify the TS option's defaults #316

Merged
merged 1 commit into from
May 4, 2022

Conversation

agilgur5
Copy link
Collaborator

@agilgur5 agilgur5 commented May 3, 2022

Summary

Be more clear about what the TS option does and what its default is -- the current peerDependency installed

Details

Unrelated:

  • auto-trim some whitespace-only lines
    • my editor does this automatically, and most of the README has trimmed whitespace anyway, so this keeps it consistent

- "latest 2.x" is no longer accurate and quite outdated (we're on 4.x
  now), so just say it's the peerDep instead
  - @rollup/plugin-typescript calls the default a peerDep too:
    https://github.com/rollup/plugins/tree/master/packages/typescript#typescript

- be more specific that you can pass in a different version or fork of
  TS (like `ttypescript`) through this option
  - follow-up to 8ec49c7

- auto-trim some whitespace-only lines
  - my editor does this automatically, and most of the README has
    trimmed whitespace anyway, so this keeps it consistent
@agilgur5 agilgur5 force-pushed the docs-clarify-ts-option branch from 31b4167 to 8afcc30 Compare May 3, 2022 20:16
@agilgur5 agilgur5 added the scope: docs Documentation could be improved. Or changes that only affect docs label May 3, 2022
@ezolenko ezolenko merged commit 462442d into ezolenko:master May 4, 2022
@agilgur5 agilgur5 added the kind: internal Changes only affect the internals, and _not_ the public API or external-facing docs label Jul 10, 2022
@agilgur5 agilgur5 added kind: dx Improvements to dev experience, e.g. error messages, logging, external-facing docs, etc and removed kind: internal Changes only affect the internals, and _not_ the public API or external-facing docs labels Jul 22, 2022
@agilgur5 agilgur5 deleted the docs-clarify-ts-option branch July 2, 2023 21:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: dx Improvements to dev experience, e.g. error messages, logging, external-facing docs, etc scope: docs Documentation could be improved. Or changes that only affect docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants