NerdTip

• Sharpen definitions that are inaccurate, unclear or too long.
• Add terms or a whole glossary for a subject NerdTip doesn't cover yet.
• Report bugs, especially sites where the layout breaks or everyday words get highlighted.
• Take a roadmap item: tooltips on keyboard focus, scanning inside iframes and shadow DOM, rescanning text that changes in place, or a dictionary fallback for unknown words.

git clone https://github.com/SUD747/NerdTip && cd NerdTip
npm install   # only copies webextension-polyfill into vendor/
npm test

You need Node.js 18 or newer. After npm install, the repo root is a loadable extension:

• Chrome, Edge or Brave: open chrome://extensions, turn on Developer mode, choose Load unpacked, and pick the repo root.
• Firefox 140+: open about:debugging#/runtime/this-firefox, choose Load Temporary Add-on, and pick manifest.json.

After each change, reload the extension and refresh the tab.

Each glossary is a flat JSON file in glossary/ that maps a term to its definition. Good entries follow a few rules:

• One or two plain-language sentences, ideally under 200 characters.
• Expand acronyms first, then explain what the term means.
• Casing controls matching: GPU in capitals matches only that casing, inference in lowercase matches anywhere.
• Avoid everyday words like “interest” or “stroke”. Prefer specific phrases like “compound interest”.
• A term can appear only once across all glossaries. npm test checks this.
• Keep it factual and neutral, and write it in your own words.

For a new subject, create glossary/<subject>-terms.json, register it in src/shared/settings.js, and add it to the README table. The glossary id is stored in user settings, so it can't change once released.

• There's no background script, only content scripts, so one manifest.json works in every browser.
• Extension APIs go through browser.* via webextension-polyfill. Don't call chrome.* directly.
• Content scripts aren't modules. They share one scope and load in the order listed in manifest.json, so new files go there too.
• matcher.js is pure matching logic with no DOM, which is why it's unit-tested under Node. scanner.js walks the page and tooltip.js draws the hover card.

• Security: never put glossary text, custom terms or page content into innerHTML. Use textContent.
• Performance: the content script runs on every page, so batch DOM changes and keep per-node work cheap.
• Privacy: anything that sends data off the device must update PRIVACY.md in the same PR.
• Dependencies: no frameworks or new runtime dependencies without discussing it in an issue first.
• Style: 2-space indentation, single quotes, semicolons, small focused functions.

npm test
npm run build && npx web-ext lint --source-dir dist/firefox

Then test by hand in one Chromium browser and in Firefox. Terms should highlight and tooltips should appear, the per-site switch should work, glossary and custom-term changes should apply without a reload, and the console should be clean.

Keep each PR to one glossary or one fix, and include screenshots for UI changes. When reporting a bug, include your browser and NerdTip versions, the page URL, what you expected versus what happened, and any console errors.