node-ghapi - npm Package Compare versions

Comparing version 0.3.6 to 1.0.0

index.js

@@ -1,3 +0,3 @@
-const ghapi = require('./src/api');
-
-module.exports = ghapi;
+module.exports = {
+  users: require('./src/user')
+}

package.json

 {
-  "name": "node-ghapi",
-  "version": "0.3.6",
-  "description": "A predictable GitHub API wrapper for NodeJS.",
-  "main": "index.js",
-  "repository": "https://github.com/haydennyyy/ghapi",
-  "author": "Hayden Young <[e-mail]>",
-  "license": "MIT",
-  "private": false,
-  "dependencies": {
-    "request": "^2.87.0"
-  }
+    "name": "node-ghapi",
+    "version": "1.0.0",
+    "description": "A simple library to interact with the GitHub API",
+    "main": "index.js",
+    "scripts": {
+        "test": "test/index.js"
+    },
+    "author": "Hayden Young <[e-mail]> (https://haydenbjyoung.me)",
+    "license": "MIT",
+    "dependencies": {
+        "node-fetch": "^2.2.0"
+    },
+    "devDependencies": {
+        "chai": "^4.1.2",
+        "mocha": "^5.2.0"
+    }
 }

README.md

@@ -1,50 +0,2 @@
-# ghapi - GitHub API Wrapper
-
-[![NPM](https://nodei.co/npm/node-ghapi.png)](https://nodei.co/npm/node-ghapi/)
-
-## About
-
-`ghapi` is a GitHub API wrapper built in NodeJS mainly for use with my current Discord bot project, [DevBot](https://github.com/haydennyyy/devbot).
-
-`ghapi` does *not* however support searching your private repos at this time, nor does it support anything outside of Repos and Users. I will be making these features soon.
-
-## Installation
-
-To install `ghapi`, you can use [Yarn](https://yarnpkg.org) or NPM.
-
-- `yarn add node-ghapi`
-- `npm i -s node-ghapi`
-
-## Usage
-
-```js
-var ghapi = require('node-ghapi');
-
-ghapi.repo('haydennyyy', 'ghapi', repo => {
-  console.log(repo);
-});
-
-ghapi.user('haydennyyy', user => {
-  console.log(user);
-});
-```
-
-## Documentation
-
-Documentation for `ghapi` can be found [here](https://haydennyyy.github.io/ghapi).
-
-## Contributing
-
-If you're gonna contribute be sure to document everything as much as possible in JSDoc, so that I can re-build the documentation and not have to include tons.
-
-## Features
-
-- [ ] 100% API Coverage
-  - [x] Repo info
-  - [x] User info
-  - [x] Commit info
-  - [ ] Fork info
-  - [ ] Issue info
-  - [ ] Org info
-- [ ] Asynchronous function
-- [ ] Promise-based function
+# node-ghapi
+The second version of my library, [node-ghapi](https://npmjs.org/node-ghapi). This version uses promises.

New alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9560

increased by127.35%

Number of package files

9

increased by50%

Number of low quality alerts

1

decreased by-50%

Worsened metrics

Dev dependency count

2

increased byInfinity%

Lines of code

63

decreased by-27.59%

Number of lines in readme file

2

decreased by-96%

Number of medium supply chain risk alerts

2

increased byInfinity%

Dependency changes

• + Addednode-fetch@^2.2.0

• + Addednode-fetch@2.7.0(transitive)

• + Addedtr46@0.0.3(transitive)

• + Addedwebidl-conversions@3.0.1(transitive)

• + Addedwhatwg-url@5.0.0(transitive)

• - Removedrequest@^2.87.0

• - Removedajv@6.12.6(transitive)

• - Removedasn1@0.2.6(transitive)

• - Removedassert-plus@1.0.0(transitive)

• - Removedasynckit@0.4.0(transitive)

• - Removedaws-sign2@0.7.0(transitive)

• - Removedaws4@1.13.2(transitive)

• - Removedbcrypt-pbkdf@1.0.2(transitive)

• - Removedcaseless@0.12.0(transitive)

• - Removedcombined-stream@1.0.8(transitive)

• - Removedcore-util-is@1.0.2(transitive)

• - Removeddashdash@1.14.1(transitive)

• - Removeddelayed-stream@1.0.0(transitive)

• - Removedecc-jsbn@0.1.2(transitive)

• - Removedextend@3.0.2(transitive)

• - Removedextsprintf@1.3.0(transitive)

• - Removedfast-deep-equal@3.1.3(transitive)

• - Removedfast-json-stable-stringify@2.1.0(transitive)

• - Removedforever-agent@0.6.1(transitive)

• - Removedform-data@2.3.3(transitive)

• - Removedgetpass@0.1.7(transitive)

• - Removedhar-schema@2.0.0(transitive)

• - Removedhar-validator@5.1.5(transitive)

• - Removedhttp-signature@1.2.0(transitive)

• - Removedis-typedarray@1.0.0(transitive)

• - Removedisstream@0.1.2(transitive)

• - Removedjsbn@0.1.1(transitive)

• - Removedjson-schema@0.4.0(transitive)

• - Removedjson-schema-traverse@0.4.1(transitive)

• - Removedjson-stringify-safe@5.0.1(transitive)

• - Removedjsprim@1.4.2(transitive)

• - Removedmime-db@1.52.0(transitive)

• - Removedmime-types@2.1.35(transitive)

• - Removedoauth-sign@0.9.0(transitive)

• - Removedperformance-now@2.1.0(transitive)

• - Removedpsl@1.15.0(transitive)

• - Removedpunycode@2.3.1(transitive)

• - Removedqs@6.5.3(transitive)

• - Removedrequest@2.88.2(transitive)

• - Removedsafe-buffer@5.2.1(transitive)

• - Removedsafer-buffer@2.1.2(transitive)

• - Removedsshpk@1.18.0(transitive)

• - Removedtough-cookie@2.5.0(transitive)

• - Removedtunnel-agent@0.6.0(transitive)

• - Removedtweetnacl@0.14.5(transitive)

• - Removeduri-js@4.4.1(transitive)

• - Removeduuid@3.4.0(transitive)

• - Removedverror@1.10.0(transitive)