refactor: refactor types (#5398)

lib/hexo/index.ts

@@ -38,6 +38,8 @@ import multiConfigPath from './multi_config_path';
 import { deepMerge, full_url_for } from 'hexo-util';
 import type Box from '../box';
 import type { AssetGenerator, LocalsType, NodeJSLikeCallback, NormalPageGenerator, NormalPostGenerator, PageGenerator, PostGenerator, SiteLocals } from '../types';
+import type { AddSchemaTypeOptions } from 'warehouse/dist/types';
+import type Schema from 'warehouse/dist/schema';
 
 let resolveSync; // = require('resolve');
 
@@ -440,7 +442,7 @@ class Hexo extends EventEmitter {
     return Promise.reject(new Error(`Console \`${name}\` has not been registered yet!`));
   }
 
-  model(name: string, schema?: any) {
+  model(name: string, schema?: Schema | Record<string, AddSchemaTypeOptions>) {
     return this.database.model(name, schema);
   }
 
@@ -560,8 +562,8 @@ class Hexo extends EventEmitter {
       page: NormalPageGenerator | NormalPostGenerator;
       path: string;
       url: string;
-      config: object;
-      theme: object;
+      config: any;
+      theme: any;
       layout: string;
       env: any;
       view_dir: string;

lib/plugins/generator/asset.ts

@@ -3,31 +3,25 @@ import { exists, createReadStream } from 'hexo-fs';
 import Promise from 'bluebird';
 import { extname } from 'path';
 import { magenta } from 'picocolors';
-import type warehouse from 'warehouse';
 import type Hexo from '../../hexo';
-import type { AssetGenerator } from '../../types';
+import type { AssetGenerator, AssetSchema } from '../../types';
+import type Document from 'warehouse/dist/document';
 
 interface Data {
   modified: boolean;
   data?: () => any;
 }
 
 const process = (name: string, ctx: Hexo) => {
-  // @ts-expect-error
-  return Promise.filter(ctx.model(name).toArray(), (asset: warehouse['Schema']) => exists(asset.source).tap(exist => {
-    // @ts-expect-error
+  return Promise.filter(ctx.model(name).toArray(), (asset: Document<AssetSchema>) => exists(asset.source).tap(exist => {
     if (!exist) return asset.remove();
-  })).map((asset: warehouse['Schema']) => {
-    // @ts-expect-error
+  })).map((asset: Document<AssetSchema>) => {
     const { source } = asset;
-    // @ts-expect-error
     let { path } = asset;
     const data: Data = {
-      // @ts-expect-error
       modified: asset.modified
     };
 
-    // @ts-expect-error
     if (asset.renderable && ctx.render.isRenderable(path)) {
       // Replace extension name if the asset is renderable
       const filename = path.substring(0, path.length - extname(path).length);

lib/plugins/generator/post.ts

@@ -1,10 +1,11 @@
 import type { PostGenerator, PostSchema, SiteLocals } from '../../types';
+import type Document from 'warehouse/dist/document';
 
 function postGenerator(locals: SiteLocals): PostGenerator[] {
   const posts = locals.posts.sort('-date').toArray();
   const { length } = posts;
 
-  return posts.map((post: PostSchema, i: number) => {
+  return posts.map((post: Document<PostSchema>, i: number) => {
     const { path, layout } = post;
 
     if (!layout || layout === 'false') {

lib/plugins/helper/css.ts

@@ -1,8 +1,9 @@
 import { htmlTag, url_for } from 'hexo-util';
 import moize from 'moize';
+import type { LocalsType } from '../../types';
 
 let relative_link = true;
-function cssHelper(...args: any[]) {
+function cssHelper(this: LocalsType, ...args: any[]) {
   let result = '\n';
 
   relative_link = this.config.relative_link;

lib/plugins/helper/date.ts

@@ -29,19 +29,19 @@ function toISOString(date: string | number | Date | moment.Moment) {
   return new Date(date as (string | number)).toISOString();
 }
 
-function dateHelper(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(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(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,15 +50,14 @@ function fullDateHelper(date: moment.Moment | moment.MomentInput, format: string
   return `${this.date(date)} ${this.time(date)}`;
 }
 
-function relativeDateHelper(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(date: string | number | Date | moment.Moment, format: string) {
-  const { config } = this;
-  return `<time datetime="${toISOString(date)}">${this.date(date, format, getLanguage(this), config.timezone)}</time>`;
+function timeTagHelper(this: LocalsType, date: string | number | Date | moment.Moment, format: string) {
+  return `<time datetime="${toISOString(date)}">${this.date(date, format)}</time>`;
 }
 
 function getLanguage(ctx: LocalsType) {

lib/plugins/helper/favicon_tag.ts

@@ -1,6 +1,7 @@
 import { url_for } from 'hexo-util';
+import type { LocalsType } from '../../types';
 
-function faviconTagHelper(path: string) {
+function faviconTagHelper(this: LocalsType, path: string) {
   return `<link rel="shortcut icon" href="${url_for.call(this, path)}">`;
 }
 

lib/plugins/helper/feed_tag.ts

@@ -1,5 +1,6 @@
 import { url_for } from 'hexo-util';
 import moize from 'moize';
+import type { LocalsType } from '../../types';
 
 const feedFn = (str = '') => {
   if (str) return str.replace(/2$/, '');
@@ -11,7 +12,7 @@ interface Options {
   type?: string;
 }
 
-function makeFeedTag(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) {
@@ -46,9 +47,9 @@ function makeFeedTag(path: string, options: Options = {}, configFeed?: any, conf
   return '';
 }
 
-function feedTagHelper(path: string, options = {}) {
+function feedTagHelper(this: LocalsType, path: string, options: Options = {}) {
   const { config } = this;
-  return moize.deep(makeFeedTag.bind(this))(path, options, config.feed, config.title);
+  return moize.deep(makeFeedTag.bind(this))(path, options, (config as any).feed, config.title);
 }
 
 export = feedTagHelper;

lib/plugins/helper/fragment_cache.ts

@@ -7,7 +7,7 @@ export = (ctx: Hexo) => {
   // reset cache for watch mode
   ctx.on('generateBefore', () => { cache.flush(); });
 
-  return function fragmentCache(id, fn) {
+  return function fragmentCache(id: string, fn: () => any) {
     if (this.cache) return cache.apply(id, fn);
 
     const result = fn();

lib/plugins/helper/full_url_for.ts

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

lib/plugins/helper/image_tag.ts

@@ -1,4 +1,5 @@
 import { htmlTag, url_for } from 'hexo-util';
+import type { LocalsType } from '../../types';
 
 interface Options {
   src?: string;
@@ -11,7 +12,7 @@ interface Attrs {
   [key: string]: string | undefined;
 }
 
-function imageTagHelper(path: string, options: Options = {}) {
+function imageTagHelper(this: LocalsType, path: string, options: Options = {}) {
   const attrs = Object.assign({
     src: url_for.call(this, path) as string
   }, options);

lib/plugins/helper/is.ts

@@ -1,4 +1,6 @@
-function isCurrentHelper(path = '/', strict: boolean) {
+import type { LocalsType } from '../../types';
+
+function isCurrentHelper(this: LocalsType, path = '/', strict: boolean) {
   const currentPath = this.path.replace(/^[^/].*/, '/$&');
 
   if (strict) {
@@ -37,7 +39,7 @@ function isArchiveHelper() {
   return Boolean(this.page.archive);
 }
 
-function isYearHelper(year) {
+function isYearHelper(year?) {
   const { page } = this;
   if (!page.archive) return false;
 
@@ -48,7 +50,7 @@ function isYearHelper(year) {
   return Boolean(page.year);
 }
 
-function isMonthHelper(year, month) {
+function isMonthHelper(year?, month?) {
   const { page } = this;
   if (!page.archive) return false;
 
@@ -63,15 +65,15 @@ function isMonthHelper(year, month) {
   return Boolean(page.year && page.month);
 }
 
-function isCategoryHelper(category) {
+function isCategoryHelper(category?) {
   if (category) {
     return this.page.category === category;
   }
 
   return Boolean(this.page.category);
 }
 
-function isTagHelper(tag) {
+function isTagHelper(tag?) {
   if (tag) {
     return this.page.tag === tag;
   }

lib/plugins/helper/js.ts

@@ -1,8 +1,9 @@
 import { htmlTag, url_for } from 'hexo-util';
 import moize from 'moize';
+import type { LocalsType } from '../../types';
 
 let relative_link = true;
-function jsHelper(...args: any[]) {
+function jsHelper(this: LocalsType, ...args: any[]) {
   let result = '\n';
 
   relative_link = this.config.relative_link;

lib/plugins/helper/link_to.ts

@@ -1,4 +1,5 @@
 import { htmlTag, url_for } from 'hexo-util';
+import type { LocalsType } from '../../types';
 
 interface Options {
   href?: string;
@@ -19,7 +20,7 @@ interface Attrs {
   [key: string]: string | boolean | null | undefined;
 }
 
-function linkToHelper(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

@@ -1,3 +1,4 @@
+import type { LocalsType } from '../../types';
 import { toMomentLocale } from './date';
 import { url_for } from 'hexo-util';
 
@@ -19,7 +20,7 @@ interface Data {
   count: number;
 }
 
-function listArchivesHelper(options: Options = {}) {
+function listArchivesHelper(this: LocalsType, options: Options = {}) {
   const { config } = this;
   const archiveDir = config.archive_dir;
   const { timezone } = config;

lib/plugins/helper/list_categories.ts

@@ -1,18 +1,37 @@
 import { url_for } from 'hexo-util';
+import type { CategorySchema, LocalsType } from '../../types';
+import type Query from 'warehouse/dist/query';
+
+interface Options {
+  style?: string;
+  class?: string;
+  depth?: number | string;
+  orderby?: string;
+  order?: number;
+  show_count?: boolean;
+  show_current?: boolean;
+  transform?: (name: string) => string;
+  separator?: string;
+  suffix?: string;
+  children_indicator?: boolean;
+}
 
-function listCategoriesHelper(categories, options) {
+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;
+    options = categories as Options;
     categories = this.site.categories;
   }
+  categories = categories as Query<CategorySchema>;
 
   if (!categories || !categories.length) return '';
   options = options || {};
 
   const { style = 'list', transform, separator = ', ', suffix = '' } = options;
   const showCount = Object.prototype.hasOwnProperty.call(options, 'show_count') ? options.show_count : true;
   const className = options.class || 'category';
-  const depth = options.depth ? parseInt(options.depth, 10) : 0;
+  const depth = options.depth ? parseInt(String(options.depth), 10) : 0;
   const orderby = options.orderby || 'name';
   const order = options.order || 1;
   const showCurrent = options.show_current || false;
@@ -27,13 +46,13 @@ function listCategoriesHelper(categories, options) {
       query.parent = {$exists: false};
     }
 
-    return categories.find(query).sort(orderby, order);
+    return (categories as Query<CategorySchema>).find(query).sort(orderby, order);
   };
 
   const hierarchicalList = (level: number, parent?: any) => {
     let result = '';
 
-    prepareQuery(parent).forEach(cat => {
+    prepareQuery(parent).forEach((cat: CategorySchema) => {
       let child;
       if (!depth || level + 1 < depth) {
         child = hierarchicalList(level + 1, cat._id);

lib/plugins/helper/list_posts.ts

@@ -1,11 +1,27 @@
 import { url_for } from 'hexo-util';
+import type { LocalsType, PostSchema } from '../../types';
+import type Query from 'warehouse/dist/query';
+
+interface Options {
+  style?: string;
+  class?: string;
+  amount?: number;
+  orderby?: string;
+  order?: number;
+  transform?: (name: string) => string;
+  separator?: string;
+}
 
-function listPostsHelper(posts, options) {
+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;
+    options = posts as Options;
     posts = this.site.posts;
   }
 
+  posts = posts as Query<PostSchema>;
+
   options = options || {};
 
   const { style = 'list', transform, separator = ', ' } = options;