Skip to content

docs(formatter): document editor command installation - #1486

Merged
Lorenzobattistela merged 1 commit into
bendlang:mainfrom
Osraka:docs/bend-fmt-lsp-install-command
Oct 11, 2026
Merged

Lorenzobattistela merged 1 commit into
bendlang:mainfrom
Osraka:docs/bend-fmt-lsp-install-command

Conversation

@Osraka

@Osraka Osraka commented Oct 11, 2026

Copy link
Copy Markdown
Contributor

Why

The current install steps build dist/server.js, but do not put bend2-fmt-lsp on PATH. The Neovim, Helix, and Emacs examples below them all invoke that command, so following the README alone leaves those editor setups unable to start the server.

What changed

  • State the checkout-relative working directory for installation and build.
  • Separate running the server directly with node from installing its command for editor use.
  • Document npm install -g . after building, with an absolute-path alternative for users who do not want a global install.

Verification

  • Reproduced the missing command after npm ci and npm run build in a clean copy.
  • Installed into an isolated npm prefix and confirmed the command starts an LSP session.
  • npm test in the formatter package: 25 passed.
  • git diff --check passed.

@Lorenzobattistela
Lorenzobattistela merged commit 42e0fa9 into bendlang:main Oct 11, 2026
1 check passed
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.

2 participants