snowboard

v4.1.22

API blueprint toolkit

NPM

README

GitHub

MIT

Latest version published 1 month ago

    npm install snowboard

Explore Similar Packages

Package Health Score

47 / 100

Popularity
Small
Maintenance
Inactive
Security
Security review needed
Community
Sustainable

Keep your project healthy

Check your package.json

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

Snyk Vulnerability Scanner

Find and fix vulnerabilities in your code and dependencies, all within your IDE.

Secure Your Project

Find & fix vulnerable dependencies and insecure code

Popularity

Small

Weekly Downloads (1,060)

Dependents: 1
GitHub Stars: 767
Forks: 111
Contributors: 20

Direct Usage Popularity

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

Based on project statistics from the GitHub repository for the npm package snowboard, we found that it has been starred 767 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

Security review needed

Security and license risk for significant versions

All Versions

Popular

Version

Release Date

02/2019

07/2019

03/2020

03/2020

12/2021

Direct Vulnerabilities

Popular

Indirect Vulnerabilities

Popular

0
C
8
H
10
M
0
L

4.1.22

License Risk

Popular

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.

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

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

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

deprecated

Commit Frequency

Open Issues: 35
Open PR: 22
Last Release: 1 month ago
Last Commit: 1 month 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 Inactive.

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

Sustainable

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

With more than 10 contributors for the snowboard repository, this is possibly a sign for a growing and inviting community.

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

Embed Package Health Score Badge

Package

Node.js Compatibility: not defined

Age: 3 years
Dependencies: 20 Direct
Versions: 117
Install Size: 33 kB
Dist-tags: 1
# of Files: 17
Maintainers: 1
TS Typings: No

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.

Readme

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

FAQs

What is snowboard?

API blueprint toolkit. Visit Snyk Advisor to see a full health score report for snowboard, including popularity, security, maintenance & community analysis.

Is snowboard popular?

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

Is snowboard well maintained?

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

Is snowboard safe to use?

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

Last updated on 17 January-2022, at 18:03 (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

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Secure Your Project

Weekly Downloads (1,060)

Direct Usage Popularity

Security and license risk for significant versions

Version

Release Date

Direct Vulnerabilities

Indirect Vulnerabilities

License Risk

Commit Frequency

Embed Package Health Score Badge

Readme

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 dependencies

FAQs

What is snowboard?

Is snowboard popular?

Is snowboard well maintained?

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

`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...]`