refactor: clean up

Author: Wenjie Xia

cli.ts

@@ -36,40 +36,39 @@ Options:
 async function main() {
     // parse deno args
     const args: Array<string> = []
-    const argOptions: Record<string, string | boolean> = {}
+    const flags: Record<string, string | boolean> = {}
     for (let i = 0; i < Deno.args.length; i++) {
         const arg = Deno.args[i]
         if (arg.startsWith('-')) {
             if (arg.includes('=')) {
                 const [key, value] = arg.replace(/^-+/, '').split('=', 2)
-                argOptions[key] = value
+                flags[key] = value
             } else {
                 const key = arg.replace(/^-+/, '')
                 const nextArg = Deno.args[i + 1]
                 if (nextArg && !nextArg.startsWith('-')) {
-                    argOptions[key] = nextArg
+                    flags[key] = nextArg
                     i++
                 } else {
-                    argOptions[key] = true
+                    flags[key] = true
                 }
             }
         } else {
             args.push(arg)
         }
     }
 
-    // get command, default is 'dev'
     const hasCommand = args.length > 0 && args[0] in commands
     const command = (hasCommand ? String(args.shift()) : 'dev') as keyof typeof commands
 
     // prints aleph.js version
-    if (argOptions.v && command != 'upgrade') {
+    if (flags.v && command != 'upgrade') {
         console.log(`aleph.js v${VERSION}`)
         Deno.exit(0)
     }
 
     // prints aleph.js and deno version
-    if (argOptions.version && command != 'upgrade') {
+    if (flags.version && command != 'upgrade') {
         const { deno, v8, typescript } = Deno.version
         console.log(`aleph.js ${VERSION}`)
         console.log(`deno ${deno}`)
@@ -79,7 +78,7 @@ async function main() {
     }
 
     // prints help message
-    if (argOptions.h || argOptions.help) {
+    if (flags.h || flags.help) {
         if (hasCommand) {
             import(`./cli/${command}.ts`).then(({ helpMessage }) => {
                 console.log(commands[command])
@@ -96,7 +95,7 @@ async function main() {
     }
 
     // sets log level
-    const l = argOptions.L || argOptions['log-level']
+    const l = flags.L || flags['log-level']
     if (util.isNEString(l)) {
         log.setLevel(l)
     }
@@ -163,14 +162,14 @@ async function main() {
 
     const { default: cmd } = await import(`./cli/${command}.ts`)
     if (command === 'upgrade') {
-        await cmd(argOptions.v || argOptions.version || args[0] || 'latest')
+        await cmd(flags.v || flags.version || args[0] || 'latest')
         return
     }
     const appDir = path.resolve(args[0] || '.')
     if (command !== 'init' && !existsDirSync(appDir)) {
         log.fatal('No such directory:', appDir)
     }
-    await cmd(appDir, argOptions)
+    await cmd(appDir, flags)
 }
 
 if (import.meta.main) {

deps.ts

@@ -1,4 +1,4 @@
-// deno.land/std
+// std
 export { Untar } from 'https://deno.land/[email protected]/archive/tar.ts'
 export * as bytes from 'https://deno.land/[email protected]/bytes/mod.ts'
 export * as base64 from 'https://deno.land/[email protected]/encoding/base64.ts'

plugins/sass.ts

@@ -1,7 +1,7 @@
 import { Options, renderSync } from 'https://esm.sh/[email protected]'
-import type { Plugin } from '../types.ts'
+import type { LoaderPlugin } from '../types.ts'
 
-const pluginFactory = (opts: Options = {}): Plugin => ({
+const pluginFactory = (opts: Options = {}): LoaderPlugin => ({
     type: 'loader',
     name: 'sass-loader',
     test: /.(sass|scss)$/,

plugins/wasm.ts

@@ -1,20 +1,18 @@
-import type { Plugin } from '../types.ts'
+import type { LoaderPlugin } from '../types.ts'
 
-const wasmLoader: Plugin = {
+const wasmLoader: LoaderPlugin = {
     type: 'loader',
     name: 'wasm-loader',
     test: /.wasm$/,
-    transform(content: Uint8Array, path: string) {
-        return {
-            code: `
-                const wasmCode = new Uint8Array([${content.join(',')}])
-                const wasmModule = new WebAssembly.Module(wasmCode)
-                const { exports } = new WebAssembly.Instance(wasmModule)
-                export default exports
-            `,
-            loader: 'js'
-        }
-    }
+    transform: (content: Uint8Array, path: string) => ({
+        code: `
+            const wasmBytes = new Uint8Array([${content.join(',')}])
+            const wasmModule = new WebAssembly.Module(wasmBytes)
+            const { exports } = new WebAssembly.Instance(wasmModule)
+            export default exports
+        `,
+        loader: 'js'
+    })
 }
 
 export default wasmLoader

plugins/wasm_test.ts

@@ -2,15 +2,15 @@ import { assertEquals } from 'https://deno.land/[email protected]/testing/asserts.ts'
 import plugin from './wasm.ts'
 
 Deno.test('project wasm loader plugin', async () => {
-    const wasmCode = new Uint8Array([
+    const wasmBytes = new Uint8Array([
         0, 97, 115, 109, 1, 0, 0, 0, 1, 133, 128, 128, 128, 0, 1, 96, 0, 1, 127,
         3, 130, 128, 128, 128, 0, 1, 0, 4, 132, 128, 128, 128, 0, 1, 112, 0, 0,
         5, 131, 128, 128, 128, 0, 1, 0, 1, 6, 129, 128, 128, 128, 0, 0, 7, 145,
         128, 128, 128, 0, 2, 6, 109, 101, 109, 111, 114, 121, 2, 0, 4, 109, 97,
         105, 110, 0, 0, 10, 138, 128, 128, 128, 0, 1, 132, 128, 128, 128, 0, 0,
         65, 42, 11
     ])
-    const { code, loader } = await plugin.transform(wasmCode, '42.wasm')
+    const { code, loader } = await plugin.transform(wasmBytes, '42.wasm')
     const jsfile = (await Deno.makeTempFile()) + '.js'
     await Deno.writeTextFile(jsfile, code)
     const { default: wasm } = await import('file://' + jsfile)

types.ts

@@ -1,13 +1,19 @@
 import type { AcceptedPlugin, bufio } from './deps.ts'
 
-type TransformRet = {
+/**
+ * The loader plugin transform result.
+ */
+type TransformResult = {
+    loader: 'js' | 'ts' | 'jsx' | 'tsx' | 'css' // default is 'js'
     code: string,
     map?: string,
-    loader?: 'js' | 'ts' | 'jsx' | 'tsx' | 'css' // default is 'js'
 }
 
+/**
+ * A loader plugin to transform the source media.
+ */
 export type LoaderPlugin = {
-    /* `type` defines the plugin type */
+    /** `type` defines the plugin type. */
     type: 'loader'
     /** `name` gives the plugin a name. */
     name: string
@@ -16,7 +22,7 @@ export type LoaderPlugin = {
     /** `acceptHMR` enables the HMR. */
     acceptHMR?: boolean
     /** `transform` transforms the source content. */
-    transform(content: Uint8Array, url: string): TransformRet | Promise<TransformRet>
+    transform(content: Uint8Array, url: string): TransformResult | Promise<TransformResult>
 }
 
 /**