Skip to content

Commit 3243894

Browse files
committed
docs: update README and develop documentation for improved clarity on build and test commands
1 parent 0d21b82 commit 3243894

File tree

3 files changed

+25
-18
lines changed

3 files changed

+25
-18
lines changed

README.md

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -253,22 +253,37 @@ Skip Credits and Watch Credits are mutally exclusive, but you can turn both of t
253253

254254
- `npm install -g pnpm` install pnpm. npm is also possible but pnpm is recommended
255255
- `pnpm install` install all required packages
256-
- `pnpm build` build firefox and chrome zip files in dist folder
257-
- `pnpm web-ext` run the extension in firefox
258-
- `pnpm chrome` run the extension in chrome
256+
- `pnpm build` build firefox and chrome zip files for release.
259257

260-
This extension was built with the template [vite-vue3-browser-extension-v3](https://github.com/mubaidr/vite-vue3-browser-extension-v3)
258+
This extension is based on the template [vite-vue3-browser-extension-v3](https://github.com/mubaidr/vite-vue3-browser-extension-v3)
261259

262-
### Further Commands
260+
### Building with live reload
263261

264-
- `pnpm dev` hot build with sourcemaps and w/o minification for both
265-
- `pnpm dev:chrome` hot build with sourcemaps and w/o minification for chrome
266-
- `pnpm dev:firefox` hot build with sourcemaps and w/o minification for firefox
267-
- `npm run start-android` start on firefox android
262+
- `pnpm dev` build both chrome and firefox files
263+
- `pnpm dev:chrome` build only chrome files
264+
- `pnpm dev:firefox` build only firefox files
265+
266+
### Open in Browser with live reload
267+
268+
- `pnpm web-ext` Open in firefox.
269+
- `pnpm chrome` Open in chrome.
270+
- `pnpm firefox` Open in firefox with permanent firefox profile
271+
- `pnpm start-android` start on firefox android
272+
273+
### Running unit tests
274+
275+
- `pnpm test` run all tests with live reload
276+
- `pnpm test:coverage` run coverage report
277+
278+
### Formatting and Linting Commands
279+
280+
- `pnpm format` run prettier on all files
281+
- `pnpm lint` run esLint
282+
- `pnpm lint:manifest` web-ext lint manifest files
268283

269284
Further documentation is [here](develop.md)
270285

271-
## Open the Extension without web-ext
286+
## Open the Extension without web-ext/live reload
272287

273288
## Chrome
274289

develop.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,18 +37,11 @@
3737
└── package.json # Project dependencies and scripts
3838
```
3939

40-
### Formatting and Linting Commands
41-
42-
- `pnpm format` run prettier on all files
43-
- `pnpm lint` run esLint
44-
- `pnpm lint:manifest` web-ext lint manifest files
45-
4640
### Author Commands
4741

4842
- `pnpm transDeepL` translate .translation/deepl.EN.json and output them into the locales files directly
4943
- `pnpm hours` calculate the hours spent on the project
5044
- `pnpm copyDocsFtoC` copy the docs from the firefox folder to the chrome folder
51-
- `pnpm firefox` run extension with permanent firefox profile
5245

5346
## Development tools
5447

package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
"scripts": {
77
"web-ext": "web-ext run",
88
"firefox": "web-ext run --keep-profile-changes --firefox-profile=test2",
9-
"firefox:noProfile": "web-ext run",
109
"chrome": "web-ext run --source-dir dist/chrome/ -t chromium",
1110
"start-android": "adb devices && web-ext run -t firefox-android --firefox-apk org.mozilla.firefox --adb-device 38091FDJH002WH",
1211
"build": "npm run build:chrome && npm run build:firefox && tsx scripts/zip.ts",

0 commit comments

Comments
 (0)