Repository navigation
Modernize tooling and add VitePress docs #7
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| # Defines the coding style for different editors and IDEs. | ||
| # https://editorconfig.org/ | ||
|
|
||
| # top-most EditorConfig file | ||
| root = true | ||
|
|
||
| # Rules for source code. | ||
| [*] | ||
| charset = utf-8 | ||
| end_of_line = lf | ||
| trim_trailing_whitespace = true | ||
| insert_final_newline = true | ||
| indent_style = space | ||
| indent_size = 2 | ||
| max_line_length = 80 | ||
|
|
||
| [*.{py,pyi}] | ||
| indent_size = 4 | ||
|
|
||
| # Documentation. | ||
| [*.md] | ||
| max_line_length = 0 | ||
| trim_trailing_whitespace = false | ||
|
|
||
| # Git commit messages. | ||
| [COMMIT_EDITMSG] | ||
| max_line_length = 0 | ||
| trim_trailing_whitespace = false | ||
|
|
||
| # Makefiles require tabs. | ||
| [Makefile] | ||
| indent_style = tab | ||
| indent_size = 8 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| name: Deploy Docs | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main] | ||
| paths: | ||
| - "docs/**" | ||
| - "package.json" | ||
| - "pnpm-lock.yaml" | ||
| - ".github/workflows/docs.yml" | ||
|
|
||
| permissions: | ||
| contents: read | ||
| pages: write | ||
| id-token: write | ||
|
|
||
| concurrency: | ||
| group: pages | ||
| cancel-in-progress: false | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - name: Setup Node.js | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 24 | ||
|
|
||
| - name: Enable corepack | ||
| run: corepack enable pnpm | ||
|
|
||
| - name: Get pnpm store directory | ||
| id: pnpm-cache | ||
| shell: bash | ||
| run: | | ||
| echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT | ||
|
|
||
| - name: Setup pnpm cache | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: ${{ steps.pnpm-cache.outputs.STORE_PATH }} | ||
| key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }} | ||
| restore-keys: | | ||
| ${{ runner.os }}-pnpm-store- | ||
|
|
||
| - name: Install dependencies | ||
| run: pnpm install --frozen-lockfile | ||
|
|
||
| - name: Build docs | ||
| run: pnpm docs:build | ||
|
|
||
| - name: Setup Pages | ||
| uses: actions/configure-pages@v5 | ||
|
|
||
| - name: Upload artifact | ||
| uses: actions/upload-pages-artifact@v3 | ||
| with: | ||
| path: docs/.vitepress/dist | ||
|
|
||
| deploy: | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| needs: build | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v4 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,157 @@ | ||
| name: Publish | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| inputs: | ||
| bump: | ||
| description: "Version bump type" | ||
| required: true | ||
| type: choice | ||
| options: | ||
| - patch | ||
| - minor | ||
| - major | ||
| - prepatch | ||
| - preminor | ||
| - premajor | ||
| - prerelease | ||
| preid: | ||
| description: "Prerelease identifier (alpha, beta, rc). Only used with pre* bumps." | ||
| required: false | ||
| type: string | ||
| explicit_version: | ||
| description: "Explicit version (e.g. 2.0.0-beta.1). Overrides bump and preid when set." | ||
| required: false | ||
| type: string | ||
| dry_run: | ||
| description: "Dry run — skip publish, push, and release" | ||
| required: false | ||
| type: boolean | ||
| default: false | ||
|
|
||
| concurrency: | ||
| group: publish | ||
| cancel-in-progress: false | ||
|
|
||
| jobs: | ||
| checks: | ||
| if: github.ref == 'refs/heads/main' || startsWith(inputs.bump, 'pre') || inputs.explicit_version != '' | ||
| uses: ./.github/workflows/checks.yml | ||
|
|
||
| publish: | ||
| if: github.ref == 'refs/heads/main' || startsWith(inputs.bump, 'pre') || inputs.explicit_version != '' | ||
| needs: checks | ||
|
0x80 marked this conversation as resolved.
Resolved
|
||
| runs-on: ubuntu-latest | ||
| # Authentication is handled via OIDC trusted publishing (id-token), | ||
| # so no NPM_TOKEN secret is needed. | ||
| permissions: | ||
| contents: write | ||
| id-token: write | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - name: Setup Node.js | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 24 | ||
| registry-url: "https://registry.npmjs.org" | ||
|
|
||
| - name: Enable corepack | ||
| run: corepack enable pnpm | ||
|
|
||
| - name: Get pnpm store directory | ||
| id: pnpm-cache | ||
| shell: bash | ||
| run: | | ||
| echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT | ||
|
|
||
| - name: Setup pnpm cache | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: ${{ steps.pnpm-cache.outputs.STORE_PATH }} | ||
| key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }} | ||
| restore-keys: | | ||
| ${{ runner.os }}-pnpm-store- | ||
|
|
||
| - name: Install dependencies | ||
| run: pnpm install --frozen-lockfile | ||
|
|
||
| - name: Build | ||
| run: pnpm build | ||
|
|
||
| - name: Configure git | ||
| run: | | ||
| git config user.name "github-actions[bot]" | ||
| git config user.email "41898282+github-actions[bot]@users.noreply.github.com" | ||
|
|
||
| - name: Bump version | ||
| id: version | ||
| env: | ||
| BUMP: ${{ inputs.bump }} | ||
| PREID: ${{ inputs.preid }} | ||
| EXPLICIT_VERSION: ${{ inputs.explicit_version }} | ||
| run: | | ||
| if [[ -n "$EXPLICIT_VERSION" ]]; then | ||
| npm version "$EXPLICIT_VERSION" --git-tag-version true | ||
| else | ||
| ARGS=("$BUMP") | ||
| if [[ "$BUMP" == pre* && -n "$PREID" ]]; then | ||
| ARGS+=(--preid "$PREID") | ||
| fi | ||
| npm version "${ARGS[@]}" --git-tag-version true | ||
| fi | ||
|
|
||
| VERSION=$(node -p "require('./package.json').version") | ||
| TAG="v${VERSION}" | ||
|
|
||
| echo "version=${VERSION}" >> $GITHUB_OUTPUT | ||
| echo "tag=${TAG}" >> $GITHUB_OUTPUT | ||
|
|
||
| if [[ "$VERSION" == *-* ]]; then | ||
| echo "dist_tag=next" >> $GITHUB_OUTPUT | ||
| echo "prerelease=true" >> $GITHUB_OUTPUT | ||
| else | ||
| echo "dist_tag=latest" >> $GITHUB_OUTPUT | ||
| echo "prerelease=false" >> $GITHUB_OUTPUT | ||
| fi | ||
|
|
||
| - name: Publish summary | ||
| run: | | ||
| echo "### Publish Summary" >> $GITHUB_STEP_SUMMARY | ||
| echo "" >> $GITHUB_STEP_SUMMARY | ||
| echo "- **Version:** ${{ steps.version.outputs.version }}" >> $GITHUB_STEP_SUMMARY | ||
| echo "- **Tag:** ${{ steps.version.outputs.tag }}" >> $GITHUB_STEP_SUMMARY | ||
| echo "- **Dist tag:** ${{ steps.version.outputs.dist_tag }}" >> $GITHUB_STEP_SUMMARY | ||
| echo "- **Prerelease:** ${{ steps.version.outputs.prerelease }}" >> $GITHUB_STEP_SUMMARY | ||
| echo "- **Dry run:** ${{ inputs.dry_run }}" >> $GITHUB_STEP_SUMMARY | ||
|
|
||
| # Publish before push: npm publish is not retryable (same version | ||
| # can't be published twice), while git push is idempotent. If push | ||
| # fails after a successful publish, it can simply be retried manually. | ||
| - name: Publish to npm | ||
| if: ${{ inputs.dry_run == false }} | ||
| run: | | ||
| npm publish --provenance --tag ${{ steps.version.outputs.dist_tag }} | ||
|
|
||
| - name: Push version commit | ||
| if: ${{ inputs.dry_run == false }} | ||
| run: git push origin HEAD | ||
|
|
||
| - name: Push version tag | ||
| if: ${{ inputs.dry_run == false }} | ||
| run: git push origin ${{ steps.version.outputs.tag }} | ||
|
|
||
| - name: Create GitHub Release | ||
| if: ${{ inputs.dry_run == false }} | ||
| run: | | ||
| PRERELEASE_FLAG="" | ||
| if [[ "${{ steps.version.outputs.prerelease }}" == "true" ]]; then | ||
| PRERELEASE_FLAG="--prerelease" | ||
| fi | ||
|
|
||
| gh release create "${{ steps.version.outputs.tag }}" \ | ||
| --generate-notes \ | ||
| $PRERELEASE_FLAG | ||
| env: | ||
| GH_TOKEN: ${{ github.token }} | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,5 @@ | ||
| /node_modules | ||
| /dist | ||
| /tsconfig.tsbuildinfo | ||
| docs/.vitepress/cache | ||
| docs/.vitepress/dist |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| dist | ||
| pnpm-lock.yaml |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| { | ||
| "$schema": "./node_modules/oxfmt/configuration_schema.json", | ||
| "printWidth": 80, | ||
| "tabWidth": 2, | ||
| "useTabs": false, | ||
| "semi": true, | ||
| "singleQuote": false, | ||
| "trailingComma": "all", | ||
| "bracketSpacing": true, | ||
| "arrowParens": "always", | ||
| "endOfLine": "lf", | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| { | ||
| "$schema": "./node_modules/oxlint/configuration_schema.json", | ||
| "plugins": ["typescript"], | ||
| "categories": { | ||
| "correctness": "error", | ||
| "suspicious": "warn", | ||
| "perf": "warn" | ||
| }, | ||
| "rules": { | ||
| "typescript/no-floating-promises": "error", | ||
| "typescript/no-misused-promises": "error", | ||
| "typescript/await-thenable": "error", | ||
| "typescript/no-unused-vars": ["warn", { "argsIgnorePattern": "^_" }], | ||
| "typescript/no-unsafe-type-assertion": "off", | ||
| "no-await-in-loop": "off" | ||
| }, | ||
| "ignorePatterns": ["*.d.ts", "*.d.mts"] | ||
| } |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.