88 lines
2.0 KiB
Markdown
88 lines
2.0 KiB
Markdown
# browser-scripts-builder
|
|
|
|
builder for [browser-scripts](https://git.zomo.dev/zomo/browser-scripts)
|
|
|
|
## Source File Structure
|
|
|
|
note: if `package.json` is not present, running the command is presumed to be a mistake and will refuse to run
|
|
|
|
```text
|
|
Root
|
|
├───<package.json/etc>
|
|
└───scripts
|
|
└───[each script folder]
|
|
├───<tsconfig.json>
|
|
├───<other files for main.ts>
|
|
├───main.ts
|
|
└───meta.json (optional)
|
|
```
|
|
|
|
## Dist File Structure
|
|
|
|
```text
|
|
Root
|
|
├───<package.json/etc>
|
|
└───dist
|
|
└───[each script folder].user.js
|
|
```
|
|
|
|
if there is an error compiling a file, an `error.log` will be placed inside the source folder:
|
|
|
|
```text
|
|
Root
|
|
├───<package.json/etc>
|
|
└───scripts
|
|
└───[each script folder]
|
|
└───error.log
|
|
```
|
|
|
|
## Command Line Options
|
|
|
|
```text
|
|
--watch
|
|
alias: -w
|
|
default: false
|
|
automatically recompile on save
|
|
--minify
|
|
alias: -m
|
|
default: false
|
|
minify output files
|
|
--prettier
|
|
alias: -p
|
|
default: false
|
|
prettify output files
|
|
--srccomment
|
|
alias: -c
|
|
default: false
|
|
include src file path comments in the output files, i.e. // scripts/example/main.ts
|
|
--readme
|
|
alias: -r
|
|
default: false
|
|
update the readme.md file in your directory to include links to each userscript
|
|
|
|
--url <url>
|
|
alias: -u <url>
|
|
default: ""
|
|
the base for urls used in the meta comments
|
|
--supporturl <url>
|
|
alias: -s <url>
|
|
default: ""
|
|
the support url used in the meta comments
|
|
--remotebranch <name>
|
|
alias: -b <name>
|
|
default: ""
|
|
if included, the included base url will be treated as a git repo, and the support url is not required
|
|
--in
|
|
alias: -i
|
|
default: "scripts"
|
|
include src file path comments in the output files, i.e. // scripts/example/main.ts
|
|
--out
|
|
alias: -o
|
|
default: "dist"
|
|
include src file path comments in the output files, i.e. // scripts/example/main.ts
|
|
|
|
--help
|
|
alias: -h
|
|
show this help message
|
|
```
|