Skip to content

User guide, package.json: add name and version#972

Merged
chalin merged 1 commit intogoogle:mainfrom
deining:ug-npm
Apr 27, 2022
Merged

User guide, package.json: add name and version#972
chalin merged 1 commit intogoogle:mainfrom
deining:ug-npm

Conversation

@deining
Copy link
Contributor

@deining deining commented Apr 9, 2022

From the npm docs:

A package.json file must contain "name" and "version" fields.

package.json inside the userguide directory does not have this fields.

As a consequence users may be confronted with poor output like this:

/path/to/docsy/userguide$ npm run-script
Scripts available in undefined via `npm run-script`:
  _build
  ...

This PR corrects this.

@deining deining added user guide Improvements to user guide CI/infra CI & infrastructure labels Apr 9, 2022
Copy link
Collaborator

@chalin chalin left a comment

Choose a reason for hiding this comment

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

Interesting, I had not noticed that behavior of "undefined" being printed when NPM lists the scripts.

I doubt that we need a version since the UG isn't a published package, but I'm ok with this PR. (We might consider removing the version field later.)

@chalin chalin merged commit ff06987 into google:main Apr 27, 2022
@deining deining deleted the ug-npm branch May 16, 2022 09:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI/infra CI & infrastructure user guide Improvements to user guide

2 participants