broccoli-source - npm Package Compare versions

Comparing version 2.0.0 to 2.1.0

CHANGELOG.md

 # master
 
+# 2.1.0
+* convert the project to typescript
+
 # 2.0.0
@@ -4,0 +7,0 @@

package.json

 {
   "name": "broccoli-source",
   "description": "Broccoli plugin for referring to source directories on the file system",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "author": "Jo Liss <[e-mail]>",
   "main": "index.js",
+  "types": "index.d.ts",
   "license": "MIT",
@@ -16,11 +17,24 @@ "repository": {
   "files": [
-    "index.js"
+    "index.js",
+    "index.ts",
+    "index.d.ts",
+    "index.js.map"
   ],
   "scripts": {
-    "lint": "eslint **/*.js",
-    "pretest": "multidep test/multidep.json",
-    "test": "mocha"
+    "build": "tsc -b .",
+    "clean": "tsc -b --clean .",
+    "lint": "eslint **/*.ts",
+    "test": "yarn build && yarn test:pre && yarn test:js",
+    "test:pre": "multidep test/multidep.json",
+    "test:js": "mocha test/*.test.js",
+    "watch": "tsc --watch ."
   },
   "dependencies": {},
   "devDependencies": {
+    "@types/chai": "^4.1.7",
+    "@types/chai-as-promised": "^7.1.0",
+    "@types/mocha": "^5.2.6",
+    "@types/node": "^11.13.4",
+    "@typescript-eslint/eslint-plugin": "^1.6.0",
+    "@typescript-eslint/parser": "^1.6.0",
     "chai": "^3.2.0",
@@ -31,7 +45,7 @@ "chai-as-promised": "^5.1.0",
     "eslint-plugin-mocha": "^5.3.0",
-    "eslint-plugin-node": "^8.0.1",
     "eslint-plugin-prettier": "^3.0.1",
-    "mocha": "^2.2.5",
+    "mocha": "^6.1.2",
     "multidep": "^2.0.0",
-    "prettier": "^1.16.4"
+    "prettier": "^1.16.4",
+    "typescript": "^3.4.3"
   },
@@ -38,0 +52,0 @@ "engines": {

README.md

@@ -14,13 +14,11 @@ # Broccoli Source
 ```js
-var broccoliSource = require('broccoli-source');
-var WatchedDir = broccoliSource.WatchedDir;
-var UnwatchedDir = broccoliSource.UnwatchedDir;
+const { WatchedDir, UnwatchedDir } = require('broccoli-source');
 
 // Refers to the ./lib directory on disk, and watches it.
-var lib = new WatchedDir('lib');
+const lib = new WatchedDir('lib');
 // Note: this is equivalent to the deprecated plain-string syntax:
-//var lib = 'lib';
+// const lib = 'lib';
 
 // Refers to the ./bower_components/jquery directory, but does not watch it.
-var jquery = new UnwatchedDir('bower_components/jquery');
+const jquery = new UnwatchedDir('bower_components/jquery');
 ```
@@ -41,4 +39,3 @@
 
-* `options`
-
+* `options`:
      * `annotation`: A human-readable description for this node.
@@ -45,0 +42,0 @@

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

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a 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

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

7424

increased by20.03%

Lines of code

86

increased by43.33%

Worsened metrics

Dev dependency count

16

increased by60%

Number of lines in readme file

51

decreased by-5.56%

No dependency changes