spdx-license-ids - npm Package Compare versions

Comparing version 3.0.0-1 to 3.0.0

index.json

@@ -343,24 +343,3 @@ [
 	"ZPL-2.0",
-	"ZPL-2.1",
-	"AGPL-3.0",
-	"eCos-2.0",
-	"GFDL-1.1",
-	"GFDL-1.2",
-	"GFDL-1.3",
-	"GPL-1.0",
-	"GPL-2.0-with-autoconf-exception",
-	"GPL-2.0-with-bison-exception",
-	"GPL-2.0-with-classpath-exception",
-	"GPL-2.0-with-font-exception",
-	"GPL-2.0-with-GCC-exception",
-	"GPL-2.0",
-	"GPL-3.0-with-autoconf-exception",
-	"GPL-3.0-with-GCC-exception",
-	"GPL-3.0",
-	"LGPL-2.0",
-	"LGPL-2.1",
-	"LGPL-3.0",
-	"Nunit",
-	"StandardML-NJ",
-	"wxWindows"
+	"ZPL-2.1"
 ]

package.json

 {
 	"name": "spdx-license-ids",
-	"version": "3.0.0-1",
+	"version": "3.0.0",
 	"description": "A list of SPDX license identifiers",
@@ -8,5 +8,4 @@ "repository": "shinnn/spdx-license-ids",
 	"scripts": {
-		"prebuild": "eslint --fix --format=codeframe .",
 		"build": "node build.js",
-		"pretest": "npm run-script build",
+		"pretest": "eslint --fix --format=codeframe .",
 		"test": "node test.js"
@@ -16,2 +15,3 @@ },
 	"files": [
+		"deprecated.json",
 		"index.json"
@@ -35,2 +35,3 @@ ],
 		"get-spdx-license-ids": "^2.1.0",
+		"log-symbols": "^2.2.0",
 		"loud-rejection": "^1.6.0",
@@ -37,0 +38,0 @@ "rmfr": "^2.0.0-3",

README.md

@@ -6,3 +6,3 @@ # spdx-license-ids
 
-A list of currently available [SPDX license](https://spdx.org/licenses/) identifiers
+A list of [SPDX license](https://spdx.org/licenses/) identifiers
 
@@ -17,11 +17,38 @@ ## Installation
 
-## [Node.js](https://nodejs.org/) usage
+## [Node.js](https://nodejs.org/) API
 
+### require('spdx-license-ids')
+
+Type: `<Array<string>>`
+
+All license IDs except for the currently deprecated ones.
+
 ```javascript
-const spdxLicenseIds = require('spdx-license-ids');
+const ids = require('spdx-license-ids');
 //=> ['0BSD', 'AAL', 'Abstyles', 'Adobe-2006', 'Adobe-Glyph', 'ADSL', 'AFL-1.1', ...]
+
+ids.includes('BSD-3-Clause'); //=> true
+ids.includes('CC-BY-1.0'); //=> true
+
+ids.includes('GPL-3.0'); //=> false
 ```
 
+### require('spdx-license-ids/deprecated')
+
+Type: `<Array<string>>`
+
+Deprecated license IDs.
+
+```javascript
+const deprecatedIds = require('spdx-license-ids/deprecated');
+//=> ['AGPL-3.0', 'eCos-2.0', 'GFDL-1.1', 'GFDL-1.2', 'GFDL-1.3', 'GPL-1.0', ...]
+
+deprecatedIds.includes('BSD-3-Clause'); //=> false
+deprecatedIds.includes('CC-BY-1.0'); //=> false
+
+deprecatedIds.includes('GPL-3.0'); //=> true
+```
+
 ## License
 
 [Creative Commons Zero v1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/deed)

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

7664

increased by8.69%

Number of package files

4

increased by33.33%

Lines of code

367

increased by0.55%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

53

increased by103.85%

Worsened metrics

Dev dependency count

9

increased by12.5%

No dependency changes