diff --git a/npmextra.json b/npmextra.json index 49012dc..c01e009 100644 --- a/npmextra.json +++ b/npmextra.json @@ -2,12 +2,12 @@ "gitzone": { "projectType": "npm", "module": { - "githost": {}, - "gitscope": {}, - "gitrepo": {}, - "shortDescription": {}, - "npmPackagename": {}, - "license": {} + "githost": "gitlab.com", + "gitscope": "pushrocks", + "gitrepo": "smartinteract", + "shortDescription": "smart cli interaction", + "npmPackagename": "@pushrocks/smartinteract", + "license": "MIT" } }, "npmci": { diff --git a/package.json b/package.json index 3a8c7b7..5bd14d2 100644 --- a/package.json +++ b/package.json @@ -52,4 +52,4 @@ "browserslist": [ "last 1 chrome versions" ] -} +} \ No newline at end of file diff --git a/readme.md b/readme.md index bee1823..c3b6eab 100644 --- a/readme.md +++ b/readme.md @@ -1,26 +1,26 @@ -# @[object Object]/[object Object] -[object Object] +# @pushrocks/smartinteract +smart cli interaction ## Availabililty and Links -* [npmjs.org (npm package)](https://www.npmjs.com/package/[object Object]) -* [gitlab.com (source)](https://[object Object]/[object Object]/[object Object]) -* [github.com (source mirror)](https://github.com/[object Object]/[object Object]) -* [docs (typedoc)](https://[object Object].gitlab.io/[object Object]/) +* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartinteract) +* [gitlab.com (source)](https://gitlab.com/pushrocks/smartinteract) +* [github.com (source mirror)](https://github.com/pushrocks/smartinteract) +* [docs (typedoc)](https://pushrocks.gitlab.io/smartinteract/) ## Status for master Status Category | Status Badge -- | -- -GitLab Pipelines | [![pipeline status](https://[object Object]/[object Object]/[object Object]/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) -npm | [![npm downloads per month](https://badgen.net/npm/dy/[object Object])](https://lossless.cloud) -Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/[object Object]/[object Object])](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://gitlab.com/pushrocks/smartinteract/badges/master/coverage.svg)](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/pushrocks/smartinteract)](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/) 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 (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/[object Object])](https://lossless.cloud) -BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/[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/@pushrocks/smartinteract)](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) ## 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. -> [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) [![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com) diff --git a/test/test.ts b/test/test.ts index cae04ec..ae010f4 100644 --- a/test/test.ts +++ b/test/test.ts @@ -10,7 +10,10 @@ tap.test('should create a valid new instance', 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; }); diff --git a/ts/smartinteract.classes.smartinteract.ts b/ts/smartinteract.classes.smartinteract.ts index 4c4114d..911375a 100644 --- a/ts/smartinteract.classes.smartinteract.ts +++ b/ts/smartinteract.classes.smartinteract.ts @@ -46,16 +46,19 @@ export interface IValidateFunction { */ export class SmartInteract { // STATIC - public static async getCliConfirmation(questionArg: string, defaultArg: boolean): Promise { + public static async getCliConfirmation( + questionArg: string, + defaultArg: boolean + ): Promise { const smartinteractInstance = new SmartInteract(); const response = await smartinteractInstance.askQuestion({ default: defaultArg, message: questionArg, name: 'question', - type: 'confirm' + type: 'confirm', }); return response.value; - }; + } // INSTANCE /**