Compare commits

..

6 Commits

Author SHA1 Message Date
bd66903419 4.0.3 2022-08-03 18:48:40 +02:00
740d8dac35 fix(core): update 2022-08-03 18:48:40 +02:00
488e7410fe 4.0.2 2022-08-03 18:47:35 +02:00
04deb8960c fix(core): update 2022-08-03 18:47:35 +02:00
19f0a9563f 4.0.1 2022-08-03 17:07:11 +02:00
db1e866fe1 fix(core): update 2022-08-03 17:07:11 +02:00
8 changed files with 50 additions and 94 deletions

View File

@ -12,20 +12,12 @@ stages:
- release
- metadata
before_script:
- npm install -g @shipzone/npmci
# ====================
# security stage
# ====================
mirror:
stage: security
script:
- npmci git mirror
only:
- tags
tags:
- lossless
- docker
- notpriv
auditProductionDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
@ -36,6 +28,7 @@ auditProductionDependencies:
- npmci command npm audit --audit-level=high --only=prod --production
tags:
- docker
allow_failure: true
auditDevDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
@ -96,10 +89,9 @@ codequality:
only:
- tags
script:
- npmci command npm install -g tslint typescript
- npmci command npm install -g typescript
- npmci npm prepare
- npmci npm install
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
tags:
- lossless
- docker
@ -119,11 +111,10 @@ trigger:
pages:
stage: metadata
script:
- npmci node install lts
- npmci command npm install -g @gitzone/tsdoc
- npmci node install stable
- npmci npm prepare
- npmci npm install
- npmci command tsdoc
- npmci command npm run buildDocs
tags:
- lossless
- docker

24
.vscode/launch.json vendored
View File

@ -2,28 +2,10 @@
"version": "0.2.0",
"configurations": [
{
"name": "current file",
"type": "node",
"command": "npm test",
"name": "Run npm test",
"request": "launch",
"args": [
"${relativeFile}"
],
"runtimeArgs": ["-r", "@gitzone/tsrun"],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"internalConsoleOptions": "openOnSessionStart"
},
{
"name": "test.ts",
"type": "node",
"request": "launch",
"args": [
"test/test.ts"
],
"runtimeArgs": ["-r", "@gitzone/tsrun"],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"internalConsoleOptions": "openOnSessionStart"
"type": "node-terminal"
}
]
}

4
package-lock.json generated
View File

