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

Moved @types/minimatch dependency to devDepencencies #1206

Merged
merged 2 commits into from Mar 15, 2020
Merged

Moved @types/minimatch dependency to devDepencencies #1206

merged 2 commits into from Mar 15, 2020

Conversation

alexandercerutti
Copy link
Contributor

I moved @types/minimatch to devDependencies because, right now any project that uses typedoc, installs along with the main package, also minimatch's types. They shouldn't be installed if not for development.

Or is there a specific reason for which these types have been inserted in dependencies? If any, can you please explain it?

😊

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Feb 15, 2020

Minimatch is included because we re-export some of its types - see #1035.

I'd like to move it to devDependencies, but haven't had the time to look at what is exported and if it can be removed from the public API. I think if createMinimatch is no longer exported from the root file, it could be removed. If you want to go ahead and do that and make sure the tests still pass, I think @types/minimatch can be moved to devDependencies :)

export { createMinimatch } from './lib/utils/paths';

@alexandercerutti
Copy link
Contributor Author

I'll investigate more and let you know! 😊 Thank you for the explanation.

@alexandercerutti
Copy link
Contributor Author

I think that removing this, would mean a possible breaking change for plugins... what do you think about @Gerrit0?

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Feb 17, 2020

Yes, it would. I am okay with that, it will have to wait for the 0.17 release, but that already has several breaking changes slated for it, one more to include this fix is well worth it.

@alexandercerutti
Copy link
Contributor Author

alexandercerutti commented Feb 22, 2020

I've run the tests before and after the edits.
I've removed, as you showed to me, the export of createMinimatch from index.ts and changed tests path.

There's only one test that fails due to a timeout error (over 10000 milliseconds), so it should definitely not be related to the changes.
I'm gonna report it here below, probably you already know that:

 1) TypeDoc
       Application
         Honors the exclude option even if a module is imported:
     Error: Timeout of 10000ms exceeded. For async tests and hooks, ensure "done()" is called; if returning a Promise, ensure it resolves. (/mnt/c/Users/alexa/repos/typedoc/dist/test/typedoc.test.js)
      at processImmediate (internal/timers.js:445:21)

Copy link
Collaborator

@Gerrit0 Gerrit0 left a comment

Choose a reason for hiding this comment

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

Looks good! This will be included in 0.17.

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Feb 22, 2020

The failing test you have locally is due to the tests just running slowly on your machine for some reason (slow disk access probably). They don't fail on mine or on the CI.

@alexandercerutti
Copy link
Contributor Author

alexandercerutti commented Feb 22, 2020

That's weird, but I don't know. ¯_(ツ)_/¯
Anyway, I corrected the message, I meant the failing test wasn't related to the PR changes.

Thank you!

@Gerrit0 Gerrit0 added this to the 0.17 milestone Feb 28, 2020
@Gerrit0 Gerrit0 merged commit 592e0b3 into TypeStrong:master Mar 15, 2020
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Mar 15, 2020

Thanks! Will be in 0.17 later today.

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.

None yet

2 participants