bimba-cli 0.1.2 → 0.1.4

package/README.md

@@ -1,15 +1,49 @@
-# bimba-cli
+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 😉
 
-To install dependencies:
+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 install
+bun add bimba-cli
 ```
 
-To run:
+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
-bun run index.ts
+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 project was created using `bun init` in bun v1.0.26. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
+Just let bimba rebuild the sources on change and Lite Server will reload the page in the browser.

package/index.ts

@@ -5,7 +5,6 @@ import ansis from 'ansis';
 import { imbaPlugin, stats } from './plugin.ts'
 import fs from 'fs'
 import path from 'path';
-import { $ } from "bun";
 
 let flags = {};
 let folders = {};
@@ -51,44 +50,31 @@ const theme = {
 // help: more on bun building params here: https://bun.sh/docs/bundler
 if(flags.help) {
     console.log("");
-    console.log("Bimba requeres an .imba file as the first argument.");
-    console.log("By default the provided .imba file will be launched (the project will be compiled on the fly by Bun):");
-    console.log("   "+theme.flags('bimba <file.imba>')+"           The entrypoint of the imba project");
+    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("To compile Imba project to .js file the outdir should be specified:");
-    console.log("   "+theme.flags('--outdir <folder>')+"                          Compile imba files to specified folder");
-    console.log("");
-    console.log("There are other options that could be used when compiling .imba files:");
-    console.log("   "+theme.flags('--minify')+"                                 Minify compiled .js files");
-    console.log("   "+theme.flags('--sourcemap <inline|external|none>')+"     How should be 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("");
-    console.log("The watch switch is applied in both scenarios (when running and when building Imba sources):");
-    console.log("   "+theme.flags('--watch')+"              Watch for changes in the entrypoint folder");
+    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
-if(!flags.entry) {
+// no entrypoint or outdir
+if(!flags.entry || !flags.outdir) {
     console.log("");
-    console.log("No entrypoint provided: "+theme.flags('bimba file.imba'));
+    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
-if(flags.outdir){
-    bundle();
-    watch(bundle);
-}
-else {
-    run();
-    watch(run);
-}
+bundle();
+watch(bundle);
 
 function watch(callback) {
     if (flags.watch) {
@@ -103,11 +89,6 @@ function watch(callback) {
     }
 }
 
-async function run() {
-    await $`bun run ${path.resolve(flags.entry)}`;
-}
-
-
 async function bundle() {
     if (!fs.existsSync(flags.entry)) {
         console.log(theme.failure('Error.') + ` The specified entrypoint does not exist: ${theme.filedir(flags.entry)}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bimba-cli",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "repository": "github:HeapVoid/bimba",
   "module": "index.ts",
   "bin": {

package/bunfig.toml

@@ -1 +0,0 @@
-preload = ["./plugin.ts"]