@nuxtjs/opencollective
Advanced tools
Package description
The @nuxtjs/opencollective npm package is designed to encourage users of an open-source project to contribute to its collective fund. It displays a post-install message in the terminal, prompting users to donate to the project's Open Collective. This helps maintainers to sustain their work on the project by raising funds from users who find the project valuable.
Post-install donation prompt
Displays a message after `npm install` is run, encouraging users to support the project on Open Collective.
const { showPostInstallMessage } = require('@nuxtjs/opencollective');
// This function is typically called in a postinstall script in package.json
showPostInstallMessage();Similar to @nuxtjs/opencollective, opencollective-postinstall is a package that displays a message after npm install, encouraging users to support the project through Open Collective. It serves the same purpose but is not scoped under the Nuxt.js project.
The fund package is another tool that can be used to encourage financial support for open-source projects. It differs from @nuxtjs/opencollective in that it allows for a more customizable message and can direct users to various funding platforms, not just Open Collective.
Readme
Displaying opencollective statistics and a donation URL after users install a package is important for many creators. After problems with current packages that offer similar features, we decided to spin off our one own. Our key goals are:
@nuxt/opencollective dependency using yarn or npm to your projectpostinstall in your package.json{
// ...
"scripts": {
"postinstall": "opencollective || exit 0"
},
"collective": {
"url": "https://opencollective.com/nuxtjs"
}
// ...
}
Configuration is applied through your project's package.json.
A full configuration looks like:
{
"collective": {
"url": "https://opencollective.com/nuxtjs",
"logoUrl": "https://opencollective.com/nuxtjs/logo.txt?reverse=true&variant=variant2",
"donation": {
"slug": "/order/591",
"amount": "50",
"text": "Please donate:"
}
}
}
| Attribute | Optional | Default | Comment |
|---|---|---|---|
| url | ❌ | - | The URL to your opencollective page |
| logo | ✅ | - | LEGACY: The URL to the logo that should be displayed. Please use logoUrl instead. |
| logoUrl | ✅ | - | The URL to the ASCII-logo that should be displayed. |
| donation.slug | ✅ | '/donate' | The slug that should be appended to url. Can be used to setup a specific order. |
| donation.amount | ✅ | - | The default amount that should be selected on the opencollective page. |
| donation.text | ✅ | 'Donate:' | The text that will be displayed before your donation url. |
We know the postinstall messages can be annoying when deploying in production or running a CI pipeline. That's why the message is disabled in those environments by default.
Enabled when one the following environment variables is set:
NODE_ENV=devNODE_ENV=developmentOPENCOLLECTIVE_FORCEStrictly Disabled when one the following environment variables is set:
OC_POSTINSTALL_TESTOPENCOLLECTIVE_HIDECICONTINUOUS_INTEGRATIONNODE_ENV (set and not dev or development)DISABLE_OPENCOLLECTIVE (set to any string value that is not 'false' or '0',
for compatability with
opencollective-postinatall)yarn install or npm installpath/to/project/root/src/index.js path/to/package/you/want/to/trynpm t or yarn testThis project is heavily inspired by opencollective-cli.
MIT License MIT. Made with 💖
FAQs
[![npm version][npm-v-src]][npm-v-href] [![npm downloads][npm-d-src]][npm-d-href] [![status][github-actions-src]][github-actions-href]
The npm package @nuxtjs/opencollective receives a total of 2,714,455 weekly downloads. As such, @nuxtjs/opencollective popularity was classified as popular.
We found that @nuxtjs/opencollective demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.