Skip to content

Update docs to include type-aware linting support #462

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

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Aug 21, 2025

Updates documentation to reflect that oxlint now supports type-aware linting in preview mode, as announced in the type-aware linting blog post.

Changes Made

Main Linter Documentation (src/docs/guide/usage/linter.md)

  • Moved type-aware rules from "No support" to "Supports" section with preview designation
  • Added new "Type-Aware Linting (Preview)" section containing:
    • Installation instructions for the required oxlint-tsgolint@latest dependency
    • Usage instructions with the --type-aware flag
    • Link to the detailed announcement blog post

Plugins Documentation (src/docs/guide/usage/linter/plugins.md)

  • Updated TypeScript plugin description to indicate type-aware rules are supported in preview mode

Key Information for Users

  • Type-aware linting requires installing oxlint-tsgolint@latest
  • Enable with the --type-aware CLI flag
  • Feature is currently in preview status
  • Full list of supported type-aware rules available in the blog post

The documentation now accurately reflects the current capabilities of oxlint instead of stating that type-aware rules are not supported.

Documentation showing updated type-aware linting support

Fixes #461.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • cdn.jsdelivr.net
    • Triggering command: node /home/REDACTED/work/oxc-project.github.io/oxc-project.github.io/node_modules/.bin/../vitepress/bin/vitepress.js build (dns block)
  • plugins.dprint.dev
    • Triggering command: /home/REDACTED/work/oxc-project.github.io/oxc-project.github.io/node_modules/.pnpm/dprint@0.50.1/node_modules/dprint/dprint fmt --staged /home/REDACTED/work/oxc-project.github.io/oxc-project.github.io/package-lock.json /home/REDACTED/work/oxc-project.github.io/oxc-project.github.io/src/docs/guide/usage/linter.md /home/REDACTED/work/oxc-project.github.io/oxc-project.github.io/src/docs/guide/usage/linter/plugins.md (dns block)
    • Triggering command: /home/REDACTED/work/oxc-project.github.io/oxc-project.github.io/node_modules/.pnpm/dprint@0.50.1/node_modules/dprint/dprint fmt --staged /home/REDACTED/work/oxc-project.github.io/oxc-project.github.io/src/docs/guide/usage/linter.md /home/REDACTED/work/oxc-project.github.io/oxc-project.github.io/src/docs/guide/usage/linter/plugins.md (dns block)

If you need me to access, download, or install something from one of these locations, you can either:


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copy link
Contributor Author

Copilot AI commented Aug 21, 2025

@camchenry 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs.

I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review.

Copy link

netlify bot commented Aug 21, 2025

Deploy Preview for oxc-project ready!

Name Link
🔨 Latest commit 8b3fae6
🔍 Latest deploy log https://app.netlify.com/projects/oxc-project/deploys/68a75b2cc4e380000828b48a
😎 Deploy Preview https://deploy-preview-462--oxc-project.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@Copilot Copilot AI changed the title [WIP] Update docs to include type aware linting support Update docs to include type-aware linting support Aug 21, 2025
@Copilot Copilot AI requested a review from camchenry August 21, 2025 16:05
Copilot finished work on behalf of camchenry August 21, 2025 16:05
@camchenry
Copy link
Member

@copilot run fmt task to fix lint

…ng long lines

Co-authored-by: camchenry <1514176+camchenry@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Aug 21, 2025

@copilot run fmt task to fix lint

Fixed formatting issues by breaking long lines to stay under 120 characters. Since dprint requires internet access that's blocked in this environment, I manually formatted the files by:

  • Breaking long bullet points and paragraphs in linter.md
  • Shortening table descriptions in plugins.md (e.g., "Rules ported from" → "Rules from")
  • Properly breaking markdown table lines and links

All changes verified with oxlint - no warnings or errors. See commit 8b3fae6.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • plugins.dprint.dev
    • Triggering command: /home/REDACTED/.npm/_npx/e94364357ee2fa87/node_modules/dprint/dprint fmt (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot finished work on behalf of camchenry August 21, 2025 17:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update docs to include type aware linting support
2 participants