environment-marker

A browser WebExtension that adds a color marker (ribbon) to the page depending if the URL contains a given string.

https://github.com/xjsv/environment-marker

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.6%) to scientific vocabulary

Keywords

browser-addon browser-extension browser-webextension chrome-extension chrome-extensions chrome-plugin chrome-webextension environment-marker extension firefox-addon firefox-browser firefox-extension firefox-extensions firefox-webextension webextension
Last synced: 6 months ago · JSON representation ·

Repository

A browser WebExtension that adds a color marker (ribbon) to the page depending if the URL contains a given string.

Basic Info
Statistics
  • Stars: 20
  • Watchers: 0
  • Forks: 4
  • Open Issues: 4
  • Releases: 17
Topics
browser-addon browser-extension browser-webextension chrome-extension chrome-extensions chrome-plugin chrome-webextension environment-marker extension firefox-addon firefox-browser firefox-extension firefox-extensions firefox-webextension webextension
Created almost 6 years ago · Last pushed 7 months ago
Metadata Files
Readme Contributing Funding License Code of conduct Citation Security

README.md

Logo

Environment Marker

A Browser Extension

Firefox Addons · Chrome Web Store · Edge Add-ons · Opera addons · Report Bug · Request Feature

Table of Contents

About The Project

A browser WebExtension that adds a color marker (ribbon) to the page depending on whether the URL contains a given string (e.g. 'http://dev-', 'http://qa-', 'http://prod-'). Currently, this extension supports Firefox and Chromium based browser such as Microsoft Edge, Opera and Brave. Plans are in place to also support Safari in the near future.

Browser Support

  • Firefox
  • Chrome & Chromium based browser
    • Microsoft Edge
    • Opera
    • Brave
  • Safari (coming soon...)

Features

  • Configurable Ribbons - Add a URL or part of a URL, choose a color and a ribbon will be added to the page for any website that matches part of that URL. Here are some examples:

    • github.com
    • https://github.com
    • https://github.com/XjSv/environment-marker
    • http://dev.
    • http://qa.
    • http://prod.
    • environment-marker
    • *.google.com
    • (?<!books).google.com
  • Configurable Ribbon Positions - Choose where to position the ribbon (top left, top right, bottom left, bottom right).

  • Configurable Ribbon Sizes - Choose one of 5 sizes (extra small, small, normal, large, extra large).

  • Ribbon Labels - Displays a label on the ribbon.

  • Import/Export - Export and import ribbon configurations.

  • Multilingual Support - Currently supports English, Spanish, German & French.

  • Reusable Color Swatch - The last 7 colors used will be available from the color swatch.

  • RegExp - When enabled the URL fragment can be used with RegExp instead of searching using indexOf.

  • Tab Counter - Displays the number of open tabs. Color is green when under 10 tabs and red when above. See Tab Counter Settings for more info.

  • Font Picker - Ability to select fonts for the ribbons. Font come from Google Fonts.

  • Favicon Marker - Ability to set a colored circle marker to the favicon of the site.

Built With

Installation

There are a couple of options for installation.

1 - Install From Firefox.com or the Chromium Web Stores (Recommended)

2 - Build & Install From File (Firefox)

Note: Pre-built files are available for: - Firefox: build/environment-marker-firefox.zip - Chrome, Edge & Opera: build/environment-marker-chromium.zip

Step 1 - Build it 1. Install dependencies bash npm install 2. Run the build script bash npm run build

Step 2 - Navigate to: about:addons

Step 3 - Choose the "Install Add-on From File..."

Step 4 - Select build/environment-marker-firefox.zip.

Development

  1. Install dependencies bash npm install
  2. Run the default gulp task bash npm run develop
  3. Develop...
  4. Run the build script when ready bash npm run build

Usage

See Usage instructions in the Wiki
See Opera Usage instructions in the Wiki for specific Opera related settings.

Roadmap

See the open issues for a list of proposed features (and known issues).

Localization

Localization is done through Crowdin. To contribute to the translations see the Environment Marker Crowdin project page.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MPL-2.0 License. See LICENSE for more information.

Contact

Armand Tresova - @XjSv - atresova@gmail.com

Project Link: https://github.com/XjSv/environment-marker

Acknowledgements

Owner

  • Name: Armand Tresova
  • Login: XjSv
  • Kind: user
  • Location: New York
  • Company: Weill Cornell Medicine

A Software Developer from Earth

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use environment-marker, please cite it using the following metadata"
title: environment-marker
authors:
  - family-names: Tresova
    given-names: Armand
version: 3.0.0
doi: 10.5281/zenodo.1171250
date-released: 2023-06-06
url: "https://github.com/XjSv/environment-marker"

GitHub Events

Total
  • Issues event: 5
  • Watch event: 3
  • Delete event: 30
  • Issue comment event: 35
  • Push event: 17
  • Pull request event: 63
  • Create event: 30
Last Year
  • Issues event: 5
  • Watch event: 3
  • Delete event: 30
  • Issue comment event: 35
  • Push event: 17
  • Pull request event: 63
  • Create event: 30

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 4
  • Total pull requests: 18
  • Average time to close issues: over 1 year
  • Average time to close pull requests: 12 days
  • Total issue authors: 4
  • Total pull request authors: 2
  • Average comments per issue: 2.0
  • Average comments per pull request: 0.61
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 17
Past Year
  • Issues: 2
  • Pull requests: 18
  • Average time to close issues: 8 months
  • Average time to close pull requests: 12 days
  • Issue authors: 2
  • Pull request authors: 2
  • Average comments per issue: 1.5
  • Average comments per pull request: 0.61
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 17
Top Authors
Issue Authors
  • XjSv (1)
  • MurzNN (1)
  • jonnsn (1)
  • LPABR (1)
  • theunf (1)
  • magiva (1)
Pull Request Authors
  • dependabot[bot] (90)
  • XjSv (2)
Top Labels
Issue Labels
enhancement (4) bug (2)
Pull Request Labels
dependencies (90) javascript (5) translation (1)

Dependencies

package-lock.json npm
  • 450 dependencies
package.json npm
  • archiver ^5.3.1 development
  • autoprefixer ^10.4.7 development
  • cssnano ^5.1.9 development
  • gulp ^4.0.2 development
  • gulp-postcss ^9.0.1 development
  • gulp-rename ^2.0.0 development
  • gulp-sass ^5.1.0 development
  • gulp-sourcemaps ^3.0.0 development
  • gulp-uglify-es ^3.0.0 development
  • merge-stream ^2.0.0 development
  • postcss ^8.4.14 development
  • sass ^1.52.1 development
  • webextension-polyfill ^0.9.0
.github/workflows/codeql-analysis.yml actions
  • actions/checkout v2 composite
  • github/codeql-action/analyze v1 composite
  • github/codeql-action/init v1 composite