Skip to content

Migrate from yarn to npm #26

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

Merged
jspahrsummers merged 3 commits into from
Oct 31, 2024
Merged

Migrate from yarn to npm #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
810494c
Migrate from yarn to npm
jspahrsummers Oct 31, 2024
e11bd20
Ignore diffs in package-lock.json
jspahrsummers Oct 31, 2024
9d2179d
Add .npmrc
jspahrsummers Oct 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitattributes
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
package-lock.json linguist-generated=true
12 changes: 6 additions & 6 deletions .github/workflows/main.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ jobs:
- uses: actions/setup-node@v2
with:
node-version: 20
cache: yarn
cache: npm

- run: yarn install --immutable
- run: npm ci

- run: yarn validate:schema
- run: npm run validate:schema

- run: yarn generate:json
- name: Verify that `yarn generate:json` did not change outputs (if it did, please re-run it and re-commit!)
- run: npm run generate:json
- name: Verify that `npm run generate:json` did not change outputs (if it did, please re-run it and re-commit!)
run: git diff --exit-code

- run: yarn validate:examples
- run: npm run validate:examples
1 change: 1 addition & 0 deletions .npmrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
registry = "https://registry.npmjs.org/"
11 changes: 5 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ The following software is required to work on the spec:

* Typescript
* Node.JS 20 or above
* Yarn
* Typescript JSON Schema (for generating json schema)
* Hugo (optionally, for serving the documentation)
* Go (optionally, for serving the documentation)
Expand All @@ -21,17 +20,17 @@ The following commands install the dependencies, validate the schema and generat

```bash
$ nvm install # install the correct node version
$ yarn install # install dependencies
$ yarn validate:schema # validate the schema
$ yarn validate:examples # validate the examples
$ yarn generate:json # generate the json schema
$ npm install # install dependencies
$ npm run validate:schema # validate the schema
$ npm run validate:examples # validate the examples
$ npm run generate:json # generate the json schema
```

## Serving the documentation
The documentation lives in the `docs` folder. To serve the documentation, run the following commands:

```bash
$ yarn serve:docs # serve the documentation
$ npm run serve:docs # serve the documentation
```

Note that this requires Hugo and Go to be installed.
Loading