https://github.com/errata-ai/vale-web
A browser extension for the Vale CLI.
https://github.com/errata-ai/vale-web
Last synced: 5 months ago
JSON representation
A browser extension for the Vale CLI.
- Host: GitHub
- URL: https://github.com/errata-ai/vale-web
- Owner: errata-ai
- License: mit
- Created: 2024-01-26T14:24:03.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-15T23:23:34.000Z (over 1 year ago)
- Last Synced: 2024-12-21T13:40:43.511Z (12 months ago)
- Language: Svelte
- Homepage:
- Size: 538 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vale *for the web*
Vale's chrome extension allows you to use your local Vale configurations on any website's `textarea` or `[contenteditable]` input fields.
Like the Vale CLI, the extension focuses on providing a high level of privacy and security: it only uses the lowest level of permissions (`activeTab`) and does all of its content processing locally.
> This is a [Plasmo extension](https://docs.plasmo.com/) project bootstrapped with [`plasmo init`](https://www.npmjs.com/package/plasmo).
## Getting Started
First, run the development server:
```bash
pnpm dev
# or
npm run dev
```
Open your browser and load the appropriate development build. For example, if you are developing for the chrome browser, using manifest v3, use: `build/chrome-mv3-dev`.
You can start editing the popup by modifying `popup.tsx`. It should auto-update as you make changes. To add an options page, simply add a `options.tsx` file to the root of the project, with a react component default exported. Likewise to add a content page, add a `content.ts` file to the root of the project, importing some module and do some logic, then reload the extension on your browser.
For further guidance, [visit our Documentation](https://docs.plasmo.com/)
## Making production build
Run the following:
```bash
pnpm build
# or
npm run build
```
This should create a production bundle for your extension, ready to be zipped and published to the stores.
## Submit to the webstores
The easiest way to deploy your Plasmo extension is to use the built-in [bpp](https://bpp.browser.market) GitHub action. Prior to using this action however, make sure to build your extension and upload the first version to the store to establish the basic credentials. Then, simply follow [this setup instruction](https://docs.plasmo.com/workflows#submit-your-extension) and you should be on your way for automated submission!