View resin-cli-form on Snyk Open Source Advisor

Package Health Score

49 / 100

security
Security review needed
popularity
Small
maintenance
Inactive
community
Limited

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
3.0.0	\|	04/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.0.2	\|	03/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.4.2	\|	09/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.3.3	\|	12/2015		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.2.1	\|	08/2015		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (1,363)

GitHub Stars: 1
Forks: 0
Contributors: -

Direct Usage Popularity

The npm package resin-cli-form receives a total of 1,363 downloads a week. As such, we scored resin-cli-form popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package resin-cli-form, we found that it has been starred 1 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 0
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like resin-cli-form is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 0
Open PR: 0
Last Release: 7 months ago
Last Commit: 7 months ago

Further analysis of the maintenance status of resin-cli-form based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

We found that resin-cli-form demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=18.0

Age: 9 years
Dependencies: 4 Direct
Versions: 25
Install Size: 33.2 kB
Dist-tags: 3
# of Files: 11
Maintainers: 1
TS Typings: No

resin-cli-form has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

resin-cli-form

Join our online chat at

Resin.io CLI form interpreter.

Role

The intention of this module is to provide an interpreter for our internal declarative form definitions.

Installation

Install resin-cli-form by running:

$ npm install --save resin-cli-form

Documentation

form
- .run(form, [options]) ⇒ Promise.<Object>
- .ask(question) ⇒ Promise.<*>

form.run(form, [options]) ⇒ `Promise.<Object>`

Kind: static method of form
Summary: Run a form description
Returns: Promise.<Object> - answers
Access: public

Param	Type	Default	Description
form	`Array.<Object>`		form description
[options]	`Object`	`{}`	options
[options.override]	`Object`		overrides

Example

form.run [
	message: 'Processor'
	name: 'processorType'
	type: 'list'
	choices: [ 'Z7010', 'Z7020' ]
,
	message: 'Coprocessor cores'
	name: 'coprocessorCore'
	type: 'list'
	choices: [ '16', '64' ]
],

	# coprocessorCore will always be 64
	# Notice that the question will not be asked at all
	override:
		coprocessorCore: '64'

.then (answers) -&gt;
	console.log(answers)

form.ask(question) ⇒ `Promise.<*>`

Kind: static method of form
Summary: Run a single form question
Returns: Promise.<*> - answer
Access: public

Param	Type	Description
question	`Object`	form question

Example

form.ask
	message: 'Processor'
	type: 'list'
	choices: [ 'Z7010', 'Z7020' ]
.then (processor) -&gt;
	console.log(processor)

When

We use a when property to determine the conditions needed for a question to be asked. This property consists of an object determining the value name (as key), and the value it must have (as value) for the condition to hold. A when property can depend on one or more answers, by having many key value pairs.

Example:

form.run [
	message: 'Network Type'
	name: 'network'
	type: 'list'
	choices: [ 'ethernet', 'wifi' ]
,
	message: 'Wifi Ssid'
	name: 'wifiSsid'
	type: 'input'
	when:
		network: 'wifi'
,
	message: 'Wifi Key'
	name: 'wifiKey'
	type: 'input'
	when:
		network: 'wifi'
]

In this case, the wifi ssid and wiki key will only be asked if the network type is wifi.

Support

If you're having any problem, please raise an issue on GitHub and the Resin.io team will be happy to help.

Tests

Run the test suite by doing:

$ gulp test

Contribute

Issue Tracker: github.com/resin-io-modules/resin-cli-form/issues
Source Code: github.com/resin-io-modules/resin-cli-form

Before submitting a PR, please make sure that you include tests, and that coffeelint runs without any warning:

$ gulp lint

License

The project is licensed under the Apache 2.0 license.

resin-cli-form dependencies

bluebird inquirer lodash resin-cli-visuals

resin-cli-form development dependencies

coffeescript gulp gulp-coffee gulp-coffeelint gulp-util jsdoc-to-markdown mocha mochainon resin-lint

FAQs

What is resin-cli-form?

Resin.io CLI form interpreter. Visit Snyk Advisor to see a full health score report for resin-cli-form, including popularity, security, maintenance & community analysis.

Is resin-cli-form popular?

The npm package resin-cli-form receives a total of 1,363 weekly downloads. As such, resin-cli-form popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is resin-cli-form well maintained?

We found indications that resin-cli-form is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is resin-cli-form safe to use?

While scanning the latest version of resin-cli-form, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 24 October-2024, at 02:14 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (1,363)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

resin-cli-form

Role

Installation

Documentation

form.run(form, [options]) ⇒ Promise.<Object>

form.ask(question) ⇒ Promise.<*>

When

Support

Tests

Contribute

License

resin-cli-form dependencies

resin-cli-form development dependencies

FAQs

What is resin-cli-form?

Is resin-cli-form popular?

Is resin-cli-form well maintained?

Is resin-cli-form safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

form.run(form, [options]) ⇒ `Promise.<Object>`

form.ask(question) ⇒ `Promise.<*>`