Installations

npm install @nuxtjs/opencollective

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=8.0.0

Node Version

14.15.0

NPM Version

6.14.8 Score

83.4

Supply Chain

97.9

Quality

82

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

7

Total

98

Closed

65

Merged

26

Issues

Open

3

Total

12

Closed

9

Releases

Unable to fetch releases

Contributors

10

View all 10 contributors

Languages

1

JavaScript

JavaScript (100%)

Developer

nuxt-contrib

Download Statistics

Total Downloads

406,431,100

Last Day

598,899

Last Week

2,747,665

Last Month

12,749,433

Last Year

154,738,213

GitHub Statistics

27 Stars

86 Commits

14 Forks

3 Watching

8 Branches

10 Contributors

Maintainers

3

Package Meta Information

Latest Version

0.3.2

Package Id

@nuxtjs/opencollective@0.3.2

Size

7.25 kB

NPM Version

6.14.8

Node Version

14.15.0

Publised On

04 Nov 2020

Total Downloads

Cumulative downloads

Total Downloads

406,431,100

Last day

-9.8%

598,899

Compared to previous day

Last week

-19.7%

2,747,665

Compared to previous week

Last month

2.7%

12,749,433

Compared to previous month

Last year

34.3%

154,738,213

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

3

chalk consola node-fetch

Dev Dependencies

11

@commitlint/cli @commitlint/config-conventional @nuxtjs/eslint-config ava bili eslint esm fetch-mock nyc sinon standard-version

Versions

@nuxt/opencollective ???? Pretty opencollective stats on postinstall!

Showcase

???? Release Notes

Features

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:

No interference/problems when installing packages. Never break installation because of the package
Pretty output for all information
Decent configurability
Seamless drop-in for common solutions

Setup

Add @nuxt/opencollective dependency using yarn or npm to your project
Add the script to postinstall in your package.json

1{
2  // ...
3  "scripts": {
4    "postinstall": "opencollective || exit 0"
5  },
6  "collective": {
7    "url": "https://opencollective.com/nuxtjs"
8  }
9  // ...
10}

Configure it

Configuration

Configuration is applied through your project's package.json.

A full configuration looks like:

1{
2  "collective": {
3    "url": "https://opencollective.com/nuxtjs",
4    "logoUrl": "https://opencollective.com/nuxtjs/logo.txt?reverse=true&variant=variant2",
5    "donation": {
6      "slug": "/order/591",
7      "amount": "50",
8      "text": "Please donate:"
9    }
10  }
11}

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.

Disable message

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=dev
NODE_ENV=development
OPENCOLLECTIVE_FORCE

Strictly Disabled when one the following environment variables is set:

OC_POSTINSTALL_TEST
OPENCOLLECTIVE_HIDE
CI
CONTINUOUS_INTEGRATION
NODE_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)

Development

Clone this repository
Install dependencies using yarn install or npm install
Run it manually path/to/project/root/src/index.js path/to/package/you/want/to/try
Run tests with npm t or yarn test

Inspiration

This project is heavily inspired by opencollective-cli.

License

MIT License MIT. Made with ????

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Maintained

Determines if the project is "actively maintained".

10

License

Determines if the project has defined a license.

6

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

4

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More