@ -1,12 +1,12 @@
{
"name": "@pushrocks/smartcli",
"version": "4.0.0",
"version": "4.0.3",
"lockfileVersion": 2,
"requires": true,
"packages": {
"": {
"name": "@pushrocks/smartcli",
"version": "4.0.0",
"version": "4.0.3",
"license": "MIT",
"dependencies": {
"@pushrocks/lik": "^6.0.0",

View File

@ -1,14 +1,15 @@
{
"name": "@pushrocks/smartcli",
"private": false,
"version": "4.0.0",
"version": "4.0.3",
"description": "easy observable cli tasks",
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"type": "module",
"scripts": {
"test": "(tstest test/ --web)",
"build": "(tsbuild --web)"
"build": "(tsbuild --web)",
"buildDocs": "tsdoc"
},
"repository": {
"type": "git",

View File

@ -3,41 +3,40 @@ import { Subject } from 'rxjs';
import * as smartcli from '../ts/index.js';
let smartCliTestObject: smartcli.Smartcli;
tap.test('should create a new Smartcli', async () => {
smartCliTestObject = new smartcli.Smartcli();
const smartCliTestObject = new smartcli.Smartcli();
expect(smartCliTestObject).toBeInstanceOf(smartcli.Smartcli);
});
tap.test('should add an command', async () => {
expect(smartCliTestObject.addCommand('awesome')).toBeInstanceOf(Subject);
tap.test('should add an command', async (toolsArg) => {
const done = toolsArg.defer();
const smartCliTestObject = new smartcli.Smartcli();
const awesomeCommandSubject = smartCliTestObject.addCommand('awesome')
expect(awesomeCommandSubject).toBeInstanceOf(Subject);
awesomeCommandSubject.subscribe(() => {
done.resolve();
});
console.log(process.argv);
process.argv.splice(2, 0, 'awesome');
console.log(process.argv);
smartCliTestObject.startParse();
await done.promise;
});
tap.test('should start parsing a standardTask', async () => {
const smartCliTestObject = new smartcli.Smartcli();
expect(smartCliTestObject.standardCommand()).toBeInstanceOf(Subject);
});
let hasExecuted: boolean = false;
tap.test('should accept a command', async () => {
const smartCliTestObject = new smartcli.Smartcli();
smartCliTestObject.addCommand('triggerme').subscribe(() => {
hasExecuted = true;
});
});
tap.test('should not have executed yet', async () => {
expect(hasExecuted).toBeFalse();
});
tap.test('should execute when triggered', async () => {
smartCliTestObject.triggerCommand('triggerme', {});
expect(hasExecuted).toBeTrue();
});
tap.test('should start parsing the CLI input', async () => {
smartCliTestObject.startParse();
expect(smartCliTestObject.parseCompleted.promise).toBeInstanceOf(Promise);
});
tap.start();

View File

@ -3,6 +3,6 @@
*/
export const commitinfo = {
name: '@pushrocks/smartcli',
version: '4.0.0',
version: '4.0.3',
description: 'easy observable cli tasks'
}

View File

@ -16,10 +16,8 @@ export class Smartcli {
* this Deferred contains the parsed result in the end
*/
public parseCompleted = plugins.smartpromise.defer<any>();
public version: string;
private checkForEnvCliCall = true;
/**
* map of all Trigger/Observable objects to keep track
@ -29,24 +27,17 @@ export class Smartcli {
/**
* maps alias
*/
public aliasObject: {[key: string]: string[]} = {};
public aliasObject: { [key: string]: string[] } = {};
/**
* The constructor of Smartcli
*/
constructor() {}
/**
* halts any execution of commands if (process.env.CLI_CALL === false)
*/
disableEnvCliCall() {
this.checkForEnvCliCall = false;
}
/**
* adds an alias, meaning one equals the other in terms of command execution.
*/
public addCommandAlias(originalArg, aliasArg): void {
public addCommandAlias(originalArg: string, aliasArg: string): void {
this.aliasObject[originalArg] = this.aliasObject[originalArg] || [];
this.aliasObject[originalArg].push(aliasArg);
}
@ -58,12 +49,12 @@ export class Smartcli {
public addCommand(commandNameArg: string): plugins.smartrx.rxjs.Subject<any> {
let commandSubject: plugins.smartrx.rxjs.Subject<any>;
const existingCommandSubject = this.getCommandSubject(commandNameArg);
commandSubject = existingCommandSubject || new plugins.smartrx.rxjs.Subject<any>();
commandSubject = existingCommandSubject || new plugins.smartrx.rxjs.Subject<any>();
this.commandObservableMap.add({
commandName: commandNameArg,
subject: commandSubject,
})
});
return commandSubject;
}
@ -105,7 +96,7 @@ export class Smartcli {
public addVersion(versionArg: string) {
this.version = versionArg;
this.addCommandAlias('v', 'version');
this.parseCompleted.promise.then(argv => {
this.parseCompleted.promise.then((argv) => {
if (argv.v) {
console.log(this.version);
}
@ -124,20 +115,13 @@ export class Smartcli {
* start the process of evaluating commands
*/
public startParse(): void {
// if we check for cli env calls, we might want to abort here.
if (!process.env.CLI_CALL && this.checkForEnvCliCall) {
console.log(
`note: @pushrocks/smartcli: You called .startParse() on a SmartCli instance. However process.env.CLI_CALL being absent prevented parsing.`
);
return;
}
const parsedYArgs = plugins.yargsParser(process.argv);
// lets handle commands
let counter = 0;
let foundCommand = false;
parsedYArgs._.map((commandPartArg) => {
counter ++;
parsedYArgs._ = parsedYArgs._.filter((commandPartArg) => {
counter++;
if (typeof commandPartArg === 'number') {
return true;
}
@ -148,25 +132,26 @@ export class Smartcli {
} else {
return true;
}
})
});
for (const command of this.commandObservableMap.getArray()) {
if (!parsedYArgs._[0]) {
const standardCommand = this.commandObservableMap.findSync(commandArg => {
return commandArg.commandName === "standardCommand";
const wantedCommand = parsedYArgs._[0];
if (!wantedCommand) {
const standardCommand = this.commandObservableMap.findSync((commandArg) => {
return commandArg.commandName === 'standardCommand';
});
if (standardCommand) {
standardCommand.subject.next(parsedYArgs);
} else {
console.log('no smartcli standard task was created or assigned.');
};
}
break;
}
console.log(`Wanted command: ${wantedCommand}`);
if (command.commandName === parsedYArgs._[0]) {
command.subject.next(parsedYArgs);
break;
}
if (this.aliasObject[parsedYArgs[0]]) {
}
}
this.parseCompleted.resolve(parsedYArgs);

View File

@ -11,6 +11,4 @@ export { smartlog, lik, path, smartparam, smartpromise, smartrx };
// thirdparty scope
import yargsParser from 'yargs-parser';
export {
yargsParser
}
export { yargsParser };