👕 refactor: siwtch to typescript from babel

kazupon · kazupon · commit ac2fa049c896 · 2019-07-18T19:44:09.000+09:00
diff --git a/.eslintignore b/.eslintignore
@@ -1 +1,3 @@
 ./lib
+./jest.config.js
+./test/fixtures
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -9,10 +9,16 @@ module.exports = {
   extends: [
     'plugin:vue-libs/recommended'
   ],
-  plugins: [],
+  plugins: [
+    '@typescript-eslint'
+  ],
+  parser: 'vue-eslint-parser',
   parserOptions: {
-    ecmaVersion: 2015
+    parser: '@typescript-eslint/parser',
+    sourceType: 'module'
   },
   rules: {
+    'no-unused-vars': 'off', // HACK: due to override with @typescript-eslint/no-unused-vars
+    '@typescript-eslint/no-unused-vars': [2, { 'vars': 'all', 'args': 'none' }]
   }
 }
diff --git a/@types/index.d.ts b/@types/index.d.ts
@@ -0,0 +1,8 @@
+import { DOMWindow } from 'jsdom'
+
+declare global {
+  interface Window {
+    module: any,
+    exports: any
+  }
+}
diff --git a/jest.config.js b/jest.config.js
@@ -1,8 +1,15 @@
 'use strict'
 
 module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
   coveragePathIgnorePatterns: [
     'node_modules',
     '<rootDir>/test/*.*'
-  ]
+  ],
+  globals: {
+    'ts-jest': {
+      diagnostics: false
+    }
+  }
 }
