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.

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

Add @pkl-community/pkl as peer dependency #39

Merged
merged 2 commits into from
Mar 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 0 additions & 5 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,6 @@ jobs:
node-version: ${{ matrix.node-version }}
cache: npm

- name: Install pkl
uses: pkl-community/setup-pkl@v0
with:
pkl-version: ${{ matrix.pklVersion }}

- run: npm install
- run: npm run test:e2e
timeout-minutes: 3
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,10 @@ Until then, minor and patch releases may contain breaking changes.

## Appendix

### Pkl Binary Version

This package has a peer dependency on `@pkl-community/pkl`, to ensure a Pkl binary is installed. You can use an alternative Pkl binary (for either the evaluator or codegen) by setting the environment variable `PKL_EXEC` with the path to a Pkl binary.

### Type Mappings

When code-generating TypeScript type definitions from Pkl schemas, each Pkl type is converted to an associated TypeScript type, as per the table below. While in pre-release, these mappings are subject to change!
Expand Down
72 changes: 71 additions & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@
"consola": "^3.2.3",
"msgpackr": "^1.10.1"
},
"peerDependencies": {
"@pkl-community/pkl": "*"
},
"bin": {
"pkl-gen-typescript": "./dist/bin/pkl-gen-typescript.js"
}
Expand Down
Loading