snowboard

v4.1.21

API blueprint toolkit

NPM

README

GitHub

Website

MIT

Latest version published 2 months ago

    npm install snowboard

Explore Similar Packages

Package Health Score

67 / 100

Popularity
Limited
Maintenance
Healthy
Security
No known security issues
Community
Limited

Make sure the open source you're using is safe to use

Secure my Project

Popularity

Limited

Weekly Downloads (454)

Dependents: 1
GitHub Stars: 699
Forks: 108
Contributors: 10

The npm package snowboard receives a total of 454 downloads a week. As such, we scored snowboard popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package snowboard, we found that it has been starred 699 times, and that 1 other projects in the ecosystem are dependent on it.

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

Security

No known security issues

Security and license risk for significant versions

All Versions

Direct Vulnerabilities

1.8.15

2.0.6

3.7.5

4.0.4

4.1.21

Indirect Vulnerabilities

1.8.15

2.0.6

3.7.5

4.0.4

4.1.21

License Risks

1.8.15

2.0.6

3.7.5

4.0.4

4.1.21

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

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like snowboard is missing a security policy.

Snyk detected that the latest version of snowboard has a security vulnerability.

We highly advise you to review these security issues.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

We found a way for you to contribute to the project! Looks like snowboard is missing a security policy.

    # Install the Snyk CLI and test your project
npm i snyk && snyk test snowboard

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 27
Merged PR: 40
Open PR: 0
Last Commit: 20 days ago

Further analysis of the maintenance status of snowboard based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that snowboard demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Limited

Readme.md: No
Contributing.md: No
Code of Conduct: No
Contributors: 10
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like snowboard is missing a Code of Conduct.

How about a good first contribution to this project? It seems that snowboard is missing a README file.

Embed Package Health Score Badge

Package

Node.js Compatibility: not defined

Age: 2 years
Dependencies: 20 Direct / 905 Total
Versions: 116
Install Size: 33.1 kB
Dist-tags: 1
# of Files: 17
Maintainers: 1
TS Typings: No

We detected a total of 905 direct & transitive dependencies for snowboard. See the full dependency tree of snowboard

snowboard 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.

snowboard

API blueprint toolkit.

Usage

$ npm install -g snowboard
$ snowboard COMMAND
running command...
$ snowboard (-v|--version|version)
snowboard/4.0.0-rc.14 darwin-x64 node-v12.16.0
$ snowboard --help [COMMAND]
USAGE
  $ snowboard COMMAND
...

Commands

`snowboard apib INPUT`

render API blueprint

USAGE
  $ snowboard apib INPUT

OPTIONS
  -o, --output=output  output file
  -q, --quiet          quiet mode

See code: lib/commands/apib.js

`snowboard help [COMMAND]`

display help for snowboard

USAGE
  $ snowboard help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

`snowboard html INPUT`

render HTML documentation

USAGE
  $ snowboard html INPUT

OPTIONS
  -O, --optimized          optimized mode
  -o, --output=output      output directory
  -q, --quiet              quiet mode
  -t, --template=template  custom template
  -w, --watch              watch for the files changes

See code: lib/commands/html.js

`snowboard http INPUT`

serve HTML documentation

USAGE
  $ snowboard http INPUT

OPTIONS
  -C, --cert=cert          SSL cert file
  -K, --key=key            SSL key file
  -O, --optimized          optimized mode
  -S, --ssl                enable https
  -b, --bind=bind          [default: :8088] listen address
  -q, --quiet              quiet mode
  -t, --template=template  custom template
  -w, --watch              watch for the files changes

See code: lib/commands/http.js

`snowboard json INPUT`

render API elements json

USAGE
  $ snowboard json INPUT

OPTIONS
  -O, --optimized      optimized mode
  -o, --output=output  output file
  -q, --quiet          quiet mode

See code: lib/commands/json.js

`snowboard lint INPUT`

validate API blueprint

USAGE
  $ snowboard lint INPUT

OPTIONS
  -O, --optimized  optimized mode
  -j, --json       json mode
  -q, --quiet      quiet mode

See code: lib/commands/lint.js

`snowboard list INPUT [INPUTS...]`

list API routes

USAGE
  $ snowboard list INPUT [INPUTS...]

OPTIONS
  -O, --optimized  optimized mode
  -j, --json       json mode
  -q, --quiet      quiet mode

See code: lib/commands/list.js

`snowboard mock INPUT [INPUTS...]`

run mock server

USAGE
  $ snowboard mock INPUT [INPUTS...]

OPTIONS
  -C, --cert=cert  SSL cert file
  -K, --key=key    SSL key file
  -S, --ssl        enable https
  -b, --bind=bind  [default: :8087] listen address
  -q, --quiet      quiet mode

See code: lib/commands/mock.js

snowboard versions

Dist-Tags for snowboard

latest

Version	Published	Tag	Node.js Compatability	Licenses	Dependencies	Direct Vulnerabilities	Publisher
4.1.21	04 December 2020	latest	*	MIT	20	0 H 0 M 0 L	subosito
4.0.4	19 March 2020		*	MIT	20	0 H 0 M 0 L	subosito
3.7.5	06 March 2020		*	MIT	42	0 H 0 M 0 L	subosito
All Versions

Last updated on 17 January-2021, at 15:34 (UTC).

snowboard

API blueprint toolkit

Explore Similar Packages

Package Health Score

Popularity

Security

Security and license risk for significant versions

Version

Release Date

Direct Vulnerabilities

Indirect Vulnerabilities

License Risks

Maintenance

Community

Embed Package Health Score Badge

Package

snowboard

Usage

Commands

`snowboard apib INPUT`

`snowboard help [COMMAND]`

`snowboard html INPUT`

`snowboard http INPUT`

`snowboard json INPUT`

`snowboard lint INPUT`

`snowboard list INPUT [INPUTS...]`

`snowboard mock INPUT [INPUTS...]`

snowboard versions

snowboard dependencies