Skip to content

Commit 2faaf1f

Browse files
authored
Fix simple typos found (#22)
1 parent 4a09b49 commit 2faaf1f

File tree

4 files changed

+15
-15
lines changed

4 files changed

+15
-15
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
![support response-def](https://img.shields.io/badge/support%20response-best--effort-yellow.svg)
1111

1212
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)
1414
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
1515
some tooling around working with the format proposed.
1616

doc/command-line-usage.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Using the packge support tool from the command line
1+
# Using the package support tool from the command line
22

33
There are 2 main uses cases for the package support tool
44

@@ -16,7 +16,7 @@ you can run the support tool using `npx support`.
1616

1717
## Package Consumers
1818

19-
The support tool helps package conumers review and understand the
19+
The support tool helps package consumers review and understand the
2020
package support information provided by maintainers. See
2121
[Package-support.md](https://github.com/nodejs/package-maintenance/blob/master/docs/PACKAGE-SUPPORT.md)
2222
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
123123
remote calls.
124124
125125
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.
127127
128128
129129
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
138138
Local support information may be available locally but outside of the package itself.
139139
This may be the case if you are using mono-repo and sharing the support file.
140140
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
142142
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:
144144
145145
```shell
146146
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
181181
explains the options for providing support info and what goes into the package.json for
182182
each case.
183183
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.
185185
Depending the how the `support` section in the package.json is configured validate will:
186186
187187
* validate the format of the `support` section in the package.json conforms to the
188188
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
190190
* if the file is available locally, use that data unless the `--canonical`
191191
option was specified.
192192
* 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
195195
where it can be retrieved.
196196
197197
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:
199199
200200
```shell
201201
Your support information is valid!
202202
```
203203
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
205205
`--canonical` without `--fetch` you'll see something like:
206206
207207
```shell
@@ -210,7 +210,7 @@ support info not resolved: https://github.com/pkgjs/support/blob/master/package-
210210
211211
in this case the file is local to the package, but --canonical was specified. The same
212212
would be shown if the info in the package.json file pointed to a file a different github
213-
respository.
213+
repository.
214214
215215
You might also see this if the file with the support information is outside of the
216216
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:
221221
```
222222
223223
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
225225
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:
227227
228228
```shell
229229
npx @pkgjs/support --base-path=${cwd}/../.. validate

lib/cli/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ module.exports = (options = {}) => {
6262
group: 'preferences'
6363
})
6464
.option('fetch', {
65-
describe: 'Fetch canonical support info from remote repos when necessary',
65+
describe: 'Fetch canonical support info from remote repositories when necessary',
6666
type: 'boolean',
6767
group: 'preferences'
6868
})

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"support": true,
77
"keywords": [
88
"support",
9-
"pacakge maintenence",
9+
"package maintenance",
1010
"sustainability"
1111
],
1212
"license": "MIT",

0 commit comments

Comments
 (0)