refactor: migrate typescript

.eslintignore

@@ -1,3 +1,4 @@
 node_modules/
 coverage/
-tmp/
+tmp/
+dist/

.eslintrc

@@ -1,4 +1,8 @@
 {
-  "extends": "hexo",
-  "root": true
+  "root": true,
+  "extends": "hexo/ts.js",
+  "parserOptions": {
+    "sourceType": "module",
+    "ecmaVersion": 2020
+  }
 }

.gitignore

@@ -3,4 +3,6 @@ node_modules/
 tmp/
 *.log
 .idea/
-coverage
+coverage
+dist
+package-lock.json

lib/i18n.js → lib/i18n.ts

@@ -1,9 +1,14 @@
-'use strict';
+import { vsprintf } from 'sprintf-js';
 
-const { vsprintf } = require('sprintf-js');
+interface Options {
+  languages?: string[];
+}
 
 class i18n {
-  constructor(options = {}) {
+  data: object;
+  languages: string[];
+
+  constructor(options: Options = {}) {
     this.data = {};
     this.languages = options.languages || ['default'];
 
@@ -12,7 +17,7 @@ class i18n {
     }
   }
 
-  get(languages) {
+  get(languages?: string[] | string) {
     const { data } = this;
     const result = {};
 
@@ -39,7 +44,7 @@ class i18n {
     return result;
   }
 
-  set(lang, data) {
+  set(lang: string, data: object) {
     if (typeof lang !== 'string') throw new TypeError('lang must be a string!');
     if (typeof data !== 'object') throw new TypeError('data is required!');
 
@@ -48,7 +53,7 @@ class i18n {
     return this;
   }
 
-  remove(lang) {
+  remove(lang: string) {
     if (typeof lang !== 'string') throw new TypeError('lang must be a string!');
 
     delete this.data[lang];
@@ -60,10 +65,10 @@ class i18n {
     return Object.keys(this.data);
   }
 
-  __(lang) {
+  __(lang?: string[]) {
     const data = this.get(lang);
 
-    return (key, ...args) => {
+    return (key: string, ...args) => {
       if (!key) return '';
 
       const str = data[key] || key;
@@ -72,10 +77,10 @@ class i18n {
     };
   }
 
-  _p(lang) {
+  _p(lang?: string[]) {
     const data = this.get(lang);
 
-    return (key, ...args) => {
+    return (key: string, ...args) => {
       if (!key) return '';
 
       const number = args.length ? +args[0] : 0;
@@ -110,4 +115,4 @@ function flattenObject(data, obj = {}, parent = '') {
   return obj;
 }
 
-module.exports = i18n;
+export = i18n;

package.json

@@ -2,18 +2,23 @@
   "name": "hexo-i18n",
   "version": "1.0.0",
   "description": "i18n module for Hexo.",
-  "main": "lib/i18n.js",
+  "main": "dist/i18n.js",
   "scripts": {
+    "prepublish ": "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": "c8 --reporter=lcovonly npm run test"
   },
   "directories": {
     "lib": "./lib"
   },
   "files": [
-    "lib/"
+    "dist/**"
   ],
+  "types": "./dist/i18n.d.ts",
   "engines": {
     "node": ">=14"
   },
@@ -30,10 +35,16 @@
     "sprintf-js": "^1.1.2"
   },
   "devDependencies": {
+    "@types/node": "^18.11.8",
+    "@types/sprintf-js": "^1.1.2",
+    "@typescript-eslint/eslint-plugin": "^5.41.0",
+    "@typescript-eslint/parser": "^5.41.0",
     "c8": "^7.12.0",
-    "chai": "^4.3.4",
-    "eslint": "^8.6.0",
+    "chai": "^4.3.6",
+    "eslint": "^8.26.0",
     "eslint-config-hexo": "^5.0.0",
-    "mocha": "^10.1.0"
+    "mocha": "^10.1.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.8.4"
   }
 }

test/.eslintrc

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

test/index.js

@@ -3,7 +3,7 @@
 const should = require('chai').should();
 
 describe('i18n', () => {
-  const Ctor = require('../lib/i18n');
+  const Ctor = require('../dist/i18n');
 
   const i18n = new Ctor({
     languages: ['zh-TW', 'en']

tsconfig.json

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