Skip to content

Latest commit

 

History

History
108 lines (84 loc) · 2.48 KB

README.md

File metadata and controls

108 lines (84 loc) · 2.48 KB
Raw

Label

Use this to differentiate your dev, test, and production environments by adding a loud color and label, without mucking with your source code.

No more testing on the wrong environment and pulling your hair out as to why your data is differnet, or throwing off your analytics with over 9000 hits to the same page by the same user.

Features

  • Support for * wildcards in the host config
    • eg: *dev.*.stackoverflow.com or test-*.stackoverflow.*
  • First matched rule will be applied

Browser Support

  • Google Chrome
  • Mozilla Firefox
  • Microsoft Edge
  • Safari
  • Brave

Config

Initially this is configured via a JSON object with the following schema:

[
    {
        "label": "string",
        "color": "string",
        "hosts": [
            "string"
        ]
    }
]

For example:

[    
    {
        "label": "PRODUCTION",
        "color": "#ff8000",
        "hosts": [
            "stackoverflow.com"
        ]
    },
    {
        "label": "TEST",
        "color": "#006400",
        "hosts": [
            "test-*.stackoverflow.com",
            "test.*.stackoverflow.com"

        ]
    },
    {
        "label": "DEV",
        "color": "#230000",
        "hosts": [
            "dev.*.stackoverflow.com"
        ]
    }
]

Develop and Contribute

Simply clone the repository, open the extensions tab in Chrome (chrome://extensions), select Load Unpacked and then select the root folder.

Install

$ npm install

Development

npm run dev chrome
npm run dev firefox
npm run dev opera
npm run dev edge

Build

npm run build chrome
npm run build firefox
npm run build opera
npm run build edge

Firefox

To debug in Firefox, you need to add an app id in order to use the storage API. Do this by adding the following property to the manifest.json.

"browser_specific_settings": {
    "gecko": {
        "id": "{b7a32ab9-5d49-4dfd-a2c6-b50ffc25e140}"
    }
}

Tasks

  • Deploy to Chrome and Firefox
  • Support for wildcards when matching host names (eg. dev.*.website.com)
  • Make overlay more robust - does not work in certain cases with existing headers. Possibly a z-index issue.
  • Add a configuration UI rather than using JSON
  • Browser testing
  • Microsoft Edge: resolve viewport size not being recognized when setting width: 100% via the Bootstrap .container class.