add text revealer

text-revealer/.github/workflows/web-ext-workflow.yml

@@ -0,0 +1,50 @@
+name: Release new version
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+  # release:
+  #   types: [published]
+
+jobs:
+  build-release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Build
+        id: web-ext-build
+        uses: kewisch/action-web-ext@v1
+        with:
+          cmd: build
+          filename: "{name}-{version}.xpi"
+          ignoreFiles: '[
+            "package.json",
+            "package-lock.json",
+            "yarn.lock",
+            ".github",
+            ".gitattributes",
+            "LICENSE",
+            "README.md"]'
+
+      - name: Sign
+        id: web-ext-sign
+        uses: kewisch/action-web-ext@v1
+        with:
+          cmd: sign
+          channel: listed
+          source: ${{ steps.web-ext-build.outputs.target }}
+          apiKey: ${{ secrets.FIREFOX_JWT_ISSUER }}
+          apiSecret: ${{ secrets.FIREFOX_JWT_SECRET }}
+          timeout: 900000
+
+      - name: Release
+        uses: softprops/action-gh-release@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          files: ${{ steps.web-ext-sign.outputs.target }}

text-revealer/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024 Miguel Pimentel
+Copyright (c) 2020 Jami Gibbs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

text-revealer/README.md

@@ -0,0 +1,43 @@
+<img src="assets/logo.jpg" style="align-center" />
+
+# ![text revealer logo](assets/logo.jpg)
+
+![Mozilla Add-on Version](https://img.shields.io/amo/v/{b5ca06cf-4c6e-40f6-b367-a20a6f2a15ee})
+![Mozilla Add-on Rating](https://img.shields.io/amo/rating/{b5ca06cf-4c6e-40f6-b367-a20a6f2a15ee})
+![Mozilla Add-on Downloads](https://img.shields.io/amo/dw/{b5ca06cf-4c6e-40f6-b367-a20a6f2a15ee})
+![Mozilla Add-on Users](https://img.shields.io/amo/users/{b5ca06cf-4c6e-40f6-b367-a20a6f2a15ee})
+![GitHub License](https://img.shields.io/github/license/semanticdata/text-revealer-firefox-extension)
+
+Reveal deeper information about highlighted text on a web page. When text is selected, a popover displays useful details about the text such as:
+
+- Wikipedia entries,
+- Dictionary definition,
+- ...and more to come.
+
+[![Get the Addon](../get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/text-revealer/)
+
+There is also a [vanilla JS version](https://github.com/jamigibbs/text-revealer-js) available. The script for this extension is generated from that project so please report any issues on [that repo](https://github.com/jamigibbs/text-revealer-js/issues/new/choose) unless it's a Firefox Extension specific issue.
+
+## 🖼 Preview
+
+<p align=center>
+<img src="assets/preview.gif" alt="Preview" />
+</p>
+
+You can also take a look at the [Demo](https://jamigibbs.github.io/text-revealer-js/).
+
+## Available Settings
+
+After activating the extenion, settings are available by clicking the Text Revealer icon in your browser navigation bar and selecting "Options":
+
+<p align=center>
+<img src="assets/settings.png" alt="Settings" width=400 />
+</p>
+
+## 💜 Acknowledgments
+
+This is the Firefox port of [Text Revealer](https://github.com/jamigibbs/text-revealer-js) by [Jami Gibbs](https://github.com/jamigibbs/).
+
+## © License
+
+Source code in this repository is available under the [MIT License](LICENSE).

text-revealer/manifest.json

@@ -0,0 +1,30 @@
+{
+  "manifest_version": 2,
+  "name": "Text Revealer",
+  "version": "1.1.1",
+  "description": "Reveal deeper information about text you highlight on a web page.",
+  "homepage_url": "https://github.com/semanticdata/text-revealer-firefox-extension/",
+  "icons": {
+    "16": "src/icons/16x16.png",
+    "32": "src/icons/32x32.png",
+    "48": "src/icons/48x48.png",
+    "128": "src/icons/128x128.png"
+  },
+  "options_ui": {
+    "page": "src/options/index.html",
+    "open_in_tab": false,
+    "browser_style": true
+  },
+  "permissions": ["*://*/*", "storage"],
+  "content_scripts": [
+    {
+      "matches": ["*://*/*"],
+      "css": ["src/inject/text-revealer.css"]
+    },
+    {
+      "matches": ["*://*/*"],
+      "run_at": "document_start",
+      "js": ["src/inject/text-revealer.js", "src/inject/init.js"]
+    }
+  ]
+}

text-revealer/src/inject/init.js

@@ -0,0 +1,36 @@
+(function () {
+  /**
+   * Initiate the script.
+   */
+  let myTextRevealer = new TextRevealer({
+    wikipedia: true,
+    merriamWebsterDictionary: false,
+    delay: 500,
+    scrollIntoView: true,
+  });
+  myTextRevealer.init();
+
+  /**
+   * Apply any previously saved options to the text revealer instance.
+   */
+  storage.sync.get(
+    ["skin", "delay", "merriamWebsterDictionary", "maxTextCount"],
+    function (items) {
+      myTextRevealer.options.merriamWebsterDictionary =
+        items.merriamWebsterDictionary || false;
+      myTextRevealer.options.delay = items.delay || 500;
+      myTextRevealer.options.skin = items.skin || "light";
+      myTextRevealer.options.maxTextCount = items.maxTextCount || 3;
+    }
+  );
+
+  /**
+   * Update the instance with new options from the extension settings.
+   * changes = { newValue: 'newExample', oldValue: 'oldExample }
+   */
+  storage.onChanged.addListener(function (changes, namespace) {
+    for (let key in changes) {
+      myTextRevealer.options[key] = changes[key].newValue;
+    }
+  });
+})();