Skip to content

docs: add OpenRPC linter guides - #715

Open
BelfordZ wants to merge 2 commits into
masterfrom
docs/openrpc-linter-guides
Open

BelfordZ wants to merge 2 commits into
masterfrom
docs/openrpc-linter-guides

Conversation

@BelfordZ

Copy link
Copy Markdown
Member

Summary

  • add an OpenRPC Linter category to the website documentation
  • document installation, quick start, linting versus validation, the recommended ruleset, CI usage, and current limitations
  • include a reproducible run against the linter repository's known-bad fixture with representative output
  • add a developer guide for composing rules with built-in functions and contributing new functions

Verification

  • bun run build passes and prerenders both new linter routes
  • Prettier passes for all changed files
  • repository-wide ESLint still reports pre-existing errors in generated Pagefind assets and existing application code; it reports no new MDX errors

@vercel

vercel Bot commented Sep 11, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
website Ready Ready Preview Sep 14, 2026 8:36pm UTC

Comment thread src/content/linter/index.mdx
Comment on lines +240 to +254
jobs:
lint-openrpc:
name: Lint OpenRPC
runs-on: ubuntu-latest
steps:
- name: Check out the repository
uses: actions/checkout@v7

- name: Set up Node.js
uses: actions/setup-node@v7
with:
node-version: "24"
cache: npm

- name: Install dependencies

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'd change this to be generic, and use npm install , and then I'd maybe just call npx open-rpc-linter with a name of file or completely inline the example so someone knows full story of setting it up.

- New executable rule functions must be compiled into the linter; YAML rules
can only use registered functions.

The linter is currently pre-1.0. Pin a release in CI when reproducible behavior

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

probably could drop this comment might not age

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

its a nit though :)

@zcstarr zcstarr left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This generally looks good to me a few minor nits, the most lingering one is probably that the github actions ci should not use assumed npm as context, if we switch to using npx as the command entry point , and drop npm install then users using say C++ , rust, or go will also gain the benefit of the yml file and won't require an additional kind of setup assumption.

--rules rules/defaults/recommended.yaml
```

With release `v0.0.17`, the command exits non-zero and reports:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
With release `v0.0.17`, the command exits non-zero and reports:
The command exits non-zero and reports:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Probably ok to drop the version reference here

- New executable rule functions must be compiled into the linter; YAML rules
can only use registered functions.

The linter is currently pre-1.0. Pin a release in CI when reproducible behavior

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

its a nit though :)

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