digitalocean-js
Advanced tools
Comparing version 1.5.12 to 2.0.0
106
package.json
{ | ||
"name": "digitalocean-js", | ||
"version": "1.5.12", | ||
"description": "JavaScript library for the DigitalOcean API", | ||
"main": "build/main/index.js", | ||
"typings": "build/main/index.d.ts", | ||
"module": "build/module/index.js", | ||
"version": "2.0.0", | ||
"license": "MIT", | ||
"private": false, | ||
"repository": "https://github.com/johnbwoodruff/digitalocean-js", | ||
"license": "MIT", | ||
"author": { | ||
"name": "John Woodruff", | ||
"email": "johnwoodruff91@gmail.com" | ||
}, | ||
"keywords": [ | ||
@@ -18,83 +19,20 @@ "digitalocean", | ||
], | ||
"scripts": { | ||
"describe": "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 --config \"./.prettierrc\"", | ||
"test:unit": "nyc --silent ava", | ||
"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 --options 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" | ||
}, | ||
"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", | ||
"version": "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" | ||
}, | ||
"engines": { | ||
"node": ">=8.9" | ||
}, | ||
"dependencies": { | ||
"axios": "^0.21.1", | ||
"sha.js": "^2.4.11" | ||
"axios": "^0.24.0" | ||
}, | ||
"devDependencies": { | ||
"@types/node": "^14.0.27", | ||
"ava": "1.0.0-beta.7", | ||
"codecov": "^3.1.0", | ||
"cz-conventional-changelog": "^2.1.0", | ||
"gh-pages": "^2.0.1", | ||
"npm-run-all": "^4.1.5", | ||
"nyc": "^13.1.0", | ||
"opn-cli": "^4.0.0", | ||
"prettier": "^2.0.5", | ||
"standard-version": "^8.0.1", | ||
"trash-cli": "^1.4.0", | ||
"tslint": "^5.11.0", | ||
"tslint-config-prettier": "^1.17.0", | ||
"tslint-immutable": "^5.0.0", | ||
"typedoc": "^0.17.3", | ||
"typescript": "^3.1.6" | ||
}, | ||
"ava": { | ||
"failFast": true, | ||
"files": [ | ||
"build/main/**/*.spec.js" | ||
], | ||
"sources": [ | ||
"build/main/**/*.js" | ||
] | ||
}, | ||
"config": { | ||
"commitizen": { | ||
"path": "cz-conventional-changelog" | ||
} | ||
}, | ||
"nyc": { | ||
"exclude": [ | ||
"**/*.spec.js" | ||
] | ||
"main": "./src/index.js", | ||
"types": "./src/index.d.ts", | ||
"peerDependencies": { | ||
"follow-redirects": "1.15.2", | ||
"form-data": "4.0.0", | ||
"asynckit": "0.4.0", | ||
"combined-stream": "1.0.8", | ||
"delayed-stream": "1.0.0", | ||
"mime-types": "2.1.34", | ||
"mime-db": "1.51.0", | ||
"proxy-from-env": "1.1.0", | ||
"fast-deep-equal": "3.1.3", | ||
"is-buffer": "2.0.5", | ||
"tslib": "2.3.1" | ||
} | ||
} |
@@ -1,36 +0,11 @@ | ||
![digitalocean-js](https://user-images.githubusercontent.com/5883616/126348407-dd1e694d-64a9-402e-b8df-f59e67686014.png) | ||
# digitalocean-js | ||
# DigitalOcean JS | ||
This library was generated with [Nx](https://nx.dev). | ||
[![CI](https://github.com/johnbwoodruff/digitalocean-js/actions/workflows/main.yml/badge.svg)](https://github.com/johnbwoodruff/digitalocean-js/actions/workflows/main.yml) [![npm](https://img.shields.io/npm/dm/digitalocean-js.svg)](https://www.npmjs.com/package/digitalocean-js) [![npm](https://img.shields.io/npm/dt/digitalocean-js.svg)](https://www.npmjs.com/package/digitalocean-js) [![npm](https://img.shields.io/npm/v/digitalocean-js.svg)](https://www.npmjs.com/package/digitalocean-js) | ||
## Building | ||
JavaScript library for the DigitalOcean API. For use in Node or the browser. | ||
Run `nx build digitalocean-js` to build the library. | ||
## Goals | ||
## Running unit tests | ||
This library was built with a few goals in mind: | ||
- Be able to use in a Node or Browser environment with no difference in usage. | ||
- Use Promises instead of callbacks so clients can make use of `async`/`await`. | ||
- Be built in TypeScript so consumers of the library can benefit from excellent intellisense with the TypeScript definitions. | ||
- Provide solid documentation including examples for usage. | ||
## 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](https://johnbwoodruff.github.io/digitalocean-js/). | ||
Run `nx test digitalocean-js` to execute the unit tests via [Jest](https://jestjs.io). |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage 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
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No contributors or author data
MaintenancePackage does not specify a list of contributors or an author in package.json.
Found 1 instance in 1 package
0
1
255175
12
167
6572
12
1
+ Addedasynckit@0.4.0(transitive)
+ Addedaxios@0.24.0(transitive)
+ Addedcombined-stream@1.0.8(transitive)
+ Addeddelayed-stream@1.0.0(transitive)
+ Addedfast-deep-equal@3.1.3(transitive)
+ Addedfollow-redirects@1.15.2(transitive)
+ Addedform-data@4.0.0(transitive)
+ Addedis-buffer@2.0.5(transitive)
+ Addedmime-db@1.51.0(transitive)
+ Addedmime-types@2.1.34(transitive)
+ Addedproxy-from-env@1.1.0(transitive)
+ Addedtslib@2.3.1(transitive)
- Removedsha.js@^2.4.11
- Removedaxios@0.21.4(transitive)
- Removedfollow-redirects@1.15.9(transitive)
- Removedinherits@2.0.4(transitive)
- Removedsafe-buffer@5.2.1(transitive)
- Removedsha.js@2.4.11(transitive)
Updatedaxios@^0.24.0