Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

added a header for usage with process.env #14

Merged
merged 3 commits into from Aug 7, 2018
Merged

added a header for usage with process.env #14

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0a37f41
added a header for usage with process.env
mwarger Jul 17, 2018
18914a8
updated usage example
mwarger Jul 20, 2018
bab4de8
updated with review recommendation
mwarger Jul 26, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 5 additions & 1 deletion doc/misc/npm-scripts.md
View file
Open in desktop
Expand Up @@ -143,7 +143,11 @@ The package.json fields are tacked onto the `npm_package_` prefix. So,
for instance, if you had `{"name":"foo", "version":"1.2.5"}` in your
package.json file, then your package scripts would have the
`npm_package_name` environment variable set to "foo", and the
`npm_package_version` set to "1.2.5"
`npm_package_version` set to "1.2.5".

#### Usage
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For consistency with the other sections, I would recommend moving the example up to follow the previous paragraph, and changing the language a bit. Here's how that might look:

The package.json fields are tacked onto the npm_package_ prefix. So, for instance, if you had {"name":"foo", "version":"1.2.5"} in your package.json file, then your package scripts would have the npm_package_name environment variable set to "foo", and the npm_package_version set to "1.2.5". You can access these variables in your code with process.env.npm_package_name and process.env.npm_package_version, and so on for other fields.

As an example, you could access the `npm_package_version` variable by
referencing `process.env.npm_package_version` in your code.

### configuration

Expand Down