Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 7b94834

Browse files
committedDec 16, 2024·
swap to pnpm and fix readme
1 parent aec3421 commit 7b94834

File tree

5 files changed

+3450
-6287
lines changed

5 files changed

+3450
-6287
lines changed
 

‎.github/workflows/ci.yaml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,17 @@ jobs:
1616
runs-on: ubuntu-latest
1717
strategy:
1818
matrix:
19-
node-version: [18.x, 20.x]
19+
node-version: [18.x, 20.x, 22.x]
2020
fail-fast: false
2121

2222
steps:
2323
- uses: actions/checkout@v4
24+
- uses: pnpm/action-setup@v4
2425
- name: Use Node.js ${{ matrix.node-version }}
2526
uses: actions/setup-node@v4
2627
with:
2728
node-version: ${{ matrix.node-version }}
28-
cache: 'npm'
29-
- run: npm ci
30-
- run: npm run lint
31-
- run: npm test
29+
cache: 'pnpm'
30+
- run: pnpm i --frozen-lockfile
31+
- run: pnpm run lint
32+
- run: pnpm test

‎README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
# Ember JSON API Docs [![Build Status](https://travis-ci.org/ember-learn/ember-jsonapi-docs.svg?branch=master)](https://travis-ci.org/ember-learn/ember-jsonapi-docs)
1+
# Ember JSON API Docs [![Build Status](https://github.com/ember-learn/ember-json-api-docs/actions/workflows/ci.yml/badge.svg)](https://github.com/ember-learn/ember-jsonapi-docs/actions/workflows/ci.yaml)
22

3-
This tool gets the code comments from `ember.js` and `ember-data` libraries,
3+
4+
This tool gets the code comments from `ember.js` and `ember-data` libraries,
45
turns them into JSON files, and then turns those JSON files into a
56
[JSON:API](http://jsonapi.org/) format.
67

@@ -13,7 +14,7 @@ The files this tool creates are used to power
1314
## Prerequisites
1415

1516
- the latest [Node.js](https://nodejs.org/) LTS
16-
- [yarn v1](https://yarnpkg.com/)
17+
- [pnpm v9](https://pnpm.io/) (preferably managed via [corepack](https://github.com/nodejs/corepack))
1718

1819
Clone all of the following repositories into the same directory so they are "siblings" on the file system
1920

@@ -45,8 +46,8 @@ files into the `s3-docs` directory of `ember-api-docs-data`:
4546

4647
```sh
4748
cd ../ember-jsonapi-docs
48-
yarn
49-
yarn gen --project ember --version "5.2.0"
49+
pnpm i
50+
pnpm gen --project ember --version "5.2.0"
5051
```
5152

5253
I would recommend committing in ember-api-docs-data at this stage so that you can see that the following steps work.

‎package-lock.json

Lines changed: 0 additions & 6271 deletions
This file was deleted.

‎package.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@
1010
"license": "MIT",
1111
"author": "Stanley Stuart <stanley+npm@stan.li>",
1212
"type": "module",
13-
"bin":{
14-
"build-jsonapi-docs": "./index.js",
15-
"build-yuidoc": "./generate-local.js"
16-
},
13+
"bin": {
14+
"build-jsonapi-docs": "./index.js",
15+
"build-yuidoc": "./generate-local.js"
16+
},
1717
"contributors": [
1818
"Todd Jordan",
1919
"Sivakumar Kailasam <siva@rubberduck.engineering>",
@@ -62,9 +62,9 @@
6262
"eslint-config-prettier": "^9.0.0",
6363
"eslint-plugin-n": "^16.2.0",
6464
"eslint-plugin-prettier": "^5.0.1",
65-
"husky": "^3.0.5",
6665
"mocha": "^10.2.0",
6766
"prettier": "^3.0.3",
6867
"pretty-quick": "^1.11.1"
69-
}
68+
},
69+
"packageManager": "pnpm@9.15.0+sha512.76e2379760a4328ec4415815bcd6628dee727af3779aaa4c914e3944156c4299921a89f976381ee107d41f12cfa4b66681ca9c718f0668fa0831ed4c6d8ba56c"
7070
}

‎pnpm-lock.yaml

Lines changed: 3432 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)
Please sign in to comment.