6 Commits

Author SHA1 Message Date
2e5f69c6a7 2.0.13 2023-07-13 15:47:52 +02:00
bf168f688c fix(core): update 2023-07-13 15:47:52 +02:00
5e92004a9f 2.0.12 2023-07-13 14:07:13 +02:00
db268d4fad fix(core): update 2023-07-13 14:07:12 +02:00
0acb00c9c4 switch to new org scheme 2023-07-11 00:50:50 +02:00
b2bf396bb6 switch to new org scheme 2023-07-10 02:56:26 +02:00
17 changed files with 5248 additions and 11474 deletions

View File

@ -0,0 +1,66 @@
name: Default (not tags)
on:
push:
tags-ignore:
- '**'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Install pnpm and npmci
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
- name: Run npm prepare
run: npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build

View File

@ -0,0 +1,124 @@
name: Default (tags)
on:
push:
tags:
- '*'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build
release:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Release
run: |
npmci node install stable
npmci npm publish
metadata:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
continue-on-error: true
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Code quality
run: |
npmci command npm install -g typescript
npmci npm install
- name: Trigger
run: npmci trigger
- name: Build docs and upload artifacts
run: |
npmci node install stable
npmci npm install
pnpm install -g @gitzone/tsdoc
npmci command tsdoc
continue-on-error: true

View File

@ -1,137 +0,0 @@
# gitzone ci_default
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
cache:
paths:
- .npmci_cache/
key: '$CI_BUILD_STAGE'
stages:
- security
- test
- release
- metadata
# ====================
# 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
script:
- npmci npm prepare
- npmci command npm install --production --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=prod --production
tags:
- docker
auditDevDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=dev
tags:
- docker
allow_failure: true
# ====================
# test stage
# ====================
testStable:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
testBuild:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci command npm run build
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
release:
stage: release
script:
- npmci node install stable
- npmci npm publish
only:
- tags
tags:
- lossless
- docker
- notpriv
# ====================
# metadata stage
# ====================
codequality:
stage: metadata
allow_failure: true
only:
- tags
script:
- npmci command npm install -g tslint typescript
- npmci npm prepare
- npmci npm install
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
tags:
- lossless
- docker
- priv
trigger:
stage: metadata
script:
- npmci trigger
only:
- tags
tags:
- lossless
- docker
- notpriv
pages:
stage: metadata
script:
- npmci node install lts
- npmci command npm install -g @gitzone/tsdoc
- npmci npm prepare
- npmci npm install
- npmci command tsdoc
tags:
- lossless
- docker
- notpriv
only:
- tags
artifacts:
expire_in: 1 week
paths:
- public
allow_failure: true

24
.vscode/launch.json vendored
View File

@ -2,28 +2,10 @@
"version": "0.2.0", "version": "0.2.0",
"configurations": [ "configurations": [
{ {
"name": "current file", "command": "npm test",
"type": "node", "name": "Run npm test",
"request": "launch", "request": "launch",
"args": [ "type": "node-terminal"
"${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"
} }
] ]
} }

View File

@ -3,10 +3,10 @@
"projectType": "npm", "projectType": "npm",
"module": { "module": {
"githost": "gitlab.com", "githost": "gitlab.com",
"gitscope": "pushrocks", "gitscope": "push.rocks",
"gitrepo": "smartinteract", "gitrepo": "smartinteract",
"shortDescription": "smart cli interaction", "description": "smart cli interaction",
"npmPackagename": "@pushrocks/smartinteract", "npmPackagename": "@push.rocks/smartinteract",
"license": "MIT" "license": "MIT"
} }
}, },

11243
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,13 +1,14 @@
{ {
"name": "@pushrocks/smartinteract", "name": "@push.rocks/smartinteract",
"private": false, "private": false,
"version": "2.0.11", "version": "2.0.13",
"description": "smart cli interaction", "description": "smart cli interaction",
"main": "dist_ts/index.js", "main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts", "typings": "dist_ts/index.d.ts",
"scripts": { "scripts": {
"test": "(tstest test/)", "test": "(tstest test/)",
"build": "(tsbuild --web)" "build": "(tsbuild --web)",
"buildDocs": "tsdoc"
}, },
"repository": { "repository": {
"type": "git", "type": "git",
@ -24,18 +25,17 @@
}, },
"homepage": "https://gitlab.com/pushrocks/smartinteract#README", "homepage": "https://gitlab.com/pushrocks/smartinteract#README",
"dependencies": { "dependencies": {
"@pushrocks/lik": "^4.0.17", "@push.rocks/lik": "^6.0.2",
"@pushrocks/smartparam": "^1.1.6", "@push.rocks/smartobject": "^1.0.12",
"@pushrocks/smartpromise": "^3.0.6", "@push.rocks/smartpromise": "^4.0.2",
"@types/inquirer": "^7.3.1", "@types/inquirer": "^9.0.3",
"inquirer": "^7.3.3" "inquirer": "^9.2.7"
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.1.25", "@gitzone/tsbuild": "^2.1.66",
"@gitzone/tstest": "^1.0.44", "@gitzone/tsrun": "^1.2.44",
"@pushrocks/tapbundle": "^3.2.9", "@gitzone/tstest": "^1.0.74",
"tslint": "^6.1.3", "@push.rocks/tapbundle": "^5.0.12"
"tslint-config-prettier": "^1.18.0"
}, },
"files": [ "files": [
"ts/**/*", "ts/**/*",
@ -51,5 +51,6 @@
], ],
"browserslist": [ "browserslist": [
"last 1 chrome versions" "last 1 chrome versions"
] ],
"type": "module"
} }

