This repository has been archived by the owner on Oct 14, 2024. It is now read-only.
forked from ubiquity/work.ubq.fi
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'template/development' into sync-templat…
…e/development
- Loading branch information
Showing
32 changed files
with
3,004 additions
and
105 deletions.
There are no files selected for viewing
This file contains 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,4 +1,11 @@ | ||
| { | ||
| "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json", | ||
| "version": "0.2", | ||
| "words": ["devpool", "octocat", "ratelimit", "supabase", "UBIQUIBOT"] | ||
| } | ||
| "ignorePaths": ["**/*.json", "**/*.css", "node_modules", "**/*.log"], | ||
| "useGitignore": true, | ||
| "language": "en", | ||
| "words": ["dataurl", "devpool", "outdir", "servedir", "octocat", "ratelimit", "supabase", "UBIQUIBOT", "greyscale", "devrel", "fract", "VZLJ", "localstorage"], | ||
| "dictionaries": ["typescript", "node", "software-terms"], | ||
| "import": ["@cspell/dict-typescript/cspell-ext.json", "@cspell/dict-node/cspell-ext.json", "@cspell/dict-software-terms"], | ||
| "ignoreRegExpList": ["[0-9a-fA-F]{6}"] | ||
| } |
This file contains 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 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,129 @@ | ||
| import * as core from "@actions/core"; | ||
| import { Octokit } from "@octokit/rest"; | ||
| import simpleGit from "simple-git"; | ||
|
|
||
| const token = process.env.GITHUB_TOKEN; | ||
| const [owner, repo] = process.env.GITHUB_REPOSITORY?.split("/") || []; | ||
| const pullNumber = process.env.GITHUB_PR_NUMBER || process.env.PULL_REQUEST_NUMBER || "0"; | ||
| const baseRef = process.env.GITHUB_BASE_REF; | ||
|
|
||
| if (!token || !owner || !repo || pullNumber === "0" || !baseRef) { | ||
| core.setFailed("Missing required environment variables."); | ||
| process.exit(1); | ||
| } | ||
|
|
||
| const octokit = new Octokit({ auth: token }); | ||
| const git = simpleGit(); | ||
|
|
||
| async function main() { | ||
| try { | ||
| const { data: pullRequest } = await octokit.pulls.get({ | ||
| owner, | ||
| repo, | ||
| pull_number: parseInt(pullNumber, 10), | ||
| }); | ||
|
|
||
| const baseSha = pullRequest.base.sha; | ||
| const headSha = pullRequest.head.sha; | ||
|
|
||
| await git.fetch(["origin", baseSha, headSha]); | ||
|
|
||
| const diff = await git.diff([`${baseSha}...${headSha}`]); | ||
|
|
||
| core.info("Checking for empty strings..."); | ||
| const violations = parseDiffForEmptyStrings(diff); | ||
|
|
||
| if (violations.length > 0) { | ||
| violations.forEach(({ file, line, content }) => { | ||
| core.warning( | ||
| "Detected an empty string.\n\nIf this is during variable initialization, consider using a different approach.\nFor more information, visit: https://www.github.com/ubiquity/ts-template/issues/31", | ||
| { | ||
| file, | ||
| startLine: line, | ||
| } | ||
| ); | ||
| }); | ||
|
|
||
| // core.setFailed(`${violations.length} empty string${violations.length > 1 ? "s" : ""} detected in the code.`); | ||
|
|
||
| await octokit.rest.checks.create({ | ||
| owner, | ||
| repo, | ||
| name: "Empty String Check", | ||
| head_sha: headSha, | ||
| status: "completed", | ||
| conclusion: violations.length > 0 ? "failure" : "success", | ||
| output: { | ||
| title: "Empty String Check Results", | ||
| summary: `Found ${violations.length} violation${violations.length !== 1 ? "s" : ""}`, | ||
| annotations: violations.map((v) => ({ | ||
| path: v.file, | ||
| start_line: v.line, | ||
| end_line: v.line, | ||
| annotation_level: "warning", | ||
| message: "Empty string found", | ||
| raw_details: v.content, | ||
| })), | ||
| }, | ||
| }); | ||
| } else { | ||
| core.info("No empty strings found."); | ||
| } | ||
| } catch (error) { | ||
| core.setFailed(`An error occurred: ${error instanceof Error ? error.message : String(error)}`); | ||
| } | ||
| } | ||
|
|
||
| function parseDiffForEmptyStrings(diff: string) { | ||
| const violations: Array<{ file: string; line: number; content: string }> = []; | ||
| const diffLines = diff.split("\n"); | ||
|
|
||
| let currentFile: string; | ||
| let headLine = 0; | ||
| let inHunk = false; | ||
|
|
||
| diffLines.forEach((line) => { | ||
| const hunkHeaderMatch = /^@@ -\d+(?:,\d+)? \+(\d+)(?:,\d+)? @@/.exec(line); | ||
| if (hunkHeaderMatch) { | ||
| headLine = parseInt(hunkHeaderMatch[1], 10); | ||
| inHunk = true; | ||
| return; | ||
| } | ||
|
|
||
| if (line.startsWith("--- a/") || line.startsWith("+++ b/")) { | ||
| currentFile = line.slice(6); | ||
| inHunk = false; | ||
| return; | ||
| } | ||
|
|
||
| // Only process TypeScript files | ||
| if (!currentFile?.endsWith(".ts")) { | ||
| return; | ||
| } | ||
|
|
||
| if (inHunk && line.startsWith("+")) { | ||
| // Check for empty strings in TypeScript syntax | ||
| if (/^\+.*""/.test(line)) { | ||
| // Ignore empty strings in comments | ||
| if (!line.trim().startsWith("//") && !line.trim().startsWith("*")) { | ||
| // Ignore empty strings in template literals | ||
| if (!/`[^`]*\$\{[^}]*\}[^`]*`/.test(line)) { | ||
| violations.push({ | ||
| file: currentFile, | ||
| line: headLine, | ||
| content: line.substring(1).trim(), | ||
| }); | ||
| } | ||
| } | ||
| } | ||
| headLine++; | ||
| } else if (!line.startsWith("-")) { | ||
| headLine++; | ||
| } | ||
| }); | ||
|
|
||
| return violations; | ||
| } | ||
| main().catch((error) => { | ||
| core.setFailed(`Error running empty string check: ${error instanceof Error ? error.message : String(error)}`); | ||
| }); |
This file contains 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,13 @@ | ||
| import type { KnipConfig } from "knip"; | ||
|
|
||
| const config: KnipConfig = { | ||
| entry: ["build/index.ts", ".github/empty-string-checker.ts"], | ||
| project: ["src/**/*.ts"], | ||
| ignore: ["src/types/config.ts", "**/__mocks__/**", "**/__fixtures__/**"], | ||
| ignoreExportsUsedInFile: true, | ||
| // eslint can also be safely ignored as per the docs: https://knip.dev/guides/handling-issues#eslint--jest | ||
| ignoreDependencies: ["eslint-config-prettier", "eslint-plugin-prettier", "@types/jest", "@mswjs/data"], | ||
| eslint: true, | ||
| }; | ||
|
|
||
| export default config; |
This file contains 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,24 @@ | ||
| name: Spell Check | ||
|
|
||
| on: | ||
| push: | ||
|
|
||
| jobs: | ||
| spellcheck: | ||
| name: Check for spelling errors | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Set up Node.js | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: "20.10.0" | ||
|
|
||
| - name: Install cspell | ||
| run: yarn add cspell | ||
|
|
||
| - name: Run cspell | ||
| run: yarn format:cspell |
This file contains 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 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,27 @@ | ||
| name: Run Jest testing suite | ||
| on: | ||
| workflow_dispatch: | ||
| pull_request: | ||
|
|
||
| env: | ||
| NODE_ENV: "test" | ||
|
|
||
| jobs: | ||
| testing: | ||
| permissions: write-all | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: "20.10.0" | ||
|
|
||
| - uses: actions/checkout@master | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Jest With Coverage | ||
| run: yarn install --immutable --immutable-cache --check-cache && yarn test | ||
|
|
||
| - name: Add Jest Report to Summary | ||
| if: always() | ||
| run: echo "$(cat test-dashboard.md)" >> $GITHUB_STEP_SUMMARY |
This file contains 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,38 @@ | ||
| name: Knip-reporter | ||
|
|
||
| on: | ||
| workflow_run: | ||
| workflows: ["Knip"] | ||
| types: | ||
| - completed | ||
|
|
||
| jobs: | ||
| knip-reporter: | ||
| runs-on: ubuntu-latest | ||
| if: ${{ github.event.workflow_run.conclusion != 'success' }} | ||
| steps: | ||
| - uses: actions/download-artifact@v4 | ||
| with: | ||
| name: knip-results | ||
| run-id: ${{ github.event.workflow_run.id }} | ||
| github-token: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| - name: Read pr number | ||
| id: pr-number | ||
| uses: juliangruber/read-file-action@v1 | ||
| with: | ||
| path: ./pr-number.txt | ||
| trim: true | ||
|
|
||
| - name: Report knip results to pull request | ||
| uses: gitcoindev/knip-reporter@main | ||
| with: | ||
| verbose: true | ||
| comment_id: ${{ github.workflow }}-reporter | ||
| command_script_name: knip-ci | ||
| annotations: true | ||
| ignore_results: false | ||
| json_input: true | ||
| json_input_file_name: knip-results.json | ||
| pull_request_number: ${{ steps.pr-number.outputs.content }} | ||
| token: ${{ secrets.GITHUB_TOKEN }} |
This file contains 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,38 @@ | ||
| name: Knip | ||
|
|
||
| on: | ||
| pull_request: | ||
|
|
||
| jobs: | ||
| run-knip: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
|
|
||
| # needed to use yarn v4 | ||
| - name: Enable corepack | ||
| run: corepack enable | ||
|
|
||
| - name: Setup Node | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 20.10.0 | ||
|
|
||
| - name: Install toolchain | ||
| run: yarn install | ||
|
|
||
| - name: Store PR number | ||
| run: echo ${{ github.event.number }} > pr-number.txt | ||
|
|
||
| - name: Run Knip | ||
| run: yarn knip || yarn knip --reporter json > knip-results.json | ||
|
|
||
| - name: Upload knip result | ||
| if: failure() | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: knip-results | ||
| path: | | ||
| knip-results.json | ||
| pr-number.txt |
Oops, something went wrong.