Skip to content

docs(web): add JetBrains IDE integration guide (LSP4IJ) - #3866

Open
TropinAlexey wants to merge 1 commit into
Automattic:masterfrom
TropinAlexey:docs/jetbrains-integration
Open

docs(web): add JetBrains IDE integration guide (LSP4IJ)#3866
TropinAlexey wants to merge 1 commit into
Automattic:masterfrom
TropinAlexey:docs/jetbrains-integration

Conversation

@TropinAlexey

Copy link
Copy Markdown

Disclosure

Parts of this PR (research and the doc page draft) were produced with AI assistance (Claude Code), per Harper's agent PR policy.

Summary

Closes #362.

That issue asked for JetBrains IDE support. The thread already converged on the right answer: LSP4IJ (a community LSP client plugin for the IntelliJ Platform) ships with built-in support for harper-ls as a predefined language server — see LSP4IJ's harper-ls docs. A separate custom Harper plugin isn't needed, and another contributor who tried building one directly against harper-core/harper-ls ran into "typical Gradle horrors and version incompatibilities" in the issue thread.

@elijah-potter had explicitly asked for exactly this doc page in the issue thread:

If you'd put something in packages/web/src/routes/docs/integrations/intellij/+page.md, I can take care of the rest.

This PR adds that page (at .../integrations/jetbrains/+page.md to match the "JetBrains IDEs" framing used for the sidebar entry, since the plugin/IDE family covers more than just IntelliJ IDEA), covering:

  • Required setup (harper-ls + the LSP4IJ plugin)
  • Enabling harper-ls in LSP4IJ
  • A pointer to the shared harper-ls configuration reference

Changes

  • packages/web/src/routes/docs/integrations/jetbrains/+page.md (new): the integration guide, modeled on the existing visual-studio-code and sublime-text pages.
  • packages/web/vite.config.ts: registers the new page in the docs sidebar under "Integrations".
  • AGENTS.md: adds the new page to the sidebar file inventory, per the existing convention.

Test plan

  • pnpm dev in packages/web, confirmed /docs/integrations/jetbrains renders (200) with the new sidebar entry linking correctly.
  • npx @biomejs/biome check on the changed files (no issues).
  • Maintainer review of tone/content, since I'm not a JetBrains/LSP4IJ user myself — happy to adjust wording.

Documents using harper-ls in any IntelliJ Platform IDE (IntelliJ IDEA,
WebStorm, PyCharm, Rider, GoLand, RustRover, etc.) via the LSP4IJ
plugin, which ships with harper-ls support built in.

Closes Automattic#362

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01JHPfJZHgCizuPgvEZogAhi
@TropinAlexey TropinAlexey mentioned this pull request Jul 22, 2026
@hippietrail hippietrail added harper-ls Related to the Harper Language Server false-negative Real errors that Harper has a linter for yet failed to catch labels Jul 22, 2026
@elijah-potter

Copy link
Copy Markdown
Collaborator

If you are not an IntelliJ user yourself, how can you attest that this guide works? Have you or someone else tried it out on a real IDE?

I say that not to be critical, but to know if I need to find someone to test this out (or try it out myself).

@hippietrail

Copy link
Copy Markdown
Collaborator

I've been chronically low on SSD space lately and had to uninstall my IntelliJ stuff so I haven't been able to test this for now...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

false-negative Real errors that Harper has a linter for yet failed to catch harper-ls Related to the Harper Language Server

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Intellij Plugin

3 participants