fix(core): update

This commit is contained in:
Philipp Kunz 2020-08-31 19:25:25 +00:00
parent ffe0f202f0
commit aa74482b29
5 changed files with 36 additions and 25 deletions

View File

@ -2,12 +2,12 @@
"gitzone": { "gitzone": {
"projectType": "npm", "projectType": "npm",
"module": { "module": {
"githost": {}, "githost": "gitlab.com",
"gitscope": {}, "gitscope": "pushrocks",
"gitrepo": {}, "gitrepo": "smartinteract",
"shortDescription": {}, "shortDescription": "smart cli interaction",
"npmPackagename": {}, "npmPackagename": "@pushrocks/smartinteract",
"license": {} "license": "MIT"
} }
}, },
"npmci": { "npmci": {

View File

@ -1,26 +1,26 @@
# @[object Object]/[object Object] # @pushrocks/smartinteract
[object Object] smart cli interaction
## Availabililty and Links ## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/[object Object]) * [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartinteract)
* [gitlab.com (source)](https://[object Object]/[object Object]/[object Object]) * [gitlab.com (source)](https://gitlab.com/pushrocks/smartinteract)
* [github.com (source mirror)](https://github.com/[object Object]/[object Object]) * [github.com (source mirror)](https://github.com/pushrocks/smartinteract)
* [docs (typedoc)](https://[object Object].gitlab.io/[object Object]/) * [docs (typedoc)](https://pushrocks.gitlab.io/smartinteract/)
## Status for master ## Status for master
Status Category | Status Badge Status Category | Status Badge
-- | -- -- | --
GitLab Pipelines | [![pipeline status](https://[object Object]/[object Object]/[object Object]/badges/master/pipeline.svg)](https://lossless.cloud) GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartinteract/badges/master/pipeline.svg)](https://lossless.cloud)
GitLab Pipline Test Coverage | [![coverage report](https://[object Object]/[object Object]/[object Object]/badges/master/coverage.svg)](https://lossless.cloud) GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartinteract/badges/master/coverage.svg)](https://lossless.cloud)
npm | [![npm downloads per month](https://badgen.net/npm/dy/[object Object])](https://lossless.cloud) npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartinteract)](https://lossless.cloud)
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/[object Object]/[object Object])](https://lossless.cloud) Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/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/[object Object])](https://lossless.cloud) PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartinteract)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/[object Object])](https://lossless.cloud) PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartinteract)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/[object Object])](https://lossless.cloud) BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/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) 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,9 +56,14 @@ myInteract.askQuestion{ // note: its an array. You can specify multiple question
}) })
``` ```
## 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. For further information read the linked docs at the top of this readme.
> [object Object] licensed | **©** [Lossless GmbH](https://lossless.gmbh) > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
| 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) [![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

View File

@ -10,7 +10,10 @@ tap.test('should create a valid new instance', async () => {
}); });
tap.test('should get a simple confirmation', async () => { tap.test('should get a simple confirmation', async () => {
const response = await smartinteract.SmartInteract.getCliConfirmation('You feel awesome, right?', true); const response = await smartinteract.SmartInteract.getCliConfirmation(
'You feel awesome, right?',
true
);
expect(response).to.be.true; expect(response).to.be.true;
}); });

View File

@ -46,16 +46,19 @@ export interface IValidateFunction {
*/ */
export class SmartInteract { export class SmartInteract {
// STATIC // STATIC
public static async getCliConfirmation(questionArg: string, defaultArg: boolean): Promise<boolean> { public static async getCliConfirmation(
questionArg: string,
defaultArg: boolean
): Promise<boolean> {
const smartinteractInstance = new SmartInteract(); const smartinteractInstance = new SmartInteract();
const response = await smartinteractInstance.askQuestion({ const response = await smartinteractInstance.askQuestion({
default: defaultArg, default: defaultArg,
message: questionArg, message: questionArg,
name: 'question', name: 'question',
type: 'confirm' type: 'confirm',
}); });
return response.value; return response.value;
}; }
// INSTANCE // INSTANCE
/** /**