refactor: migrate ts and refactor types

.gitignore

@@ -5,4 +5,6 @@ tmp/
 .idea/
 .nyc_output/
 .vscode/
-dist/
+dist/
+package-lock.json
+coverage/

lib/console/help.ts

@@ -2,10 +2,20 @@ import { underline, bold } from 'picocolors';
 import { readFile } from 'hexo-fs';
 import { join } from 'path';
 import Promise from 'bluebird';
+import type Context from '../context';
+import type { Callback, Store, Command } from '../types';
 
 const COMPLETION_DIR = join(__dirname, '../../completion');
 
-function helpConsole(args) {
+interface HelpArgs {
+ _: string[];
+ v?: boolean;
+ version?: boolean;
+ consoleList?: boolean;
+ completion?: string;
+}
+
+function helpConsole(this: Context, args: HelpArgs) {
  if (args.v || args.version) {
  return this.call('version');
  } else if (args.consoleList) {
@@ -24,7 +34,7 @@ function helpConsole(args) {
  return printAllHelp(this.extend.console.list());
 }
 
-function printHelpForCommand(command, data) {
+function printHelpForCommand(command: string, data: Callback) {
  const { options } = data;
 
  const desc = options.description || options.desc || data.description || data.desc;
@@ -40,7 +50,7 @@ function printHelpForCommand(command, data) {
  return Promise.resolve();
 }
 
-function printAllHelp(list) {
+function printAllHelp(list: Store) {
  const keys = Object.keys(list);
  const commands = [];
  const { length } = keys;
@@ -73,7 +83,7 @@ function printAllHelp(list) {
  return Promise.resolve();
 }
 
-function printList(title, list) {
+function printList(title: string, list: Command[]) {
  list.sort((a, b) => {
  const nameA = a.name;
  const nameB = b.name;
@@ -101,13 +111,13 @@ function printList(title, list) {
  return Promise.resolve();
 }
 
-function printConsoleList(list) {
+function printConsoleList(list: Store) {
  console.log(Object.keys(list).join('\n'));
 
  return Promise.resolve();
 }
 
-function printCompletion(type) {
+function printCompletion(type: string) {
  return readFile(join(COMPLETION_DIR, type)).then(content => {
  console.log(content);
  });

lib/console/index.ts

@@ -1,8 +1,9 @@
+import type Context from '../context';
 import helpConsole from './help';
 import initConsole from './init';
 import versionConsole from './version';
 
-export = function(ctx) {
+export = function(ctx: Context) {
  const { console } = ctx.extend;
 
  console.register('help', 'Get help on a command.', {}, helpConsole);

lib/console/init.ts

@@ -3,13 +3,20 @@ import { join, resolve } from 'path';
 import { magenta } from 'picocolors';
 import { existsSync, readdirSync, rmdir, unlink, copyDir, readdir, stat } from 'hexo-fs';
 import tildify from 'tildify';
-import { spawn } from 'hexo-util';
+import spawn from 'hexo-util/dist/spawn'; // for rewire
 import { sync as commandExistsSync } from 'command-exists';
+import type Context from '../context';
 
 const ASSET_DIR = join(__dirname, '../../assets');
 const GIT_REPO_URL = 'https:/hexojs/hexo-starter.git';
 
-async function initConsole(args) {
+interface InitArgs {
+ _: string[];
+ install?: boolean;
+ clone?: boolean;
+}
+
+async function initConsole(this: Context, args: InitArgs) {
  args = Object.assign({ install: true, clone: true }, args);
 
  const baseDir = this.base_dir;
@@ -83,11 +90,11 @@ async function initConsole(args) {
  }
 }
 
-async function copyAsset(target) {
+async function copyAsset(target: string) {
  await copyDir(ASSET_DIR, target, { ignoreHidden: false });
 }
 
-function removeGitDir(target) {
+function removeGitDir(target: string) {
  const gitDir = join(target, '.git');
 
  return stat(gitDir).catch(err => {
@@ -100,7 +107,7 @@ function removeGitDir(target) {
  }).then(() => readdir(target)).map(path => join(target, path)).filter(path => stat(path).then(stats => stats.isDirectory())).each(removeGitDir);
 }
 
-async function removeGitModules(target) {
+async function removeGitModules(target: string) {
  try {
  await unlink(join(target, '.gitmodules'));
  } catch (err) {

lib/console/version.ts

@@ -2,8 +2,9 @@ import os from 'os';
 const pkg = require('../../package.json');
 import BlueBirdPromise from 'bluebird';
 import { spawn } from 'hexo-util';
+import type Context from '../context';
 
-async function versionConsole() {
+async function versionConsole(this: Context) {
  const { versions, platform } = process;
  const keys = Object.keys(versions);
 

lib/context.ts

@@ -4,9 +4,9 @@
 import ConsoleExtend from './extend/console';
 
 // a stub Hexo object
-// see `hexojs/hexo/lib/hexo/index.js`
+// see `hexojs/hexo/lib/hexo/index.ts`
 
 type Callback = (err?: any, value?: any) => void;
 
 class Context {
  base_dir: string;
@@ -14,6 +14,7 @@
  extend: {
  console: ConsoleExtend;
  };
+ version?: string | null;
 
  constructor(base = process.cwd(), args = {}) {
  this.base_dir = base;
@@ -28,7 +29,7 @@
  // Do nothing
  }
 
- call(name: string, args: object, callback: Callback);
+ call(name: string, args: object, callback?: Callback);
  call(name: string, callback?: Callback);
  call(name: string, args?: object | Callback, callback?: Callback) {
  if (!callback && typeof args === 'function') {

lib/extend/console.ts

@@ -1,19 +1,6 @@
 import Promise from 'bluebird';
 import abbrev from 'abbrev';
-
-interface Callback {
- (args?: object): any;
- options?: object;
- desc?: string;
-}
-
-interface Store {
- [key: string]: Callback;
-}
-
-interface Alias {
- [key: string]: string;
-}
+import type { Options, Callback, Store, Alias } from '../types';
 
 class Console {
  store: Store;
@@ -33,11 +20,11 @@ class Console {
  return this.store;
  }
 
- register(name: string, desc: string, options: object, fn: Callback): void;
- register(name: string, options: object, fn: Callback): void;
+ register(name: string, desc: string, options: Options, fn: Callback): void;
+ register(name: string, options: Options, fn: Callback): void;
  register(name: string, desc: string, fn: Callback): void;
  register(name: string, fn: Callback): void;
- register(name: string, desc: string | object | Callback, options?: object | Callback, fn?: Callback) {
+ register(name: string, desc: string | Options | Callback, options?: Options | Callback, fn?: Callback) {
  if (!name) throw new TypeError('name is required');
 
  if (!fn) {
@@ -74,7 +61,7 @@ class Console {
 
  this.store[name.toLowerCase()] = fn;
  const c = fn;
- c.options = options;
+ c.options = options as Options;
  c.desc = desc as string;
 
  this.alias = abbrev(Object.keys(this.store));

lib/hexo.ts

@@ -83,7 +83,7 @@ function loadModule(path, args) {
  });
 }
 
-function watchSignal(hexo) {
+function watchSignal(hexo: Context) {
  process.on('SIGINT', () => {
  hexo.log.info(goodbye());
  hexo.unwatch();

lib/types.ts

@@ -0,0 +1,29 @@
+export interface Command {
+ name: string;
+ desc: string;
+ description?: string;
+}
+
+export interface Options {
+ desc?: string;
+ description?: string;
+ usage?: string;
+ arguments?: Command[];
+ options?: Command[];
+ commands?: Command[];
+}
+
+export interface Callback {
+ (args?: object): any;
+ options?: Options;
+ desc?: string;
+ description?: string;
+}
+
+export interface Store {
+ [key: string]: Callback;
+}
+
+export interface Alias {
+ [key: string]: string;
+}