This is a browser extension designed to be used in Firefox, Google Chrome, and chromium-based browsers (such as MS Edge) by players of the popular ARPG - Path of Exile. The purpose of this extension is to provide two benefits:
-
An easy to use hotkeyed trigger (
ALT+W) to enable users to search for information about the game using the official community wiki. -
As part of an ongoing outcry over the old wiki
pathofexile.fandom.comemploying user-hostile and predatory approaches via tracking, fingerprinting and advertising, this extension intercepts any request your browser sends to Fandom's domain forpath of exile(all other fandom wiki's are not affected, neither are any other web page requests) and parses out the target of your journey (A.K.A what section of the fandom wiki you were going to) and directs you to the official community wiki instead, leaving you to land on the same exact page you were after, just in a friendlier, community-backed wiki.
PNPM is just in my experience a way better package manager in that it not only supports monorepos better, it also sanely handles packages via linking whereby your individual projects do not ever have to pull a useless copy of a package down unless it's a new version. It saves on space and node_modules/ bloat. They do a better job of explaining this than I can, so please read about it here.
WEB-EXT is a neat little dev runner for Mozzila extensions (requires Firefox to be installed) so you can live test your work - as you work. It runs as a process and reloads the extension live as you make changes to your source code. Neat!
npm i -g pnpm<-- the last time you'll ever use NPM if you decided to switch to PNPM.git clone <this repo or fork>pnpm i -g web-extcdinto the cloned repo.pnpm install- Setup your vscode to format via ESLint on save. In
.vscode/settings.json-"editor.codeActionsOnSave": { "source.fixAll.eslint": true } - In two terminals run:
pnpm run test:watchandpnpm run start
Now every time you make changes to the code, you'll see them live on Firefox. Unless you do something browser-specific in the code, your extension should just work almost everywhere!
To build your extension for publishing, simply run pnpm run build. The packaged zip file will be output to build/.
We use Jest for testing. Run pnpm run test or pnpm run test:watch.
Yes, it is. We do not enforce its use, we provide it as a means to simplify your life when searching for PoE related information and as a means to globally redirect your requests to the official wiki, instead of the ad-ridden Fandom site. The code that does this sits in two places:
src/background/background.jssrc/ui/ui.js
Each file has a laymanised comment stack to walk even non-technical users through what it does and why. Don't be shy and read through!
No, you can use whatever you like. This is for people who want to optimise their wiki searches.
Absolutely not. This extension does not need anything from you to work. The only thing it does is tell your browser to let it know when you click on any fandom link, and if this happens, it asks your browser to instead take you to the new community wiki. No other information is read, asked for or needed. At all.
Just fork the repo, add your changes and submit a PR to us!
Not sure yet. For now the two most important things are implemented. Everything else is a secondary concern compared to work being put into the wiki itself. We may find more functionality we wish to add to this in the future.
Yes, as long as the wiki is up, this should be something we actively maintain. Although it does not need much maintenance. It's a VERY small extension for now. :)