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

Release 1.10.2 #120

Merged
merged 1 commit into from
Jul 18, 2018
Merged

Release 1.10.2 #120

merged 1 commit into from
Jul 18, 2018

Conversation

kalinchernev
Copy link
Contributor

No description provided.

@kalinchernev kalinchernev merged commit 64a6ec9 into master Jul 18, 2018
@kalinchernev kalinchernev deleted the chore/release branch July 18, 2018 18:39
@chdanielmueller
Copy link
Member

@kalinchernev
FYI: Adding the README.md to npmignore is (according to the docs) pointless.
https://docs.npmjs.com/misc/developers

@kalinchernev
Copy link
Contributor Author

kalinchernev commented Jul 18, 2018

Agree. It's strange to me too seeing requests to remove the CLI out of the package to reduce size.
Reductions after ignore updates are
Before:

npm notice package size:  10.0 kB
npm notice unpacked size: 29.1 kB

After:

npm notice package size:  7.6 kB
npm notice unpacked size: 22.2 kB

PS: The CLI is 5kb, hopefully the 2.4kb is ok of an optimisation for now.

@chdanielmueller
Copy link
Member

I think it's not because of the package size itself but the dependency to node-gyp. see #92

@kalinchernev
Copy link
Contributor Author

@chdanielmueller what is your suggestion about it? Shall I remove it out of the package?

@chdanielmueller
Copy link
Member

First: It's up to you ;)

I would suggest to remove it in swagger-jsdoc and create a new package swagger-jsdoc-cli which depends on swagger-jsdoc.
This way the two projects are able to evolve without interfering with each other.
(+ you will be able to see how many people are working with the CLI -> npm stats)
If you would like I could create another repo.

@kalinchernev
Copy link
Contributor Author

kalinchernev commented Jul 18, 2018

@chdanielmueller not only up to me, that's why I'm asking :)
My first reply would be - yeah - let's take it out and simplify the project, etc.

However, I'm hesitating on the thought, as if there is any of the 62 dependent packages using the CLI, they will fail. I also imagine many use the package as a part of an automation pipeline, which could be even worse to break without a warning.
Removing the CLI at all means we go directly to 2.0. No problem from my side to do so.

At the same time, there's https://www.npmjs.com/package/swagger-jsdoc-generator already. The only benefit of someone to use swagger-jsdoc-cli and not swagger-jsdoc-generator would be the watch task.

Another idea would be to remove chokidar. This way we remain compatible for all dependent packages and hopefully remove the problem with the node-gyp. Then, if watch mode is so missed, someone will open an issue and we'll point him to the chokidar package to solve the problem by himself, if one hasn't done so yet.

@chdanielmueller
Copy link
Member

Yeah if you are able to remove chokidar without removing the cli completely that sounds like the best option to me.

@chdanielmueller
Copy link
Member

@kalinchernev Maybe @lmammino is interested to implement the watch mode to lmammino/swagger-jsdoc-generator for those missing the feature.

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.

2 participants