Skip to content
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
35 changes: 34 additions & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:
- main

jobs:
deploy:
deploy-v3:
runs-on: ubuntu-latest
permissions:
contents: read
Expand All @@ -33,3 +33,36 @@ jobs:
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
gitHubToken: ${{ secrets.GITHUB_TOKEN }}
command: pages deploy packages/docs/.vitepress/dist --project-name=js-toolkit

deploy-v4:
runs-on: ubuntu-latest
permissions:
contents: read
deployments: write
steps:
- uses: actions/checkout@v4

- uses: actions/setup-node@v4
with:
node-version: 24
cache: 'npm'

- run: npm ci

# The v4 exports map has no `typescript` condition, so twoslash resolves the
# package types out of `dist`. The committed `@twoslash-cache` comments make
# that unnecessary on a cache hit — this is what keeps a cache *miss* from
# failing the build instead of silently type-checking against nothing.
- name: Build the v4 package
run: npm run build:v4

- name: Build v4 docs
run: npm run docs:v4:build

- name: Deploy to Cloudflare Pages
uses: cloudflare/wrangler-action@v3
with:
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
gitHubToken: ${{ secrets.GITHUB_TOKEN }}
command: pages deploy packages/v4/docs/.vitepress/dist --project-name=js-toolkit-v4
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ packages/demo/dist/
.bench-report.json
/packages/docs/.vitepress/cache
/packages/docs/.vitepress/dist
/packages/v4/docs/.vitepress/cache
/packages/v4/docs/.vitepress/dist
coverage/
/full.d.ts
/index.d.ts
Expand Down
3 changes: 2 additions & 1 deletion .oxlintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,8 @@
"**/*.bench.ts",
"**/__benchmarks__/**",
"packages/v4/test/**",
"packages/v4/scripts/**"
"packages/v4/scripts/**",
"packages/v4/docs/**"
],
"rules": {
"complexity": "off",
Expand Down
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,14 @@ Visit [js-toolkit.studiometa.dev](https://js-toolkit.studiometa.dev) to learn mo

## Packages

| Package | Description |
| ------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| [`@studiometa/js-toolkit`](./packages/js-toolkit/) | The framework and its utility functions. |
| [`@studiometa/eslint-plugin-js-toolkit`](./packages/eslint-plugin/) | Oxlint/ESLint rules enforcing the framework's best practices. |
| [`packages/v4`](./packages/v4/) | The v4 prototype, private and not published. |
| [`packages/docs`](./packages/docs/) | Sources of [js-toolkit.studiometa.dev](https://js-toolkit.studiometa.dev). |
| [`packages/demo`](./packages/demo/) | A playground application used during development. |
| Package | Description |
| ------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| [`@studiometa/js-toolkit`](./packages/js-toolkit/) | The framework and its utility functions. |
| [`@studiometa/eslint-plugin-js-toolkit`](./packages/eslint-plugin/) | Oxlint/ESLint rules enforcing the framework's best practices. |
| [`packages/v4`](./packages/v4/) | The v4 prototype, private and not published. |
| [`packages/docs`](./packages/docs/) | Sources of [js-toolkit.studiometa.dev](https://js-toolkit.studiometa.dev). |
| [`packages/v4/docs`](./packages/v4/docs/) | Sources of [js-toolkit-v4.studiometa.dev](https://js-toolkit-v4.studiometa.dev). |
| [`packages/demo`](./packages/demo/) | A playground application used during development. |

## Installation

Expand Down
44 changes: 20 additions & 24 deletions 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 @@ -14,6 +14,9 @@
"docs:dev": "npm run dev --workspace=@studiometa/js-toolkit-docs",
"docs:build": "npm run build --workspace=@studiometa/js-toolkit-docs",
"docs:preview": "npm run preview --workspace=@studiometa/js-toolkit-docs",
"docs:v4:dev": "npm run docs:dev -w @studiometa/js-toolkit-v4",
"docs:v4:build": "npm run docs:build -w @studiometa/js-toolkit-v4",
"docs:v4:preview": "npm run docs:preview -w @studiometa/js-toolkit-v4",
"build": "npm run build:js-toolkit && npm run build:v4 && npm run build:eslint-plugin",
"build:js-toolkit": "npm run build -w @studiometa/js-toolkit",
"build:v4": "npm run build -w @studiometa/js-toolkit-v4",
Expand Down
Loading
Loading