Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/open-wc/locator

Chrome extension to find custom elements on a page, and search the catalog for extra information
https://github.com/open-wc/locator

chrome-extension custom-elements hacktoberfest open-wc web-components

Last synced: 3 months ago
JSON representation

Chrome extension to find custom elements on a page, and search the catalog for extra information

Awesome Lists containing this project

README

        

> ## 🛠 Status: In Development
>
> This chrome extension is still in development, and dependant on `custom-elements.json` becoming a standardized format, and the [catalog](https://catalog.open-wc.org) being in a more mature state. You can read more about `custom-elements.json` [here](https://github.com/webcomponents/custom-elements-json/).



## Custom Elements Locator

[![Built with open-wc recommendations](https://img.shields.io/badge/built%20with-open--wc-blue.svg)](https://github.com/open-wc)

Chrome extension to find custom elements on a page, and search the catalog for extra information


## Instructions

- Write code
- Run `npm run build`
- Go to [chrome://extensions/](chrome://extensions/)
- Toggle 'Developer mode' in top right corner
- Click 'Load unpacked' in top left corner
- Select the root folder of this project

If you are implementing and want to test repeatedly:

- Install [Extensions Reloader](https://chrome.google.com/webstore/detail/extensions-reloader/fimgfedafeadlieiabdeeaodndnlbhid)
- Running `npm run start` will rebuild on each change in the `src` folder, and trigger a reload of the extension.
- Refresh your current tab

## CI and Release process

CI and releases are created using Github Actions.

* Any push on any branch or PR will run `npm run build` and create a zip in case content needs to be checked.
* The zip can be tested in chrome using the `load packed extension` button in [chrome://extensions/](chrome://extensions/)
* See [this link](https://github.com/jlengrand/locator/actions/runs/239670902) for an example of pipeline.
* Any push to master (thus including a PR merge) will do the same **AND bump `package.json` and `manifest.json` as well as commit the new bump**.
* The archive can then be used for upload in the Chrome Store. See [this link](https://github.com/jlengrand/locator/actions/runs/239692407) for an example.

You can see all running actions [here](https://github.com/open-wc/locator/actions/new).

## [Extension on the Chrome Store](https://chrome.google.com/webstore/detail/custom-elements-locator/eccplgjbdhhakefbjfibfhocbmjpkafc)