push.rocks/smartinteract
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update tsconfig

Browse Source
This commit is contained in:
Philipp Kunz 2024-04-14 17:43:28 +02:00
parent 2a4526297c
commit 61a0bfc966
4 changed files with 139 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
npmextra.json
View File

@ -5,16 +5,28 @@
"githost": "code.foss.global",
"gitscope": "push.rocks",
"gitrepo": "smartinteract",
"description": "smart cli interaction",
"description": "A package for creating smart CLI interactions with customizable questions and answers.",
"npmPackagename": "@push.rocks/smartinteract",
"license": "MIT"
"license": "MIT",
"keywords": [
"CLI",
"interactive prompts",
"command line interface",
"user input handling",
"inquirer integration",
"CLI questions",
"CLI validations",
"CLI interactions",
"smart CLI",
"typescript"
]
}
},
"npmci": {
"npmGlobalTools": [],
"npmAccessLevel": "public"
},
"tsdocs": {
"tsdoc": {
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
}
}

16
package.json
View File

@ -2,7 +2,7 @@
"name": "@push.rocks/smartinteract",
"private": false,
"version": "2.0.15",
"description": "smart cli interaction",
"description": "A package for creating smart CLI interactions with customizable questions and answers.",
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"scripts": {
@ -15,8 +15,16 @@
"url": "git+ssh://git@gitlab.com/pushrocks/smartinteract.git"
},
"keywords": [
"interaction",
"cli"
"CLI",
"interactive prompts",
"command line interface",
"user input handling",
"inquirer integration",
"CLI questions",
"CLI validations",
"CLI interactions",
"smart CLI",
"typescript"
],
"author": "Lossless GmbH",
"license": "MIT",
@ -53,4 +61,4 @@
"last 1 chrome versions"
],
"type": "module"
}
}

1
readme.hints.md Normal file
View File

@ -0,0 +1 @@

161
readme.md
View File

@ -1,66 +1,127 @@
# @push.rocks/smartinteract
smart cli interaction
## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartinteract)
* [gitlab.com (source)](https://gitlab.com/push.rocks/smartinteract)
* [github.com (source mirror)](https://github.com/push.rocks/smartinteract)
* [docs (typedoc)](https://push.rocks.gitlab.io/smartinteract/)
## Install
## Status for master
To install `@push.rocks/smartinteract`, use npm or yarn as follows:
Status Category | Status Badge
-- | --
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/push.rocks/smartinteract/badges/master/coverage.svg)](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/push.rocks/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/@push.rocks/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/@push.rocks/smartinteract)](https://lossless.cloud)
```bash
npm install @push.rocks/smartinteract --save
# or using yarn
yarn add @push.rocks/smartinteract
```
This will add it to your project's `node_modules` folder and list it as a dependency in your project's `package.json` file.
## Usage
Use TypeScript for best in class instellisense.
The `@push.rocks/smartinteract` module is designed to facilitate smart command-line interactions by providing a flexible way to query input from users in a structured manner. It leverages TypeScript for enhanced development experience, offering strong types and IntelliSense in supported editors.
```javascript
import { SmartInteract } from 'smartinteract'
### Getting Started
let myInteract = new SmartInteract([{ // note: its an array. You can specify multiple questions
name: 'question1',
type: 'input',
message: 'Who are you?',
default: 'Somebody',
validate: (inputString) => { return true } // implement your own validation
}])
myInteract.addQuestions([ ... ]) // add more questions
myInteract.runQueue()
.then(answerBucket => { // the bucket has all the answers of the completed queue
let answerQuestion1 = answerBucket.getAnswerFor('question1')
// do something with the answers
})
To begin, import `SmartInteract` from the module:
// alternatively use .askQuestion() for more direct control
myInteract.askQuestion{ // note: its an array. You can specify multiple questions
name: 'question2',
type: 'confirm',
message: 'Do you speak English?',
default: true,
validate: (inputString) => { return true } // implement your own validation
}().then(answerObject => {
// answerObject looks like { name: 'question2', value: true }
})
```typescript
import { SmartInteract } from '@push.rocks/smartinteract';
```
## Contribution
### Creating and Running Interactions
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). :)
You can specify questions for user interaction as shown below:
For further information read the linked docs at the top of this readme.
```typescript
const smartInteract = new SmartInteract([
{
name: 'userName',
type: 'input',
message: 'What is your name?',
default: 'John Doe',
},
{
name: 'userConfirmation',
type: 'confirm',
message: 'Do you agree with the terms?',
default: false,
}
]);
```
## 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)
`SmartInteract` supports various question types such as 'input', 'confirm', 'list', 'rawlist', 'checkbox', 'password', and 'editor'. This allows for a diverse range of user inputs from simple text inputs to selections from a list.
### Adding Additional Questions Dynamically
You can dynamically add more questions to the interaction:
```typescript
smartInteract.addQuestions([
{
name: 'userHobby',
type: 'input',
message: 'What is your favorite hobby?',
default: 'Programming',
}
]);
```
### Running the Interaction Queue
Execute the queued interaction and process the responses:
```typescript
smartInteract.runQueue()
.then(answerBucket => {
const userResponse = {
name: answerBucket.getAnswerFor('userName'),
agreed: answerBucket.getAnswerFor('userConfirmation'),
hobby: answerBucket.getAnswerFor('userHobby')
};
console.log(userResponse);
// Output: { name: 'John Doe', agreed: true/false, hobby: 'Programming'}
});
```
### Direct Questioning
For immediate prompting without queuing, you can utilize the `askQuestion` method:
```typescript
smartInteract.askQuestion({
name: 'urgentQuery',
type: 'confirm',
message: 'Do you need to save changes?',
default: true,
})
.then(answerObject => {
console.log(answerObject);
// Output: { name: 'urgentQuery', value: true/false }
});
```
### Advanced Usage
You can customize validations, provide choice selections for 'list', 'rawlist', 'expand', and 'checkbox' types, and much more according to the [Inquirer.js](https://github.com/SBoudrias/Inquirer.js/) module which `@push.rocks/smartinteract` leverages internally.
### Conclusion
`@push.rocks/smartinteract` offers an elegant and robust solution for CLI interactions in Node.js projects. Its integration of TypeScript enhances code quality and developer workflow. Whether for simple prompts or complex inquisitive flows, it provides the tools necessary for obtaining and managing user inputs efficiently.
## License and Legal Information
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
### Trademarks
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
### Company Information
Task Venture Capital GmbH
Registered at District court Bremen HRB 35230 HB, Germany
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.