Setup .npmignore file

[glensc]

Public-Facing Changes

None

Description

Exclude unneeded files from npm package dist.

Mainly src directory. It confused my IDE (PhpStorm), so I added debug to the wrong code without noticing the package had src folder also included, not just dist.

This also decreases node_modules on installations. ftw!

[CLAassistant]

All committers have signed the CLA.

[glensc]

NOTE: the patterns work with yarn, but break npm:

• Use yarn to publish glensc/node-wiki-rpc-client#4

but as this project uses yarn, all is fine. just a reminder for the future when switching to npm for some reason.

[defunctzombie]

Sorry for the delay. I think a better solution that yarn and npm support would be the files field in the package.json. If you want to make that change I'd merge that.

[jhurliman]

FYI the src/ directory is included in the npm distribution on purpose. It's helpful to be able to click through a class or function name and see the original (unminified) TypeScript implementation. IMO the benefit of this outweighs a streamlined workflow for editing code in your node_modules/ directory.

[defunctzombie]

Seems this went stale so I am closing it. If you do decide to pick this up at some later time and incorporate the suggestions we can revisit.

[glensc]

Rather opposite, bundling src make ide confused, and added breakpoints to wrong files (files not used at runtime). you want to browse source, you should clone the repository.

[defunctzombie]

Rather opposite, bundling src make ide confused, and added breakpoints to wrong files (files not used at runtime). you want to browse source, you should clone the repository.

I am ok not shipping the source code in the build - but I think the way we want to do it is with an explicit files field in package.json that indicates the files we want. That is supported by yarn and npm (to my knowledge)

[glensc]

I find separate file more maintainable. you can compare more easily with other projects or copy while file.

also the .npmignore I submitted also only whitelists things (i.e first hides everything and then unhides)

as for npm/yarn, yarn doesn't have publish functionality, it invokes npm internally. at least that's what I think is happening behind the scenes. in short, it works the same way in npm/yarn.

but if you insist on package.json change, what is the section for that, root level "files" ?

[defunctzombie]

root level "files" ?

Yep.

[glensc]

Created #20