Use start script

[piranna]

The canonical default executable is start script in the package.json file, that by default is server.js file, not bin entry since you can define several binaries in a single package.

[TooTallNate]

That is, you'd like to just run pkg without specifying a filename? An interesting idea. The problem with start is that it's an arbitrary shell command, not a JavaScript entry point. The main entry point could perhaps be more appropriate since it does point to a JavaScript file.

[TooTallNate]

Or some property in the package.pkg config object, like "entrypoint".

[igorklopov]

You can always specify entry point javascript file explicitly in CLI instead of passing path to package.json.

[jimbuck]

Thoughts on using the main field?

I know it's primarily used in libraries, but it would be a good fit for pkg as well.

[piranna]

I would still go for the start script entry, also if it's supposed to be a shell command, because people usually just define an executable there or if not an ad-hoc executable script can be created. If not, I would add a new field, but I'm a bit against this idea having currently valid alternatives. El 2/5/2017 6:28, "Jim Buck" <notifications@github.com> escribió:

…

Thoughts on using the main <https://docs.npmjs.com/files/package.json#main> field? I know it's primarily used in libraries, but it would be a good fit for pkg as well. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#43 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAgfvsB_MGKMUwiZ6AhEUOJ6pv42_jKBks5r1rD-gaJpZM4NMhwZ> .

[igorklopov]

Sorry, i can not get why you don't like bin field. Pkg's purpose is to (mostly) emulate npm i something -g tool installation and usage scenario. Since globally installed tool uses bin field, the idea behind pkg was to use bin field as well.

[igorklopov]

And yeah, you can specify several subfields in bin field. Pkg will use one that's name matches with name field of package.json.

[TooTallNate]

@igorklopov Ahhh I did not realize that the bin entry was already supported. I see now that it's also documented in the README.

I'm closing since I don't think it makes sense to duplicate functionality when there is already a mechanism to specify entry point in the package.json. Thank you for the suggestion though!

[piranna]

Please open this again, the problem is not the lack of functionality but the fact it's not standard compliant, as start script is. Please read npm package.json documentation and fix that, bin field is not designed to be used that way and it's a bug. El 2/5/2017 7:45, "Nathan Rajlich" <notifications@github.com> escribió:

…

@igorklopov <https://github.com/igorklopov> Ahhh I did not realize that the bin entry was already supported. I see now that it's also documented in the README <https://github.com/zeit/pkg#usage>. I'm closing since I don't think it makes sense to duplicate functionality when there is already a mechanism to specify entry point in the package.json. Thank you for the suggestion though! — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#43 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAgfvkGT919cBfMrlEPWDRJr_PNwiksUks5r1sMVgaJpZM4NMhwZ> .

[TooTallNate]

@piranna The "start" script is used for starting servers, not CLI applications. The bin field is absolutely used for CLI applications, and npm encourages this with the --global flag installing into your $PATH.

pkg mapping to bin is perfect.

[piranna]

npm start is also used to start cli applications too, I have seen using server.js just for this everywhere. Also, since several years ago usage of --global and globally installed modules are absolutely deprecated, so that's not the point. You can use bin, but that's a mapping of the executables that offer that module, that can be several of them, and there's no requeriment that any of them has the same name of the current module, so blindly trust on that field is a bad usage and a bug according to the spec. As I said before, better alternatives are to use standard start script, or if not following standard practices, add a new custom field on package.json file just for this.

[dotcypress]

Great idea with npm start 👍

Implementing that allows us easily pack micro-services to single executable.

UPD: As quick fix, it possible to use full path to runner in bin script, works well in my case.
"bin": "node_modules/micro-bot/bin/micro-bot".

[joaodvilla]

Hello, is it possible to run a global CLI, like "adonis migration: run" from pkg side?