Skip to content

docs: add harper.js Chrome extension intro and example - #3890

Open
Hashim1999164 wants to merge 6 commits into
Automattic:masterfrom
Hashim1999164:docs/harperjs-chrome-extension
Open

docs: add harper.js Chrome extension intro and example#3890
Hashim1999164 wants to merge 6 commits into
Automattic:masterfrom
Hashim1999164:docs/harperjs-chrome-extension

Conversation

@Hashim1999164

@Hashim1999164 Hashim1999164 commented Jul 26, 2026

Copy link
Copy Markdown

Issues

Fixes #3628

Description

Adds a minimal MV3 Chrome extension example under packages/harper.js/examples/chrome-extension-simple that loads local harper.js, shows the package version, and runs a one-line lint.

Documents extension-specific constraints (MV3 CSP, popup vs service worker, prefer local dist over unpkg) at /docs/harperjs/chrome-extension.

Wires the page into the docs sidebar and links it from the harper.js introduction and CDN pages. Points readers at packages/harper.js/examples.

Demo

N/A (documentation and example scaffolding)

How Has This Been Tested?

  • Confirmed sidebar wiring in packages/web/vite.config.ts
  • Skimmed /docs/harperjs/chrome-extension for accuracy and links
  • Reviewed the example package layout

AI Disclosure

  • I used an AI agent interactively.
  • I am a human and didn't use any AI.
  • I used LLM features of my editor, but not an agent.
  • I am an agent or I got an agent to do the work autonomously.

If Your PR Implements or Enhances a Linter

  • I made up the sentences in the unit tests.
  • The sentences in the unit tests were generated by an AI.
  • I'm using examples from the bug report / feature request.
  • I collected real-world sentences for the unit tests.

Checklist

  • I have performed a self-review of my own code
  • I have added tests to cover my changes
  • I have considered splitting this into smaller pull requests.

@hippietrail hippietrail added the harper.js Related to the Harper JavaScript library label Jul 27, 2026
@hippietrail

Copy link
Copy Markdown
Collaborator

Thanks for this, it looks very promising. I see that you did include an AI disclaimer, but could you please use our GitHub PR template, it has a couple more questions.

@Hashim1999164

Copy link
Copy Markdown
Author

Thanks for the note. I've updated the PR description to follow the GitHub PR template (issues, description, demo, testing, AI disclosure, and checklist).

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

Labels

harper.js Related to the Harper JavaScript library

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Add an intro for how to use harper.js inside a Chrome extension

2 participants