refactor: migrate typescript (#418)

Co-authored-by: yoshinorin <yoshinorin.net@outlook.com>

Author: stevenjoezhang

.eslintignore

@@ -1,4 +1,5 @@
 node_modules/
 coverage/
 tmp/
-assets/
+assets/
+dist/

.eslintrc.json

@@ -1,4 +1,11 @@
 {
-  "extends": "hexo",
-  "root": true
+  "root": true,
+  "extends": "hexo/ts.js",
+  "parserOptions": {
+    "sourceType": "module",
+    "ecmaVersion": 2020
+  },
+  "rules": {
+    "@typescript-eslint/no-var-requires": 0
+  }
 }

.gitignore

@@ -5,3 +5,4 @@ tmp/
 .idea/
 .nyc_output/
 .vscode/
+dist/

lib/console/help.js lib/console/help.ts

@@ -1,9 +1,7 @@
-'use strict';
-
-const { underline, bold } = require('picocolors');
-const { readFile } = require('hexo-fs');
-const { join } = require('path');
-const Promise = require('bluebird');
+import { underline, bold } from 'picocolors';
+import { readFile } from 'hexo-fs';
+import { join } from 'path';
+import Promise from 'bluebird';
 
 const COMPLETION_DIR = join(__dirname, '../../completion');
 
@@ -115,4 +113,4 @@ function printCompletion(type) {
   });
 }
 
-module.exports = helpConsole;
+export = helpConsole;

lib/console/index.js lib/console/index.ts

@@ -1,9 +1,11 @@
-'use strict';
+import helpConsole from './help';
+import initConsole from './init';
+import versionConsole from './version';
 
-module.exports = function(ctx) {
+export = function(ctx) {
   const { console } = ctx.extend;
 
-  console.register('help', 'Get help on a command.', {}, require('./help'));
+  console.register('help', 'Get help on a command.', {}, helpConsole);
 
   console.register('init', 'Create a new Hexo folder.', {
     desc: 'Create a new Hexo folder at the specified path or the current directory.',
@@ -15,7 +17,7 @@ module.exports = function(ctx) {
       {name: '--no-clone', desc: 'Copy files instead of cloning from GitHub'},
       {name: '--no-install', desc: 'Skip npm install'}
     ]
-  }, require('./init'));
+  }, initConsole);
 
-  console.register('version', 'Display version information.', {}, require('./version'));
+  console.register('version', 'Display version information.', {}, versionConsole);
 };

lib/console/init.js lib/console/init.ts

@@ -1,12 +1,10 @@
-'use strict';
-
-const Promise = require('bluebird');
-const { join, resolve } = require('path');
-const { magenta } = require('picocolors');
-const { existsSync, readdirSync, rmdir, unlink, copyDir, readdir, stat } = require('hexo-fs');
-const tildify = require('tildify');
-const { spawn } = require('hexo-util');
-const commandExistsSync = require('command-exists').sync;
+import BlueBirdPromise from 'bluebird';
+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 { sync as commandExistsSync } from 'command-exists';
 
 const ASSET_DIR = join(__dirname, '../../assets');
 const GIT_REPO_URL = 'https://github.com/hexojs/hexo-starter.git';
