egg-watcher - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "egg-watcher",
-  "version": "0.0.1",
-  "description": "egg plugin <egg-watcher>",
-  "keywords": [
-    "egg",
-    "eggjs",
-    "egg-plugin"
+  "version": "0.0.2",
+  "description": "file watcher plugin for egg",
+  "eggPlugin": {
+    "name": "watcher"
+  },
+  "files": [
+    "app.js",
+    "agent.js",
+    "config",
+    "lib"
   ],
+  "scripts": {
+    "test": "npm run lint && npm run test-local",
+    "test-local": "egg-bin test",
+    "cov": "egg-bin cov",
+    "lint": "eslint --ext js . --fix",
+    "ci": "npm run lint && npm run cov",
+    "autod": "autod"
+  },
+  "dependencies": {
+    "sdk-base": "~1.1.0",
+    "wt": "~1.1.0"
+  },
+  "devDependencies": {
+    "autod": "^2.6.1",
+    "egg-bin": "^1.0.2",
+    "egg-ci": "^1.0.2",
+    "eslint": "3",
+    "eslint-config-egg": "3",
+    "should": "^9.0.2",
+    "supertest": "^1.2.0"
+  },
   "homepage": "https://github.com/eggjs/egg-watcher",
-  "license": "MIT",
-  "author": "eggjs",
-  "contributors": [
-    "TZ <[e-mail]>",
-    "popomore <[e-mail]>",
-    "fengmk2 <[e-mail]>",
-    "dead-horse <[e-mail]>"
-  ],
   "repository": {
     "type": "git",
     "url": "[e-mail]:eggjs/egg-watcher.git"
+  },
+  "keywords": [
+    "egg-watcher",
+    "egg",
+    "watcher",
+    "watch"
+  ],
+  "engines": {
+    "node": ">= 4.0.0"
+  },
+  "ci": {
+    "version": "4, 6"
   }
-}
+}

README.md

@@ -1,1 +0,68 @@
-# egg-watcher - egg plugin
+# egg-watcher
+Watcher plugin for egg
+
+[![NPM version][npm-image]][npm-url]
+[![build status][travis-image]][travis-url]
+[![Test coverage][codecov-image]][codecov-url]
+[![David deps][david-image]][david-url]
+[![Known Vulnerabilities][snyk-image]][snyk-url]
+[![npm download][download-image]][download-url]
+
+[npm-image]: https://img.shields.io/npm/v/egg-watcher.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/egg-watcher
+[travis-image]: https://img.shields.io/travis/eggjs/egg-watcher.svg?style=flat-square
+[travis-url]: https://travis-ci.org/eggjs/egg-watcher
+[codecov-image]: https://codecov.io/github/eggjs/egg-watcher/coverage.svg?branch=master
+[codecov-url]: https://codecov.io/github/eggjs/egg-watcher?branch=master
+[david-image]: https://img.shields.io/david/eggjs/egg-watcher.svg?style=flat-square
+[david-url]: https://david-dm.org/eggjs/egg-watcher
+[snyk-image]: https://snyk.io/test/npm/egg-watcher/badge.svg?style=flat-square
+[snyk-url]: https://snyk.io/test/npm/egg-watcher
+[download-image]: https://img.shields.io/npm/dm/egg-watcher.svg?style=flat-square
+[download-url]: https://npmjs.org/package/egg-watcher
+
+## Usage
+
+In worker process:
+
+### app.watcher.watch(path, listener)
+Start watching file(s).
+
+- path(String|Array): file path(s)
+- listener(Function): file change callback
+
+### app.watcher.unwatch(path[, listener])
+Stop watching file(s).
+
+- path(String|Array): file path(s)
+- listener(Function): file change callback
+
+In agent process:
+
+### agent.watcher.watch(path, listener)
+Start watching file(s).
+
+- path(String|Array): file path(s)
+- listener(Function): file change callback
+
+### agent.watcher.unwatch(path[, listener])
+Stop watching file(s).
+
+- path(String|Array): file path(s)
+- listener(Function): file change callback
+
+## watch mode
+
+[development mode](https://github.com/eggjs/egg-watcher/blob/master/lib/event-sources/development.js) is included.
+
+### development Mode
+
+When your app is running at local(env is `local`), it will be in `development mode`. Once local file is modified it will emit `change` event immediately.
+
+## Questions & Suggestions
+
+Please open an issue [here](https://github.com/eggjs/egg/issues).
+
+## License
+
+[MIT](LICENSE)

New alerts

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

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

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

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

Fixed alerts

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

11164

increased by1978.96%

Number of package files

13

increased by550%

Lines of code

247

increased byInfinity%

Number of lines in readme file

69

increased by6800%

Worsened metrics

Dependency count

2

increased byInfinity%

Dev dependency count

7

increased byInfinity%

Number of low maintenance alerts

2

increased by100%

Number of low supply chain risk alerts

2

increased byInfinity%

Number of medium supply chain risk alerts

2

increased by100%

Dependency changes

• + Addedsdk-base@~1.1.0

• + Addedwt@~1.1.0

• + Addeddebug@2.6.9(transitive)

• + Addedget-ready@1.0.0(transitive)

• + Addedms@2.0.0(transitive)

• + Addedndir@0.1.5(transitive)

• + Addedsdk-base@1.1.02.0.1(transitive)

• + Addedwt@1.1.1(transitive)