stringify-github-short-url

v3.3.8

Generate Github / npm shorthand from list of arguments or object For more information about how to use this package see README

Latest version published 5 years ago

License: MPL-2.0

NPM

GitHub

Package Health Score

52 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

No known security issues

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.3.8	\|	03/2020	Popular	0 C 0 H 0 M 0 L	1 H 0 M 0 L
3.2.3	\|	01/2020		0 C 0 H 0 M 0 L	1 H 0 M 0 L
2.0.0	\|	03/2015		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.4	\|	01/2015		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.0.0	\|	01/2015		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MPL-2.0

Non-Permissive License

We noticed that this project uses a license which requires less permissive conditions such as disclosing the source code, stating changes or redistributing the source under the same license. It is advised to further consult the license terms before use.

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

Limited

Weekly Downloads (16)

GitHub Stars: 481
Forks: 18
Contributors: 6

Direct Usage Popularity

The npm package stringify-github-short-url receives a total of 16 downloads a week. As such, we scored stringify-github-short-url popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package stringify-github-short-url, we found that it has been starred 481 times.

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

Community

Sustainable

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

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 43
Open PR: 12
Last Release: 5 years ago
Last Commit: 17 days ago

Further analysis of the maintenance status of stringify-github-short-url based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for stringify-github-short-url is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

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.

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: >=10.13

Age: 10 years
Dependencies: 0 Direct
Versions: 28
Install Size: 28.7 kB
Dist-tags: 1
# of Files: 7
Maintainers: 2
TS Typings: No

stringify-github-short-url 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

stringify-github-short-url

> Generate Github / npm shorthand from list of arguments or object

Please consider following this project's author, Charlike Mike Reagent, and ⭐ the project to show your ❤️ and support.

If you have any how-to kind of questions, please read the Contributing Guide and Code of Conduct documents. For bugs reports and feature requests, please create an issue or ping @tunnckoCore at Twitter.

Project is semantically versioned & automatically released from GitHub Actions with Lerna.

Topic	Contact
Any legal or licensing questions, like private or commerical use
For any critical problems and security reports
Consulting, professional support, personal or team training
For any questions about Open Source, partnerships and sponsoring

(TOC generated by verb using markdown-toc)

Install

This project requires Node.js >=10.13 (see Support & Release Policy). Install it using yarn or npm.
We highly recommend to use Yarn when you think to contribute to this project.

$ yarn add stringify-github-short-url

API

Generated using jest-runner-docs.

stringifyGithubShortUrl

Generate github / npm shorthand from list of arguments or object.

Signature

function(owner, name, branch, npm)

Params

`` {string|object} - user or org string, or object
[name] {string} - repo name
[branch] {string} - branch name
[npm] {string} - pass true if you want to generate npm shorthand
returns {string} - generated shorthand

Examples

import stringify from 'stringify-github-short-url';

stringify('jonschlinkert', 'micromatch'); // =&gt; 'jonschlinkert/micromatch'
stringify('jonschlinkert', 'micromatch', 'dev'); // =&gt; 'jonschlinkert/micromatch#dev'
stringify('gulpjs', 'gulp', 'v3.8.1', true); // =&gt; 'gulpjs/gulp@v3.8.1'
stringify({
  owner: 'tunnckoCore',
  name: 'parse-function',
}); // =&gt; 'tunnckoCore/parse-function'
stringify({
  user: 'assemble',
  repo: 'assemble-core',
}); // =&gt; 'assemble/assemble-core'

back to top

Contributing

Guides and Community

Please read the Contributing Guide and Code of Conduct documents for advices.

For bug reports and feature requests, please join our community forum and open a thread there with prefixing the title of the thread with the name of the project if there's no separate channel for it.

Consider reading the Support and Release Policy guide if you are interested in what are the supported Node.js versions and how we proceed. In short, we support latest two even-numbered Node.js release lines.

Support the project

Become a Partner or Sponsor? 💵 Check the OpenSource Commision (tier). 🎉 You can get your company logo, link & name on this file. It's also rendered on package's page in npmjs.com and yarnpkg.com sites too! 🚀

Not financial support? Okey! Pull requests, stars and all kind of contributions are always welcome. ✨

Contributors

This project follows the all-contributors specification. Contributions of any kind are welcome!

Thanks goes to these wonderful people (emoji key), consider showing your support to them:

_{Charlike Mike Reagent}
🚇 💻 📖 🤔 🚧 ⚠️

back to top

License

FAQs

What is stringify-github-short-url?

Generate Github / npm shorthand from list of arguments or object. Visit Snyk Advisor to see a full health score report for stringify-github-short-url, including popularity, security, maintenance & community analysis.

Is stringify-github-short-url popular?

The npm package stringify-github-short-url receives a total of 16 weekly downloads. As such, stringify-github-short-url popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is stringify-github-short-url well maintained?

We found indications that stringify-github-short-url is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is stringify-github-short-url safe to use?

The npm package stringify-github-short-url was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 8 November-2024, at 15: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

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (16)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

stringify-github-short-url

Table of Contents

Install

API

stringifyGithubShortUrl

Signature

Params

Examples

Contributing

Guides and Community

Support the project

Contributors

License

FAQs

What is stringify-github-short-url?

Is stringify-github-short-url popular?

Is stringify-github-short-url well maintained?

Is stringify-github-short-url 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