@@ -20,7 +18,7 @@ async function initConsole(args) {
 
   if (existsSync(target) && readdirSync(target).length !== 0) {
     log.fatal(`${magenta(tildify(target))} not empty, please run \`hexo init\` on an empty folder and then copy your files into it`);
-    await Promise.reject(new Error('target not empty'));
+    await BlueBirdPromise.reject(new Error('target not empty'));
   }
 
   log.info('Cloning hexo-starter', GIT_REPO_URL);
@@ -38,7 +36,7 @@ async function initConsole(args) {
     await copyAsset(target);
   }
 
-  await Promise.all([
+  await BlueBirdPromise.all([
     removeGitDir(target),
     removeGitModules(target)
   ]);
@@ -111,4 +109,4 @@ async function removeGitModules(target) {
   }
 }
 
-module.exports = initConsole;
+export = initConsole;

lib/console/version.js lib/console/version.ts

@@ -1,11 +1,9 @@
-'use strict';
-
-const os = require('os');
+import os from 'os';
 const pkg = require('../../package.json');
-const Promise = require('bluebird');
-const { spawn } = require('hexo-util');
+import BlueBirdPromise from 'bluebird';
+import { spawn } from 'hexo-util';
 
-async function versionConsole(args) {
+async function versionConsole() {
   const { versions, platform } = process;
   const keys = Object.keys(versions);
 
@@ -33,7 +31,7 @@ async function versionConsole(args) {
     console.log('%s: %s', key, versions[key]);
   }
 
-  await Promise.resolve();
+  await BlueBirdPromise.resolve();
 }
 
-module.exports = versionConsole;
+export = versionConsole;

lib/context.js lib/context.ts

@@ -1,15 +1,21 @@
-'use strict';
-
-const logger = require('hexo-log');
-const { underline } = require('picocolors');
-const { EventEmitter } = require('events');
-const Promise = require('bluebird');
-const ConsoleExtend = require('./extend/console');
+import logger from 'hexo-log';
+import { underline } from 'picocolors';
+import { EventEmitter } from 'events';
+import Promise from 'bluebird';
+import ConsoleExtend from './extend/console';
 
 // a stub Hexo object
 // see `hexojs/hexo/lib/hexo/index.js`
 
+type Callback = (err?: any, value?: any) => void;
+
 class Context extends EventEmitter {
+  base_dir: string;
+  log: logger;
+  extend: {
+    console: ConsoleExtend;
+  };
+
   constructor(base = process.cwd(), args = {}) {
     super();
     this.base_dir = base;
@@ -24,9 +30,11 @@ class Context extends EventEmitter {
     // Do nothing
   }
 
-  call(name, args, 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') {
-      callback = args;
+      callback = args as Callback;
       args = {};
     }
 
@@ -41,7 +49,7 @@ class Context extends EventEmitter {
     }).asCallback(callback);
   }
 
-  exit(err) {
+  exit(err?: Error) {
     if (err) {
       this.log.fatal(
         {err},
@@ -58,4 +66,4 @@ class Context extends EventEmitter {
   }
 }
 
-module.exports = Context;
+export = Context;

lib/extend/console.js lib/extend/console.ts

@@ -1,15 +1,30 @@
-'use strict';
+import Promise from 'bluebird';
+import abbrev from 'abbrev';
 
-const Promise = require('bluebird');
-const abbrev = require('abbrev');
+interface Callback {
+  (args?: object): any;
+  options?: object;
+  desc?: string;
+}
+
+interface Store {
+  [key: string]: Callback;
+}
+
+interface Alias {
+  [key: string]: string;
+}
 
 class Console {
+  store: Store;
+  alias: Alias;
+
   constructor() {
     this.store = {};
     this.alias = {};
   }
 
-  get(name) {
+  get(name: string) {
     name = name.toLowerCase();
     return this.store[this.alias[name]];
   }
@@ -18,13 +33,17 @@ class Console {
     return this.store;
   }
 
-  register(name, desc, options, fn) {
+  register(name: string, desc: string, options: object, fn: Callback): void;
+  register(name: string, options: object, 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) {
     if (!name) throw new TypeError('name is required');
 
     if (!fn) {
       if (options) {
         if (typeof options === 'function') {
-          fn = options;
+          fn = options as Callback;
 
           if (typeof desc === 'object') { // name, options, fn
             options = desc;
@@ -38,7 +57,7 @@ class Console {
       } else {
         // name, fn
         if (typeof desc === 'function') {
-          fn = desc;
+          fn = desc as Callback;
           options = {};
           desc = '';
         } else {
@@ -56,10 +75,10 @@ class Console {
     this.store[name.toLowerCase()] = fn;
     const c = fn;
     c.options = options;
-    c.desc = desc;
+    c.desc = desc as string;
 
     this.alias = abbrev(Object.keys(this.store));
   }
 }
 
-module.exports = Console;
+export = Console;

lib/find_pkg.js lib/find_pkg.ts

@@ -1,21 +1,23 @@
-'use strict';
+import { resolve, join, dirname } from 'path';
+import { readFile } from 'hexo-fs';
 
-const { resolve, join, dirname } = require('path');
-const { readFile } = require('hexo-fs');
+interface findPkgArgs {
+  cwd?: string;
+}
 
-function findPkg(cwd, args = {}) {
+function findPkg(cwd: string, args: findPkgArgs = {}) {
   if (args.cwd) {
     cwd = resolve(cwd, args.cwd);
   }
 
   return checkPkg(cwd);
 }
 
-function checkPkg(path) {
+function checkPkg(path: string) {
   const pkgPath = join(path, 'package.json');
 
   return readFile(pkgPath).then(content => {
-    const json = JSON.parse(content);
+    const json = JSON.parse(content as string);
     if (typeof json.hexo === 'object') return path;
   }).catch(err => {
     if (err && err.code === 'ENOENT') {
@@ -29,4 +31,4 @@ function checkPkg(path) {
   });
 }
 
-module.exports = findPkg;
+export = findPkg;

lib/goodbye.js lib/goodbye.ts

@@ -1,5 +1,3 @@
-'use strict';
-
 const byeWords = [
   'Good bye',
   'See you again',
@@ -9,4 +7,4 @@ const byeWords = [
   'Catch you later'
 ];
 
-module.exports = () => byeWords[(Math.random() * byeWords.length) | 0];
+export = () => byeWords[(Math.random() * byeWords.length) | 0];

lib/hexo.js lib/hexo.ts

@@ -1,14 +1,16 @@
-'use strict';
-
-const { magenta } = require('picocolors');
-const tildify = require('tildify');
-const Promise = require('bluebird');
-const Context = require('./context');
-const findPkg = require('./find_pkg');
-const goodbye = require('./goodbye');
-const minimist = require('minimist');
-const resolve = require('resolve');
-const { camelCaseKeys } = require('hexo-util');
+import { magenta } from 'picocolors';
+import tildify from 'tildify';
+import Promise from 'bluebird';
+import Context from './context';
+import findPkg from './find_pkg';
+import goodbye from './goodbye';
+import minimist from 'minimist';
+import resolve from 'resolve';
+import { camelCaseKeys } from 'hexo-util';
+import registerConsole from './console';
+import helpConsole from './console/help';
+import initConsole from './console/init';
+import versionConsole from './console/version';
 
 class HexoNotFoundError extends Error {}
 
@@ -44,7 +46,7 @@ function entry(cwd = process.cwd(), args) {
     if (mod) hexo = mod;
     log = hexo.log;
 
-    require('./console')(hexo);
+    registerConsole(hexo);
 
     return hexo.init();
   }).then(() => {
@@ -65,12 +67,12 @@ function entry(cwd = process.cwd(), args) {
 }
 
 entry.console = {
-  init: require('./console/init'),
-  help: require('./console/help'),
-  version: require('./console/version')
+  init: initConsole,
+  help: helpConsole,
+  version: versionConsole
 };
 
-entry.version = require('../package.json').version;
+entry.version = require('../package.json').version as string;
 
 function loadModule(path, args) {
   return Promise.try(() => {
@@ -93,4 +95,4 @@ function watchSignal(hexo) {
   });
 }
 
-module.exports = entry;
+export = entry;

package-lock.json

@@ -7,14 +7,19 @@
     "hexo": "./bin/hexo"
   },
   "files": [
-    "lib",
+    "dist/**",
     "completion",
     "bin",
     "assets"
   ],
+  "types": "./dist/hexo.d.ts",
   "scripts": {
+    "prepublish ": "npm install && npm run clean && npm run build",
+    "build": "tsc -b",
+    "clean": "tsc -b --clean",
     "eslint": "eslint .",
-    "test": "mocha test/index.js",
+    "pretest": "npm run clean && npm run build",
+    "test": "mocha test/index.js --require ts-node/register",
     "test-cov": "nyc --reporter=lcovonly npm test",
     "prepare": "git submodule init && git submodule update && git submodule foreach git pull origin master"
   },
@@ -41,7 +46,7 @@
     "abbrev": "^2.0.0",
     "bluebird": "^3.7.2",
     "command-exists": "^1.2.9",
-    "hexo-fs": "^4.0.0",
+    "hexo-fs": "^4.1.1",
     "hexo-log": "^3.0.0",
     "hexo-util": "^2.5.0",
     "minimist": "^1.2.5",
@@ -50,6 +55,10 @@
     "tildify": "^2.0.0"
   },
   "devDependencies": {
+    "@types/bluebird": "^3.5.37",
+    "@types/node": "^18.11.8",
+    "@typescript-eslint/eslint-plugin": "^5.41.0",
+    "@typescript-eslint/parser": "^5.41.0",
     "chai": "^4.3.4",
     "eslint": "^8.2.0",
     "eslint-config-hexo": "^5.0.0",
@@ -58,7 +67,9 @@
     "nyc": "^15.1.0",
     "proxyquire": "^2.1.3",
     "rewire": "^6.0.0",
-    "sinon": "^14.0.0"
+    "sinon": "^14.0.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.8.4"
   },
   "engines": {
     "node": ">=14"

package.json

@@ -1,3 +1,6 @@
 {
-  "extends": "hexo/test"
+  "extends": "hexo/test",
+  "rules": {
+    "@typescript-eslint/no-var-requires": 0
+  }
 }

test/.eslintrc.json

@@ -1,6 +1,6 @@
 'use strict';
 
-const chai = require('chai');
+require('chai');
 
 describe('hexo-cli', () => {
   require('./scripts/find_pkg');

test/index.js

@@ -5,7 +5,7 @@ const should = require('chai').should();
 const sinon = require('sinon');
 
 describe('context', () => {
-  const Context = require('../../lib/context');
+  const Context = require('../../dist/context');
 
   describe('call', () => {
     const hexo = new Context();

test/scripts/context.js

@@ -5,7 +5,7 @@ const { rmdir, writeFile, unlink } = require('hexo-fs');
 const { dirname, join } = require('path');
 
 describe('Find package', () => {
-  const findPkg = require('../../lib/find_pkg');
+  const findPkg = require('../../dist/find_pkg');
   const baseDir = join(__dirname, 'find_pkg_test');
 
   after(async () => await rmdir(baseDir));

test/scripts/find_pkg.js

@@ -1,7 +1,7 @@
 'use strict';
 
 require('chai').should();
-const Context = require('../../lib/context');
+const Context = require('../../dist/context');
 const sinon = require('sinon');
 const { readFile } = require('hexo-fs');
 const { join } = require('path');
@@ -13,10 +13,10 @@ function getConsoleLog({ args }) {
 }
 
 describe('help', () => {
-  const helpModule = rewire('../../lib/console/help');
+  const helpModule = rewire('../../dist/console/help');
   const hexo = new Context();
 
-  require('../../lib/console')(hexo);
+  require('../../dist/console')(hexo);
 
   it('show global help', () => {
     const spy = sinon.spy();

test/scripts/help.js

@@ -9,7 +9,7 @@ describe('hexo', () => {
 
   it('run help if no specified command', async () => {
     const spy = sinon.spy();
-    const hexo = proxyquire('../../lib/hexo', {
+    const hexo = proxyquire('../../dist/hexo', {
       './console'(ctx) {
         ctx.extend.console.register('help', spy);
       }
@@ -21,7 +21,7 @@ describe('hexo', () => {
 
   it('run specified command', async () => {
     const spy = sinon.spy();
-    const hexo = proxyquire('../../lib/hexo', {
+    const hexo = proxyquire('../../dist/hexo', {
       './console'(ctx) {
         ctx.extend.console.register('test', spy);
       }
@@ -33,7 +33,7 @@ describe('hexo', () => {
 
   it('run help if specified command not found', async () => {
     const spy = sinon.spy();
-    const hexo = proxyquire('../../lib/hexo', {
+    const hexo = proxyquire('../../dist/hexo', {
       './console'(ctx) {
         ctx.extend.console.register('help', spy);
       }

test/scripts/hexo.js

@@ -5,12 +5,12 @@ const { join } = require('path');
 const { listDir, rmdir, createReadStream } = require('hexo-fs');
 const { createSha1Hash } = require('hexo-util');
 const rewire = require('rewire');
-const Context = require('../../lib/context');
+const Context = require('../../dist/context');
 const assetDir = join(__dirname, '../../assets');
 
 describe('init', () => {
   const baseDir = join(__dirname, 'init_test');
-  const initModule = rewire('../../lib/console/init');
+  const initModule = rewire('../../dist/console/init');
   const hexo = new Context(baseDir, { silent: true });
   const init = initModule.bind(hexo);
   let assets = [];
@@ -57,7 +57,7 @@ describe('init', () => {
   }
 
   function withoutSpawn(fn) {
-    return initModule.__with__('spawn', () => Promise.reject(new Error('spawn is not available')))(fn);
+    return initModule.__with__('hexo_util_1.spawn', () => Promise.reject(new Error('spawn is not available')))(fn);
   }
 
   before(async () => {

test/scripts/init.js

@@ -1,7 +1,7 @@
 'use strict';
 
 require('chai').should();
-const Context = require('../../lib/context');
+const Context = require('../../dist/context');
 const sinon = require('sinon');
 const { platform, release } = require('os');
 const { format } = require('util');
@@ -14,7 +14,7 @@ function getConsoleLog({ args }) {
 }
 
 describe('version', () => {
-  const versionModule = rewire('../../lib/console/version');
+  const versionModule = rewire('../../dist/console/version');
   const hexo = new Context();
 
   it('show version info', () => {

test/scripts/version.js

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "es6",
+    "sourceMap": true,
+    "outDir": "dist",
+    "declaration": true,
+    "esModuleInterop": true,
+    "types": [
+      "node"
+    ]
+  },
+  "include": [
+    "lib/hexo.ts"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}