oxlint-suggestion-action 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Cat Chen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,100 @@
+# oxlint-suggestion-action
+
+[![Build](https://github.com/CatChen/oxlint-suggestion-action/actions/workflows/build.yml/badge.svg?branch=main&event=push)](https://github.com/CatChen/oxlint-suggestion-action/actions/workflows/build.yml)
+[![Test](https://github.com/CatChen/oxlint-suggestion-action/actions/workflows/test.yml/badge.svg?branch=main&event=push)](https://github.com/CatChen/oxlint-suggestion-action/actions/workflows/test.yml)
+[![Oxlint](https://github.com/CatChen/oxlint-suggestion-action/actions/workflows/oxlint.yml/badge.svg?branch=main&event=push)](https://github.com/CatChen/oxlint-suggestion-action/actions/workflows/oxlint.yml)
+[![CodeQL](https://github.com/CatChen/oxlint-suggestion-action/actions/workflows/codeql.yml/badge.svg?branch=main&event=schedule)](https://github.com/CatChen/oxlint-suggestion-action/actions/workflows/codeql.yml)
+
+This GitHub Action runs Oxlint and provides inline feedback on the changes in a pull request. Features:
+
+1. It posts review comments for Oxlint diagnostics on modified lines.
+2. It only provides feedback for lines changed in the pull request, so pre-existing issues outside the diff do not add noise.
+
+## Examples
+
+When there is any Oxlint warning or error, this action will leave a comment:
+
+![example-screenshot](https://github.com/user-attachments/assets/e1f9dd35-1768-477f-b769-a936e7066940)
+
+## Usage
+
+Set up a GitHub Action like this:
+
+```yaml
+name: Oxlint
+
+on:
+  push:
+    branches: [main] # or [master] if that's the name of the main branch
+  pull_request:
+    branches: [main] # or [master] if that's the name of the main branch
+
+jobs:
+  oxlint:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
+        with:
+          node-version: '24'
+          check-latest: true
+
+      - name: Install dependencies
+        run: yarn install # or npm ci if you use npm and have package-lock.json
+
+      - uses: CatChen/oxlint-suggestion-action@main
+        with:
+          request-changes: true # optional
+          fail-check: false # optional
+          github-token: ${{ secrets.GITHUB_TOKEN }} # optional
+          directory: './' # optional
+          targets: '.' # optional
+          oxlint-bin-path: './node_modules/.bin/oxlint' # optional
+          config-path: '' # optional
+```
+
+Save the file to `.github/workflows/oxlint.yml`. It will start working on new pull requests.
+
+## Options
+
+### `request-changes`
+
+This option determines whether this GitHub Action should request changes if Oxlint does not pass. This option has no effect when the workflow is not triggered by a `pull_request` event. The default value is `true`.
+
+### `fail-check`
+
+This option determines whether the GitHub workflow should fail if Oxlint does not pass. The default value is `false`.
+
+### `github-token`
+
+The default value is `${{ github.token }}`, which is the GitHub token generated for this workflow. You can [create a different token with a different set of permissions](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) and use it here as well.
+
+### `directory`
+
+The default value is `'./'`. This action runs Oxlint from this directory.
+
+### `targets`
+
+The default value is `'.'`. For example, it could be `'src'` or `'src/**/*.ts'` for a typical TypeScript project. You can use glob patterns to match multiple directories, for example `'{src,lib}'`.
+
+### `oxlint-bin-path`
+
+The default value is `'./node_modules/.bin/oxlint'`. This action uses the Oxlint binary from this path.
+
+### `config-path`
+
+The default value is an empty string. Oxlint's default config discovery is used when this value is empty. If your config file is in a non-default location, set this option.
+
+## FAQ
+
+### Can I have GitHub suggestions outside of the scope?
+
+No, mostly not. GitHub only allows review comments inside diff hunks (changed lines and a small surrounding context). For consistency, this action only comments on changed lines in the pull request.
+
+### How can I avoid having annotations in generated code inside a project?
+
+Follow [GitHub's documentation](https://github.com/github/linguist/blob/master/docs/overrides.md#generated-code) and use `.gitattributes` to mark generated files and directories correctly. GitHub will hide those files in pull requests.

package/dist/changeDirectory.d.ts

@@ -0,0 +1 @@
+export declare function changeDirectory(directory: string): void;

package/dist/changeDirectory.js

@@ -0,0 +1,12 @@
+import path from 'node:path';
+import { chdir, cwd } from 'node:process';
+import { info } from '@actions/core';
+const DEFAULT_WORKING_DIRECTORY = cwd();
+export function changeDirectory(directory) {
+    info(`Working directory is: ${DEFAULT_WORKING_DIRECTORY}`);
+    const absoluteDirectory = path.resolve(DEFAULT_WORKING_DIRECTORY, directory);
+    if (absoluteDirectory !== DEFAULT_WORKING_DIRECTORY) {
+        info(`Working directory is changed to: ${absoluteDirectory}`);
+        chdir(absoluteDirectory);
+    }
+}

package/dist/getIndexedModifiedLines.d.ts

@@ -0,0 +1,4 @@
+import type { components } from '@octokit/openapi-types/types.js';
+export declare function getIndexedModifiedLines(file: components['schemas']['diff-entry']): {
+    [line: string]: true;
+};

package/dist/getIndexedModifiedLines.js

@@ -0,0 +1,41 @@
+import { info } from '@actions/core';
+const HUNK_HEADER_PATTERN = /^@@ -\d+(,\d+)? \+(\d+)(,(\d+))? @@/;
+export function getIndexedModifiedLines(file) {
+    var _a;
+    const modifiedLines = [];
+    const indexedModifiedLines = {};
+    let currentLine = 0;
+    let remainingLinesInHunk = 0;
+    const lines = (_a = file.patch) === null || _a === void 0 ? void 0 : _a.split('\n');
+    if (lines) {
+        for (const line of lines) {
+            if (remainingLinesInHunk === 0) {
+                const matches = line.match(HUNK_HEADER_PATTERN);
+                currentLine = parseInt((matches === null || matches === void 0 ? void 0 : matches[2]) || '1');
+                remainingLinesInHunk = parseInt((matches === null || matches === void 0 ? void 0 : matches[4]) || '1');
+                if (!currentLine || !remainingLinesInHunk) {
+                    throw new Error(`Expecting hunk header in ${file.filename} but seeing ${line}.`);
+                }
+            }
+            else if (line[0] === '-') {
+                continue;
+            }
+            else {
+                if (line[0] === '+') {
+                    modifiedLines.push(currentLine);
+                    indexedModifiedLines[currentLine] = true;
+                }
+                currentLine++;
+                remainingLinesInHunk--;
+            }
+        }
+    }
+    info(`  File modified lines: ${modifiedLines.join()}`);
+    if (file.patch !== undefined) {
+        info(`  File patch: \n${file.patch
+            .split('\n')
+            .map((line) => '    ' + line)
+            .join('\n')}\n`);
+    }
+    return indexedModifiedLines;
+}

package/dist/getOctokit.d.ts

@@ -0,0 +1,6 @@
+import type { Octokit } from '@octokit/core';
+import type { PaginateInterface } from '@octokit/plugin-paginate-rest';
+import type { Api } from '@octokit/plugin-rest-endpoint-methods';
+export declare function getOctokit(githubToken: string): Octokit & Api & {
+    paginate: PaginateInterface;
+};

package/dist/getOctokit.js

@@ -0,0 +1,39 @@
+import { GitHub, getOctokitOptions } from '@actions/github/lib/utils';
+import { retry } from '@octokit/plugin-retry';
+import { throttling } from '@octokit/plugin-throttling';
+export function getOctokit(githubToken) {
+    const Octokit = GitHub.plugin(throttling, retry);
+    const octokit = new Octokit(getOctokitOptions(githubToken, {
+        throttle: {
+            onRateLimit: (retryAfter, options, _, retryCount) => {
+                if (retryCount === 0) {
+                    octokit.log.warn(`Request quota exhausted for request ${options.method} ${options.url}`);
+                    octokit.log.info(`Retrying after ${retryAfter} seconds!`);
+                    return true;
+                }
+                else {
+                    octokit.log.error(`Request quota exhausted for request ${options.method} ${options.url}`);
+                }
+            },
+            onSecondaryRateLimit: (retryAfter, options, _, retryCount) => {
+                if (retryCount === 0) {
+                    octokit.log.warn(`Abuse detected for request ${options.method} ${options.url}`);
+                    octokit.log.info(`Retrying after ${retryAfter} seconds!`);
+                    return true;
+                }
+                else {
+                    octokit.log.warn(`Abuse detected for request ${options.method} ${options.url}`);
+                }
+            },
+        },
+        retry: {
+            doNotRetry: [429],
+        },
+    }));
+    octokit.graphql = octokit.graphql.defaults({
+        headers: {
+            'X-GitHub-Next-Global-ID': 1,
+        },
+    });
+    return octokit;
+}

package/dist/getPullRequestMetadata.d.ts

@@ -0,0 +1,7 @@
+export declare function getPullRequestMetadata(): {
+    owner: string;
+    repo: string;
+    pullRequestNumber: number;
+    baseSha: string;
+    headSha: string;
+};

package/dist/getPullRequestMetadata.js

@@ -0,0 +1,22 @@
+import { info } from '@actions/core';
+import { context } from '@actions/github';
+export function getPullRequestMetadata() {
+    const pullRequest = context.payload.pull_request;
+    const owner = context.repo.owner;
+    const repo = context.repo.repo;
+    const pullRequestNumber = pullRequest.number;
+    const baseSha = pullRequest.base.sha;
+    const headSha = pullRequest.head.sha;
+    info(`Owner: ${owner}`);
+    info(`Repo: ${repo}`);
+    info(`Pull Request number: ${pullRequestNumber}`);
+    info(`Base SHA: ${baseSha}`);
+    info(`Head SHA: ${headSha}`);
+    return {
+        owner,
+        repo,
+        pullRequestNumber,
+        baseSha,
+        headSha,
+    };
+}

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+export declare function oxlintSuggestion({ requestChanges, failCheck, githubToken, directory, targets, oxlintBinPath, configPath, }: {
+    requestChanges: boolean;
+    failCheck: boolean;
+    githubToken: string;
+    directory: string;
+    targets: string;
+    oxlintBinPath: string;
+    configPath: string;
+}): Promise<void>;

package/dist/index.js

@@ -0,0 +1,57 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { endGroup, getBooleanInput, getInput, info, setFailed, startGroup, } from '@actions/core';
+import { context } from '@actions/github';
+import { changeDirectory } from './changeDirectory.js';
+import { getOctokit } from './getOctokit.js';
+import { getPullRequestMetadata } from './getPullRequestMetadata.js';
+import { parseOxlintOutput } from './parseOxlintOutput.js';
+import { handlePullRequest } from './pullRequest.js';
+import { runOxlint } from './runOxlint.js';
+export function oxlintSuggestion(_a) {
+    return __awaiter(this, arguments, void 0, function* ({ requestChanges, failCheck, githubToken, directory, targets, oxlintBinPath, configPath, }) {
+        startGroup('Oxlint');
+        changeDirectory(directory);
+        const output = yield runOxlint({
+            oxlintBinPath,
+            targets,
+            configPath,
+        });
+        const parsedOutput = parseOxlintOutput(output);
+        endGroup();
+        info(`Event name: ${context.eventName}`);
+        switch (context.eventName) {
+            case 'pull_request':
+            case 'pull_request_target':
+                yield (() => __awaiter(this, void 0, void 0, function* () {
+                    const octokit = getOctokit(githubToken);
+                    const { owner, repo, pullRequestNumber, headSha } = getPullRequestMetadata();
+                    yield handlePullRequest(octokit, parsedOutput.diagnostics, owner, repo, pullRequestNumber, headSha, failCheck, requestChanges);
+                }))();
+                break;
+            default:
+                break;
+        }
+    });
+}
+function run() {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield oxlintSuggestion({
+            requestChanges: getBooleanInput('request-changes'),
+            failCheck: getBooleanInput('fail-check'),
+            githubToken: getInput('github-token'),
+            directory: getInput('directory'),
+            targets: getInput('targets'),
+            oxlintBinPath: getInput('oxlint-bin-path'),
+            configPath: getInput('config-path'),
+        });
+    });
+}
+run().catch((error) => setFailed(error));

package/dist/parseOxlintOutput.d.ts

@@ -0,0 +1,29 @@
+export type OxlintSeverity = 'warning' | 'error';
+type OxlintSpan = {
+    offset: number;
+    length: number;
+    line: number;
+    column: number;
+};
+type OxlintLabel = {
+    label?: string;
+    span: OxlintSpan;
+};
+export type OxlintDiagnostic = {
+    message: string;
+    code?: string;
+    severity: OxlintSeverity;
+    url?: string;
+    help?: string;
+    filename: string;
+    labels: OxlintLabel[];
+};
+export type OxlintOutput = {
+    diagnostics: OxlintDiagnostic[];
+    number_of_files: number;
+    number_of_rules: number;
+    threads_count: number;
+    start_time: number;
+};
+export declare function parseOxlintOutput(output: string): OxlintOutput;
+export {};

package/dist/parseOxlintOutput.js

@@ -0,0 +1,19 @@
+import { info } from '@actions/core';
+export function parseOxlintOutput(output) {
+    var _a, _b, _c, _d;
+    var _e;
+    const parsed = JSON.parse(output);
+    const indexedDiagnostics = {};
+    for (const diagnostic of parsed.diagnostics) {
+        (_a = indexedDiagnostics[_e = diagnostic.filename]) !== null && _a !== void 0 ? _a : (indexedDiagnostics[_e] = []);
+        (_b = indexedDiagnostics[diagnostic.filename]) === null || _b === void 0 ? void 0 : _b.push(diagnostic);
+    }
+    for (const [file, diagnostics] of Object.entries(indexedDiagnostics)) {
+        info(`File name: ${file}`);
+        for (const diagnostic of diagnostics) {
+            const line = (_d = (_c = diagnostic.labels[0]) === null || _c === void 0 ? void 0 : _c.span.line) !== null && _d !== void 0 ? _d : 1;
+            info(`  (${diagnostic.severity}) ${diagnostic.message} @ ${line}`);
+        }
+    }
+    return parsed;
+}

package/dist/pullRequest.d.ts

@@ -0,0 +1,7 @@
+import type { OxlintDiagnostic } from './parseOxlintOutput.js';
+import type { Octokit } from '@octokit/core';
+import type { PaginateInterface } from '@octokit/plugin-paginate-rest';
+import type { Api } from '@octokit/plugin-rest-endpoint-methods';
+export declare function handlePullRequest(octokit: Octokit & Api & {
+    paginate: PaginateInterface;
+}, diagnostics: OxlintDiagnostic[], owner: string, repo: string, pullRequestNumber: number, headSha: string, failCheck: boolean, requestChanges: boolean): Promise<void>;

package/dist/pullRequest.js

@@ -0,0 +1,161 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { endGroup, error, info, notice, startGroup } from '@actions/core';
+import { getIndexedModifiedLines } from './getIndexedModifiedLines.js';
+const REVIEW_BODY = "Oxlint doesn't pass. Please fix all Oxlint issues.";
+const GITHUB_ACTIONS_BOT_ID = 41898282;
+function getPullRequestFiles(octokit, owner, repo, pullRequestNumber) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const files = yield octokit.paginate(octokit.rest.pulls.listFiles, {
+            owner,
+            repo,
+            pull_number: pullRequestNumber,
+            per_page: 100,
+        });
+        info(`Files: (${files.length})`);
+        return files;
+    });
+}
+function getReviewComments(octokit, owner, repo, pullRequestNumber) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const reviews = yield octokit.paginate(octokit.rest.pulls.listReviews, {
+            owner,
+            repo,
+            pull_number: pullRequestNumber,
+            per_page: 100,
+        });
+        const reviewComments = yield octokit.paginate(octokit.rest.pulls.listReviewComments, {
+            owner,
+            repo,
+            pull_number: pullRequestNumber,
+            per_page: 100,
+        });
+        const relevantReviews = reviews.filter((review) => { var _a; return ((_a = review.user) === null || _a === void 0 ? void 0 : _a.id) === GITHUB_ACTIONS_BOT_ID && review.body === REVIEW_BODY; });
+        const relevantReviewIds = relevantReviews.map((review) => review.id);
+        const relevantReviewComments = reviewComments.filter((reviewComment) => reviewComment.user.id === GITHUB_ACTIONS_BOT_ID &&
+            reviewComment.pull_request_review_id !== null &&
+            relevantReviewIds.includes(reviewComment.pull_request_review_id));
+        info(`Existing review comments: (${relevantReviewComments.length})`);
+        return relevantReviewComments;
+    });
+}
+function getDiagnosticLines(diagnostic) {
+    const lines = diagnostic.labels.map((label) => label.span.line);
+    return [...new Set(lines)];
+}
+function getReviewCommentFromDiagnostic(diagnostic, line, path) {
+    const ruleInfo = diagnostic.code
+        ? diagnostic.url
+            ? `[\`${diagnostic.code}\`](${diagnostic.url})`
+            : `\`${diagnostic.code}\``
+        : '';
+    const trailingRuleInfo = ruleInfo ? ` ${ruleInfo}` : '';
+    return {
+        body: `**${diagnostic.message}**${trailingRuleInfo}`,
+        path,
+        side: 'RIGHT',
+        line,
+    };
+}
+function matchReviewComments(reviewComments, reviewComment) {
+    const matchedNodeIds = [];
+    for (const existingReviewComment of reviewComments) {
+        if (existingReviewComment.path === reviewComment.path &&
+            existingReviewComment.line === reviewComment.line &&
+            existingReviewComment.side === reviewComment.side &&
+            existingReviewComment.body === reviewComment.body) {
+            matchedNodeIds.push(existingReviewComment.node_id);
+        }
+    }
+    return matchedNodeIds;
+}
+export function handlePullRequest(octokit, diagnostics, owner, repo, pullRequestNumber, headSha, failCheck, requestChanges) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a, _b, _c;
+        var _d;
+        startGroup('GitHub Pull Request');
+        const files = yield getPullRequestFiles(octokit, owner, repo, pullRequestNumber);
+        const existingReviewComments = yield getReviewComments(octokit, owner, repo, pullRequestNumber);
+        const indexedDiagnostics = {};
+        for (const diagnostic of diagnostics) {
+            (_a = indexedDiagnostics[_d = diagnostic.filename]) !== null && _a !== void 0 ? _a : (indexedDiagnostics[_d] = []);
+            (_b = indexedDiagnostics[diagnostic.filename]) === null || _b === void 0 ? void 0 : _b.push(diagnostic);
+        }
+        let commentsCounter = 0;
+        let outOfScopeResultsCounter = 0;
+        const reviewComments = [];
+        for (const file of files) {
+            info(`  File name: ${file.filename}`);
+            info(`  File status: ${file.status}`);
+            if (file.status === 'removed') {
+                continue;
+            }
+            const indexedModifiedLines = getIndexedModifiedLines(file);
+            const fileDiagnostics = (_c = indexedDiagnostics[file.filename]) !== null && _c !== void 0 ? _c : [];
+            for (const diagnostic of fileDiagnostics) {
+                const lines = getDiagnosticLines(diagnostic);
+                for (const line of lines) {
+                    if (indexedModifiedLines[line]) {
+                        info(`  Matched line: ${line}`);
+                        const reviewComment = getReviewCommentFromDiagnostic(diagnostic, line, file.filename);
+                        const matchedComments = matchReviewComments(existingReviewComments, reviewComment);
+                        commentsCounter++;
+                        if (matchedComments.length === 0) {
+                            reviewComments.push(reviewComment);
+                            info(`    Comment queued`);
+                        }
+                        else {
+                            info(`    Comment skipped`);
+                        }
+                    }
+                    else {
+                        outOfScopeResultsCounter++;
+                        info(`  Out of scope line: ${line}`);
+                    }
+                }
+            }
+        }
+        if (outOfScopeResultsCounter > 0) {
+            info(`Out of scope results: ${outOfScopeResultsCounter}`);
+        }
+        endGroup();
+        startGroup('Feedback');
+        if (commentsCounter > 0) {
+            try {
+                yield octokit.rest.pulls.createReview({
+                    owner,
+                    repo,
+                    body: REVIEW_BODY,
+                    pull_number: pullRequestNumber,
+                    commit_id: headSha,
+                    event: requestChanges ? 'REQUEST_CHANGES' : 'COMMENT',
+                    comments: reviewComments,
+                });
+            }
+            catch (_e) {
+                throw new Error(`Failed to create review with ${reviewComments.length} comment(s).`);
+            }
+            if (commentsCounter - reviewComments.length > 0) {
+                info(`Review comments existed and skipped: ${commentsCounter - reviewComments.length}`);
+            }
+            info(`Review comments submitted: ${reviewComments.length}`);
+            if (failCheck) {
+                throw new Error('Oxlint fails. Please review comments.');
+            }
+            else {
+                error('Oxlint fails');
+            }
+        }
+        else {
+            notice('Oxlint passes');
+        }
+        endGroup();
+    });
+}

