The issue checks for incorrect or missing shebang in files mentioned in the bin field of the package.json. When creating a CLI tool with Node.js, it is necessary to add a shebang to the file that serves as the entry point for the application. As the NPM docs say, the file(s) referenced in bin must start with #!/usr/bin/env node, or the scripts won't be run with the Node.js executable.

The bin field in package.json is used to specify JS files which run as tools when launched with the Node.js launcher.

Bad Practice

Incorrect shebang:

// /user/bin/env node
console.log("App launched");

No shebang in a file referenced in package.json's bin field:

console.log("App launched")

Recommended

The following code snippet is assumed to be in a file that is referenced in the bin field:

#!/usr/bin/env node
console.log("App launched");

References

weareinreach / InReach

No ignore rules found