bimba-cli 0.1.4 → 0.1.6

package/README.md

@@ -1,49 +1,69 @@
-This tool helps to work with [Imba](https://imba.io) projects under [Bun](https://bun.sh). That is why it is called Bun+IMBA = BIMBA 😉
-
-It includes the plugin for Bun to compile .imba files and also the CLI tool for buiding .imba files, since the plugins can't be passed to Bun via shell command `bun build`.
-
-First of all install this tool like any other npm package:
-```bash
-bun add bimba-cli
-```
-
-Then create a `bunfig.toml` file in the root folder of your project, and add only one line in it (I could not find any workaround to do this automatically):
-```bash
-preload = ["bimba-cli/plugin.ts"]
-```
-
-You are done!
-
-### Backend development
-Now to run an .imba file in Bun's environment you can use the usual Bun syntax: 
-```bash
-bun run src/index.imba
-```
-Or with the watch argument:
-```bash
-bun --watch run src/index.imba
-```
-
-###Frontend development
-For frontend you will need to compile and bundle your source code from .imba to .js. And here the bimba-cli will help:
-```bash
-bunx bimba src/index.imba --outdir public
-```
-Or with the watch argument: 
-```bash
-bunx bimba src/index.imba --outdir public --watch
-```
-
-There are additional arguments that you can pass to the bimba:
-
-`--sourcemap` - to tell Bun how to inculde sourcemap files in the final .js. It is `none` by default.
-
-`--minify` - to minify the final JS code in the bundle produced by Bun. It is `false` by default.
-
-`platform` - the value of this argument will be passed to the Imba compiler. By default it is `browswer`. The value `node` does not work under Bun.
-
-####Live reload
-Initially I implemented the live reload functionality, but then decided to refuse it. There is a pretty good VS Code extension: [Lite Server](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer).
-It does everything needed out of the box. 
-
+This tool helps to work with [Imba](https://imba.io) projects under [Bun](https://bun.sh). That is why it is called Bun+IMBA = BIMBA 😉
+
+It includes the plugin for Bun to compile .imba files and also the CLI tool for buiding .imba files, since the plugins can't be passed to Bun via shell command `bun build`.
+
+First of all install this tool like any other npm package:
+```bash
+bun add bimba-cli -d
+```
+
+Then create a `bunfig.toml` file in the root folder of your project, and add only one line in it (I could not find any workaround to do this automatically):
+```bash
+preload = ["bimba-cli/plugin.js"]
+```
+
+You are done!
+
+### Backend development
+Now to run an .imba file in Bun's environment you can use the usual Bun syntax: 
+```bash
+bun run src/index.imba
+```
+Or with the watch argument:
+```bash
+bun --watch run src/index.imba
+```
+
+### Frontend development
+For frontend you will need to compile and bundle your source code from .imba to .js. And here the bimba-cli will help:
+```bash
+bunx bimba src/index.imba --outdir public
+```
+Or with the watch argument: 
+```bash
+bunx bimba src/index.imba --outdir public --watch
+```
+
+Here are all the available argumentsthat you can pass to the bimba:
+
+`--watch` - Monitors changes in the directory where the entry point is located, and rebuilds the projects when the change occures. Keep entrypoint file in the subfolder, otherwise Bun will trigger several times since the cache dir update also triggers rebuilding.
+
+`--clearcache` - If is set, the cache directory is deleted when bimba exits. Works only in the watch mode, since when bundling cache will be used next time to speed up the compiling time.
+
+```bash
+bunx bimba src/index.imba --outdir public --watch --clearcache
+```
+
+`--sourcemap` - Tells Bun how to inculde sourcemap files in the final .js. It is `none` by default.
+
+```bash
+bunx bimba src/index.imba --outdir public --sourcemap inline
+```
+
+`--minify` - If is set the final JS code in the bundle produced by Bun will be minified. It is `false` by default.
+
+```bash
+bunx bimba src/index.imba --outdir public --minify
+```
+
+`--platform` - The value of this argument will be passed to the Imba compiler. By default it is `browswer`. The value `node` does not work under Bun.
+
+```bash
+bunx bimba src/index.imba --outdir public --platform browser
+```
+
+#### Live reload
+Initially I have implemented the live reload functionality, but then decided to refuse it. There is a pretty good VS Code extension: [Lite Server](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer).
+It does everything needed out of the box. 
+
 Just let bimba rebuild the sources on change and Lite Server will reload the page in the browser.

package/{index.ts → index.js}

@@ -1,129 +1,120 @@
-#!/usr/bin/env bun
-
-import { parseArgs } from "util";
-import ansis from 'ansis';
-import { imbaPlugin, stats } from './plugin.ts'
-import fs from 'fs'
-import path from 'path';
-
-let flags = {};
-let folders = {};
-
-try {
-    const { values, positionals } = parseArgs({
-        args: Bun.argv,
-        options: {
-            watch: { type: 'boolean' },
-            outdir: { type: 'string' },
-            help: { type: 'boolean' },
-            minify: { type: 'boolean' },
-            target: { type: 'string' },
-            sourcemap: { type: 'string' },
-        },
-        strict: true,
-        allowPositionals: true,
-    });
-    flags = values;
-    flags.entry = Bun.argv[2];
-    folders = positionals;
-}
-catch (error) {
-    if (error instanceof Error)
-        console.log(error.message);
-    else
-        console.log("Could not resolve CLI arguments. Read help to know them: " + theme.flags('--entry file.imba'));
-    process.exit(1);
-}
-
-const theme = {
-    flags: ansis.fg(5),
-    count: ansis.fg(15).bold,
-	start: ansis.fg(252).bg(233),
-	filedir: ansis.fg(15),
-	success: ansis.fg(40),
-	failure: ansis.fg(196),
-	time: ansis.fg(41),
-	link: ansis.fg(15),
-	online: ansis.fg(40).bg(22)
-};
-
-// help: more on bun building params here: https://bun.sh/docs/bundler
-if(flags.help) {
-    console.log("");
-    console.log("Bimba requeres an .imba file and a folder where to put compiled .js files.");
-    console.log("For example like this: "+theme.filedir('bimba file.imba --outdir public'));
-    console.log("");
-    console.log("   "+theme.flags('--outdir <folder>')+"                     Compile imba files to the specified folder");
-    console.log("   "+theme.flags('--minify')+"                              Minify compiled .js files");
-    console.log("   "+theme.flags('--sourcemap <inline|external|none>')+"    How should sourcemap files be included in the .js");
-    console.log("   "+theme.flags('--platform <browser|node>')+"             Flag that will be passed to Imba compiler ('node' value does not work in Bun)");
-    console.log("   "+theme.flags('--watch')+"                               Watch for changes in the entrypoint folder");
-    console.log("");
-    process.exit(1);
-}
-
-
-// no entrypoint or outdir
-if(!flags.entry || !flags.outdir) {
-    console.log("");
-    console.log("You should provide entrypoint and the output dir: "+theme.flags('bimba file.imba --outdir public'));
-    console.log("For more information: "+theme.flags('--help'));
-    console.log("");
-    process.exit(1);
-}
-
-// build
-bundle();
-watch(bundle);
-
-function watch(callback) {
-    if (flags.watch) {
-        const watcher = fs.watch(path.dirname(flags.entry), {recursive: true}, async (event, filename) => ( callback() ));
-    
-        process.on("SIGINT", () => {
-            if(watcher) {
-                watcher.close();
-                process.exit(0);
-            }
-        });
-    }
-}
-
-async function bundle() {
-    if (!fs.existsSync(flags.entry)) {
-        console.log(theme.failure('Error.') + ` The specified entrypoint does not exist: ${theme.filedir(flags.entry)}`);
-        process.exit(1);
-    }
-
-    //if (!fs.existsSync(flags.bundle)){ fs.mkdirSync(flags.bundle);}
-
-    stats.failed = 0
-    stats.compiled = 0
-    stats.errors = 0
-    stats.bundled = 0
-
-    const start = Date.now();
-
-    console.log("──────────────────────────────────────────────────────────────────────");
-    console.log(theme.start(`Start building the Imba entrypoint: ${theme.filedir(flags.entry)}`));
-
-    const result = await Bun.build({
-        entrypoints: [flags.entry],
-        outdir: flags.outdir,
-        target: flags.target || 'browser',
-        sourcemap: flags.sourcemap || 'none',
-        minify: flags.minify || true,
-        plugins: [imbaPlugin]
-    });
-
-    if(stats.failed)
-        console.log(theme.start(theme.failure("Failure.") +` Imba compiler failed to proceed ${theme.count(stats.failed)} file${stats.failed > 1 ? 's' : ''}`));
-    else
-        console.log(theme.start(theme.success("Success.") +` It took ${theme.time(Date.now() - start)} ms to bundle ${theme.count(stats.bundled)} file${stats.bundled > 1 ? 's' : ''} to the folder: ${theme.filedir(flags.outdir)}`));
-
-    if(!result.success && !stats.errors){
-        for (const log of result.logs) {
-            console.log(log);
-        }
-    }
+#!/usr/bin/env bun
+
+import { parseArgs } from "util";
+import { imbaPlugin, stats, cache } from './plugin.js'
+import {theme} from './utils.js';
+import fs from 'fs'
+import path from 'path';
+import { rmSync } from "node:fs";
+
+
+let flags = {}
+let entrypoint = ''
+
+try {
+    const { values, positionals } = parseArgs({
+        args: Bun.argv,
+        options: {
+            watch: { type: 'boolean' },
+            outdir: { type: 'string' },
+            help: { type: 'boolean' },
+            clearcache: { type: 'boolean' },
+            minify: { type: 'boolean' },
+            target: { type: 'string' },
+            sourcemap: { type: 'string' },
+        },
+        strict: true,
+        allowPositionals: true,
+    });
+    flags = values;
+    entrypoint = Bun.argv[2];
+}
+catch (error) {
+    if (error instanceof Error)
+        console.log(error.message);
+    else
+        console.log("Could not resolve CLI arguments. Read help to know them: " + theme.flags('--entry file.imba'));
+    process.exit(0);
+}
+
+// help: more on bun building params here: https://bun.sh/docs/bundler
+if(flags.help) {
+    console.log("");
+    console.log("Bimba requeres an .imba file and a folder where to put compiled .js files.");
+    console.log("For example like this: "+theme.filedir('bimba file.imba --outdir public'));
+    console.log("");
+    console.log("   "+theme.flags('--outdir <folder>')+"                     Compile imba files to the specified folder");
+    console.log("   "+theme.flags('--minify')+"                              Minify compiled .js files");
+    console.log("   "+theme.flags('--sourcemap <inline|external|none>')+"    How should sourcemap files be included in the .js");
+    console.log("   "+theme.flags('--platform <browser|node>')+"             Flag that will be passed to Imba compiler ('node' value does not work in Bun)");
+    console.log("   "+theme.flags('--watch')+"                               Watch for changes in the entrypoint folder");
+    console.log("   "+theme.flags('--clearcache')+"                          Clear cache on exit, works only when in watch mode");
+    console.log("");
+    process.exit(0);
+}
+
+
+// no entrypoint or outdir
+if(!entrypoint || !flags.outdir) {
+    console.log("");
+    console.log("You should provide entrypoint and the output dir: "+theme.flags('bimba file.imba --outdir public'));
+    console.log("For more information: "+theme.flags('--help'));
+    console.log("");
+    process.exit(1);
+}
+
+// build
+bundle();
+watch(bundle);
+
+function watch(callback) {
+    if (flags.watch) {
+        const watcher = fs.watch(path.dirname(entrypoint), {recursive: true}, async (event, filename) => ( callback() ));
+    
+        process.on("SIGINT", () => {
+            if(flags.clearcache) rmSync(cache, { recursive: true, force: true });
+
+            if(watcher) {
+                watcher.close();
+                process.exit(0);
+            }
+        });
+    }
+}
+
+async function bundle() {
+    if (!fs.existsSync(entrypoint)) {
+        console.log(theme.failure('Error.') + ` The specified entrypoint does not exist: ${theme.filedir(entrypoint)}`);
+        process.exit(0);
+    }
+
+    stats.failed = 0
+    stats.compiled = 0
+    stats.errors = 0
+    stats.bundled = 0
+
+    const start = Date.now();
+
+    console.log("──────────────────────────────────────────────────────────────────────");
+    console.log(theme.start(`Start building the Imba entrypoint: ${theme.filedir(entrypoint)}`));
+
+    const result = await Bun.build({
+        entrypoints: [entrypoint],
+        outdir: flags.outdir,
+        target: flags.target || 'browser',
+        sourcemap: flags.sourcemap || 'none',
+        minify: flags.minify || true,
+        plugins: [imbaPlugin]
+    });
+
+    if(stats.failed)
+        console.log(theme.start(theme.failure("Failure.") +` Imba compiler failed to proceed ${theme.count(stats.failed)} file${stats.failed > 1 ? 's' : ''}`));
+    else
+        console.log(theme.start(theme.success("Success.") +` It took ${theme.time(Date.now() - start)} ms to bundle ${theme.count(stats.bundled)} file${stats.bundled > 1 ? 's' : ''} to the folder: ${theme.filedir(flags.outdir)}`));
+
+    if(!result.success && !stats.errors){
+        for (const log of result.logs) {
+            console.log(log);
+        }
+    }
 }

package/package.json

@@ -1,17 +1,16 @@
-{
-  "name": "bimba-cli",
-  "version": "0.1.4",
-  "repository": "github:HeapVoid/bimba",
-  "module": "index.ts",
-  "bin": {
-    "bimba": "./index.ts"
-  },
-  "description": "The CLI tool to run Imba projects under Bun",
-  "keywords": ["imba", "bun", "plugin"],
-  "license": "MIT",
-  "type": "module",
-  "dependencies": {
-    "ansis": "^2.2.0",
-    "imba": "^2.0.0-alpha.234"
-  }
+{
+  "name": "bimba-cli",
+  "version": "0.1.6",
+  "repository": "github:HeapVoid/bimba",
+  "module": "index.js",
+  "bin": {
+    "bimba": "./index.js"
+  },
+  "description": "The CLI tool to run Imba projects under Bun",
+  "keywords": ["imba", "bun", "plugin"],
+  "license": "MIT",
+  "type": "module",
+  "devDependencies": {
+    "imba": "^2.0.0-alpha.234"
+  }
 }

package/{plugin.ts → plugin.js}

@@ -1,21 +1,12 @@
-import { plugin, type BunPlugin } from "bun";
-import ansis from 'ansis';
+import { plugin } from "bun";
+import {theme} from './utils.js';
 import * as compiler from 'imba/compiler'
 import dir from 'path'
 import fs from 'fs'
+import { Glob } from "bun";
+import { unlink } from "node:fs/promises";
 
-// theme for messages printed in terminal
-// color pallete can be seen here: https://raw.githubusercontent.com/webdiscus/ansis/master/docs/img/ansi256.png
-// for more details read the project page: https://github.com/webdiscus/ansis
-const theme = {
-  action: ansis.fg(237),
-  folder: ansis.fg(240),
-  filename: ansis.fg(15),
-  success: ansis.fg(40),
-  failure: ansis.fg(15).bg(124),
-};
-
-const cache = process.cwd() + '/.cache/';
+export const cache = process.cwd() + '/.cache/';
 if (!fs.existsSync(cache)){ fs.mkdirSync(cache);}
 
 // this should be reset from outside to get results of entrypoint building
@@ -27,7 +18,7 @@ export let stats = {
   errors: 0
 };
 
-export const imbaPlugin: BunPlugin = {
+export const imbaPlugin = {
   name: "imba",
   async setup(build) {
 
@@ -82,7 +73,7 @@ export const imbaPlugin: BunPlugin = {
       let contents = '';
       
       // return the cached version if it exists
-      const cached = cache + Bun.hash(path + fs.statSync(path).mtimeMs) + '_' + f.name + '.js';;
+      const cached = cache + Bun.hash(path) + '_' + fs.statSync(path).mtimeMs + '.js';
       if (fs.existsSync(cached)) {
         stats.bundled++;
         stats.cached++;
@@ -93,6 +84,10 @@ export const imbaPlugin: BunPlugin = {
         };
       }
 
+      // clear previous cached version
+      const glob = new Glob(Bun.hash(path) + '_' + "*.js");
+      for await (const file of glob.scan(cache)) unlink(cache + file);
+
       // if no cached version read and compile it with the imba compiler
       const file = await Bun.file(path).text();
       const out = compiler.compile(file, {
@@ -137,32 +132,13 @@ plugin(imbaPlugin);
 // print pretty messages produced by the imba compiler 
 // -------------------------------------------------------------------------------
 
-type imbaCompilerError = {
-  toSnippet: Function;
-  toError: Function;
-  message: string;
-  range: {
-    start: {
-      line: number
-    }
-  }
-}
-
 // print an error generated by the imba compiler
-function printerr(err: imbaCompilerError) {
+function printerr(err) {
   
   // halper function to produce empty strings
   const fill = (len = 0) => {return new Array(len + 1).join(' ')}
   
-  // set color theme for an error message
-  const colors = {
-    code: ansis.fg(252).bg(238),
-    margin: ansis.fg(229).bg(145),
-    error: ansis.fg(196).bg(52),
-    ecode: ansis.fg(196).bg(238).bold,
-  };
-
-  // gather the needed information from the compiler error
+   // gather the needed information from the compiler error
   const snippet = err.toSnippet().split("\n");
   const display = {
     error: " " + err.message + " ",
@@ -186,21 +162,21 @@ function printerr(err: imbaCompilerError) {
   // print line with the error message
   console.log(
     display.outdent +
-    colors.margin(fill(Math.min(start, display.margin.length))) + 
-    colors.code(fill(Math.max(0, start - display.margin.length))) + 
-    colors.error(display.error) +
-    colors.margin(fill(Math.max(0, display.margin.length - end))) +
-    colors.code(fill(Math.min(total - display.margin.length, total - end)))
+    theme.margin(fill(Math.min(start, display.margin.length))) + 
+    theme.code(fill(Math.max(0, start - display.margin.length))) + 
+    theme.error(display.error) +
+    theme.margin(fill(Math.max(0, display.margin.length - end))) +
+    theme.code(fill(Math.min(total - display.margin.length, total - end)))
   );
 
   // print line with the source code
   console.log(
     display.outdent + 
-    colors.margin(display.margin) + 
-    colors.code(display.source.slice(0,display.errs)) + 
-    colors.error(display.source.slice(display.errs,display.erre)) + 
-    colors.code(display.source.slice(display.erre)) +
-    colors.code(fill(total - display.source.length - display.margin.length))
+    theme.margin(display.margin) + 
+    theme.code(display.source.slice(0,display.errs)) + 
+    theme.error(display.source.slice(display.errs,display.erre)) + 
+    theme.code(display.source.slice(display.erre)) +
+    theme.code(fill(total - display.source.length - display.margin.length))
   );
 
   // print empty line to balance the view 
@@ -208,8 +184,8 @@ function printerr(err: imbaCompilerError) {
   // for example a link to online docs about the error
   console.log(
     display.outdent + 
-    colors.margin(fill(display.margin.length)) + 
-    colors.code(fill(total - display.margin.length))
+    theme.margin(fill(display.margin.length)) + 
+    theme.code(fill(total - display.margin.length))
   );
 
   // print emtpy line

package/utils.js

@@ -0,0 +1,30 @@
+function colorize(text:string, fg?:number, bg?:number) {
+    let result = ''
+    if(fg) result += "\x1b[38;5;" + fg.toString() + "m"
+    if(bg) result += "\x1b[48;5;" + bg.toString() + "m"
+    result += text
+    if(fg || bg) result += "\x1b[0m"
+    return result
+}
+
+// theme for messages printed in terminal
+// https://i.stack.imgur.com/KTSQa.png
+export const theme = {
+    code: (text:string) =>      colorize(text, 252, 238),
+    margin: (text:string) =>    colorize(text, 229, 145),
+    error: (text:string) =>     colorize(text, 196 , 52),
+    ecode: (text:string) =>     colorize(text, 196, 238),
+    action: (text:string) =>    colorize(text, 237),
+    folder: (text:string) =>    colorize(text, 240),
+    filename: (text:string) =>  colorize(text, 15),
+    success: (text:string) =>   colorize(text, 40),
+    failure: (text:string) =>   colorize(text, 15, 124),
+
+    flags: (text:string) =>      colorize(text, 5),
+    count: (text:string) =>      colorize(text, 15),
+    start: (text:string) =>      colorize(text, 252, 233),
+    filedir: (text:string) =>    colorize(text, 15),
+    time: (text:string) =>       colorize(text, 41),
+    link: (text:string) =>       colorize(text, 15),
+    online: (text:string) =>     colorize(text, 40, 22)
+}

package/tsconfig.json

@@ -1,22 +0,0 @@
-{
-  "compilerOptions": {
-    "lib": ["ESNext"],
-    "target": "ESNext",
-    "module": "ESNext",
-    "moduleDetection": "force",
-    "jsx": "react-jsx",
-    "allowJs": true,
-
-    /* Bundler mode */
-    "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "verbatimModuleSyntax": true,
-    "noEmit": true,
-
-    /* Linting */
-    "skipLibCheck": true,
-    "strict": true,
-    "noFallthroughCasesInSwitch": true,
-    "forceConsistentCasingInFileNames": true
-  }
-}