package/dist/runOxlint.d.ts

@@ -0,0 +1,5 @@
+export declare function runOxlint({ oxlintBinPath, targets, configPath, }: {
+    oxlintBinPath: string;
+    targets: string;
+    configPath: string;
+}): Promise<string>;

package/dist/runOxlint.js

@@ -0,0 +1,38 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { existsSync } from 'node:fs';
+import { resolve } from 'node:path';
+import { cwd } from 'node:process';
+import { notice } from '@actions/core';
+import { getExecOutput } from '@actions/exec';
+import { globSync } from 'glob';
+export function runOxlint(_a) {
+    return __awaiter(this, arguments, void 0, function* ({ oxlintBinPath, targets, configPath, }) {
+        const absoluteOxlintBinPath = resolve(cwd(), oxlintBinPath);
+        if (!existsSync(absoluteOxlintBinPath)) {
+            throw new Error(`Oxlint binary cannot be found at ${absoluteOxlintBinPath}`);
+        }
+        notice(`Using Oxlint from: ${absoluteOxlintBinPath}`);
+        const args = [...globSync(targets), '--format=json'];
+        const absoluteConfigPath = configPath ? resolve(cwd(), configPath) : null;
+        if (absoluteConfigPath) {
+            if (!existsSync(absoluteConfigPath)) {
+                throw new Error(`Oxlint config cannot be found at ${absoluteConfigPath}`);
+            }
+            notice(`Using Oxlint config from: ${absoluteConfigPath}`);
+            args.push(`--config=${absoluteConfigPath}`);
+        }
+        const oxlintOutput = yield getExecOutput(absoluteOxlintBinPath, args, {
+            ignoreReturnCode: true,
+            silent: true,
+        });
+        return oxlintOutput.stdout;
+    });
+}

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "oxlint-suggestion-action",
+  "version": "0.1.0",
+  "description": "A template to create custom GitHub Action with TypeScript/JavaScript.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.js",
+  "type": "module",
+  "scripts": {
+    "codegen": "rm -rf src/__graphql__ && graphql-codegen-esm --config codegen.ts",
+    "build": "rm -rf dist && yarn tsc",
+    "bundle": "rm -rf bundle && yarn ncc build src/index.ts --source-map --license licenses.txt --out bundle",
+    "format": "oxfmt --write .",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "lint": "oxlint src",
+    "prepublishOnly": "pinst --disable && yarn build",
+    "postpublish": "pinst --enable",
+    "prepare": "is-ci || husky"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/CatChen/oxlint-suggestion-action.git"
+  },
+  "author": "Cat Chen",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/CatChen/oxlint-suggestion-action/issues"
+  },
+  "homepage": "https://github.com/CatChen/oxlint-suggestion-action#readme",
+  "funding": "https://github.com/CatChen/oxlint-suggestion-action?sponsor=1",
+  "devDependencies": {
+    "@0no-co/graphqlsp": "^1.12.12",
+    "@graphql-codegen/cli": "6.1.2",
+    "@graphql-codegen/near-operation-file-preset": "^4.0.0",
+    "@graphql-codegen/typescript": "5.0.8",
+    "@graphql-codegen/typescript-document-nodes": "5.0.8",
+    "@types/node": "^25.0.0",
+    "@vercel/ncc": "^0.38.0",
+    "graphql": "^16.9.0",
+    "husky": "^9.0.5",
+    "is-ci": "^4.1.0",
+    "lint-staged": "^16.0.0",
+    "oxfmt": "^0.35.0",
+    "oxlint": "^1.24.3",
+    "pinst": "^3.0.0",
+    "typescript": "^5.0.2"
+  },
+  "dependencies": {
+    "@actions/core": "^3.0.0",
+    "@actions/exec": "^3.0.0",
+    "@actions/github": "^9.0.0",
+    "@graphql-typed-document-node/core": "^3.2.0",
+    "@octokit/plugin-retry": "^8.0.1",
+    "@octokit/plugin-throttling": "^11.0.1",
+    "glob": "^13.0.6"
+  },
+  "lint-staged": {
+    "*.{ts,js}": [
+      "yarn format",
+      "yarn lint --fix"
+    ],
+    "*.{json,yml,yaml,md,markdown}": "yarn format"
+  }
+}