erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 00:15:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

docs(common/resources): spruce up gosh README

Browse source
This commit is contained in:
Eddie Antonio Santos 2020-05-25 08:27:25 -06:00
parent 88b83c24ba
commit a62d1877ab
No known key found for this signature in database
GPG key ID: DD411EA4D9509D87
1 changed files with 11 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
resources/gosh/README.md
View file

@ -1,33 +1,24 @@
# `@keymanapp/resources-gosh`
gosh is a simple platform-agnostic launcher for bash scripts. On Windows, it will locate an installation of Git for Windows and use bash from that script. On *nix, it uses the system-supplied version of bash.
`gosh` is a simple platform-agnostic launcher for bash scripts. On Windows, it will locate an installation of Git for Windows and use bash from that script. On \*nix, it uses the system-supplied version of bash.
TODO: it would be possible for gosh to grab a newer version of bash on macOS which could simplify some of our cross-platform scripts?
> **TODO**: it would be possible for gosh to grab a newer version of bash on macOS which could simplify some of our cross-platform scripts?
## Usage
gosh can be run as an npm module command or from the command line with the `gosh`/`gosh.bat` pair. The first parameter should be the bash script to run, and all subsequent parameters passed to gosh will be passed to the script unmodified. Note that paths passed to gosh should always use forward slashes (`/`), irrespective of the platform.
`gosh` can be run as an npm module command or from the command line with the `gosh`/`gosh.bat` pair. The first parameter should be the bash script to run, and all subsequent parameters passed to gosh will be passed to the script unmodified. Note that paths passed to gosh should always use forward slashes (`/`), irrespective of the platform.
## Examples
* `package.json`:
### `package.json`
\```
...
"scripts": {
"tsc": "tsc",
Invoke bash scripts using `gosh` instead:
```json
"scripts": {
"build": "gosh ./build.sh",
"test": "gosh ./unit_tests/test.sh"
},
...
\```
},
```
* `TeamCity instantiation`: (path = `web/source`) `../../resources/gosh/gosh ./build.sh -publish-sentry`
## Usage
```
const resourcesGosh = require('@keymanapp/resources-gosh');
// TODO: DEMONSTRATE API
```