patch: devtools command

Author: pelikhan

cli/src/build.ts

@@ -14,7 +14,7 @@ import {
     DEVS_BYTECODE_FILE,
 } from "devicescript-compiler"
 import { CmdOptions } from "./command"
-import { startDevTools } from "./devtools"
+import { devtools } from "./devtools"
 
 function jacsFactory() {
     let d = require("devicescript-vm")
@@ -28,11 +28,11 @@ function jacsFactory() {
     return d()
 }
 
-async function getHost(options: BuildOptions) {
+async function getHost(options: BuildOptions & CmdOptions) {
     const inst = options.noVerify ? undefined : await jacsFactory()
     inst?.jacsInit()
 
-    const outdir = options.outDir     
+    const outdir = options.outDir
     ensureDirSync(outdir)
 
     const jacsHost = {
@@ -74,7 +74,7 @@ async function compileBuf(buf: Buffer, options: BuildOptions) {
     return res.binary
 }
 
-export interface BuildOptions extends CmdOptions {
+export interface BuildOptions {
     noVerify?: boolean
     library?: boolean
     outDir?: string
@@ -84,12 +84,12 @@ export interface BuildOptions extends CmdOptions {
     mainFileName?: string
 }
 
-export async function build(file: string, options: BuildOptions) {
+export async function build(file: string, options: BuildOptions & CmdOptions) {
     file = file || "main.ts"
     options = options || {}
     options.outDir = options.outDir || "./built"
     options.mainFileName = file
-    
+
     await buildOnce(file, options)
     if (options.watch) await buildWatch(file, options)
 }
@@ -110,10 +110,10 @@ async function buildWatch(file: string, options: BuildOptions) {
     watch(file, work)
 
     // start watching bytecode file
-    await startDevTools(bytecodeFile)
+    await devtools({ ...options, bytecodeFile })
 }
 
-async function buildOnce(file: string, options: BuildOptions) {
+async function buildOnce(file: string, options: BuildOptions & CmdOptions) {
     try {
         if (!pathExistsSync(file))
             throw new Error(`source file ${file} not found`)

cli/src/cli.ts

@@ -1,6 +1,7 @@
-import { build } from "./build"
-import pkg from "../package.json"
 import { program } from "commander"
+import pkg from "../package.json"
+import { build } from "./build"
+import { devtools } from "./devtools"
 
 export async function mainCli() {
     program
@@ -26,6 +27,16 @@ export async function mainCli() {
         .arguments("[file.ts]")
         .action(build)
 
+    program
+        .command("devtools")
+        .description("launches a local deveplopement tools server")
+        .option("--internet", "allow connections from non-localhost")
+        .option(
+            "--localhost",
+            "use localhost:8000 instead of the internet dashboard"
+        )
+        .action(devtools)
+
     program.parse(process.argv)
 }
 

cli/src/command.ts

@@ -1,5 +1,4 @@
 export interface CmdOptions {
     verbose?: boolean
     noVerify?: boolean
-    library?: boolean
 }

cli/src/devtools.ts

@@ -6,6 +6,7 @@ import https from "https"
 import url from "url"
 import net from "net"
 import fs from "fs"
+import { CmdOptions } from "./command"
 
 const log = console.log
 const debug = console.debug
@@ -43,14 +44,15 @@ function fetchProxy(localhost: boolean): Promise<string> {
     })
 }
 
-export async function startDevTools(
-    bytecodeFile: string,
-    options?: {
-        internet?: boolean
-        localhost?: boolean
-    }
-) {
-    const { internet, localhost } = options || {}
+export interface DevToolsOptions {
+    internet?: boolean
+    localhost?: boolean
+
+    bytecodeFile?: string
+}
+
+export async function devtools(options: DevToolsOptions & CmdOptions) {
+    const { internet, localhost, bytecodeFile } = options
     const port = 8081
     const tcpPort = 8082
     const listenHost = internet ? undefined : "127.0.0.1"
@@ -66,16 +68,18 @@ export async function startDevTools(
     const clients: WebSocket[] = []
 
     // upload DeviceScript file is needed
-    const sendDeviceScript = () => {
-        const bytecode = fs.readFileSync(bytecodeFile)
-        debug(`refresh bytecode...`)
-        const msg = JSON.stringify({
-            type: "bytecode",
-            channel: "devicescript",
-            bytecode: bytecode.toString("hex"),
-        })
-        clients.forEach(c => c.send(msg))
-    }
+    const sendDeviceScript = bytecodeFile
+        ? () => {
+              const bytecode = fs.readFileSync(bytecodeFile)
+              debug(`refresh bytecode...`)
+              const msg = JSON.stringify({
+                  type: "bytecode",
+                  channel: "devicescript",
+                  bytecode: bytecode.toString("hex"),
+              })
+              clients.forEach(c => c.send(msg))
+          }
+        : undefined
 
     const server = http.createServer(function (req, res) {
         const parsedUrl = url.parse(req.url)
@@ -140,6 +144,8 @@ export async function startDevTools(
     server.listen(port, listenHost)
     tcpServer.listen(tcpPort, listenHost)
 
-    debug(`watch ${bytecodeFile}`)
-    fs.watch(bytecodeFile, sendDeviceScript)
+    if (bytecodeFile) {
+        debug(`watch ${bytecodeFile}`)
+        fs.watch(bytecodeFile, sendDeviceScript)
+    }
 }

website/docs/Dev/cli.md

@@ -2,8 +2,8 @@
 
 ## Setup
 
-* install [Node.js](https://nodejs.org/en/download/)
-* install the CLI using npm or yarn
+-   install [Node.js](https://nodejs.org/en/download/)
+-   install the CLI using npm or yarn
 
 ```bash
 npm install -g devicescript
@@ -16,15 +16,15 @@ yarn add devicescript
 
 The command tool is named `devicescript` or `devsc` for short.
 
-## Build
+## build
 
 The `build` command compiles a DeviceScript file (default is `main.ts`), using the resolution rules in `tsconfig.json`. It is the default command.
 
 ```bash
 devsc build main.ts
 ```
 
-### watch
+### --watch
 
 To automatically rebuild your program based on file changes,
 add `--watch`.
@@ -44,3 +44,19 @@ To access the developer tools outside localhost, add `--internet`
 ```bash
 devsc build --watch --internet
 ```
+
+## devtools
+
+The `devtools` command launches the developer tool server, without trying to build a project.
+
+```bash
+devsc devtools
+```
+
+#### --internet
+
+To access the developer tools outside localhost, add `--internet`
+
+```bash
+devsc devtools --internet
+```