Skip to content

Ignore local_* files to allow for customized startup scripts. #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
msqr wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Ignore local_* files to allow for customized startup scripts. #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,3 +128,6 @@ dist
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*

# local scripts
local_*
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,15 @@ npx ts-node index_201.ts
2023-03-27 13:10:17 info: Receive message ⬅️ [3,"79a41b2e-2c4a-4a65-9d7e-417967a8f95f",{"currentTime":"2023-03-27T11:10:17.955Z"}]
```

## Custom VCP scripts

If you would like to customize the VCP startup script, any file whose name starts with `local_` will be ignored by git,
so you can write a custom VCP script like `local_16.ts` and then run it like

```bash
WS_URL=ws://localhost:3000 CP_ID=vcp_16_test npx ts-node local_16.ts
```

## Executing Admin Commands

Some messages are automatically sent by the VCP, for example, `BootNotification` or `StartTransaction` and `StopTransaction`.
Expand Down