diff --git a/lib/.gitkeep b/lib/.gitkeep
diff --git a/lib/index.js b/lib/index.js
@@ -1,33 +1,32 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-
-exports.default = function (content) {
-  if (this.version && this.version >= 2) {
-    try {
-      this.cacheable && this.cacheable();
-      this.callback(null, `module.exports = ${generateCode(content)}`);
-    } catch (err) {
-      this.emitError(err.message);
-      this.callback(err);
+Object.defineProperty(exports, "__esModule", { value: true });
+var loader = function (source) {
+    if (this.version && Number(this.version) >= 2) {
+        try {
+            this.cacheable && this.cacheable();
+            this.callback(null, "module.exports = " + generateCode(source));
+        }
+        catch (err) {
+            this.emitError(err.message);
+            this.callback(err);
+        }
+    }
+    else {
+        var message = 'support webpack 2 later';
+        this.emitError(message);
+        this.callback(new Error(message));
     }
-  } else {
-    const message = 'support webpack 2 later';
-    this.emitError(message);
-    this.callback(new Error(message));
-  }
 };
-
-function generateCode(content) {
-  let code = '';
-  let value = typeof content === 'string' ? JSON.parse(content) : content;
-  value = JSON.stringify(value).replace(/\u2028/g, '\\u2028').replace(/\u2029/g, '\\u2029').replace(/\\/g, '\\\\');
-  code += `function (Component) {
-  Component.options.__i18n = Component.options.__i18n || []
-  Component.options.__i18n.push('${value.replace(/\u0027/g, '\\u0027')}')
-  delete Component.options._Ctor
-}\n`;
-  return code;
-}
+function generateCode(source) {
+    var code = '';
+    var value = typeof source === 'string'
+        ? JSON.parse(source)
+        : source;
+    value = JSON.stringify(value)
+        .replace(/\u2028/g, '\\u2028')
+        .replace(/\u2029/g, '\\u2029')
+        .replace(/\\/g, '\\\\');
+    code += "function (Component) {\n  Component.options.__i18n = Component.options.__i18n || []\n  Component.options.__i18n.push('" + value.replace(/\u0027/g, '\\u0027') + "')\n  delete Component.options._Ctor\n}\n";
+    return code;
+}
+exports.default = loader;
diff --git a/package.json b/package.json
@@ -10,21 +10,25 @@
     "url": "https://github.com/kazupon/vue-i18n-loader/issues"
   },
   "devDependencies": {
-    "@babel/cli": "^7.5.0",
-    "@babel/core": "^7.5.4",
-    "babel-eslint": "^10.0.2",
-    "babel-jest": "^24.8.0",
-    "babel-preset-env": "^1.7.0",
+    "@types/jest": "^24.0.15",
+    "@types/jsdom": "^12.2.4",
+    "@types/memory-fs": "^0.3.2",
+    "@types/node": "^12.6.8",
+    "@types/webpack": "^4.4.35",
+    "@typescript-eslint/eslint-plugin": "^1.12.0",
+    "@typescript-eslint/parser": "^1.12.0",
+    "@typescript-eslint/typescript-estree": "^1.12.0",
     "conventional-changelog-cli": "^2.0.12",
     "conventional-github-releaser": "^3.1.2",
-    "cross-env": "^5.2.0",
     "eslint": "^6.0.0",
     "eslint-plugin-vue-libs": "^4.0.0",
     "git-commit-message-convention": "git://github.com/kazupon/git-commit-message-convention.git",
     "jest": "^24.8.0",
     "jsdom": "^15.1.1",
     "memory-fs": "^0.4.1",
     "opener": "^1.5.1",
+    "ts-jest": "^24.0.2",
+    "typescript": "^3.5.3",
     "vue-loader": "^15.7.0",
     "vue-template-compiler": "^2.6.10",
     "webpack": "^4.35.3"
@@ -50,15 +54,15 @@
     "url": "git+https://github.com/kazupon/vue-i18n-loader.git"
   },
   "scripts": {
-    "build": "cross-env BABEL_ENV=production babel ./src --out-dir ./lib",
+    "build": "tsc -p .",
     "changelog": "conventional-changelog -i CHANGELOG.md -s -n ./node_modules/git-commit-message-convention/convention.js",
     "clean": "rm -rf ./coverage && rm -rf ./lib/*.js*",
     "coverage": "opener coverage/lcov-report/index.html",
-    "lint": "eslint ./src ./test",
+    "lint": "eslint ./src ./test --ext .ts",
     "release": "conventional-github-releaser -n ./node_modules/git-commit-message-convention/convention.js",
     "test": "npm run lint && npm run test:cover",
     "test:cover": "npm run test:unit -- --coverage",
-    "test:unit": "cross-env BABEL_ENV=test jest --env node",
-    "watch": "cross-env BABEL_ENV=development babel ./src --out-dir ./lib --watch"
+    "test:unit": "jest --env node",
+    "watch": "tsc -p . --watch"
   }
 }
