digitalocean-js - npm Package Compare versions

Comparing version 0.2.3 to 0.3.0

.vscode/settings.json

 {
-  "eslint.enable": false
-}
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "editor.formatOnSave": true
+  // "typescript.implementationsCodeLens.enabled": true
+  // "typescript.referencesCodeLens.enabled": true
+}

package.json

 {
   "name": "digitalocean-js",
-  "version": "0.2.3",
-  "description": "JavaScript library for the DigitalOcean API",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
-  "author": {
-    "name": "John Woodruff",
-    "email": "[e-mail]"
+  "version": "0.3.0",
+  "description": "JavaScript library for the DigitalOcean API.",
+  "main": "build/main/index.js",
+  "typings": "build/main/index.d.ts",
+  "module": "build/module/index.js",
+  "repository": "https://github.com/jbw91/digitalocean-js",
+  "license": "MIT",
+  "keywords": [
+    "digitalocean",
+    "api",
+    "droplet",
+    "droplets",
+    "client",
+    "typescript"
+  ],
+  "scripts": {
+    "info": "npm-scripts-info",
+    "build": "run-s clean && run-p build:*",
+    "build:main": "tsc -p tsconfig.json",
+    "build:module": "tsc -p tsconfig.module.json",
+    "fix": "run-s fix:*",
+    "fix:prettier": "prettier \"src/**/*.ts\" --write",
+    "fix:tslint": "tslint --fix --project .",
+    "test": "run-s build test:*",
+    "test:lint": "tslint --project . && prettier \"src/**/*.ts\" --list-different",
+    "test:unit": "nyc --silent ava",
+    "test:nsp": "nsp check",
+    "watch": "run-s clean build:main && run-p \"build:main -- -w\" \"test:unit -- --watch\"",
+    "cov": "run-s build test:unit cov:html && opn coverage/index.html",
+    "cov:html": "nyc report --reporter=html",
+    "cov:send": "nyc report --reporter=lcov > coverage.lcov && codecov",
+    "cov:check": "nyc report && nyc check-coverage --lines 0 --functions 0 --branches 0",
+    "doc": "run-s doc:html && opn build/docs/index.html",
+    "doc:html": "typedoc src/ --target ES6 --mode file --out build/docs",
+    "doc:json": "typedoc src/ --target ES6 --mode file --json build/docs/typedoc.json",
+    "doc:publish": "gh-pages -m \"[ci skip] Updates\" -d build/docs",
+    "version": "standard-version",
+    "reset": "git clean -dfx && git reset --hard && yarn install",
+    "clean": "trash build test",
+    "all": "run-s reset test cov:check doc:html",
+    "prepare-release": "run-s all version doc:publish",
+    "preinstall": "node -e \"if(process.env.npm_execpath.indexOf('yarn') === -1) throw new Error('digitalocean-js must be installed with Yarn: https://yarnpkg.com/')\""
   },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/jbw91/digitalocean-js"
+  "scripts-info": {
+    "info": "Display information about the package scripts",
+    "build": "Clean and rebuild the project",
+    "fix": "Try to automatically fix any linting problems",
+    "test": "Lint and unit test the project",
+    "watch": "Watch and rebuild the project on save, then rerun relevant tests",
+    "cov": "Rebuild, run tests, then create and open the coverage report",
+    "doc": "Generate HTML API documentation and open it in a browser",
+    "doc:json": "Generate API documentation in typedoc JSON format",
+    "changelog": "Bump package.json version, update CHANGELOG.md, tag release",
+    "reset": "Delete all untracked files and reset the repo to the last commit",
+    "prepare-release": "One-step: clean, build, test, publish docs, and prep a release"
   },
-  "scripts": {
-    "start": "tsc -w",
-    "build": "npm run lint && tsc",
-    "lint": "tslint -p tsconfig.json --type-check -t stylish"
+  "engines": {
+    "node": ">=8.9"
   },
-  "license": "MIT",
+  "dependencies": {
+    "axios": "^0.18.0",
+    "sha.js": "^2.4.10"
+  },
   "devDependencies": {
-    "tslint": "^5.7.0",
-    "typescript": "^2.4.2"
+    "ava": "^1.0.0-beta.3",
+    "codecov": "^3.0.0",
+    "cz-conventional-changelog": "^2.1.0",
+    "gh-pages": "^1.0.0",
+    "npm-run-all": "^4.1.2",
+    "npm-scripts-info": "^0.3.6",
+    "nsp": "^3.2.1",
+    "nyc": "^11.5.0",
+    "opn-cli": "^3.1.0",
+    "prettier": "^1.10.2",
+    "standard-version": "^4.0.0",
+    "trash-cli": "^1.4.0",
+    "tslint": "^5.4.3",
+    "tslint-config-prettier": "^1.8.0",
+    "tslint-immutable": "^4.5.1",
+    "typedoc": "^0.11.1",
+    "typescript": "^2.4.1"
   },
-  "dependencies": {
-    "axios": "^0.16.2"
+  "ava": {
+    "failFast": true,
+    "files": [
+      "build/main/**/*.spec.js"
+    ],
+    "sources": [
+      "build/main/**/*.js"
+    ]
+  },
+  "config": {
+    "commitizen": {
+      "path": "cz-conventional-changelog"
+    }
+  },
+  "greenkeeper": {
+    "ignore": [
+      "@types/node"
+    ]
+  },
+  "prettier": {
+    "singleQuote": true
+  },
+  "nyc": {
+    "exclude": [
+      "**/*.spec.js"
+    ]
   }
 }

README.md

 # DigitalOcean JS
 
-JavaScript library for the DigitalOcean API.
+[![Build Status](https://travis-ci.org/jbw91/digitalocean-js.svg?branch=master)](https://travis-ci.org/jbw91/digitalocean-js)
 
-## UNDER CONSTRUCTION
+JavaScript library for the DigitalOcean API. For use in Node or the browser.
 
-This library is still very early and very much under construction. Nothing is guaranteed to work and no documentation will be provided until the initial release.
+## Usage
 
+To use the library, install from the npm repository.
+
+```shell
+$ npm install --save digitalocean-js
+# Alternatively install with yarn
+$ yarn add digitalocean-js
+```
+
+Simply import the client and initialize it with your API token:
+
+```js
+import { DigitalOcean } from 'digitalocean-js';
+
+const client = new DigitalOcean('my-api-token');
+```
+
+To see all the services available, check out the [documentation](http://johnbwoodruff.com/digitalocean-js/).
+
 ## Un-Implemented Services
 
+There are a few unavailable aspects of the API currently. They are:
+
 * Floating IPs
 * Floating IP Actions
 * Firewalls
-* Images
-* Image Actions
 * Load Balancers
-* Snapshots
-* SSH Keys
-* Tags
+
+If a service you need is unavailable, feel free to contribute a pull request!

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Install scripts

Supply chain risk

Install scripts are run when the package is installed. The majority of malware in npm is hidden in install scripts.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No contributors or author data

Maintenance

Package does not specify a list of contributors or an author in package.json.

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

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

566262

increased by196.02%

Lines of code

8110

increased by87.99%

Number of lines in readme file

37

increased by94.74%

Worsened metrics

Dependency count

2

increased by100%

Dev dependency count

17

increased by750%

Number of package files

152

decreased by-2.56%

Number of low maintenance alerts

2

increased by100%

Number of high supply chain risk alerts

1

increased byInfinity%

Number of low supply chain risk alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedsha.js@^2.4.10

• + Addedaxios@0.18.1(transitive)

• + Addedfollow-redirects@1.5.10(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedis-buffer@2.0.5(transitive)

• + Addedsafe-buffer@5.2.1(transitive)

• + Addedsha.js@2.4.11(transitive)

• - Removedaxios@0.16.2(transitive)

• - Removedfollow-redirects@1.15.9(transitive)

• - Removedis-buffer@1.1.6(transitive)

• Updatedaxios@^0.18.0