1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
# node/no-unpublished-bin
> disallow `bin` files that npm ignores
> - ⭐️ This rule is included in `plugin:node/recommended` preset.
We can publish CLI commands by `npm`. It uses `bin` field of `package.json`.
```json
{
"name": "command-name",
"bin": "bin/index.js"
}
```
At this time, if `npm` ignores the file, your package will fail to install.
## 📖 Rule Details
If `npm` ignores the files in `bin` field, this rule warns the files.
- If `files` field does not includes the files in `bin` field.
- If `.npmignore` file includes the files in `bin` field.
### Options
```json
{
"rules": {
"node/no-unpublished-bin": ["error", {
"convertPath": null
}]
}
}
```
#### convertPath
If we use transpilers (e.g. Babel), perhaps the file path to a source code is never published.
`convertPath` option tells to the rule, it needs to convert file paths.
For example:
```json
{
"rules": {
"node/no-unpublished-bin": ["error", {
"convertPath": {
"src/bin/**/*.js": ["^src/(.+)$", "$1"]
}
}]
}
}
```
This option has the following shape: `<targetFiles>: [<fromRegExp>, <toString>]`
`targetFiles` is a glob pattern.
It converts paths which are matched to the pattern with the following way.
```js
path.replace(new RegExp(fromRegExp), toString);
```
So on this example, `src/bin/index.js` is handled as `bin/index.js`.
The `convertPath` option can be an array as well.
For example:
```json
{
"rules": {
"node/no-unpublished-bin": ["error", {
"convertPath": [
{
"include": ["src/bin/**/*.js"],
"exclude": ["**/*.spec.js"],
"replace": ["^src/(.+)$", "$1"]
}
]
}]
}
}
```
In this style, this option has the following shape as the same expression as above: `{include: [<targetFiles>], replace: [<fromRegExp>, <toString>]}`.
In addition, we can specify glob patterns to exclude files.
### Shared Settings
The following options can be set by [shared settings](http://eslint.org/docs/user-guide/configuring.html#adding-shared-settings).
Several rules have the same option, but we can set this option at once.
- `convertPath`
For Example:
```json
{
"settings": {
"node": {
"convertPath": {
"src/bin/**/*.js": ["^src/bin/(.+)$", "bin/$1"]
}
}
},
"rules": {
"node/no-unpublished-bin": "error"
}
}
```
## 🔎 Implementation
- [Rule source](../../lib/rules/no-unpublished-bin.js)
- [Test source](../../tests/lib/rules/no-unpublished-bin.js)
|
