Add support for npm publish

tscpp commented 4 years ago

Changes

Changed to ignore ignore (not ignore) .npmignore in .gitignore. (!.gitignore)
Added .npmignore
Added build.js
Added package.json

File purposes

.npmignore - The name says it all. This file includes all glob patterns to be excluded when published at npm.
build.js - JavaScript file to run cargo build.
package.json - Information for npm required to publish at npm.

Requirements

Have a recent installation of nodejs, including npm and fundamental JSON knowledge.

Publishing

Change the version property in the package.json file to the version and run npm publish.

Big oof

The name crush is taken. There are two options;

Get the name The crush package on npm has 0 weekly downloads and hasn't been updated for six years; therefore, it could be possible to get the name anyways by contacting the owner or npm.
Choose another name For example, you could name the package: crush-term, crush-cli, ccrush, crush-shell or cru-sh.

After choosing the name change the name property in package.json.

And also...

When if support for windows, remove this part of build.js:

// ------- REMOVE THIS WHEN SUPPORT FOR WINDOWS -----------
if (isWindows()) {
    process.stdout.write('\n' + '-'.repeat(29) + '\nWindows is not supported yet.\n' + '-'.repeat(29) + '\n\n\n');
    process.exit(1);
}
// --------------------------------------------------------

mascguy commented 3 years ago

In terms of a package name, how about 'crush-shell'? That's what I'm proposing for the MacPorts project, where it will also be published.

Thoughts?

tscpp commented 3 years ago

A bit shorter name could be 'cru-sh', but where crush-shell would give more search results on google.

tscpp commented 3 years ago

I also could manage the npm package in an independent repository to separate the project with npm. This would also mean nobody in this project would need to publish to npm for each new version. The releases for npm could also be made automatically. But I need clearance from the owner to publish this project on npm.

tscpp commented 3 years ago

I am closing this because npm is the "node package manager" and rust crates does not belong there.

liljencrantz / crush