Merge pull request #30 from line/refac

Refactoring

Author: Hyunje Jun

.npmignore

@@ -1,6 +1,5 @@
 language: node_js
 node_js:
-  - "4"
   - "6"
   - "7"
-cache: yarn
+  - "8"

.travis.yml

@@ -25,7 +25,8 @@ Here are each top-level directory explained:
 Also, you may use the following npm scripts for development:
 
 * `npm run test`: Run test suites in `test`.
-* `npm run lint`: Lint source code with [TSLint](https://github.com/palantir/tslint)
+* `npm run format`: Format source code with [Prettier](https://github.com/prettier/prettier)
+* `npm run format:check`: Silently run `format` and report formatting errors
 * `npm run build`: Build TypeScript code into JavaScript. The built files will
   be placed in `dist/`.
 * `npm run docs`: Build GitBook docs and serve a doc server

CONTRIBUTING.md

@@ -13,21 +13,30 @@ export default class Client {
     this.config = config;
   }
 
-  public pushMessage(to: string, messages: Line.Message | Line.Message[]): Promise<any> {
+  public pushMessage(
+    to: string,
+    messages: Line.Message | Line.Message[],
+  ): Promise<any> {
     return this.post(URL.push, {
       messages: toArray(messages),
       to,
     });
   }
 
-  public replyMessage(replyToken: string, messages: Line.Message | Line.Message[]): Promise<any> {
+  public replyMessage(
+    replyToken: string,
+    messages: Line.Message | Line.Message[],
+  ): Promise<any> {
     return this.post(URL.reply, {
       messages: toArray(messages),
       replyToken,
     });
   }
 
-  public multicast(to: string[], messages: Line.Message | Line.Message[]): Promise<any> {
+  public multicast(
+    to: string[],
+    messages: Line.Message | Line.Message[],
+  ): Promise<any> {
     return this.post(URL.multicast, {
       messages: toArray(messages),
       to,
@@ -38,36 +47,44 @@ export default class Client {
     return this.get(URL.profile(userId));
   }
 
-  public getGroupMemberProfile(groupId: string, userId: string): Promise<Line.Profile> {
+  public getGroupMemberProfile(
+    groupId: string,
+    userId: string,
+  ): Promise<Line.Profile> {
     return this.get(URL.groupMemberProfile(groupId, userId));
   }
 
-  public getRoomMemberProfile(roomId: string, userId: string): Promise<Line.Profile> {
+  public getRoomMemberProfile(
+    roomId: string,
+    userId: string,
+  ): Promise<Line.Profile> {
     return this.get(URL.roomMemberProfile(roomId, userId));
   }
 
   public getGroupMemberIds(groupId: string): Promise<string[]> {
     const load = (start?: string): Promise<string[]> =>
-      this.get(URL.groupMemberIds(groupId, start))
-      .then((res: { memberIds: string[], next?: string }) => {
+      this.get(
+        URL.groupMemberIds(groupId, start),
+      ).then((res: { memberIds: string[]; next?: string }) => {
         if (!res.next) {
           return res.memberIds;
         }
 
-        return load(res.next).then((extraIds) => res.memberIds.concat(extraIds));
+        return load(res.next).then(extraIds => res.memberIds.concat(extraIds));
       });
     return load();
   }
 
   public getRoomMemberIds(roomId: string): Promise<string[]> {
     const load = (start?: string): Promise<string[]> =>
-      this.get(URL.roomMemberIds(roomId, start))
-      .then((res: { memberIds: string[], next?: string }) => {
+      this.get(
+        URL.roomMemberIds(roomId, start),
+      ).then((res: { memberIds: string[]; next?: string }) => {
         if (!res.next) {
           return res.memberIds;
         }
 
-        return load(res.next).then((extraIds) => res.memberIds.concat(extraIds));
+        return load(res.next).then(extraIds => res.memberIds.concat(extraIds));
       });
     return load();
   }

lib/client.ts

@@ -1,17 +1,11 @@
 export class SignatureValidationFailed extends Error {
-  constructor(
-    message: string,
-    public signature?: string,
-  ) {
+  constructor(message: string, public signature?: string) {
     super(message);
   }
 }
 
 export class JSONParseError extends Error {
-  constructor(
-    message: string,
-    public raw: any,
-  ) {
+  constructor(message: string, public raw: any) {
     super(message);
   }
 }
@@ -27,9 +21,7 @@ export class RequestError extends Error {
 }
 
 export class ReadError extends Error {
-  constructor(
-    private originalError: Error,
-  ) {
+  constructor(private originalError: Error) {
     super(originalError.message);
   }
 }

lib/exceptions.ts

@@ -6,7 +6,7 @@ import {
   RequestError,
 } from "./exceptions";
 
-const pkg = require("../package.json"); // tslint:disable-line no-var-requires
+const pkg = require("../package.json");
 
 function checkJSON(raw: any): any {
   if (typeof raw === "object") {
@@ -25,11 +25,7 @@ function wrapError(err: AxiosError) {
       err,
     );
   } else if (err.code) {
-    throw new RequestError(
-      err.message,
-      err.code,
-      err,
-    );
+    throw new RequestError(err.message, err.code, err);
   } else if (err.config) {
     // unknown, but from axios
     throw new ReadError(err);
@@ -41,19 +37,22 @@ function wrapError(err: AxiosError) {
 
 const userAgent = `${pkg.name}/${pkg.version}`;
 
-export function stream(url: string, headers: any): Promise<NodeJS.ReadableStream> {
+export function stream(
+  url: string,
+  headers: any,
+): Promise<NodeJS.ReadableStream> {
   headers["User-Agent"] = userAgent;
   return axios
     .get(url, { headers, responseType: "stream" })
-    .then((res) => res.data as NodeJS.ReadableStream);
+    .then(res => res.data as NodeJS.ReadableStream);
 }
 
 export function get(url: string, headers: any): Promise<any> {
   headers["User-Agent"] = userAgent;
 
   return axios
     .get(url, { headers })
-    .then((res) => checkJSON(res.data))
+    .then(res => checkJSON(res.data))
     .catch(wrapError);
 }
 
@@ -62,6 +61,6 @@ export function post(url: string, headers: any, data?: any): Promise<any> {
   headers["User-Agent"] = userAgent;
   return axios
     .post(url, data, { headers })
-    .then((res) => checkJSON(res.data))
+    .then(res => checkJSON(res.data))
     .catch(wrapError);
 }

lib/http.ts

@@ -7,9 +7,15 @@ export type Request = http.IncomingMessage & { body: any };
 export type Response = http.ServerResponse;
 export type NextCallback = (err?: Error) => void;
 
-export type Middleware = (req: Request, res: Response, next: NextCallback) => void;
-
-export default function middleware(config: Line.Config & Line.MiddlewareConfig): Middleware {
+export type Middleware = (
+  req: Request,
+  res: Response,
+  next: NextCallback,
+) => void;
+
+export default function middleware(
+  config: Line.Config & Line.MiddlewareConfig,
+): Middleware {
   if (!config.channelSecret) {
     throw new Error("no channel secret");
   }
@@ -28,7 +34,12 @@ export default function middleware(config: Line.Config & Line.MiddlewareConfig):
 
     const validate = (body: string | Buffer) => {
       if (!validateSignature(body, secret, signature)) {
-        next(new SignatureValidationFailed("signature validation failed", signature));
+        next(
+          new SignatureValidationFailed(
+            "signature validation failed",
+            signature,
+          ),
+        );
         return;
       }
 

lib/middleware.ts

@@ -1,6 +1,7 @@
 import * as qs from "querystring";
 
-const baseURL: string = process.env.API_BASE_URL || "https://api.line.me/v2/bot/";
+const baseURL: string =
+  process.env.API_BASE_URL || "https://api.line.me/v2/bot/";
 
 const apiURL = (path: string, query?: object) =>
   baseURL + path + (query ? `?${qs.stringify(query)}` : "");

lib/urls.ts

@@ -25,15 +25,21 @@ function safeCompare(a: Buffer, b: Buffer): boolean {
   } else {
     let result = 0;
     for (let i = 0; i < a.length; i++) {
-      result |= a[i] ^ b[i]; // tslint:disable-line no-bitwise
+      result |= a[i] ^ b[i];
     }
     return result === 0;
   }
 }
 
-export default function validateSignature(body: string | Buffer, channelSecret: string, signature: string): boolean {
+export default function validateSignature(
+  body: string | Buffer,
+  channelSecret: string,
+  signature: string,
+): boolean {
   return safeCompare(
-    createHmac("SHA256", channelSecret).update(body).digest(),
+    createHmac("SHA256", channelSecret)
+      .update(body)
+      .digest(),
     s2b(signature, "base64"),
   );
 }