Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

getcontributors

Package Overview
Dependencies
Maintainers
2
Versions
95
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

getcontributors - npm Package Compare versions

Comparing version 1.10.0 to 2.0.0-next.1585265245.05a7db90b3812f5dff80b34fcf30c059ea6dacce

edition-browsers/index.js
edition-esnext/index.js
source/index.ts
tsconfig.json

6

HISTORY.md
# History
## v2.0.0 2020 March 27
- Rewrote in TypeScript with breaking API changes for simplicity as new native abilities allows us to do more with less
- Updated dependencies, [base files](https://github.com/bevry/base), and [editions](https://editions.bevry.me) using [boundation](https://github.com/bevry/boundation)
- Minimum required node version changed from `node: >=8` to `node: >=10` to keep up with mandatory ecosystem changes
## v1.10.0 2019 December 9

@@ -4,0 +10,0 @@

104

package.json
{
"title": "Get Contributors",
"name": "getcontributors",
"version": "1.10.0",
"description": "Fetch all the contributors of all the specified github users repositories",
"version": "2.0.0-next.1585265245.05a7db90b3812f5dff80b34fcf30c059ea6dacce",
"description": "Fetch all the contributors from a github repository, github organisation, or github search",
"homepage": "https://github.com/bevry/getcontributors",
"license": "MIT",
"keywords": [
"browser",
"contributors",
"package.json",
"github",
"maintainers",
"module",
"organisation",
"organization",
"users",
"owners",
"maintainers"
"package.json",
"typed",
"types",
"typescript",
"users"
],

@@ -65,11 +70,34 @@ "badges": {

"engines": {
"node": ">=8"
"node": ">=10"
},
"editions": [
{
"description": "esnext source code with require for modules",
"description": "TypeScript source code with Import for modules",
"directory": "source",
"entry": "index.ts",
"tags": [
"typescript",
"import"
],
"engines": false
},
{
"description": "TypeScript compiled against ESNext for web browsers with Import for modules",
"directory": "edition-browsers",
"entry": "index.js",
"tags": [
"javascript",
"import"
],
"engines": {
"node": false,
"browsers": "defaults"
}
},
{
"description": "TypeScript compiled against ESNext for Node.js with Require for modules",
"directory": "edition-esnext",
"entry": "index.js",
"tags": [
"javascript",
"esnext",

@@ -79,37 +107,45 @@ "require"

"engines": {
"node": "8 || 10 || 12 || 13"
"node": "10 || 12 || 13",
"browsers": false
}
}
],
"types": "source/index.ts",
"type": "commonjs",
"main": "source/index.js",
"main": "edition-esnext/index.js",
"browser": "edition-browsers/index.js",
"module": "edition-browsers/index.js",
"dependencies": {
"extendr": "^4.3.0",
"feedr": "^4.7.0",
"getrepos": "^2.0.1",
"githubauthquerystring": "^2.2.0",
"taskgroup": "^6.4.0",
"typechecker": "^6.2.0"
"cross-fetch": "^3.0.4",
"fellow": "^6.0.0",
"getrepos": "^4.0.3",
"githubauthquerystring": "^4.0.0",
"simplytyped": "^3.2.3"
},
"devDependencies": {
"assert-helpers": "^5.8.0",
"eslint": "^6.7.2",
"eslint-config-bevry": "^2.3.0",
"eslint-config-prettier": "^6.7.0",
"eslint-plugin-prettier": "^3.1.1",
"jsdoc": "^3.6.3",
"kava": "^4.3.0",
"minami": "^1.2.3",
"prettier": "^1.19.1",
"projectz": "^1.15.0",
"@typescript-eslint/eslint-plugin": "^2.25.0",
"@typescript-eslint/parser": "^2.25.0",
"assert-helpers": "^6.0.0",
"eslint": "^6.8.0",
"eslint-config-bevry": "^3.0.0",
"eslint-config-prettier": "^6.10.1",
"eslint-plugin-prettier": "^3.1.2",
"kava": "^4.4.0",
"prettier": "^2.0.2",
"projectz": "^1.19.0",
"surge": "^0.21.3",
"valid-directory": "^1.5.0"
"typedoc": "^0.17.3",
"typescript": "^3.8.3",
"valid-directory": "^1.6.0",
"valid-module": "^1.0.0"
},
"scripts": {
"our:clean": "rm -Rf ./docs ./edition* ./es2015 ./es5 ./out ./.next",
"our:compile": "echo no need for this project",
"our:compile": "npm run our:compile:edition-browsers && npm run our:compile:edition-esnext",
"our:compile:edition-browsers": "tsc --module ESNext --target ESNext --outDir ./edition-browsers --project tsconfig.json && test -d edition-browsers/source && ( mv edition-browsers/source edition-temp && rm -Rf edition-browsers && mv edition-temp edition-browsers ) || true",
"our:compile:edition-esnext": "tsc --module commonjs --target ESNext --outDir ./edition-esnext --project tsconfig.json && test -d edition-esnext/source && ( mv edition-esnext/source edition-temp && rm -Rf edition-esnext && mv edition-temp edition-esnext ) || true",
"our:deploy": "echo no need for this project",
"our:meta": "npm run our:meta:docs && npm run our:meta:projectz",
"our:meta:docs": "npm run our:meta:docs:jsdoc",
"our:meta:docs:jsdoc": "rm -Rf ./docs && jsdoc --recurse --pedantic --access all --destination ./docs --package ./package.json --readme ./README.md --template ./node_modules/minami ./source && mv ./docs/$npm_package_name/$npm_package_version/* ./docs/ && rm -Rf ./docs/$npm_package_name/$npm_package_version",
"our:meta:docs": "npm run our:meta:docs:typedoc",
"our:meta:docs:typedoc": "rm -Rf ./docs && typedoc --mode file --exclude '**/+(*test*|node_modules)' --excludeExternals --name \"$npm_package_name\" --readme ./README.md --out ./docs ./source",
"our:meta:projectz": "projectz compile",

@@ -125,7 +161,9 @@ "our:release": "npm run our:release:prepare && npm run our:release:check-changelog && npm run our:release:check-dirty && npm run our:release:tag && npm run our:release:push",

"our:test": "npm run our:verify && npm test",
"our:verify": "npm run our:verify:directory && npm run our:verify:eslint && npm run our:verify:prettier",
"our:verify:directory": "npx valid-directory",
"our:verify": "npm run our:verify:directory && npm run our:verify:eslint && npm run our:verify:module && npm run our:verify:prettier && npm run our:verify:typescript",
"our:verify:directory": "valid-directory",
"our:verify:eslint": "eslint --fix --ignore-pattern '**/*.d.ts' --ignore-pattern '**/vendor/' --ignore-pattern '**/node_modules/' --ext .mjs,.js,.jsx,.ts,.tsx ./source",
"our:verify:prettier": "prettier --write ./source/**",
"test": "node ./source/test.js"
"our:verify:module": "valid-module",
"our:verify:prettier": "prettier --write .",
"our:verify:typescript": "tsc --noEmit --project tsconfig.json",
"test": "node ./edition-esnext/test.js"
},

@@ -132,0 +170,0 @@ "eslintConfig": {

89

README.md

@@ -31,3 +31,3 @@ <!-- TITLE/ -->

Fetch all the contributors of all the specified github users repositories
Fetch all the contributors from a github repository, github organisation, or github search

@@ -37,2 +37,6 @@ <!-- /DESCRIPTION -->

## Usage
[Complete API Documentation.](http://master.getcontributors.bevry.surge.sh/docs/globals.html)
<!-- INSTALL/ -->

@@ -45,73 +49,42 @@

<li>Install: <code>npm install --save getcontributors</code></li>
<li>Require: <code>require('getcontributors')</code></li>
<li>Import: <code>import * as pkg from ('getcontributors')</code></li>
<li>Require: <code>const pkg = require('getcontributors')</code></li>
</ul>
<h3><a href="https://editions.bevry.me" title="Editions are the best way to produce and consume packages you care about.">Editions</a></h3>
<a href="https://www.pika.dev/cdn" title="100% Native ES Modules CDN"><h3>pika</h3></a>
<p>This package is published with the following editions:</p>
``` html
<script type="module">
import * as pkg from '//cdn.pika.dev/getcontributors/^2.0.0'
</script>
```
<ul><li><code>getcontributors</code> aliases <code>getcontributors/source/index.js</code></li>
<li><code>getcontributors/source/index.js</code> is esnext source code with require for modules</li></ul>
<a href="https://unpkg.com" title="unpkg is a fast, global content delivery network for everything on npm"><h3>unpkg</h3></a>
<p>Environments older than Node.js v8 may need <a href="https://babeljs.io/docs/usage/polyfill/" title="A polyfill that emulates missing ECMAScript environment features">Babel's Polyfill</a> or something similar.</p>
``` html
<script type="module">
import * as pkg from '//unpkg.com/getcontributors@^2.0.0'
</script>
```
<h3><a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a></h3>
<a href="https://jspm.io" title="Native ES Modules CDN"><h3>jspm</h3></a>
This project provides its type information via inline <a href="http://usejsdoc.org" title="JSDoc is an API documentation generator for JavaScript, similar to Javadoc or phpDocumentor">JSDoc Comments</a>. To make use of this in <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a>, set your <code>maxNodeModuleJsDepth</code> compiler option to `5` or thereabouts. You can accomlish this via your `tsconfig.json` file like so:
``` json
{
"compilerOptions": {
"maxNodeModuleJsDepth": 5
}
}
``` html
<script type="module">
import * as pkg from '//dev.jspm.io/getcontributors@2.0.0'
</script>
```
<!-- /INSTALL -->
<h3><a href="https://editions.bevry.me" title="Editions are the best way to produce and consume packages you care about.">Editions</a></h3>
<p>This package is published with the following editions:</p>
## Usage
<ul><li><code>getcontributors/source/index.ts</code> is <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a> source code with <a href="https://babeljs.io/docs/learn-es2015/#modules" title="ECMAScript Modules">Import</a> for modules</li>
<li><code>getcontributors/edition-browsers/index.js</code> is <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a> compiled against <a href="https://en.wikipedia.org/wiki/ECMAScript#ES.Next" title="ECMAScript Next">ESNext</a> for web browsers with <a href="https://babeljs.io/docs/learn-es2015/#modules" title="ECMAScript Modules">Import</a> for modules</li>
<li><code>getcontributors</code> aliases <code>getcontributors/edition-esnext/index.js</code></li>
<li><code>getcontributors/edition-esnext/index.js</code> is <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a> compiled against <a href="https://en.wikipedia.org/wiki/ECMAScript#ES.Next" title="ECMAScript Next">ESNext</a> for <a href="https://nodejs.org" title="Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine">Node.js</a> with <a href="https://nodejs.org/dist/latest-v5.x/docs/api/modules.html" title="Node/CJS Modules">Require</a> for modules</li></ul>
[API Documentation.](http://master.getcontributors.bevry.surge.sh/docs/)
<!-- /INSTALL -->
```javascript
// Create our getcontributors instance
var getter = require('getcontributors').create({
log: console.log // optional, arguments: level, message...
})
// Fetch all the contributors on these github repositories
getter.fetchContributorsFromRepos(['bevry/getcontributors'], function(
err,
contributors
) {
console.log(err, contributors)
// Fetch all the contributors on these github users/organisations
getter.fetchContributorsFromUsers(['bevry'], function(err, contributors) {
console.log(err, contributors)
// Get the combined listing
console.log(getter.getContributors())
})
})
```
Contributors are returned as an array of contributor objects, here is an example contributor object:
```javascript
{
name: "Benjamin Lupton",
email: "b@lupton.cc",
url: "https://github.com/balupton",
username: "balupton",
text: "Benjamin Lupton <b@lupton.cc> (https://github.com/balupton)",
repos: {
"bevry/docpad": "https://github.com/bevry/docpad",
"bevry/getcontributors": "https://github.com/bevry/getcontributors"
// ...
}
}
```
<!-- HISTORY/ -->

@@ -118,0 +91,0 @@ 

.github/FUNDING.yml
source/index.js
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc