simple-youtube-api - npm Package Compare versions

Comparing version 5.2.1 to 6.0.0-beta.1

package.json

 {
-  "name": "simple-youtube-api",
-  "version": "5.2.1",
-  "description": "A module to simplify the YouTube API.",
-  "author": "Bryan Pikaard <[e-mail]>",
-  "maintainers": [
-    "Tyler Richards <[e-mail]>"
-  ],
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/simple-youtube/simple-youtube-api.git"
-  },
-  "bugs": {
-    "url": "https://github.com/simple-youtube/simple-youtube-api/issues"
-  },
-  "homepage": "https://github.com/simple-youtube/simple-youtube-api",
-  "sideEffects": false,
-  "main": "src/index.js",
-  "unpkg": "dist/sya.min.js",
-  "scripts": {
-    "build": "webpack",
-    "docs": "jsdoc -c jsdoc.json",
-    "test": "mocha"
-  },
-  "dependencies": {
-    "iso8601-duration": "^1.2.0",
-    "node-fetch": "^2.6.0"
-  },
-  "devDependencies": {
-    "dotenv": "^4.0.0",
-    "jsdoc": "^3.6.2",
-    "lodash.defaultsdeep": "^4.6.0",
-    "minami": "^1.1.0",
-    "mocha": "^3.5.3",
-    "webpack": "^4.33.0",
-    "webpack-cli": "^3.3.4"
-  }
+	"name": "simple-youtube-api",
+	"version": "6.0.0-beta.1",
+	"description": "A library that wraps the YouTube Data API",
+	"license": "Apache-2.0",
+	"author": {
+		"name": "Tyler Richards",
+		"email": "[e-mail]"
+	},
+	"funding": "https://github.com/tjrgg/simple-youtube-api?sponsor=1",
+	"repository": "tjrgg/simple-youtube-api",
+	"engines": {
+		"node": ">=12.0.0",
+		"npm": "use-yarn",
+		"yarn": ">=1.22.0"
+	},
+	"main": "src/index.js",
+	"scripts": {
+		"build": "tsc",
+		"lint": "eslint src --ext .ts",
+		"lint:fix": "yarn run lint --fix",
+		"postversion": "git push && git push --tags"
+	},
+	"dependencies": {
+		"@enderverse/commitlint-config": "enderverse/commitlint-config",
+		"@enderverse/eslint-config": "enderverse/eslint-config",
+		"iso8601-duration": "^1.2.0",
+		"node-fetch": "^2.6.0"
+	},
+	"devDependencies": {
+		"@types/node-fetch": "^2.5.7",
+		"@typescript-eslint/eslint-plugin": "^3.0.2",
+		"@typescript-eslint/parser": "^3.0.2",
+		"commitlint": "^8.3.5",
+		"dotenv": "^8.2.0",
+		"eslint": "^7.1.0",
+		"husky": "^4.2.5",
+		"typescript": "^3.9.3"
+	},
+	"commitlint": {
+		"extends": [
+			"@enderverse/commitlint-config"
+		]
+	},
+	"eslintConfig": {
+		"extends": [
+			"@enderverse/eslint-config",
+			"@enderverse/eslint-config/typescript"
+		],
+		"parser": "@typescript-eslint/parser",
+		"rules": {
+			"default-param-last": "off",
+			"no-unused-vars": "off"
+		}
+	},
+	"husky": {
+		"hooks": {
+			"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
+		}
+	}
 }

README.md

@@ -1,22 +0,83 @@
-# Simple YouTube API [![Discord](https://discordapp.com/api/guilds/430216837276368897/embed.png)](https://discord.gg/A97Qftr) [![Build Status](https://travis-ci.org/simple-youtube/simple-youtube-api.svg?branch=master)](https://travis-ci.org/simple-youtube/simple-youtube-api)
+<h1 align="center">
+	simple-youtube-api
+</h1>
 
-A simpler way to interact with the YouTube Data API.
+<h3 align="center">
+	simple-youtube-api is a library that wraps the YouTube Data API.
+</h3>
 
+<p align="center">
+	<a href="https://github.com/tjrgg/simple-youtube-api/fork">
+		<img alt="GitHub Forks" src="https://img.shields.io/github/forks/tjrgg/simple-youtube-api?label=Fork&style=social" />
+	</a>
+	<a href="https://github.com/tjrgg/simple-youtube-api">
+		<img alt="GitHub Stars" src="https://img.shields.io/github/stars/tjrgg/simple-youtube-api?label=Star&style=social" />
+	</a>
+	<a href="https://github.com/tjrgg/simple-youtube-api/subscription">
+		<img alt="GitHub Watchers" src="https://img.shields.io/github/watchers/tjrgg/simple-youtube-api?label=Watch&style=social" />
+	</a>
+</p>
+
+<p align="center">
+	<img alt="Contributors" src="https://img.shields.io/github/contributors-anon/tjrgg/simple-youtube-api?cacheSeconds=86400" />
+	<img alt="Issues" src="https://img.shields.io/github/issues/tjrgg/simple-youtube-api?cacheSeconds=86400" />
+	<img alt="Pull Requests" src="https://img.shields.io/github/issues-pr/tjrgg/simple-youtube-api?cacheSeconds=86400" />
+	<img alt="Size" src="https://img.shields.io/github/repo-size/tjrgg/simple-youtube-api?cacheSeconds=86400&label=size" />
+	<img alt="Version" src="https://img.shields.io/github/package-json/version/tjrgg/simple-youtube-api?cacheSeconds=86400&label=version" />
+</p>
+
+<p align="center">
+	<img alt="Dependencies" src="https://img.shields.io/david/tjrgg/simple-youtube-api?cacheSeconds=86400" />
+	<img alt="Vulnerabilities" src="https://img.shields.io/snyk/vulnerabilities/github/tjrgg/simple-youtube-api?cacheSeconds=86400" />
+</p>
+
+<p align="center">
+	<a href="https://discordapp.com/invite/vxXrG8W">
+		<img alt="Discord" src="https://img.shields.io/discord/110118478119174144?style=social" />
+	</a>
+	<a href="https://twitter.com/tjrgg">
+		<img alt="Twitter" src="https://img.shields.io/twitter/follow/tjrgg?style=social" />
+	</a>
+</p>
+
+
 ## Install
 
+npm
+```sh
+npm install simple-youtube-api
 ```
-$ npm install simple-youtube-api
+
+yarn
+```sh
+yarn add simple-youtube-api
 ```
 
+
 ## Usage
 
-- [Documentation](https://simple-youtube.github.io/simple-youtube-api/master/)
-- [Examples](https://github.com/simple-youtube/simple-youtube-api/tree/master/examples)
+```js
+const YouTube = require('simple-youtube-api');
+const youtube = new YouTube('YOUTUBE-API-KEY');
 
-## Maintainers
+youtube.searchVideos('Centuries', 4)
+    .then(results => {
+        console.log(`The video's title is ${results[0].title}`);
+    })
+    .catch(console.log);
+```
 
-- [Tyler Richards](https://github.com/tjrgg)
 
+## Author
+
+👤 **Tyler Richards**
+
+* GitHub: [@tjrgg](https://github.com/tjrgg)
+* Twitter: [@tjrgg](https://twitter.com/tjrgg)
+
+
 ## License
 
-[MIT License](LICENSE).
+Copyright © 2020 Tyler Richards and contributors. All rights reserved.
+
+Released under the [Apache License, version 2.0](LICENSE.md).

New alerts

GitHub dependency

Supply chain risk

Contains a dependency which resolves to a GitHub URL. Dependencies fetched from GitHub specifiers are not immutable can be used to inject untrusted code or reduce the likelihood of a reproducible install.

Found 2 instances 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 bug tracker

Maintenance

Package does not have a linked bug tracker 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

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

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Fixed alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

49823

increased by45.29%

Number of package files

23

increased by130%

Lines of code

927

increased by7.67%

Number of lines in readme file

84

increased by265.22%

Worsened metrics

Dependency count

4

increased by100%

Dev dependency count

8

increased by14.29%

Number of low maintenance alerts

1

increased byInfinity%

Number of low quality alerts

2

increased byInfinity%

Number of high supply chain risk alerts

2

increased byInfinity%

Number of low supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@enderverse/commitlint-config@enderverse/commitlint-config

• + Added@enderverse/eslint-config@enderverse/eslint-config