Skip to content

Move unexported @types packages to devDependencies #1035

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 1 commit into from
May 15, 2019

Conversation

Gerrit0
Copy link
Collaborator

@Gerrit0 Gerrit0 commented May 10, 2019

I went through the generated declaration files for the build and moved any imported types which were not referenced from dependencies to devDependencies.

@types/minimatch is still included in dependencies because it is used in ./dist/lib/utils/paths.d.ts, the other @types packages are used internally but their types are not reexported.

If you want to validate the changes you can search for from '[^.] with "Files to include" set to ./typestrong-typedoc/dist/**/*.d.ts (or equivalent for how you opened the project) in VSCode. It gives 43 results of re-exports from TypeScript, 2 re-exports from handlebars (which now has its own type declarations) and 1 from minimatch

Closes #1010
Closes #986

@Gerrit0 Gerrit0 requested a review from aciccarello May 10, 2019 23:30
Copy link
Collaborator

@aciccarello aciccarello left a comment

Choose a reason for hiding this comment

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

Looks great! Thanks for defining how to audit the built files for types. Only improvement I could see would be to have a script to automate the audit but that seems unnecessarily complex.

@aciccarello aciccarello merged commit bb23e6d into master May 15, 2019
@Gerrit0 Gerrit0 deleted the move-types-to-devDependencies branch January 14, 2020 20:05
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.

yarn install generates warning @Types are stored as dependencies in package.json causing conflicts
2 participants