4982
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

View File

@ -1,27 +1,26 @@
# @pushrocks/smartinteract # @push.rocks/smartinteract
smart cli interaction smart cli interaction
## Availabililty and Links ## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartinteract) * [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartinteract)
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartinteract) * [gitlab.com (source)](https://gitlab.com/push.rocks/smartinteract)
* [github.com (source mirror)](https://github.com/pushrocks/smartinteract) * [github.com (source mirror)](https://github.com/push.rocks/smartinteract)
* [docs (typedoc)](https://pushrocks.gitlab.io/smartinteract/) * [docs (typedoc)](https://push.rocks.gitlab.io/smartinteract/)
## Status for master ## Status for master
Status Category | Status Badge Status Category | Status Badge
-- | -- -- | --
GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartinteract/badges/master/pipeline.svg)](https://lossless.cloud) GitLab Pipelines | [![pipeline status](https://gitlab.com/push.rocks/smartinteract/badges/master/pipeline.svg)](https://lossless.cloud)
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartinteract/badges/master/coverage.svg)](https://lossless.cloud) GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/push.rocks/smartinteract/badges/master/coverage.svg)](https://lossless.cloud)
npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartinteract)](https://lossless.cloud) npm | [![npm downloads per month](https://badgen.net/npm/dy/@push.rocks/smartinteract)](https://lossless.cloud)
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartinteract)](https://lossless.cloud) Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/push.rocks/smartinteract)](https://lossless.cloud)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud) TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/) node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud) Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartinteract)](https://lossless.cloud) PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@push.rocks/smartinteract)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartinteract)](https://lossless.cloud) PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@push.rocks/smartinteract)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartinteract)](https://lossless.cloud) BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/smartinteract)](https://lossless.cloud)
Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
## Usage ## Usage
@ -56,14 +55,12 @@ myInteract.askQuestion{ // note: its an array. You can specify multiple question
}) })
``` ```
## Contribution ## 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). :) 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. For further information read the linked docs at the top of this readme.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) ## 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) | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

View File

