katabatic 1.0.0 → 1.1.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "katabatic",
   "license": "MIT",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "type": "module",
   "repository": {
     "type": "git",
@@ -16,8 +16,12 @@
   "bin": {
     "katabatic": "src/index.js"
   },
+  "engines": {
+    "node": ">=20.0.0"
+  },
   "dependencies": {
-    "@katabatic/compiler": "^1.0.0",
+    "@katabatic/compiler": "^1.1.0",
+    "@katabatic/dev-server-hmr": "^1.0.0",
     "@web/dev-server": "^0.4.6"
   }
 }

package/src/index.js

@@ -1,32 +1,51 @@
 #! /usr/bin/env node
-
 import path from 'path'
 import { watch as watchDir, existsSync } from 'fs'
+import { parseArgs } from 'node:util'
 import { startDevServer } from '@web/dev-server'
+import { hmrPlugin } from '@katabatic/dev-server-hmr'
 import { walkDir } from './utils/files.js'
-import * as argv from './utils/argv.js'
-import { serve } from './serve.js'
-import { buildIndex, buildModule, buildRouter } from './build.js'
 import { hash } from './utils/misc.js'
+import { printHelp, withHelp } from './utils/help.js'
+import { route } from './route.js'
+import { buildIndex, buildModule, buildRouter } from './build.js'
+
+const options = {
+    root: { type: 'string', short: 'r', description: 'project root directory (default: .)' },
+    srcDir: { type: 'string', description: 'src files directory (default .)' },
+    outDir: { type: 'string', description: 'out files directory (default .)' },
+    routesDir: {
+        type: 'string',
+        description:
+            'page and layout files directory when using the file system router (default ./routes)'
+    },
+    help: { type: 'boolean', short: 'h', description: 'get help' },
+    watch: { type: 'boolean', short: 'w', description: 'watches the file system' },
+    serve: { type: 'boolean', short: 's', description: 'starts the development server' },
+    hot: { type: 'boolean', description: 'generate code to support hot module replacement' },
+    rewriteRelativeImportExtensions: {
+        type: 'boolean',
+        description: 'rewrite imported katabatic files extension (.html or .ktb) in .js'
+    }
+}
 
-const command = argv.command()
+const { values: args } = withHelp(options, () => parseArgs({ options }))
 
-const rootPath = path.resolve(argv.option('root')) ?? process.cwd()
-const srcDirPath = path.join(rootPath, argv.option('srcDir') ?? '.')
-const outDirPath = path.join(rootPath, argv.option('outDir') ?? '.')
-const routesDirPath = path.join(srcDirPath, argv.option('routesDir') ?? './routes')
+const rootPath = path.resolve(args.root ?? '.')
+const srcDirPath = path.join(rootPath, args.srcDir ?? '.')
+const outDirPath = path.join(rootPath, args.outDir ?? '.')
+const routesDirPath = path.join(srcDirPath, args.routesDir ?? './routes')
 const hasRoutes = existsSync(routesDirPath)
 
-const rewriteRelativeImportExtensions = argv.option('rewriteRelativeImportExtensions') ?? false
+const hot = (args.hot || args.serve) ?? false
+const rewriteRelativeImportExtensions = args.rewriteRelativeImportExtensions ?? false
 
-switch (command) {
-    case 'build':
-        build()
-        break
-    default:
-        watch(build())
-        start()
-        break
+if (args.help) {
+    printHelp(options)
+} else {
+    const registry = build()
+    if (args.watch) watch(registry)
+    if (args.serve) serve()
 }
 
 function build() {
@@ -76,11 +95,11 @@ function watch(registry) {
     })
 }
 
-function start() {
-    const plugins = []
+function serve() {
+    const plugins = [hmrPlugin()]
 
     if (hasRoutes) {
-        plugins.push(serve(outDirPath))
+        plugins.push(route(outDirPath))
     }
 
     startDevServer({
@@ -88,7 +107,7 @@ function start() {
             rootDir: rootPath,
             port: 3000,
             watch: true,
-            open: true,
+            open: false,
             nodeResolve: true,
             plugins
         },
@@ -127,6 +146,7 @@ function resolve(srcFilePath, isModule) {
             isLayout,
             routerImport,
             hash: moduleHash,
+            hot,
             rewriteRelativeImportExtensions,
             src: {
                 filePath: srcFilePath

package/src/{serve.js → route.js}

@@ -1,13 +1,12 @@
 import path from 'path'
 
-export function serve(outDirPath) {
+export function route(outDirPath) {
     let router
 
     return {
-        name: 'serve',
+        name: 'route',
         async serve({ request }) {
             router ??= await import(path.join(outDirPath, 'router.js'))
-            console.log(request.url)
             return router.route(request.url)
         }
     }

package/src/utils/help.js

@@ -0,0 +1,32 @@
+export function printHelp(options, error) {
+    if (error) {
+        console.log(error.message)
+        console.log('')
+    }
+
+    console.log('usage: katabatic [options]')
+    console.log('')
+    for (const [name, config] of Object.entries(options)) {
+        let line = ''.padEnd(4)
+        line += config.short ? `-${config.short}, ` : ''
+        line += `--${name}`
+        line = line.padEnd(25)
+
+        if (line.length > 25) {
+            console.log(line)
+            line = ''.padEnd(25)
+        }
+
+        line += config.description ?? ''
+        console.log(line)
+    }
+}
+
+export function withHelp(options, fn) {
+    try {
+        return fn()
+    } catch (error) {
+        printHelp(options, error)
+        process.exit(1)
+    }
+}

package/src/utils/argv.js

@@ -1,12 +0,0 @@
-export function command() {
-    return process.argv[2]
-}
-
-export function option(name) {
-    const index = process.argv.indexOf(`-${name}`)
-
-    if (index >= 0) {
-        const value = process.argv[index + 1]
-        return value && value[0] !== '-' ? value : undefined
-    }
-}