Make more suitable for npm publishing

[heralden]

Suggestions for improvements:

• Add .npmignore file that excludes the src directory (I think only dist is required when using a tool as an npm package)
• Add prepack script to package.json so we don't manually have to build on every npm publish (prepack seems to be the most suitable script to use, according to https://docs.npmjs.com/misc/scripts)

[akshatbhargava123]

Two queries: Do we need to build the dist folder in prepack? Do we only publish the dist folder only for the tool?

[heralden]

1. Yes, we need dist to be included in our npm package.
2. I think package.json and config.json needs to be available as well (@yochannah can confirm).

Edit: I think adding src, dev, tests and css to .npmignore would be a good starting point for (2). (We could add more as we see fit.)

[yochannah]

Correct on both counts! Also, ideally preview.png (but that's not mandatory)

On Tue, 18 Jun 2019 at 16:09, Herald notifications@github.com wrote:

1. Yes, we need dist to be included in our npm package.
2. I think package.json and config.json needs to be available as well ( @yochannah https://github.com/yochannah can confirm).

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/intermine/generator-bluegenes-tool/issues/14?email_source=notifications&email_token=ACGXRDUWTJZCXPKI7XI2CNDP3D3CRA5CNFSM4HW6KPAKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODX66QPI#issuecomment-503179325, or mute the thread https://github.com/notifications/unsubscribe-auth/ACGXRDX5SY3QKRPYCRHXZPDP3D3CRANCNFSM4HW6KPAA .

[pooja2299]

Hi @yochannah I am an Outreachy aspirant. I have basic knowlegde on html,css and js. Can i give this issue a try? Need ur guidance how to begin with it.

[yochannah]

@pooja2299 for prepack, we'll to automatically run the same commands as npm build - the idea being that way we can be sure that any build scripts have been run before we publish the package. A tiny bit of info here: https://docs.npmjs.com/misc/scripts - the yarn guide talks about it a little, too: https://yarnpkg.com/advanced/lifecycle-scripts

for npmignore, we want to exclude files from being published on npm that aren't relevant. See http://npm.github.io/publishing-pkgs-docs/publishing/the-npmignore-file.html - see the discussions above about which files / folders to ignore. You'll need to create the .npmignore file yourself in the root of the repo, and check it in on git. DM me on the chat if needed <3