[npm] Clean up package content

[janpio]

Currently npm packages contains folders like .github, and files like .appveyor.yml and .travis.yml. Those are probbably not useful in a package context, so should be excluded (if possible).

Implementation Progress

Platforms

• cordova-android (chore(npm): add ignore list cordova-android#958)
• cordova-browser
• cordova-electron (Added NPM Ignore File cordova-electron#10)
• cordova-ios (chore (npm): add ignore list cordova-ios#863)
• cordova-osx
• cordova-test-platform
• cordova-windows

Plugins

• cordova-plugin-battery-status (chore(npm): improve ignore list cordova-plugin-battery-status#79)
• cordova-plugin-camera (chore(npm): adds ignore list cordova-plugin-camera#575)
• cordova-plugin-device ( chore(npm): improve ignore list  cordova-plugin-device#121)
• cordova-plugin-dialogs (chore(npm): improve ignore list cordova-plugin-dialogs#135)
• cordova-plugin-file (chore(npm): improve ignore list cordova-plugin-file#383)
• cordova-plugin-geolocation (chore(npm): improve ignore list cordova-plugin-geolocation#192)
• cordova-plugin-inappbrowser (chore(npm): improve ignore list cordova-plugin-inappbrowser#658)
• cordova-plugin-media (chore(npm): improve ignore list cordova-plugin-media#275)
• cordova-plugin-media-capture (chore(npm): improve ignore list cordova-plugin-media-capture#164)
• cordova-plugin-network-information (chore(npm): improve ignore list cordova-plugin-network-information#103)
• cordova-plugin-screen-orientation (chore(npm): improve ignore list cordova-plugin-screen-orientation#60)
• cordova-plugin-splashscreen (chore(npm): adds ignore list cordova-plugin-splashscreen#251)
• cordova-plugin-statusbar (ci: updates Node.js versions cordova-plugin-statusbar#182)
• cordova-plugin-vibration (chore(npm): adds ignore list cordova-plugin-vibration#85)
• cordova-plugin-whitelist (chore(npm): improve ignore list cordova-plugin-whitelist#51)
• cordova-plugin-wkwebview-engine (chore(npm): improve ignore list cordova-plugin-wkwebview-engine#137)

Tooling

• cordova-app-hello-world (chore(npm): add ignore list & update package data cordova-app-hello-world#61)
• cordova-cli
• cordova-coho
• cordova-common (chore: improve npm ignore list cordova-common#104)
• cordova-create (chore: improve npm ignore list cordova-create#50)
• cordova-docs
• cordova-fetch (chore: improve npm ignore list cordova-fetch#74)
• cordova-js
• cordova-lib (chore: improve npm ignore list cordova-lib#809)
• cordova-mobile-spec
• cordova-node-xcode (ci: switch travis ci for github actions cordova-node-xcode#96)
• cordova-paramedic
• cordova-plugin-test-framework
• cordova-plugman
• cordova-serve

Excluded: cordova-status, cordova, and any unused, outdated, or deprecated repos

[erisu]

It is possible.

See the cordova-electron repo for example: https://github.com/apache/cordova-electron/blob/master/.npmignore

Things I believe should also be excluded from the package:

• Docs
• Test specs
• Raw src files that are not used directly but a part of some build process.
• Third-party configuration files (linting tools, testing frameworks, code formatters, etc.)

[janpio]

Great.

One thing to note: The "vote" procedure usually contains steps to make sure a package actually works, which until now meant running the tests (for plugins for example via the included tests-plugin, and generally via npm test). This might conflict with the removal from the package.

[erisu]

Yeah, that might have to change.

I feel they should be excluded because it also has no value to an end user who is only trying to develop their own app. If they want to test our code, at that point they should be using GitHub as a developer for the Cordova product.

IMO, if I am releasing something, I had already ran the tests before I made the package as well as validating the CI services were green which ran the same tests. I feel that the releasers own +1 vote should also mean that they tested since these steps are written in the release guide.

Anyways, this might need to be a later discussion in another ticket or email thread.

[raphinesse]

@erisu I know you did some work on this. Unfortunately the PRs/commits didn't reference this issue. I guess this is not yet done in all repos. How do we want to handle this issue. Add a todo list?

[erisu]

I think we can add a todo list in this ticket and check off the ones that are completed.

[brodybits]

I would also consider just adding the files field to package.json in each package to specify exactly which artifacts we do need to publish on npm.

[timbru31]

List updated as of June 2020. We are missing some platform and toolings, I've done all plugins over the past few months.