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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
# node/no-unpublished-import
> disallow `import` declarations which import private modules
> - ⭐️ This rule is included in `plugin:node/recommended` preset.
This is similar to [no-unpublished-require](no-unpublished-require.md), but this rule handles `import` declarations.
:warning: ECMAScript 2015 (ES6) does not define the lookup logic and Node does not support modules yet. So this rule spec might be changed in future.
## 📖 Rule Details
If a source code file satisfies all of the following conditions, the file is \*published\*.
- `"files"` field of `package.json` includes the file or `"files"` field of `package.json` does not exist.
- `.npmignore` does not include the file.
Then this rule warns `import` declarations in \*published\* files if the `import` declaration imports \*unpublished\* files or the packages of `devDependencies`.
> This intends to prevent "Module Not Found" error after `npm publish`.<br>
> :bulb: If you want to import `devDependencies`, please write `.npmignore` or `"files"` field of `package.json`.
### Options
```json
{
"rules": {
"node/no-unpublished-import": ["error", {
"allowModules": [],
"convertPath": null,
"tryExtensions": [".js", ".json", ".node"]
}]
}
}
```
#### allowModules
Some platforms have additional embedded modules.
For example, Electron has `electron` module.
We can specify additional embedded modules with this option.
This option is an array of strings as module names.
```json
{
"rules": {
"node/no-unpublished-import": ["error", {
"allowModules": ["electron"]
}]
}
}
```
#### 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-import": ["error", {
"convertPath": {
"src/**/*.jsx": ["^src/(.+?)\\.jsx$", "lib/$1.js"]
},
"tryExtensions": [".js", ".jsx", ".json"]
}]
}
}
```
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/a/foo.jsx` is handled as `lib/a/foo.js`.
The `convertPath` option can be an array as well.
For example:
```json
{
"rules": {
"node/no-unpublished-import": ["error", {
"convertPath": [
{
"include": ["src/**/*.js"],
"exclude": ["**/*.spec.js"],
"replace": ["^src/(.+)$", "lib/$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.
#### tryExtensions
When an import path does not exist, this rule checks whether or not any of `path.js`, `path.json`, and `path.node` exists.
`tryExtensions` option is the extension list this rule uses at the time.
Default is `[".js", ".json", ".node"]`.
### 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.
- `allowModules`
- `convertPath`
- `tryExtensions`
For Example:
```json
{
"settings": {
"node": {
"allowModules": ["electron"],
"convertPath": {
"src/**/*.jsx": ["^src/(.+?)\\.jsx$", "lib/$1.js"]
},
"tryExtensions": [".js", ".jsx", ".json"]
}
},
"rules": {
"node/no-unpublished-import": "error"
}
}
```
## 🔎 Implementation
- [Rule source](../../lib/rules/no-unpublished-import.js)
- [Test source](../../tests/lib/rules/no-unpublished-import.js)
|
