search

SAP / cf-nodejs-logging-support

Node.js Logging Support for Cloud Foundry provides the creation of structured log messages and the collection of request metrics
https://sap.github.io/cf-nodejs-logging-support/
Apache License 2.0
43 stars 22 forks source link

Avoid publishing dev folders like docs & tools #137

Closed SchroederSteffen closed 2 years ago

SchroederSteffen commented 2 years ago

Hi,

We noticed that the published package also contains the folders docs & tools which are only needed for development purposes, but not in production. Hence, we would like to suggest excluding them from the published package. The package size could be (roughly) halved by that. (Can be tested locally via npm pack.)

Especially the tools folder causes issues for us, because it includes another package.json which some build tools try to install unnecessarily.

I would suggest to use the files property of the package.json which acts as an include list to avoid publishing any new additional unnecessary files: #138 Of course, the existing .npmignore file could also be extended: #139

Please review the suggested PRs and merge either of them.

Cheers, Steffen

christiand93 commented 2 years ago

Hi @SchroederSteffen, thank you for pointing this out and providing the PR(s). I think you're totally right about that. There is no need for shipping any additional docs, tools, samples etc. as part of the package. We will review your suggestion asap.

christiand93 commented 2 years ago

We have merged #138 and plan to release new minor version update soon.

SchroederSteffen commented 2 years ago

Awesome, many thanks! 👍

fromagnoli-sap commented 2 years ago

Hi @SchroederSteffen, we released a new version 6.13.2 including your suggestion. Thank you for your contribution.

SchroederSteffen commented 2 years ago

Perfect, thanks! 👍