Skip to content

Comments

docs(napi/oxlint): add comments#13712

Merged
graphite-app[bot] merged 1 commit intomainfrom
09-12-docs_napi_oxlint_add_comments
Sep 12, 2025
Merged

docs(napi/oxlint): add comments#13712
graphite-app[bot] merged 1 commit intomainfrom
09-12-docs_napi_oxlint_add_comments

Conversation

@overlookmotel
Copy link
Member

@overlookmotel overlookmotel commented Sep 12, 2025

Docs/comments only. Document all functions in napi/oxlint crate + update safety comment in wrap_lint_file.

@github-actions github-actions bot added the C-docs Category - Documentation. Related to user-facing or internal documentation label Sep 12, 2025
Copy link
Member Author

overlookmotel commented Sep 12, 2025


How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • 0-merge - adds this PR to the back of the merge queue
  • hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@overlookmotel overlookmotel force-pushed the 09-12-docs_napi_oxlint_add_comments branch from cf1d3b8 to cb922fe Compare September 12, 2025 05:15
@overlookmotel overlookmotel marked this pull request as ready for review September 12, 2025 05:18
@graphite-app graphite-app bot force-pushed the 09-12-fix_napi_oxlint_prevent_compilation_failure_on_wasm32 branch 2 times, most recently from 09e3ad1 to 3aff5a3 Compare September 12, 2025 05:23
@graphite-app graphite-app bot force-pushed the 09-12-docs_napi_oxlint_add_comments branch from cb922fe to 3f5db19 Compare September 12, 2025 05:23
@overlookmotel overlookmotel force-pushed the 09-12-docs_napi_oxlint_add_comments branch from 3f5db19 to 7798c53 Compare September 12, 2025 05:27
@overlookmotel overlookmotel force-pushed the 09-12-fix_napi_oxlint_prevent_compilation_failure_on_wasm32 branch from 3aff5a3 to 09e3ad1 Compare September 12, 2025 05:27
@camc314 camc314 added 0-merge Merge with Graphite Merge Queue A-linter Area - Linter labels Sep 12, 2025
@graphite-app graphite-app bot changed the base branch from 09-12-fix_napi_oxlint_prevent_compilation_failure_on_wasm32 to graphite-base/13712 September 12, 2025 05:27
Copy link
Contributor

camc314 commented Sep 12, 2025

Merge activity

  • Sep 12, 5:27 AM UTC: The merge label '0-merge' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
  • Sep 12, 5:33 AM UTC: Graphite rebased this pull request, because this pull request is set to merge when ready.
  • Sep 12, 5:38 AM UTC: camc314 added this pull request to the Graphite merge queue.
  • Sep 12, 5:42 AM UTC: Merged by the Graphite merge queue.

@camc314 camc314 force-pushed the 09-12-docs_napi_oxlint_add_comments branch from 7798c53 to 69f7baf Compare September 12, 2025 05:32
@camc314 camc314 force-pushed the graphite-base/13712 branch from 09e3ad1 to 7d462fa Compare September 12, 2025 05:32
@graphite-app graphite-app bot changed the base branch from graphite-base/13712 to main September 12, 2025 05:33
Docs/comments only. Document all functions in `napi/oxlint` crate + update safety comment in `wrap_lint_file`.
Copilot AI review requested due to automatic review settings September 12, 2025 05:37
@graphite-app graphite-app bot force-pushed the 09-12-docs_napi_oxlint_add_comments branch from 69f7baf to 5f56b09 Compare September 12, 2025 05:37
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@graphite-app graphite-app bot merged commit 5f56b09 into main Sep 12, 2025
17 checks passed
@graphite-app graphite-app bot deleted the 09-12-docs_napi_oxlint_add_comments branch September 12, 2025 05:42
@graphite-app graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Sep 12, 2025
graphite-app bot pushed a commit that referenced this pull request Sep 17, 2025
Convert `oxlint` to a NAPI package.

This PR:

1. Moves files from `napi/oxlint` into `apps/oxlint`.
2. Converts `oxlint` into a NAPI package.
3. Alters the [release workflow](https://github.com/oxc-project/oxc/pull/13723/files#diff-80cb497c859bbaf7756da6ced2bca3d31933affc96102983eee1ad7d4bcc60fd) and [script](https://github.com/oxc-project/oxc/pull/13723/files#diff-4c4b7045c68805aeeae7c0af94cf7cf7487cb0403496da974a6a23accdc457d0) for building `oxlint` packages.

Most of necessary code modifications and refactoring was done in previous PRs (#13701, #13712, #13722, #13745), so this PR only includes changes necessary for packaging as NAPI.

I've done my best to update release workflow, but am mostly "flying blind" without ability to test it, so very likely there are mistakes.

A few notes and oddities:

* I've kept the `oxlint` NPM package as CommonJS. We could probably switch to ESM, but I thought it better to minimize the changes in this PR.
* NAPI-RS creates `.node` files named with a `-msvc` postfix for Windows. The scripts here remove that postfix so that filename of `.node` files and NPM package names match for all platforms, for simplicity.
* `tasks/website` has a dependency on `oxlint` as a normal library. This resulted in linker errors, so have had to put all the NAPI stuff behind `napi` cargo feature. Tests for `tasks/website` are run separately in CI, to avoid feature unification turning on the `napi` feature for `website`.

I've made a few comments below for the parts which aren't fairly self-explanatory.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-linter Area - Linter C-docs Category - Documentation. Related to user-facing or internal documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants