From 340dd4f1a3c0b715e259bbcbea9d05aeb79619c1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robin=20Pokorn=C3=BD?= Date: Tue, 15 Mar 2016 16:35:52 +0100 Subject: [PATCH] Lint JavaScript in Markdown --- .eslintrc => .eslintrc.yml | 0 Readme.md | 34 +++++++++++++----------------- docs/api/context.md | 2 +- docs/api/index.md | 26 +++++++++++------------ docs/api/request.md | 4 ++-- docs/api/response.md | 10 ++++----- docs/guide.md | 42 +++++++++++++++++++------------------- 7 files changed, 56 insertions(+), 62 deletions(-) rename .eslintrc => .eslintrc.yml (100%) diff --git a/.eslintrc b/.eslintrc.yml similarity index 100% rename from .eslintrc rename to .eslintrc.yml diff --git a/Readme.md b/Readme.md index 0a9bb83..bff3a66 100644 --- a/Readme.md +++ b/Readme.md @@ -50,32 +50,29 @@ Koa is an middleware framework, it can take 3 different kind function as middlew Here we write an logger middleware with different function. ### Common function -```js +```js // Middleware normally take two parameters (ctx, next), ctx is the context for one request, // next is an function that is invoked to execute the downstream middleware. It returns a Promise with a then function for running code after completion. app.use((ctx, next) => { - const start = new Date; + const start = new Date(); return next().then(() => { - const ms = new Date - start; + const ms = new Date() - start; console.log(`${ctx.method} ${ctx.url} - ${ms}ms`); }); }); - ``` ### ___async___ functions (Babel required) ```js - app.use(async (ctx, next) => { - const start = new Date; + const start = new Date(); await next(); - const ms = new Date - start; + const ms = new Date() - start; console.log(`${ctx.method} ${ctx.url} - ${ms}ms`); }); - ``` ### GeneratorFunction @@ -83,14 +80,12 @@ app.use(async (ctx, next) => { To use generator functions, you must use a wrapper such as [co](https://github.com/tj/co) that is no longer supplied with Koa. ```js - -app.use(co.wrap(function *(ctx, next){ - const start = new Date; +app.use(co.wrap(function *(ctx, next) { + const start = new Date(); yield next(); - const ms = new Date - start; + const ms = new Date() - start; console.log(`${ctx.method} ${ctx.url} - ${ms}ms`); })); - ``` ### Old signature middleware (v1.x) @@ -98,15 +93,14 @@ app.use(co.wrap(function *(ctx, next){ If you want to use old signature or be compatible with old middleware, you must use [koa-convert](https://github.com/gyson/koa-convert) to convert legacy generator middleware to promise middleware. ```js -const convert = require('koa-convert') +const convert = require('koa-convert'); -app.use(convert(function *(next){ - const start = new Date; +app.use(convert(function *(next) { + const start = new Date(); yield next; - const ms = new Date - start; + const ms = new Date() - start; console.log(`${this.method} ${this.url} - ${ms}ms`); })); - ``` @@ -122,8 +116,8 @@ $ npm install babel-preset-stage-3 --save ```js // set babel in entry file -require("babel-core/register")({ - presets: ['es2015-node5', 'stage-3'] +require('babel-core/register')({ + presets: ['es2015-node5', 'stage-3'] }); ``` diff --git a/docs/api/context.md b/docs/api/context.md index beee697..2cac9bf 100644 --- a/docs/api/context.md +++ b/docs/api/context.md @@ -12,7 +12,7 @@ snippet: ```js -app.use(function *(){ +app.use(function * () { this; // is the Context this.request; // is a koa Request this.response; // is a koa Response diff --git a/docs/api/index.md b/docs/api/index.md index b149602..c0a5fc8 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -80,25 +80,25 @@ const app = new Koa(); // x-response-time -app.use(async function (ctx, next){ - const start = new Date; +app.use(async function (ctx, next) { + const start = new Date(); await next(); - const ms = new Date - start; + const ms = new Date() - start; ctx.set('X-Response-Time', `${ms}ms`); }); // logger -app.use(async function (ctx, next){ - const start = new Date; +app.use(async function (ctx, next) { + const start = new Date(); await next(); - const ms = new Date - start; + const ms = new Date() - start; console.log(`${ctx.method} ${ctx.url} - ${ms}`); }); // response -app.use((ctx) => { +app.use(ctx => { ctx.body = 'Hello World'; }); @@ -198,17 +198,17 @@ app.context.db = db(); To perform custom error-handling logic such as centralized logging you can add an "error" event listener: ```js -app.on('error', function(err){ - log.error('server error', err); -}); +app.on('error', err => + log.error('server error', err) +); ``` If an error is in the req/res cycle and it is _not_ possible to respond to the client, the `Context` instance is also passed: ```js -app.on('error', function(err, ctx){ - log.error('server error', err, ctx); -}); +app.on('error', (err, ctx) => + log.error('server error', err, ctx) +); ``` When an error occurs _and_ it is still possible to respond to the client, aka no data has been written to the socket, Koa will respond diff --git a/docs/api/request.md b/docs/api/request.md index e569880..9b2ca10 100644 --- a/docs/api/request.md +++ b/docs/api/request.md @@ -96,7 +96,7 @@ this.request.href Get request `Content-Type` void of parameters such as "charset". ```js -const ct = this.request.type; +const ct = this.request.type // => "image/png" ``` @@ -130,7 +130,7 @@ this.request.charset setter does _not_ support nested objects. ```js -this.query = { next: '/login' }; +this.query = { next: '/login' } ``` ### request.fresh diff --git a/docs/api/response.md b/docs/api/response.md index bd24af3..338ea7e 100644 --- a/docs/api/response.md +++ b/docs/api/response.md @@ -146,11 +146,11 @@ If `response.status` has not been set, Koa will automatically set the status to Here's an example of stream error handling without automatically destroying the stream: ```js -const PassThrough = require('stream').PassThrough +const PassThrough = require('stream').PassThrough; app.use(function * (next) { - this.body = someHTTPStream.on('error', this.onerror).pipe(PassThrough()) -}) + this.body = someHTTPStream.on('error', this.onerror).pipe(PassThrough()); +}); ``` #### Object @@ -233,12 +233,12 @@ this.type = 'png'; ```js const minify = require('html-minifier'); -app.use(function *minifyHTML(next){ +app.use(function * minifyHTML(next) { yield next; if (!this.response.is('html')) return; - const body = this.body; + let body = this.body; if (!body || body.pipe) return; if (Buffer.isBuffer(body)) body = body.toString(); diff --git a/docs/guide.md b/docs/guide.md index 70e46e2..9fe6df8 100644 --- a/docs/guide.md +++ b/docs/guide.md @@ -13,9 +13,9 @@ ```js async function responseTime(ctx, next) { - const start = new Date; + const start = new Date(); await next(); - const ms = new Date - start; + const ms = new Date() - start; ctx.set('X-Response-Time', `${ms}ms`); } @@ -52,7 +52,7 @@ to this behaviour. For example this would be fine: ```js -app.use(async function response(ctx, next){ +app.use(async function response(ctx, next) { if ('/' != this.url) return; ctx.body = 'Hello World'; }); @@ -79,7 +79,7 @@ app.use(async function response(ctx, next){ function logger(format) { format = format || ':method ":url"'; - return async function (ctx, next){ + return async function (ctx, next) { const str = format .replace(':method', ctx.method) .replace(':url', ctx.url); @@ -87,7 +87,7 @@ function logger(format) { console.log(str); await next(); - } + }; } app.use(logger()); @@ -100,9 +100,9 @@ app.use(logger(':method :url')); ```js function logger(format) { - return async function logger(ctx, next){ + return async function logger(ctx, next) { - } + }; } ``` @@ -115,7 +115,7 @@ const compose = require('koa-compose'); async function random(ctx, next) { if ('/random' == this.path) { - ctx.body = Math.floor(Math.random()*10); + ctx.body = Math.floor(Math.random() * 10); } else { await next(); } @@ -137,7 +137,7 @@ async function pi(ctx, next) { } } -const all = compose([random, backwards, pi]) +const all = compose([random, backwards, pi]); app.use(all); ``` @@ -152,20 +152,20 @@ app.use(all); downstream "three" middleware a chance to manipulate the response. ```js -app.use(async function (ctx, next){ +app.use(async function (ctx, next) { console.log('>> one'); await next(); - console.log('<< one'); + console.log('<< one'); }); -app.use(async function (ctx, next){ +app.use(async function (ctx, next) { console.log('>> two'); ctx.body = 'two'; await next(); console.log('<< two'); }); -app.use(async function (ctx, next){ +app.use(async function (ctx, next) { console.log('>> three'); await next(); console.log('<< three'); @@ -176,19 +176,19 @@ app.use(async function (ctx, next){ with "two", however the third (and any other downstream middleware) will be ignored: ```js -app.use(async function (ctx, next){ +app.use(async function (ctx, next) { console.log('>> one'); await next(); - console.log('<< one'); + console.log('<< one'); }); -app.use(async function (ctx, next){ +app.use(async function (ctx, next) { console.log('>> two'); ctx.body = 'two'; console.log('<< two'); }); -app.use(async function (ctx, next){ +app.use(async function (ctx, next) { console.log('>> three'); await next(); console.log('<< three'); @@ -208,7 +208,7 @@ app.use(async function (ctx, next){ ```js const fs = require('fs-promise'); -app.use(async function (ctx, next){ +app.use(async function (ctx, next) { const paths = await fs.readdir('docs'); const files = await Promise.all(paths.map(path => fs.readFile(`docs/${path}`, 'utf8'))); @@ -241,15 +241,15 @@ $ DEBUG=koa* node --harmony examples/simple ```js const path = require('path'); -const static = require('koa-static'); +const serve = require('koa-static'); -const publicFiles = static(path.join(__dirname, 'public')); +const publicFiles = serve(path.join(__dirname, 'public')); publicFiles._name = 'static /public'; app.use(publicFiles); ``` - Now, instead of just seeing "static" when debugging, you will see: + Now, instead of just seeing "serve" when debugging, you will see: ``` koa:application use static /public +0ms