Compare commits
16 Commits
Author | SHA1 | Date | |
---|---|---|---|
d84c7a16a4 | |||
c5937da870 | |||
ec29db26ef | |||
e4e08910c7 | |||
730a4a05a4 | |||
20a2804924 | |||
d7247add7e | |||
b304b01ab6 | |||
9ba5447e72 | |||
6cb7ab8f19 | |||
efdb80ddba | |||
db712b2223 | |||
0199160013 | |||
199fa19899 | |||
23a3230f07 | |||
ad0b7ac21c |
4
.gitignore
vendored
4
.gitignore
vendored
@ -15,8 +15,6 @@ node_modules/
|
|||||||
|
|
||||||
# builds
|
# builds
|
||||||
dist/
|
dist/
|
||||||
dist_web/
|
dist_*/
|
||||||
dist_serve/
|
|
||||||
dist_ts_web/
|
|
||||||
|
|
||||||
# custom
|
# custom
|
125
.gitlab-ci.yml
125
.gitlab-ci.yml
@ -1,119 +1,122 @@
|
|||||||
# gitzone standard
|
# gitzone ci_default
|
||||||
image: hosttoday/ht-docker-node:npmci
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
|
||||||
cache:
|
cache:
|
||||||
paths:
|
paths:
|
||||||
- .npmci_cache/
|
- .npmci_cache/
|
||||||
key: "$CI_BUILD_STAGE"
|
key: '$CI_BUILD_STAGE'
|
||||||
|
|
||||||
stages:
|
stages:
|
||||||
- security
|
- security
|
||||||
- test
|
- test
|
||||||
- release
|
- release
|
||||||
- metadata
|
- metadata
|
||||||
|
|
||||||
|
before_script:
|
||||||
|
- pnpm install -g pnpm
|
||||||
|
- pnpm install -g @shipzone/npmci
|
||||||
|
- npmci npm prepare
|
||||||
|
|
||||||
# ====================
|
# ====================
|
||||||
# security stage
|
# security stage
|
||||||
# ====================
|
# ====================
|
||||||
mirror:
|
# ====================
|
||||||
|
# security stage
|
||||||
|
# ====================
|
||||||
|
auditProductionDependencies:
|
||||||
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
stage: security
|
stage: security
|
||||||
script:
|
script:
|
||||||
- npmci git mirror
|
- npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
- npmci command pnpm audit --audit-level=high --prod
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- lossless
|
||||||
- notpriv
|
- docker
|
||||||
|
allow_failure: true
|
||||||
|
|
||||||
snyk:
|
auditDevDependencies:
|
||||||
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
stage: security
|
stage: security
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci command npm config set registry https://registry.npmjs.org
|
||||||
- npmci command npm install -g snyk
|
- npmci command pnpm audit --audit-level=high --dev
|
||||||
- npmci command npm install --ignore-scripts
|
|
||||||
- npmci command snyk test
|
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- lossless
|
||||||
- notpriv
|
- docker
|
||||||
|
allow_failure: true
|
||||||
|
|
||||||
# ====================
|
# ====================
|
||||||
# test stage
|
# test stage
|
||||||
# ====================
|
# ====================
|
||||||
|
|
||||||
testLTS:
|
testStable:
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci node install stable
|
||||||
- npmci node install lts
|
- npmci npm install
|
||||||
- npmci npm install
|
- npmci npm test
|
||||||
- npmci npm test
|
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
|
||||||
|
testBuild:
|
||||||
testSTABLE:
|
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci node install stable
|
||||||
- npmci node install stable
|
- npmci npm install
|
||||||
- npmci npm install
|
- npmci npm build
|
||||||
- npmci npm test
|
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
|
||||||
|
|
||||||
release:
|
release:
|
||||||
stage: release
|
stage: release
|
||||||
script:
|
script:
|
||||||
- npmci node install stable
|
- npmci node install stable
|
||||||
- npmci npm publish
|
- npmci npm publish
|
||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- lossless
|
||||||
- notpriv
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
# ====================
|
# ====================
|
||||||
# metadata stage
|
# metadata stage
|
||||||
# ====================
|
# ====================
|
||||||
codequality:
|
codequality:
|
||||||
stage: metadata
|
stage: metadata
|
||||||
image: docker:stable
|
|
||||||
allow_failure: true
|
allow_failure: true
|
||||||
services:
|
only:
|
||||||
- docker:stable-dind
|
- tags
|
||||||
script:
|
script:
|
||||||
- export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
|
- npmci command npm install -g typescript
|
||||||
- docker run
|
- npmci npm prepare
|
||||||
--env SOURCE_CODE="$PWD"
|
- npmci npm install
|
||||||
--volume "$PWD":/code
|
|
||||||
--volume /var/run/docker.sock:/var/run/docker.sock
|
|
||||||
"registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
|
|
||||||
artifacts:
|
|
||||||
paths: [codeclimate.json]
|
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- lossless
|
||||||
- priv
|
- docker
|
||||||
|
- priv
|
||||||
|
|
||||||
trigger:
|
trigger:
|
||||||
stage: metadata
|
stage: metadata
|
||||||
script:
|
script:
|
||||||
- npmci trigger
|
- npmci trigger
|
||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- lossless
|
||||||
- notpriv
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
pages:
|
pages:
|
||||||
image: hosttoday/ht-docker-node:npmci
|
|
||||||
stage: metadata
|
stage: metadata
|
||||||
script:
|
script:
|
||||||
- npmci command npm install -g @gitzone/tsdoc
|
- npmci node install stable
|
||||||
- npmci npm prepare
|
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci command tsdoc
|
- npmci command npm run buildDocs
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- notpriv
|
||||||
only:
|
only:
|
||||||
@ -121,5 +124,5 @@ pages:
|
|||||||
artifacts:
|
artifacts:
|
||||||
expire_in: 1 week
|
expire_in: 1 week
|
||||||
paths:
|
paths:
|
||||||
- public
|
- public
|
||||||
allow_failure: true
|
allow_failure: true
|
||||||
|
11
.vscode/launch.json
vendored
Normal file
11
.vscode/launch.json
vendored
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
{
|
||||||
|
"version": "0.2.0",
|
||||||
|
"configurations": [
|
||||||
|
{
|
||||||
|
"command": "npm test",
|
||||||
|
"name": "Run npm test",
|
||||||
|
"request": "launch",
|
||||||
|
"type": "node-terminal"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
26
.vscode/settings.json
vendored
Normal file
26
.vscode/settings.json
vendored
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
{
|
||||||
|
"json.schemas": [
|
||||||
|
{
|
||||||
|
"fileMatch": ["/npmextra.json"],
|
||||||
|
"schema": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"npmci": {
|
||||||
|
"type": "object",
|
||||||
|
"description": "settings for npmci"
|
||||||
|
},
|
||||||
|
"gitzone": {
|
||||||
|
"type": "object",
|
||||||
|
"description": "settings for gitzone",
|
||||||
|
"properties": {
|
||||||
|
"projectType": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": ["website", "element", "service", "npm", "wcc"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
28
README.md
28
README.md
@ -1,28 +0,0 @@
|
|||||||
# @pushrocks/smartshell
|
|
||||||
shell actions designed as promises
|
|
||||||
|
|
||||||
## Availabililty and Links
|
|
||||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartshell)
|
|
||||||
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartshell)
|
|
||||||
* [github.com (source mirror)](https://github.com/pushrocks/smartshell)
|
|
||||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartshell/)
|
|
||||||
|
|
||||||
## Status for master
|
|
||||||
[](https://gitlab.com/pushrocks/smartshell/commits/master)
|
|
||||||
[](https://gitlab.com/pushrocks/smartshell/commits/master)
|
|
||||||
[](https://www.npmjs.com/package/@pushrocks/smartshell)
|
|
||||||
[](https://snyk.io/test/npm/@pushrocks/smartshell)
|
|
||||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
||||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
||||||
[](https://prettier.io/)
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
Use TypeScript for best in class instellisense.
|
|
||||||
|
|
||||||
For further information read the linked docs at the top of this readme.
|
|
||||||
|
|
||||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
||||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
|
||||||
|
|
||||||
[](https://maintainedby.lossless.com)
|
|
@ -5,11 +5,12 @@
|
|||||||
"npmRegistryUrl": "registry.npmjs.org"
|
"npmRegistryUrl": "registry.npmjs.org"
|
||||||
},
|
},
|
||||||
"gitzone": {
|
"gitzone": {
|
||||||
|
"projectType": "npm",
|
||||||
"module": {
|
"module": {
|
||||||
"githost": "gitlab.com",
|
"githost": "gitlab.com",
|
||||||
"gitscope": "pushrocks",
|
"gitscope": "pushrocks",
|
||||||
"gitrepo": "smartshell",
|
"gitrepo": "smartshell",
|
||||||
"shortDescription": "shell actions designed as promises",
|
"description": "shell actions designed as promises",
|
||||||
"npmPackagename": "@pushrocks/smartshell",
|
"npmPackagename": "@pushrocks/smartshell",
|
||||||
"license": "MIT"
|
"license": "MIT"
|
||||||
}
|
}
|
||||||
|
1650
package-lock.json
generated
1650
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
50
package.json
50
package.json
@ -1,13 +1,15 @@
|
|||||||
{
|
{
|
||||||
"name": "@pushrocks/smartshell",
|
"name": "@pushrocks/smartshell",
|
||||||
"private": false,
|
"private": false,
|
||||||
"version": "2.0.24",
|
"version": "3.0.1",
|
||||||
"description": "shell actions designed as promises",
|
"description": "shell actions designed as promises",
|
||||||
"main": "dist/index.js",
|
"main": "dist_ts/index.js",
|
||||||
"typings": "dist/index.d.ts",
|
"typings": "dist_ts/index.d.ts",
|
||||||
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(tstest test/)",
|
"test": "(tstest test/)",
|
||||||
"build": "(tsbuild)"
|
"build": "(tsbuild --web)",
|
||||||
|
"buildDocs": "tsdoc"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
@ -24,19 +26,33 @@
|
|||||||
},
|
},
|
||||||
"homepage": "https://gitlab.com/pushrocks/smartshell#README",
|
"homepage": "https://gitlab.com/pushrocks/smartshell#README",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@gitzone/tsbuild": "^2.1.17",
|
"@gitzone/tsbuild": "^2.1.66",
|
||||||
"@gitzone/tsrun": "^1.2.8",
|
"@gitzone/tsrun": "^1.2.42",
|
||||||
"@gitzone/tstest": "^1.0.24",
|
"@gitzone/tstest": "^1.0.74",
|
||||||
"@pushrocks/tapbundle": "^3.0.13",
|
"@pushrocks/tapbundle": "^5.0.8",
|
||||||
"@types/node": "^12.7.2",
|
"@types/node": "^20.3.1"
|
||||||
"tslint": "^5.19.0",
|
|
||||||
"tslint-config-prettier": "^1.18.0"
|
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@pushrocks/smartdelay": "^2.0.3",
|
"@pushrocks/smartdelay": "^3.0.1",
|
||||||
"@pushrocks/smartexit": "^1.0.15",
|
"@pushrocks/smartexit": "^1.0.20",
|
||||||
"@pushrocks/smartpromise": "^3.0.2",
|
"@pushrocks/smartpromise": "^4.0.2",
|
||||||
"@types/which": "^1.3.1",
|
"@types/which": "^3.0.0",
|
||||||
"which": "^1.3.1"
|
"tree-kill": "^1.2.2",
|
||||||
}
|
"which": "^3.0.1"
|
||||||
|
},
|
||||||
|
"files": [
|
||||||
|
"ts/**/*",
|
||||||
|
"ts_web/**/*",
|
||||||
|
"dist/**/*",
|
||||||
|
"dist_*/**/*",
|
||||||
|
"dist_ts/**/*",
|
||||||
|
"dist_ts_web/**/*",
|
||||||
|
"assets/**/*",
|
||||||
|
"cli.js",
|
||||||
|
"npmextra.json",
|
||||||
|
"readme.md"
|
||||||
|
],
|
||||||
|
"browserslist": [
|
||||||
|
"last 1 chrome versions"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
4452
pnpm-lock.yaml
generated
Normal file
4452
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
37
readme.md
Normal file
37
readme.md
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
# @pushrocks/smartshell
|
||||||
|
shell actions designed as promises
|
||||||
|
|
||||||
|
## Availabililty and Links
|
||||||
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartshell)
|
||||||
|
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartshell)
|
||||||
|
* [github.com (source mirror)](https://github.com/pushrocks/smartshell)
|
||||||
|
* [docs (typedoc)](https://pushrocks.gitlab.io/smartshell/)
|
||||||
|
|
||||||
|
## Status for master
|
||||||
|
|
||||||
|
Status Category | Status Badge
|
||||||
|
-- | --
|
||||||
|
GitLab Pipelines | [](https://lossless.cloud)
|
||||||
|
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||||
|
npm | [](https://lossless.cloud)
|
||||||
|
Snyk | [](https://lossless.cloud)
|
||||||
|
TypeScript Support | [](https://lossless.cloud)
|
||||||
|
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||||
|
Code Style | [](https://lossless.cloud)
|
||||||
|
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||||
|
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||||
|
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
Use TypeScript for best in class instellisense.
|
||||||
|
|
||||||
|
## Contribution
|
||||||
|
|
||||||
|
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||||||
|
|
||||||
|
For further information read the linked docs at the top of this readme.
|
||||||
|
|
||||||
|
## Legal
|
||||||
|
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
|
||||||
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
18
test/test.ts
18
test/test.ts
@ -1,6 +1,6 @@
|
|||||||
import { expect, tap } from '@pushrocks/tapbundle';
|
import { expect, tap } from '@pushrocks/tapbundle';
|
||||||
|
|
||||||
import * as smartshell from '../ts';
|
import * as smartshell from '../ts/index.js';
|
||||||
import * as smartpromise from '@pushrocks/smartpromise';
|
import * as smartpromise from '@pushrocks/smartpromise';
|
||||||
|
|
||||||
let testSmartshell: smartshell.Smartshell;
|
let testSmartshell: smartshell.Smartshell;
|
||||||
@ -8,29 +8,29 @@ let testSmartshell: smartshell.Smartshell;
|
|||||||
tap.test('smartshell should create a Smartshell instance', async () => {
|
tap.test('smartshell should create a Smartshell instance', async () => {
|
||||||
testSmartshell = new smartshell.Smartshell({
|
testSmartshell = new smartshell.Smartshell({
|
||||||
executor: 'bash',
|
executor: 'bash',
|
||||||
sourceFilePaths: []
|
sourceFilePaths: [],
|
||||||
});
|
});
|
||||||
expect(testSmartshell).to.be.instanceof(smartshell.Smartshell);
|
expect(testSmartshell).toBeInstanceOf(smartshell.Smartshell);
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('smartshell should run async', async () => {
|
tap.test('smartshell should run async', async () => {
|
||||||
let execResult = await testSmartshell.exec('npm -v');
|
let execResult = await testSmartshell.exec('npm -v');
|
||||||
expect(execResult.stdout).to.match(/[0-9\.]*/);
|
expect(execResult.stdout).toMatch(/[0-9\.]*/);
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('smartshell should run async and silent', async () => {
|
tap.test('smartshell should run async and silent', async () => {
|
||||||
let execResult = await testSmartshell.execSilent('npm -v');
|
let execResult = await testSmartshell.execSilent('npm -v');
|
||||||
expect(execResult.stdout).to.match(/[0-9\.]*/);
|
expect(execResult.stdout).toMatch(/[0-9\.]*/);
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('smartshell should stream a shell execution', async () => {
|
tap.test('smartshell should stream a shell execution', async () => {
|
||||||
let done = smartpromise.defer();
|
let done = smartpromise.defer();
|
||||||
let execStreamingResponse = await testSmartshell.execStreaming('npm -v');
|
let execStreamingResponse = await testSmartshell.execStreaming('npm -v');
|
||||||
execStreamingResponse.childProcess.stdout.on('data', data => {
|
execStreamingResponse.childProcess.stdout.on('data', (data) => {
|
||||||
done.resolve(data);
|
done.resolve(data);
|
||||||
});
|
});
|
||||||
let data = await done.promise;
|
let data = await done.promise;
|
||||||
expect(data).to.match(/[0-9\.]*/);
|
expect(data).toMatch(/[0-9\.]*/);
|
||||||
await execStreamingResponse.finalPromise;
|
await execStreamingResponse.finalPromise;
|
||||||
});
|
});
|
||||||
|
|
||||||
@ -39,7 +39,7 @@ tap.test('it should execute and wait for a line in the output', async () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
tap.test('smartshell should run async', async () => {
|
tap.test('smartshell should run async', async () => {
|
||||||
return testSmartshell.execSilent('sleep 1 && npm -v').then(async execResult => {
|
return testSmartshell.execSilent('sleep 1 && npm -v').then(async (execResult) => {
|
||||||
console.log(execResult.stdout);
|
console.log(execResult.stdout);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
@ -53,5 +53,5 @@ tap.test('should spawn an interactive cli', async () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
tap.start({
|
tap.start({
|
||||||
throwOnError: true
|
throwOnError: true,
|
||||||
});
|
});
|
||||||
|
8
ts/00_commitinfo_data.ts
Normal file
8
ts/00_commitinfo_data.ts
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
/**
|
||||||
|
* autocreated commitinfo by @pushrocks/commitinfo
|
||||||
|
*/
|
||||||
|
export const commitinfo = {
|
||||||
|
name: '@pushrocks/smartshell',
|
||||||
|
version: '3.0.1',
|
||||||
|
description: 'shell actions designed as promises'
|
||||||
|
}
|
@ -1 +1,2 @@
|
|||||||
export * from './smartshell.classes.smartshell';
|
export * from './smartshell.classes.smartshell.js';
|
||||||
|
export { which } from './smartshell.plugins.js';
|
||||||
|
@ -31,7 +31,7 @@ export class ShellEnv {
|
|||||||
/**
|
/**
|
||||||
* imports path into the shell from env if available and returns it with
|
* imports path into the shell from env if available and returns it with
|
||||||
*/
|
*/
|
||||||
private _setPath(commandStringArg): string {
|
private _setPath(commandStringArg: string): string {
|
||||||
let commandResult = commandStringArg;
|
let commandResult = commandStringArg;
|
||||||
let commandPaths: string[] = [];
|
let commandPaths: string[] = [];
|
||||||
commandPaths = commandPaths.concat(process.env.PATH.split(':'));
|
commandPaths = commandPaths.concat(process.env.PATH.split(':'));
|
||||||
@ -41,7 +41,7 @@ export class ShellEnv {
|
|||||||
|
|
||||||
// lets filter for unwanted paths
|
// lets filter for unwanted paths
|
||||||
// Windows WSL
|
// Windows WSL
|
||||||
commandPaths = commandPaths.filter(commandPathArg => {
|
commandPaths = commandPaths.filter((commandPathArg) => {
|
||||||
const filterResult =
|
const filterResult =
|
||||||
!commandPathArg.startsWith('/mnt/c/') &&
|
!commandPathArg.startsWith('/mnt/c/') &&
|
||||||
!commandPathArg.startsWith('Files/1E') &&
|
!commandPathArg.startsWith('Files/1E') &&
|
||||||
@ -82,7 +82,7 @@ export class ShellEnv {
|
|||||||
sourceString = sourceString + `source ${sourceFilePath} && `;
|
sourceString = sourceString + `source ${sourceFilePath} && `;
|
||||||
}
|
}
|
||||||
|
|
||||||
// deal with avaiable path
|
// deal with available path
|
||||||
let pathString = 'PATH=$PATH';
|
let pathString = 'PATH=$PATH';
|
||||||
for (const pathDir of this.pathDirArray) {
|
for (const pathDir of this.pathDirArray) {
|
||||||
pathString += `:${pathDir}`;
|
pathString += `:${pathDir}`;
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
import * as plugins from './smartshell.plugins';
|
import * as plugins from './smartshell.plugins.js';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* a log handler for spawned logs
|
* a log handler for spawned logs
|
||||||
|
@ -1,30 +1,23 @@
|
|||||||
// -- imports --
|
import * as plugins from './smartshell.plugins.js';
|
||||||
import * as plugins from './smartshell.plugins';
|
import { ShellEnv } from './smartshell.classes.shellenv.js';
|
||||||
import { ShellEnv, IShellEnvContructorOptions, TExecutor } from './smartshell.classes.shellenv';
|
import type { IShellEnvContructorOptions, TExecutor } from './smartshell.classes.shellenv.js';
|
||||||
import { ShellLog } from './smartshell.classes.shelllog';
|
import { ShellLog } from './smartshell.classes.shelllog.js';
|
||||||
|
|
||||||
import * as cp from 'child_process';
|
import * as cp from 'child_process';
|
||||||
import { Deferred } from '@pushrocks/smartpromise';
|
|
||||||
|
|
||||||
// -- interfaces --
|
// -- interfaces --
|
||||||
/**
|
|
||||||
* interface for ExecResult
|
|
||||||
*/
|
|
||||||
export interface IExecResult {
|
export interface IExecResult {
|
||||||
exitCode: number;
|
exitCode: number;
|
||||||
stdout: string;
|
stdout: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* interface for streaming ExecResult
|
|
||||||
*/
|
|
||||||
export interface IExecResultStreaming {
|
export interface IExecResultStreaming {
|
||||||
childProcess: cp.ChildProcess;
|
childProcess: cp.ChildProcess;
|
||||||
finalPromise: Promise<IExecResult>;
|
finalPromise: Promise<IExecResult>;
|
||||||
kill: () => void;
|
kill: () => void;
|
||||||
|
terminate: () => void;
|
||||||
}
|
}
|
||||||
|
|
||||||
// -- SmartShell --
|
|
||||||
export class Smartshell {
|
export class Smartshell {
|
||||||
public shellEnv: ShellEnv;
|
public shellEnv: ShellEnv;
|
||||||
public smartexit = new plugins.smartexit.SmartExit();
|
public smartexit = new plugins.smartexit.SmartExit();
|
||||||
@ -35,123 +28,136 @@ export class Smartshell {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* executes a given command async
|
* executes a given command async
|
||||||
* @param commandStringArg
|
|
||||||
*/
|
*/
|
||||||
private async _exec(
|
private async _exec(options: {
|
||||||
commandStringArg: string,
|
commandString: string,
|
||||||
silentArg: boolean = false,
|
silent?: boolean,
|
||||||
strictArg = false,
|
strict?: boolean,
|
||||||
streamingArg = false
|
streaming?: boolean,
|
||||||
): Promise<IExecResult | IExecResultStreaming> {
|
interactive?: boolean
|
||||||
// flow control promises
|
}): Promise<IExecResult | IExecResultStreaming | void> {
|
||||||
|
|
||||||
|
if (options.interactive) {
|
||||||
|
if (process.env.CI) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const done = plugins.smartpromise.defer();
|
||||||
|
const shell = cp.spawn('sh', [], { stdio: ['pipe', 'inherit', 'inherit'] });
|
||||||
|
this.smartexit.addProcess(shell);
|
||||||
|
|
||||||
|
shell.on('close', (code) => {
|
||||||
|
console.log(`interactive shell terminated with code ${code}`);
|
||||||
|
this.smartexit.removeProcess(shell);
|
||||||
|
done.resolve();
|
||||||
|
});
|
||||||
|
|
||||||
|
let commandString = options.commandString;
|
||||||
|
|
||||||
|
shell.stdin.write(commandString + '\n exit \n');
|
||||||
|
|
||||||
|
await done.promise;
|
||||||
|
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
const done = plugins.smartpromise.defer<IExecResult | IExecResultStreaming>();
|
const done = plugins.smartpromise.defer<IExecResult | IExecResultStreaming>();
|
||||||
const childProcessEnded = plugins.smartpromise.defer<IExecResult>();
|
const childProcessEnded = plugins.smartpromise.defer<IExecResult>();
|
||||||
// build commandToExecute
|
|
||||||
let commandToExecute = commandStringArg;
|
let commandToExecute = options.commandString;
|
||||||
commandToExecute = this.shellEnv.createEnvExecString(commandStringArg);
|
commandToExecute = this.shellEnv.createEnvExecString(options.commandString);
|
||||||
|
|
||||||
const spawnlogInstance = new ShellLog();
|
const spawnlogInstance = new ShellLog();
|
||||||
const execChildProcess = cp.spawn(commandToExecute, [], {
|
const execChildProcess = cp.spawn(commandToExecute, [], {
|
||||||
shell: true,
|
shell: true,
|
||||||
|
cwd: process.cwd(),
|
||||||
env: process.env,
|
env: process.env,
|
||||||
detached: false
|
detached: false,
|
||||||
});
|
});
|
||||||
|
|
||||||
this.smartexit.addProcess(execChildProcess);
|
this.smartexit.addProcess(execChildProcess);
|
||||||
|
|
||||||
execChildProcess.stdout.on('data', data => {
|
execChildProcess.stdout.on('data', (data) => {
|
||||||
if (!silentArg) {
|
if (!options.silent) {
|
||||||
spawnlogInstance.writeToConsole(data);
|
|
||||||
}
|
|
||||||
spawnlogInstance.addToBuffer(data);
|
|
||||||
});
|
|
||||||
execChildProcess.stderr.on('data', data => {
|
|
||||||
if (!silentArg) {
|
|
||||||
spawnlogInstance.writeToConsole(data);
|
spawnlogInstance.writeToConsole(data);
|
||||||
}
|
}
|
||||||
spawnlogInstance.addToBuffer(data);
|
spawnlogInstance.addToBuffer(data);
|
||||||
});
|
});
|
||||||
|
|
||||||
if (streamingArg) {
|
execChildProcess.stderr.on('data', (data) => {
|
||||||
done.resolve({
|
if (!options.silent) {
|
||||||
childProcess: execChildProcess,
|
spawnlogInstance.writeToConsole(data);
|
||||||
finalPromise: childProcessEnded.promise,
|
}
|
||||||
kill: () => {
|
spawnlogInstance.addToBuffer(data);
|
||||||
// this notation with the - kills the whole process group
|
});
|
||||||
process.kill(-execChildProcess.pid);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
execChildProcess.on('exit', (code, signal) => {
|
execChildProcess.on('exit', (code, signal) => {
|
||||||
this.smartexit.removeProcess(execChildProcess);
|
this.smartexit.removeProcess(execChildProcess);
|
||||||
if (strictArg && code === 1) {
|
if (options.strict && code === 1) {
|
||||||
done.reject();
|
done.reject();
|
||||||
}
|
}
|
||||||
|
|
||||||
const execResult = {
|
const execResult = {
|
||||||
exitCode: code,
|
exitCode: code,
|
||||||
stdout: spawnlogInstance.logStore.toString()
|
stdout: spawnlogInstance.logStore.toString(),
|
||||||
};
|
};
|
||||||
|
|
||||||
if (!streamingArg) {
|
if (!options.streaming) {
|
||||||
done.resolve(execResult);
|
done.resolve(execResult);
|
||||||
}
|
}
|
||||||
childProcessEnded.resolve(execResult);
|
childProcessEnded.resolve(execResult);
|
||||||
});
|
});
|
||||||
|
|
||||||
const result = await done.promise;
|
if (options.streaming) {
|
||||||
return result;
|
done.resolve({
|
||||||
|
childProcess: execChildProcess,
|
||||||
|
finalPromise: childProcessEnded.promise,
|
||||||
|
kill: () => {
|
||||||
|
console.log(`running tree kill with SIGKILL on process ${execChildProcess.pid}`);
|
||||||
|
plugins.treeKill(execChildProcess.pid, 'SIGKILL');
|
||||||
|
},
|
||||||
|
terminate: () => {
|
||||||
|
console.log(`running tree kill with SIGTERM on process ${execChildProcess.pid}`);
|
||||||
|
plugins.treeKill(execChildProcess.pid, 'SIGTERM');
|
||||||
|
},
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
return await done.promise;
|
||||||
}
|
}
|
||||||
|
|
||||||
public async exec(commandStringArg: string): Promise<IExecResult> {
|
public async exec(commandString: string): Promise<IExecResult> {
|
||||||
return (await this._exec(commandStringArg, false)) as IExecResult;
|
return (await this._exec({ commandString })) as IExecResult;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
public async execSilent(commandString: string): Promise<IExecResult> {
|
||||||
* executes a given command async and silent
|
return (await this._exec({ commandString, silent: true })) as IExecResult;
|
||||||
* @param commandStringArg
|
|
||||||
*/
|
|
||||||
public async execSilent(commandStringArg: string): Promise<IExecResult> {
|
|
||||||
return (await this._exec(commandStringArg, true)) as IExecResult;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
public async execStrict(commandString: string): Promise<IExecResult> {
|
||||||
* executes a command async and strict, meaning it rejects the promise if something happens
|
return (await this._exec({ commandString, strict: true })) as IExecResult;
|
||||||
*/
|
|
||||||
public async execStrict(commandStringArg: string): Promise<IExecResult> {
|
|
||||||
return (await this._exec(commandStringArg, false, true)) as IExecResult;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
public async execStrictSilent (commandStringArg: string): Promise<IExecResult> {
|
public async execStrictSilent(commandString: string): Promise<IExecResult> {
|
||||||
return (await this._exec(commandStringArg, true, true)) as IExecResult;
|
return (await this._exec({ commandString, silent: true, strict: true })) as IExecResult;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
public async execStreaming(commandString: string, silent: boolean = false): Promise<IExecResultStreaming> {
|
||||||
* executes a command and allows you to stream output
|
return (await this._exec({ commandString, silent, streaming: true })) as IExecResultStreaming;
|
||||||
*/
|
|
||||||
public async execStreaming(
|
|
||||||
commandStringArg: string,
|
|
||||||
silentArg: boolean = false
|
|
||||||
): Promise<IExecResultStreaming> {
|
|
||||||
return (await this._exec(commandStringArg, silentArg, false, true)) as IExecResultStreaming;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
public async execStreamingSilent(commandStringArg: string) {
|
public async execStreamingSilent(commandString: string): Promise<IExecResultStreaming> {
|
||||||
return (await this.execStreaming(commandStringArg, true)) as IExecResultStreaming;
|
return (await this._exec({ commandString, silent: true, streaming: true })) as IExecResultStreaming;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
public async execInteractive(commandString: string) {
|
||||||
* executes a command and returns promise that will be fullfilled once an putput line matches RegexArg
|
await this._exec({ commandString, interactive: true });
|
||||||
* @param commandStringArg
|
}
|
||||||
* @param regexArg
|
|
||||||
*/
|
public async execAndWaitForLine(commandString: string, regexArg: RegExp, silentArg: boolean = false) {
|
||||||
public async execAndWaitForLine(
|
|
||||||
commandStringArg: string,
|
|
||||||
regexArg: RegExp,
|
|
||||||
silentArg: boolean = false
|
|
||||||
) {
|
|
||||||
let done = plugins.smartpromise.defer();
|
let done = plugins.smartpromise.defer();
|
||||||
let execStreamingResult = await this.execStreaming(commandStringArg, silentArg);
|
let execStreamingResult = await this.execStreaming(commandString, silentArg);
|
||||||
execStreamingResult.childProcess.stdout.on('data', (stdOutChunk: string) => {
|
execStreamingResult.childProcess.stdout.on('data', (stdOutChunk: string) => {
|
||||||
if (regexArg.test(stdOutChunk)) {
|
if (regexArg.test(stdOutChunk)) {
|
||||||
done.resolve();
|
done.resolve();
|
||||||
@ -160,42 +166,7 @@ export class Smartshell {
|
|||||||
return done.promise;
|
return done.promise;
|
||||||
}
|
}
|
||||||
|
|
||||||
public async execAndWaitForLineSilent(commandStringArg: string, regexArg: RegExp) {
|
public async execAndWaitForLineSilent(commandString: string, regexArg: RegExp) {
|
||||||
this.execAndWaitForLine(commandStringArg, regexArg, true);
|
return this.execAndWaitForLine(commandString, regexArg, true);
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* execs an command and then enters interactive CLI
|
|
||||||
* @param commandStringArg
|
|
||||||
* @param regexArg
|
|
||||||
*/
|
|
||||||
public async execInteractive(commandStringArg: string) {
|
|
||||||
if (process.env.CI) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const done = plugins.smartpromise.defer();
|
|
||||||
const shell = cp.spawn('sh', [], { stdio: 'pipe' });
|
|
||||||
this.smartexit.addProcess(shell);
|
|
||||||
const shellLog = new ShellLog();
|
|
||||||
const stdInStream = process.stdin.pipe(shell.stdin);
|
|
||||||
const stdOutStream = shell.stdout.pipe(process.stdout);
|
|
||||||
shell.on('close', code => {
|
|
||||||
console.log(`interactive shell terminated with code ${code}`);
|
|
||||||
stdInStream.removeAllListeners();
|
|
||||||
stdInStream.uncork();
|
|
||||||
stdOutStream.removeAllListeners();
|
|
||||||
stdOutStream.unpipe();
|
|
||||||
shell.kill('SIGTERM');
|
|
||||||
process.stdin.pause();
|
|
||||||
done.resolve();
|
|
||||||
});
|
|
||||||
let commandString = commandStringArg;
|
|
||||||
if (process.env.CI) {
|
|
||||||
commandString += ' && exit';
|
|
||||||
}
|
|
||||||
commandString += '\n';
|
|
||||||
|
|
||||||
shell.stdin.write(commandString);
|
|
||||||
await done.promise;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,6 +1,11 @@
|
|||||||
import * as smartdelay from '@pushrocks/smartdelay';
|
import * as smartdelay from '@pushrocks/smartdelay';
|
||||||
import * as smartexit from '@pushrocks/smartexit';
|
import * as smartexit from '@pushrocks/smartexit';
|
||||||
import * as smartpromise from '@pushrocks/smartpromise';
|
import * as smartpromise from '@pushrocks/smartpromise';
|
||||||
import * as which from 'which';
|
import which from 'which';
|
||||||
|
|
||||||
export { smartdelay, smartexit, smartpromise, which };
|
export { smartdelay, smartexit, smartpromise, which };
|
||||||
|
|
||||||
|
// third party
|
||||||
|
import treeKill from 'tree-kill';
|
||||||
|
|
||||||
|
export { treeKill };
|
||||||
|
11
tsconfig.json
Normal file
11
tsconfig.json
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"experimentalDecorators": true,
|
||||||
|
"useDefineForClassFields": false,
|
||||||
|
"target": "ES2022",
|
||||||
|
"module": "ES2022",
|
||||||
|
"moduleResolution": "nodenext",
|
||||||
|
"esModuleInterop": true,
|
||||||
|
"verbatimModuleSyntax": true,
|
||||||
|
}
|
||||||
|
}
|
17
tslint.json
17
tslint.json
@ -1,17 +0,0 @@
|
|||||||
{
|
|
||||||
"extends": ["tslint:latest", "tslint-config-prettier"],
|
|
||||||
"rules": {
|
|
||||||
"semicolon": [true, "always"],
|
|
||||||
"no-console": false,
|
|
||||||
"ordered-imports": false,
|
|
||||||
"object-literal-sort-keys": false,
|
|
||||||
"member-ordering": {
|
|
||||||
"options":{
|
|
||||||
"order": [
|
|
||||||
"static-method"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"defaultSeverity": "warning"
|
|
||||||
}
|
|
Reference in New Issue
Block a user