Skip to content

Commit

Permalink
Fix readme; add todo
Browse files Browse the repository at this point in the history
  • Loading branch information
raducristianpopa committed Aug 16, 2024
1 parent 4167508 commit 751eb46
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,13 @@ pnpm i

All commands are run from the root of the project, from a terminal:

| Command | Action |
| :----------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pnpm dev --target=<TARGET>` | Builds the extension for development, for a specified target (`chrome`, `firefox`, `edge`, `opera`). If the target is not specified the script will build the extension for a Chromium based browser. Output folder: `dev`. |
| `pnpm build --target=<TARGET>` | Builds the extension for production usage, for a specified target (`chrome` or `firefox`). If the target is not specified the script will build the extension for all available targets. Output folder: `dist`. |
| `pnpm test` | Runs all test files using Jest. |
| Command | Action |
| :------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pnpm dev --target=<TARGET>` | Builds the extension for development, for a specified target (`chrome` or `firefox`). If the target is not specified the script will build the extension for a Chromium based browser. Output folder: `dev`. |
| `pnpm build --target=<TARGET> --channel=<CHANNEL>` | Builds the extension for production usage, for a specified target (`chrome` or `firefox`). If the target is not specified the script will build the extension for all available targets. Output folder: `dist`. |
| `pnpm test` | Runs all test files using Jest. |

### Installing the extension from source, in Chromium based browsers (Chrome, Opera, Edge, Brave, Arc)
### Installing the extension from source, in Chromium based browsers (Chrome, Opera, Edge, Brave, Arc, Vivaldi)

1. <b>Build the extension with `pnpm build chrome`</b>

Expand Down
2 changes: 1 addition & 1 deletion esbuild/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,5 +53,5 @@ export type WebExtensionManifest = Manifest.WebExtensionManifest & {

export const SERVE_PORTS: Record<Target, number> = {
chrome: 7000,
firefox: 7002,
firefox: 7002
}
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
},
"scripts": {
"build": "tsx ./scripts/build.ts",
"dev": "tsx watch ./scripts/build.ts --dev",
"dev": "tsx watch ./scripts/build.ts --dev --channel=nightly",
"lint": "eslint . --cache --cache-location 'node_modules/.cache/eslintcache' --max-warnings 0",
"lint:fix": "eslint . --fix --cache --cache-location 'node_modules/.cache/eslintcache' --max-warnings 0",
"format": "prettier . --check --cache --cache-location='node_modules/.cache/prettiercache'",
Expand Down
2 changes: 1 addition & 1 deletion scripts/build.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import {
import { getDevOptions } from '../esbuild/dev'
import { getProdOptions } from '../esbuild/prod'

// TODO: Live Reload extension with --dev
// TODO: FIX README OR ADD TARGET ALL

sade('build', true)
.option('--target', 'Target', 'chrome')
Expand Down

0 comments on commit 751eb46

Please sign in to comment.