diff --git a/src/index.ts b/src/index.ts
@@ -1,8 +1,10 @@
-export default function (content) {
-  if (this.version && this.version >= 2) {
+import webpack from 'webpack'
+
+const loader: webpack.loader.Loader = function (source: string | Buffer): void {
+  if (this.version && Number(this.version) >= 2) {
     try {
       this.cacheable && this.cacheable()
-      this.callback(null, `module.exports = ${generateCode(content)}`)
+      this.callback(null, `module.exports = ${generateCode(source)}`)
     } catch (err) {
       this.emitError(err.message)
       this.callback(err)
@@ -14,12 +16,12 @@ export default function (content) {
   }
 }
 
-function generateCode (content) {
+function generateCode (source: string | Buffer): string {
   let code = ''
 
-  let value = typeof content === 'string'
-    ? JSON.parse(content)
-    : content
+  let value = typeof source === 'string'
+    ? JSON.parse(source)
+    : source
   value = JSON.stringify(value)
     .replace(/\u2028/g, '\\u2028')
     .replace(/\u2029/g, '\\u2029')
@@ -32,3 +34,5 @@ function generateCode (content) {
 }\n`
   return code
 }
+
+export default loader
diff --git a/test/__snapshots__/index.test.ts.snap b/test/__snapshots__/index.test.ts.snap
diff --git a/test/index.test.ts b/test/index.test.ts
diff --git a/test/utils.ts b/test/utils.ts
@@ -1,10 +1,23 @@
 import path from 'path'
 import webpack from 'webpack'
 import memoryfs from 'memory-fs'
-import { JSDOM, VirtualConsole } from 'jsdom'
-import VueLoaderPlugin from 'vue-loader/lib/plugin'
+import { JSDOM, VirtualConsole, DOMWindow } from 'jsdom'
+import { VueLoaderPlugin } from 'vue-loader'
 
-export function bundle (fixture, options = {}) {
+type BundleResolve = {
+  code: string,
+  stats: webpack.Stats
+}
+
+type BundleResolveResolve = BundleResolve & {
+  jsdomError: any,
+  instance: any,
+  window: DOMWindow,
+  module: any,
+  exports: any
+}
+
+export function bundle (fixture: string): Promise<BundleResolve> {
   const compiler = webpack({
     mode: 'development',
     devtool: false,
@@ -25,7 +38,7 @@ export function bundle (fixture, options = {}) {
       }, {
         resourceQuery: /blockType=i18n/,
         type: 'javascript/auto',
-        loader: path.resolve(__dirname, '../src/index.js')
+        loader: path.resolve(__dirname, '../src/index.ts')
       }]
     },
     plugins: [
@@ -38,17 +51,18 @@ export function bundle (fixture, options = {}) {
 
   return new Promise((resolve, reject) => {
     compiler.run((err, stats) => {
-      if (err) reject(err)
-      if (stats.hasErrors()) reject(new Error(stats.toJson().errors))
+      if (err) { return reject(err) }
+      if (stats.hasErrors()) { return reject(new Error(stats.toJson().errors.join(' | '))) }
       resolve({ code: mfs.readFileSync('/bundle.js').toString(), stats })
     })
   })
 }
 
-export async function bundleAndRun (fixture, options = {}) {
-  const { code, stats } = await bundle(fixture, options)
+export async function bundleAndRun (fixture: string): Promise<BundleResolveResolve> {
+  const { code, stats } = await bundle(fixture)
 
-  let dom, jsdomError
+  let dom: JSDOM | null = null
+  let jsdomError
   try {
     dom = new JSDOM(`<!DOCTYPE html><html><head></head><body></body></html>`, {
       runScripts: 'outside-only',
@@ -60,11 +74,15 @@ export async function bundleAndRun (fixture, options = {}) {
     jsdomError = e
   }
 
+  if (!dom) {
+    return Promise.reject(new Error('Cannot assigned JSDOM instance'))
+  }
+
   const { window } = dom
   const { module, exports } = window
   const instance = {}
   if (module && module.beforeCreate) {
-    module.beforeCreate.forEach(hook => hook.call(instance))
+    module.beforeCreate.forEach((hook: Function) => hook.call(instance))
   }
 
   return Promise.resolve({ window, module, exports, instance, code, jsdomError, stats })
diff --git a/tsconfig.json b/tsconfig.json
@@ -0,0 +1,70 @@
+{
+  "compilerOptions": {
+    /* Basic Options */
+    // "incremental": true,                   /* Enable incremental compilation */
+    "target": "es5",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
+    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
+    // "lib": [],                             /* Specify library files to be included in the compilation. */
+    // "allowJs": true,                       /* Allow javascript files to be compiled. */
+    // "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
+    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    "outDir": "./lib",                        /* Redirect output structure to the directory. */
+    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                     /* Enable project compilation */
+    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    // "noEmit": true,                        /* Do not emit outputs. */
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true,                           /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,              /* Enable strict null checks. */
+    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+
+    /* Module Resolution Options */
+    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                       /* List of folders to include type definitions from. */
+    //"typeRoots": [
+    //  "./@types",
+    //  "./node_modules/@types"
+    //],
+    // "types": [],                           /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+  },
+  "include": [
+    "src/**/*"
+  ]
+}
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
`1`	`1`	`./lib`
	`2`	`+./jest.config.js`
	`3`	`+./test/fixtures`