refactor: migrate typescript (hexojs#5417)

.mocharc.yml

@@ -3,4 +3,3 @@ reporter: spec
 ui: bdd
 full-trace: true
 exit: true
-parallel: true

lib/extend/generator.ts

@@ -3,20 +3,20 @@ import type { NodeJSLikeCallback } from '../types';
 
 interface BaseObj {
   path: string;
-  data: any;
-  layout?: string;
+  data?: any;
+  layout?: string | string[];
 }
 type ReturnType = BaseObj | BaseObj[];
 type GeneratorReturnType = ReturnType | Promise<ReturnType>;
 
 interface GeneratorFunction {
-  (locals: object, callback?: NodeJSLikeCallback<any>): GeneratorReturnType;
+  (locals: any, callback?: NodeJSLikeCallback<any>): GeneratorReturnType;
 }
 
 type StoreFunctionReturn = Promise<ReturnType>;
 
 interface StoreFunction {
-  (locals: object): StoreFunctionReturn;
+  (locals: any): StoreFunctionReturn;
 }
 
 interface Store {

lib/hexo/index.ts

@@ -660,7 +660,7 @@ class Hexo extends EventEmitter {
       });
   }
 
-  exit(err?: Error): Promise<void> {
+  exit(err?: any): Promise<void> {
     if (err) {
       this.log.fatal(
         { err },
@@ -674,11 +674,11 @@ class Hexo extends EventEmitter {
     });
   }
 
-  execFilter(type: string, data: any, options) {
+  execFilter(type: string, data: any, options?) {
     return this.extend.filter.exec(type, data, options);
   }
 
-  execFilterSync(type: string, data: any, options) {
+  execFilterSync(type: string, data: any, options?) {
     return this.extend.filter.execSync(type, data, options);
   }
 }

lib/hexo/multi_config_path.ts

@@ -4,7 +4,7 @@ import yml from 'js-yaml';
 import { deepMerge } from 'hexo-util';
 import type Hexo from './index';
 
-export = (ctx: Hexo) => function multiConfigPath(base: string, configPaths: string, outputDir: string): string {
+export = (ctx: Hexo) => function multiConfigPath(base: string, configPaths?: string, outputDir?: string): string {
   const { log } = ctx;
   const defaultPath = join(base, '_config.yml');
 

lib/hexo/post.ts

@@ -231,9 +231,9 @@ interface Result {
 }
 
 interface PostData {
-  title?: string;
+  title?: string | number;
   layout?: string;
-  slug?: string;
+  slug?: string | number;
   path?: string;
   [prop: string]: any;
 }
@@ -333,7 +333,10 @@ class Post {
     });
   }
 
-  publish(data: PostData, replace: boolean, callback?: NodeJSLikeCallback<Result>) {
+  publish(data: PostData, replace?: boolean);
+  publish(data: PostData, callback?: NodeJSLikeCallback<Result>);
+  publish(data: PostData, replace: boolean, callback?: NodeJSLikeCallback<Result>);
+  publish(data: PostData, replace?: boolean | NodeJSLikeCallback<Result>, callback?: NodeJSLikeCallback<Result>) {
     if (!callback && typeof replace === 'function') {
       callback = replace;
       replace = false;
@@ -366,7 +369,7 @@ class Post {
       data.content = data._content;
       data._content = undefined;
 
-      return this.create(data, replace);
+      return this.create(data, replace as boolean);
     }).then(post => {
       result.path = post.path;
       result.content = post.content;

lib/hexo/render.ts

@@ -56,7 +56,9 @@ class Render {
     return this.getRenderer(ext, true);
   }
 
-  render(data: StoreFunctionData, options?: { highlight?: boolean; }, callback?: NodeJSLikeCallback<any>): Promise<any> {
+  render(data: StoreFunctionData, callback?: NodeJSLikeCallback<any>): Promise<any>;
+  render(data: StoreFunctionData, options: any, callback?: NodeJSLikeCallback<any>): Promise<any>;
+  render(data: StoreFunctionData, options?: any | NodeJSLikeCallback<any>, callback?: NodeJSLikeCallback<any>): Promise<any> {
     if (!callback && typeof options === 'function') {
       callback = options;
       options = {};

lib/hexo/router.ts

@@ -84,7 +84,7 @@ class RouteStream extends Readable {
   }
 }
 
-const _format = (path: string): string => {
+const _format = (path?: string): string => {
   path = path || '';
   if (typeof path !== 'string') throw new TypeError('path must be a string!');
 
@@ -118,7 +118,7 @@ class Router extends EventEmitter {
     return Object.keys(routes).filter(key => routes[key]);
   }
 
-  format(path: string): string {
+  format(path?: string): string {
     return _format(path);
   }
 

lib/models/types/moment.ts

@@ -16,7 +16,7 @@ class SchemaTypeMoment extends warehouse.SchemaType<moment.Moment> {
     super(name, options);
   }
 
-  cast(value, data) {
+  cast(value?, data?) {
     value = super.cast(value, data);
     if (value == null) return value;
 
@@ -29,7 +29,7 @@ class SchemaTypeMoment extends warehouse.SchemaType<moment.Moment> {
     return value;
   }
 
-  validate(value, data) {
+  validate(value, data?) {
     value = super.validate(value, data);
     if (value == null) return value;
 
@@ -42,11 +42,11 @@ class SchemaTypeMoment extends warehouse.SchemaType<moment.Moment> {
     return value;
   }
 
-  match(value, query, data) {
+  match(value, query, data?) {
     return value ? value.valueOf() === query.valueOf() : false;
   }
 
-  compare(a, b) {
+  compare(a?, b?) {
     if (a) {
       if (b) return a - b;
       return 1;
@@ -56,33 +56,33 @@ class SchemaTypeMoment extends warehouse.SchemaType<moment.Moment> {
     return 0;
   }
 
-  parse(value) {
+  parse(value?) {
     if (value) return toMoment(value);
   }
 
-  value(value, data) {
+  value(value?, data?) {
     // FIXME: Same as above. Also a dirty hack.
     return value ? value._d.toISOString() : value;
   }
 
-  q$day(value, query, data) {
+  q$day(value, query, data?) {
     return value ? value.date() === query : false;
   }
 
-  q$month(value, query, data) {
+  q$month(value, query, data?) {
     return value ? value.month() === query : false;
   }
 
-  q$year(value, query, data) {
+  q$year(value, query, data?) {
     return value ? value.year() === query : false;
   }
 
-  u$inc(value, update, data) {
+  u$inc(value, update, data?) {
     if (!value) return value;
     return value.add(update);
   }
 
-  u$dec(value, update, data) {
+  u$dec(value, update, data?) {
     if (!value) return value;
     return value.subtract(update);
   }

lib/plugins/filter/new_post_path.ts

@@ -18,7 +18,7 @@ const reservedKeys = {
   hash: true
 };
 
-function newPostPathFilter(this: Hexo, data: PostSchema = {}, replace: boolean): Promise<string> {
+function newPostPathFilter(this: Hexo, data: PostSchema = {}, replace?: boolean): Promise<string> {
   const sourceDir = this.source_dir;
   const draftDir = join(sourceDir, '_drafts');
   const postDir = join(sourceDir, '_posts');

lib/plugins/helper/date.ts

@@ -17,7 +17,7 @@ function getMoment(date: moment.MomentInput | moment.Moment, lang: string, timez
   return date;
 }
 
-function toISOString(date: string | number | Date | moment.Moment) {
+function toISOString(date?: string | number | Date | moment.Moment) {
   if (date == null) {
     return new Date().toISOString();
   }
@@ -29,19 +29,19 @@ function toISOString(date: string | number | Date | moment.Moment) {
   return new Date(date as (string | number)).toISOString();
 }
 
-function dateHelper(this: LocalsType, date: moment.Moment | moment.MomentInput, format?: string) {
+function dateHelper(this: LocalsType, date?: moment.Moment | moment.MomentInput, format?: string) {
   const { config } = this;
   const moment = getMoment(date, getLanguage(this), config.timezone);
   return moment.format(format || config.date_format);
 }
 
-function timeHelper(this: LocalsType, date: moment.Moment | moment.MomentInput, format?: string) {
+function timeHelper(this: LocalsType, date?: moment.Moment | moment.MomentInput, format?: string) {
   const { config } = this;
   const moment = getMoment(date, getLanguage(this), config.timezone);
   return moment.format(format || config.time_format);
 }
 
-function fullDateHelper(this: LocalsType, date: moment.Moment | moment.MomentInput, format: string) {
+function fullDateHelper(this: LocalsType, date?: moment.Moment | moment.MomentInput, format?: string) {
   if (format) {
     const moment = getMoment(date, getLanguage(this), this.config.timezone);
     return moment.format(format);
@@ -50,13 +50,13 @@ function fullDateHelper(this: LocalsType, date: moment.Moment | moment.MomentInp
   return `${this.date(date)} ${this.time(date)}`;
 }
 
-function relativeDateHelper(this: LocalsType, date: moment.Moment | moment.MomentInput) {
+function relativeDateHelper(this: LocalsType, date?: moment.Moment | moment.MomentInput) {
   const { config } = this;
   const moment = getMoment(date, getLanguage(this), config.timezone);
   return moment.fromNow();
 }
 
-function timeTagHelper(this: LocalsType, date: string | number | Date | moment.Moment, format: string) {
+function timeTagHelper(this: LocalsType, date?: string | number | Date | moment.Moment, format?: string) {
   return `<time datetime="${toISOString(date)}">${this.date(date, format)}</time>`;
 }
 
@@ -72,7 +72,7 @@ function getLanguage(ctx: LocalsType) {
  *
  * Moment defined locales: https://github.com/moment/moment/tree/master/locale
  */
-function _toMomentLocale(lang: string) {
+function _toMomentLocale(lang?: string) {
   if (lang === undefined) {
     return undefined;
   }

lib/plugins/helper/debug.ts

@@ -1,7 +1,7 @@
 import { inspect } from 'util';
 
 // this format object as string, resolves circular reference
-function inspectObject(object: any, options: boolean) {
+function inspectObject(object: any, options?: any) {
   return inspect(object, options);
 }
 

lib/plugins/helper/feed_tag.ts

@@ -9,10 +9,10 @@ const feedFn = (str = '') => {
 
 interface Options {
   title?: string;
-  type?: string;
+  type?: string | null;
 }
 
-function makeFeedTag(this: LocalsType, path: string, options: Options = {}, configFeed?: any, configTitle?: string) {
+function makeFeedTag(this: LocalsType, path?: string, options: Options = {}, configFeed?: any, configTitle?: string) {
   const title = options.title || configTitle;
 
   if (path) {
@@ -47,7 +47,7 @@ function makeFeedTag(this: LocalsType, path: string, options: Options = {}, conf
   return '';
 }
 
-function feedTagHelper(this: LocalsType, path: string, options: Options = {}) {
+function feedTagHelper(this: LocalsType, path?: string, options: Options = {}) {
   const { config } = this;
   return moize.deep(makeFeedTag.bind(this))(path, options, (config as any).feed, config.title);
 }

lib/plugins/helper/full_url_for.ts

@@ -2,6 +2,6 @@
 import { full_url_for } from 'hexo-util';
 import type { LocalsType } from '../../types';
 
-export = function(this: LocalsType, path: string) {
+export = function(this: LocalsType, path?: string) {
   return full_url_for.call(this, path);
 }

lib/plugins/helper/image_tag.ts

@@ -3,6 +3,7 @@ import type { LocalsType } from '../../types';
 
 interface Options {
   src?: string;
+  alt?: string;
   class?: string | string[];
 }
 

lib/plugins/helper/link_to.ts

@@ -2,6 +2,7 @@ import { htmlTag, url_for } from 'hexo-util';
 import type { LocalsType } from '../../types';
 
 interface Options {
+  id?: string;
   href?: string;
   title?: string;
   external?: boolean | null;
@@ -20,7 +21,7 @@ interface Attrs {
   [key: string]: string | boolean | null | undefined;
 }
 
-function linkToHelper(this: LocalsType, path: string, text: string, options: Options | boolean = {}) {
+function linkToHelper(this: LocalsType, path: string, text?: string, options: Options | boolean = {}) {
   if (typeof options === 'boolean') options = {external: options};
 
   if (!text) text = path.replace(/^https?:\/\/|\/$/g, '');

lib/plugins/helper/list_archives.ts

@@ -5,7 +5,7 @@ import { url_for } from 'hexo-util';
 interface Options {
   format?: string;
   type?: string;
-  style?: string;
+  style?: string | false;
   transform?: (name: string) => string;
   separator?: string;
   show_count?: boolean;

lib/plugins/helper/list_categories.ts

@@ -3,7 +3,7 @@ import type { CategorySchema, LocalsType } from '../../types';
 import type Query from 'warehouse/dist/query';
 
 interface Options {
-  style?: string;
+  style?: string | false;
   class?: string;
   depth?: number | string;
   orderby?: string;
@@ -13,11 +13,9 @@ interface Options {
   transform?: (name: string) => string;
   separator?: string;
   suffix?: string;
-  children_indicator?: boolean;
+  children_indicator?: string | boolean;
 }
 
-function listCategoriesHelper(this: LocalsType, options?: Options): string;
-function listCategoriesHelper(this: LocalsType, categories: Query<CategorySchema>, options?: Options): string;
 function listCategoriesHelper(this: LocalsType, categories?: Query<CategorySchema> | Options, options?: Options) {
   if (!options && (!categories || !Object.prototype.hasOwnProperty.call(categories, 'length'))) {
     options = categories as Options;

lib/plugins/helper/list_posts.ts

@@ -3,7 +3,7 @@ import type { LocalsType, PostSchema } from '../../types';
 import type Query from 'warehouse/dist/query';
 
 interface Options {
-  style?: string;
+  style?: string | false;
   class?: string;
   amount?: number;
   orderby?: string;
@@ -12,8 +12,6 @@ interface Options {
   separator?: string;
 }
 
-function listPostsHelper(this: LocalsType, options?: Options): string;
-function listPostsHelper(this: LocalsType, posts: Query<PostSchema>, options?: Options): string;
 function listPostsHelper(this: LocalsType, posts?: Query<PostSchema> | Options, options?: Options) {
   if (!options && (!posts || !Object.prototype.hasOwnProperty.call(posts, 'length'))) {
     options = posts as Options;