Skip to content

Commit

Permalink
docs(shebang): Add two new options to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
scagood committed Feb 6, 2024
1 parent 8687571 commit 3b74a71
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion docs/rules/shebang.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,11 @@ console.log("hello");

```json
{
"n/shebang": ["error", {"convertPath": null}]
"n/shebang": ["error", {
"convertPath": null,
"ignoreUnpublished": false,
"additionalExecutables": [],
}]
}
```

Expand All @@ -70,6 +74,14 @@ console.log("hello");
This can be configured in the rule options or as a shared setting [`settings.convertPath`](../shared-settings.md#convertpath).
Please see the shared settings documentation for more information.

#### ignoreUnpublished

Allow for files that are not published to npm to be ignored by this rule.

#### additionalExecutables

Mark files as executable that are not referenced by the package.json#bin property

## 🔎 Implementation

- [Rule source](../../lib/rules/shebang.js)
Expand Down

0 comments on commit 3b74a71

Please sign in to comment.