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

(deps/types/clean): remove extraneous typings #675

Merged
merged 2 commits into from
Apr 12, 2020

Conversation

agilgur5
Copy link
Collaborator

  • external @types/ are overridden by the package's own internal
    typings, so any @types/ packages on top of that are extraneous

    • and are usually deprecated too; all are in this case
  • execa has had its own typedefs since v2

    • the @types/execa package is very dated at v0.9
  • ora has had its own typedefs since v3.2

    • so @types/ora v3.2 is just a stub
  • ansi-escapes has had its own typedefs since v4

    • @types/ansi-escapes v4 is just a stub
  • camelcase has had its own typedefs since v5.2

    • @types/camelcase v5.2 is just a stub
    • pin camelcase to v5.2+ from 5.0 to ensure it's a version with
      internal typings
  • ora also had an unnecessary internal re-declaration too

  • as did ansi-escapes and camelcase


(docs/types): add comments to some remaining declarations

  • clarify why some of these internal declarations/re-declarations
    are necessary
    • I tried removing them because I didn't know why they were needed,
      so this documentation should be helpful

Hard to say where these made their way in / root cause, seems to have just happened while upgrading / downgrading deps or conversion to TS in #246, #247, #54, and probably some others.

- external @types/ are overridden by the package's own internal
  typings, so any @types/ packages on top of that are extraneous
  - and are usually deprecated too; all are in this case
- execa has had its own typedefs since v2
  - the @types/execa package is very dated at v0.9
- ora has had its own typedefs since v3.2
  - so @types/ora v3.2 is just a stub
- ansi-escapes has had its own typedefs since v4
  - @types/ansi-escapes v4 is just a stub
- camelcase has had its own typedefs since v5.2
  - @types/camelcase v5.2 is just a stub
  - pin camelcase to v5.2+ from 5.0 to ensure it's a version with
    internal typings

- ora also had an unnecessary internal re-declaration too
- as did ansi-escapes and camelcase
- clarify why some of these internal declarations/re-declarations
  are necessary
  - I tried removing them because I didn't know why they were needed,
    so this documentation should be helpful
Copy link
Collaborator Author

@agilgur5 agilgur5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Remember to rebase this in instead of squash as there's two separate commits (split the docs/comments one out)

@agilgur5 agilgur5 merged commit 72092c8 into jaredpalmer:master Apr 12, 2020
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.

1 participant