diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..56f2862 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,9 @@ +sudo: false +language: node_js +node_js: + - '4' + - '6' +install: + - npm i npminstall && npminstall +script: + - npm test diff --git a/LICENSE b/LICENSE index 05b9a64..5e601a6 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,7 @@ The MIT License (MIT) Copyright (c) 2014 dead_horse +Copyright (c) 2015 - 2016 cnpm and other contributors. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in diff --git a/Makefile b/Makefile deleted file mode 100644 index 817781a..0000000 --- a/Makefile +++ /dev/null @@ -1,8 +0,0 @@ -install: - @npm install --registry=http://registry.npm.taobao.org --save-dev autod - -autod: install - @node_modules/.bin/autod -w --prefix="^" -e example.js - -contributors: install - @./node_modules/.bin/contributors -f plain -o AUTHORS diff --git a/README.md b/README.md index 73b6823..3ea23ee 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,22 @@ koa-middlewares =============== -[![Dependency Status](https://gemnasium.com/cnpm/koa-middlewares.svg)](https://gemnasium.com/dead-horse/koa-middlewares) +[![NPM version][npm-image]][npm-url] +[![build status][travis-image]][travis-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/koa-middlewares.svg?style=flat +[npm-url]: https://npmjs.org/package/koa-middlewares +[travis-image]: https://img.shields.io/travis/cnpm/koa-middlewares.svg?style=flat +[travis-url]: https://travis-ci.org/cnpm/koa-middlewares +[david-image]: https://img.shields.io/david/cnpm/koa-middlewares.svg?style=flat +[david-url]: https://david-dm.org/cnpm/koa-middlewares +[snyk-image]: https://snyk.io/test/npm/koa-middlewares/badge.svg?style=flat-square +[snyk-url]: https://snyk.io/test/npm/koa-middlewares +[download-image]: https://img.shields.io/npm/dm/koa-middlewares.svg?style=flat-square +[download-url]: https://npmjs.org/package/koa-middlewares easy way to use some small but useful koa middlewares. @@ -9,7 +24,7 @@ easy way to use some small but useful koa middlewares. ## install -``` +```bash npm install koa-middlewares --save ``` @@ -64,7 +79,7 @@ app.listen(7001); * **koa-bodyparser**: post body parser, for `application/json` and `application/x-www-form-urlencoded`. -``` +```js app.use(middlewares.bodyParser({ limit: '10mb' })); @@ -76,7 +91,7 @@ app.use(function *(next) { * **koa-csrf**: CSRF tokens. -``` +```js middlewares.csrf(app); app.use(function *checkCsrf(next) { if (this.method === 'GET' || @@ -92,7 +107,7 @@ app.use(function *checkCsrf(next) { * **koa-ejs**: ejs view render middleware. support all feature of ejs. -``` +```js middlewares.render(app, { root: path.join(__dirname, 'view') }); @@ -106,20 +121,20 @@ app.use(function *() { * **koa-conditional-get**: HTTP response freshness testing middleware base on node-fresh. use it upstream from etag. -``` +```js app.use(middlewares.conditional()); app.use(middlewares.etag()); ``` * **koa-favicon**: Bounce favicon requests with a 404. -``` +```js app.use(middlewares.favicon()); ``` * **koa-safe-jsonp**: A safe jsonp plugins for koa. -``` +```js middlewares.jsonp(app); app.use(function* () { @@ -129,13 +144,13 @@ app.use(function* () { * **koa-logger**: Development style logger. -``` +```js app.use(middlewares.logger()); ``` * **koa-session**: cookie base session. -``` +```js app.use(middlewares.cookieSession()); ``` @@ -143,7 +158,7 @@ app.use(middlewares.cookieSession()); has friendly APIs for work with other Stores such as `redis`, `mongo`. * **koa-redis**: Work togather with `koa-generic-session`, provide a redis store from koa-sess. -``` +```js app.use(middlewares.session({ store: middlewares.RedisStore(), defer: true @@ -158,7 +173,7 @@ app.use(function *() { * **koa-router**: Provide express-style routing using app.get, app.put, app.post. -``` +```js app.use(middlewares.router(app)); app.get('/', function *() { this.body = 'Hello koa-router'; @@ -167,7 +182,7 @@ app.get('/', function *() { * **koa-resource-router**: RESTful resource routing for koa. -``` +```js var users = new middlewares.Resource('users'); app.use(users.middleware()); @@ -178,13 +193,13 @@ app.get('/users', function *() { * **koa-rewrite**: URL rewrite middleware. -``` +```js app.use(middlewares.rewrite('/js/*', '/public/assets/js/$1')); ``` * **koa-rt**: Log response time, support custom with microtime. -``` +```js var microtime = require('microtime'); app.use(middlewares.rt({ timer: microtime @@ -193,7 +208,7 @@ app.use(middlewares.rt({ * **koa-static-cache**: Static file serving from memory. -``` +```js app.use(middlewares.staticCache(path.join(__dirname, 'public'), { buffer: true, maxAge: 60 * 60 * 24 * 7, @@ -203,7 +218,7 @@ app.use(middlewares.staticCache(path.join(__dirname, 'public'), { * **koa-compress**: Compress middleware for Koa, support `gzip` and `deflate` -``` +```js var app = koa() app.use(compress({ threshold: 2048, @@ -213,10 +228,11 @@ app.use(compress({ * **koa-onerror**: Error handler -``` +```js var app = koa() onerror(app); ``` ## License -MIT + +[MIT](LICENSE) diff --git a/example.js b/example.js index 1c38f36..5f0ebad 100644 --- a/example.js +++ b/example.js @@ -1,19 +1,9 @@ -/*! - * koa-middlewares - example.js - * Copyright(c) 2014 dead_horse - * MIT Licensed - */ - 'use strict'; -/** - * Module dependencies. - */ - -var koa = require('koa'); -var middlewares = require('./'); +const koa = require('koa'); +const middlewares = require('./'); -var app = koa(); +const app = koa(); app.use(middlewares.bodyParser()); app.use(middlewares.gzip({minLength: 100})); diff --git a/index.js b/index.js index e854611..8d3e54b 100644 --- a/index.js +++ b/index.js @@ -1,15 +1,5 @@ -/*! - * koa-middlewares - index.js - * Copyright(c) 2014 dead_horse - * MIT Licensed - */ - 'use strict'; -/** - * Module dependencies. - */ - exports.resourceRouter = exports.ResourceRouter = require('koa-resource-router'); exports.bodyparser = exports.bodyParser = require('koa-bodyparser'); exports.redisStore = exports.RedisStore = require('koa-redis'); diff --git a/package.json b/package.json index 331a74f..344c9b4 100644 --- a/package.json +++ b/package.json @@ -4,11 +4,11 @@ "description": "easy way to require some useful koa middlewares", "main": "index.js", "scripts": { - "test": "echo \"Error: no test specified\" && exit 1" + "test": "node index.js" }, "repository": { "type": "git", - "url": "git://github.com/dead-horse/koa-middlewares.git" + "url": "git://github.com/cnpm/koa-middlewares.git" }, "keywords": [ "koa", @@ -21,9 +21,9 @@ "author": "dead_horse (http://deadhorse.me)", "license": "MIT", "bugs": { - "url": "https://github.com/dead-horse/koa-middlewares/issues" + "url": "https://github.com/cnpm/koa-middlewares/issues" }, - "homepage": "https://github.com/dead-horse/koa-middlewares", + "homepage": "https://github.com/cnpm/koa-middlewares", "dependencies": { "koa-bodyparser": "^2.0.1", "koa-compress": "^1.0.9", @@ -34,7 +34,7 @@ "koa-favicon": "^1.2.1", "koa-generic-session": "^1.10.2", "koa-logger": "^1.3.0", - "koa-onerror": "^1.3.1", + "koa-onerror": "^2.0.0", "koa-redis": "^2.0.1", "koa-resource-router": "^0.4.0", "koa-rewrite": "^1.1.1", @@ -45,8 +45,8 @@ "koa-static-cache": "^3.1.7" }, "devDependencies": { - "autod": "^2.5.1", - "koa": "^1.2.0" + "autod": "2", + "koa": "1" }, "files": [ "index.js"