@ -1,12 +1,12 @@
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, tap } from '@push.rocks/tapbundle';
import * as smartinteract from '../ts/index'; import * as smartinteract from '../ts/index.js';
let testInteract: smartinteract.SmartInteract; let testInteract: smartinteract.SmartInteract;
tap.test('should create a valid new instance', async () => { tap.test('should create a valid new instance', async () => {
testInteract = new smartinteract.SmartInteract(); testInteract = new smartinteract.SmartInteract();
expect(testInteract).to.be.instanceOf(smartinteract.SmartInteract); expect(testInteract).toBeInstanceOf(smartinteract.SmartInteract);
}); });
tap.test('should get a simple confirmation', async () => { tap.test('should get a simple confirmation', async () => {
@ -14,7 +14,7 @@ tap.test('should get a simple confirmation', async () => {
'You feel awesome, right?', 'You feel awesome, right?',
true true
); );
expect(response).to.be.true; expect(response).toBeTrue();
}); });
tap.test('should add question to SmartInteract instance', async () => { tap.test('should add question to SmartInteract instance', async () => {
@ -46,9 +46,9 @@ tap.test('should add question to SmartInteract instance', async () => {
tap.test('should use default value when not in CI', async () => { tap.test('should use default value when not in CI', async () => {
const answerBucket = await testInteract.runQueue(); const answerBucket = await testInteract.runQueue();
expect(answerBucket.getAnswerFor('testQuestion1')).to.equal('blue'); expect(answerBucket.getAnswerFor('testQuestion1')).toEqual('blue');
expect(answerBucket.getAnswerFor('testQuestion2')).to.equal('red'); expect(answerBucket.getAnswerFor('testQuestion2')).toEqual('red');
expect(answerBucket.getAnswerFor('some.dotted.name')).to.equal('aValidAnswer'); expect(answerBucket.getAnswerFor('some.dotted.name')).toEqual('aValidAnswer');
}); });
tap.start(); tap.start();

8
ts/00_commitinfo_data.ts Normal file
View File

@ -0,0 +1,8 @@
/**
* autocreated commitinfo by @pushrocks/commitinfo
*/
export const commitinfo = {
name: '@push.rocks/smartinteract',
version: '2.0.13',
description: 'smart cli interaction'
}

View File

@ -1,2 +1,2 @@
export * from './smartinteract.classes.smartinteract'; export * from './smartinteract.classes.smartinteract.js';
export * from './smartinteract.classes.answerbucket'; export * from './smartinteract.classes.answerbucket.js';

View File

@ -1,5 +1,5 @@
import * as plugins from './smartinteract.plugins'; import * as plugins from './smartinteract.plugins.js';
import { IAnswerObject } from './smartinteract.classes.smartinteract'; import { type IAnswerObject } from './smartinteract.classes.smartinteract.js';
/** /**
* class AnswerBucket holds answers * class AnswerBucket holds answers
@ -18,7 +18,7 @@ export class AnswerBucket {
* gets an answer for a specific name * gets an answer for a specific name
*/ */
public getAnswerFor(nameArg: string) { public getAnswerFor(nameArg: string) {
const answer = this.answerMap.find((answerArg) => { const answer = this.answerMap.findSync((answerArg) => {
return answerArg.name === nameArg; return answerArg.name === nameArg;
}); });
return answer ? answer.value : null; return answer ? answer.value : null;

View File

@ -1,6 +1,5 @@
import * as plugins from './smartinteract.plugins'; import * as plugins from './smartinteract.plugins.js';
import * as smartpromise from '@pushrocks/smartpromise'; import { AnswerBucket } from './smartinteract.classes.answerbucket.js';
import { AnswerBucket } from './smartinteract.classes.answerbucket';
/** /**
* the availeable question types * the availeable question types
@ -79,9 +78,9 @@ export class SmartInteract {
* skips the queue * skips the queue
*/ */
askQuestion(optionsArg: IQuestionObject): Promise<IAnswerObject> { askQuestion(optionsArg: IQuestionObject): Promise<IAnswerObject> {
const done = smartpromise.defer<IAnswerObject>(); const done = plugins.smartpromise.defer<IAnswerObject>();
if (this.isValidEnv()) { if (this.isValidEnv()) {
plugins.inquirer plugins.inquirer.default
.prompt([ .prompt([
{ {
name: optionsArg.name, name: optionsArg.name,
@ -94,7 +93,7 @@ export class SmartInteract {
]) ])
.then((answers) => { .then((answers) => {
// adjust to the fact that now dots define paths for inquirer // adjust to the fact that now dots define paths for inquirer
const answerValue = plugins.smartparam.smartGet(answers, optionsArg.name); const answerValue = plugins.smartobject.smartGet(answers, optionsArg.name);
done.resolve({ done.resolve({
name: optionsArg.name, name: optionsArg.name,
value: answerValue, value: answerValue,
@ -125,7 +124,7 @@ export class SmartInteract {
* run the question queue * run the question queue
*/ */
runQueue() { runQueue() {
const done = smartpromise.defer<AnswerBucket>(); const done = plugins.smartpromise.defer<AnswerBucket>();
const answerBucket = new AnswerBucket(); const answerBucket = new AnswerBucket();
const handleQuestion = async () => { const handleQuestion = async () => {
if (!this.questionMap.isEmpty()) { if (!this.questionMap.isEmpty()) {

View File

@ -1,8 +1,9 @@
// pushrocks scope // pushrocks scope
import * as lik from '@pushrocks/lik'; import * as lik from '@push.rocks/lik';
import * as smartparam from '@pushrocks/smartparam'; import * as smartobject from '@push.rocks/smartobject';
import * as smartpromise from '@push.rocks/smartpromise';
export { lik, smartparam }; export { lik, smartobject, smartpromise };
// third party scope // third party scope
import * as inquirer from 'inquirer'; import * as inquirer from 'inquirer';

11
tsconfig.json Normal file
View File

@ -0,0 +1,11 @@
{
"compilerOptions": {
"experimentalDecorators": true,
"useDefineForClassFields": false,
"target": "ES2022",
"module": "ES2022",
"moduleResolution": "nodenext",
"esModuleInterop": true,
"verbatimModuleSyntax": true,
}
}

View File

@ -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"
}