You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When an author releases an Open Source package there are many different levels
13
-
of support they may intend to provide. The [Node.js Package Maintenence Working Group](https://github.com/nodejs/package-maintenance)
13
+
of support they may intend to provide. The [Node.js Package Maintenance Working Group](https://github.com/nodejs/package-maintenance)
14
14
is working to propose [a spec](https://github.com/nodejs/package-maintenance/blob/HEAD/docs/PACKAGE-SUPPORT.md) to help package authors declare their intended support goals. This package provides
15
15
some tooling around working with the format proposed.
which documents the suggested best practice and the specific format of the
@@ -123,7 +123,7 @@ consumer can choose to find the locations without automatically triggering a num
123
123
remote calls.
124
124
125
125
If the consumer wants to have the canonical information pulled automatically they can
126
-
add the `--fetch` option which will pull the remote support information when necesarry.
126
+
add the `--fetch` option which will pull the remote support information when necessary.
127
127
128
128
129
129
The following command/options will always show the most up to date package support information
@@ -138,9 +138,9 @@ information will only be pulled when it is not provided as part of the npm packa
138
138
Local support information may be available locally but outside of the package itself.
139
139
This may be the caseif you are using mono-repo and sharing the support file.
140
140
In this case, by default, the support tool will not read/display files outside of the
141
-
packge itself to avoid potential security issues. In order to allow the tool to display
141
+
package itself to avoid potential security issues. In order to allow the tool to display
142
142
support info in these cases you can use the `--base-path` option to specify the top
143
-
most root from which packge support files can be read:
143
+
most root from which package support files can be read:
144
144
145
145
```shell
146
146
npx @pkgjs/support --base-path=${cwd}/../.. show
@@ -181,12 +181,12 @@ and the file containing the support info (package-support.json by default) is va
181
181
explains the options for providing support info and what goes into the package.json for
182
182
each case.
183
183
184
-
`npx suport validate` is run from the directory that contains the package.json for the package.
184
+
`npx support validate` is run from the directory that contains the package.json for the package.
185
185
Depending the how the `support` section in the package.json is configured validate will:
186
186
187
187
* validate the format of the `support` section in the package.json conforms to the
188
188
documentation in [Integration into package.json](https://github.com/nodejs/package-maintenance/blob/master/docs/PACKAGE-SUPPORT.md#integration-into-packagejson)
189
-
* calculate the file which cotains the support info
189
+
* calculate the file which contains the support info
190
190
* if the file is available locally, use that data unless the `--canonical`
191
191
option was specified.
192
192
* if the file is not available locally or `--canonical` was specified
@@ -195,13 +195,13 @@ documentation in [Integration into package.json](https://github.com/nodejs/packa
195
195
where it can be retrieved.
196
196
197
197
If both the entry in the package.json and the contents of the file with the package support
198
-
information is validate you'll see the follwowing output:
198
+
information is validate you'll see the following output:
199
199
200
200
```shell
201
201
Your support information is valid!
202
202
```
203
203
204
-
If the support information is not avialable locally or you have specified
204
+
If the support information is not available locally or you have specified
205
205
`--canonical` without `--fetch` you'll see something like:
206
206
207
207
```shell
@@ -210,7 +210,7 @@ support info not resolved: https://github.com/pkgjs/support/blob/master/package-
210
210
211
211
in this case the file is local to the package, but --canonical was specified. The same
212
212
would be shown if the info in the package.json file pointed to a file a different github
213
-
respository.
213
+
repository.
214
214
215
215
You might also see this if the file with the support information is outside of the
216
216
the package itself, but still available locally. This may be the case if you
@@ -221,9 +221,9 @@ are using mono-repo and sharing the support file. An example would be:
221
221
```
222
222
223
223
This is the case because, by default, the support tool will not read/display files outside of the
224
-
packge itself in order to avoid potential security issues. In order to allow the tool to validate
224
+
package itself in order to avoid potential security issues. In order to allow the tool to validate
225
225
support info in these cases you can use the `--base-path` option to specify the top
226
-
most root from which packge support files can be read:
226
+
most root from which package support files can be read:
0 commit comments