bunosh 0.1.0 → 0.1.2

package/README.md

@@ -1,15 +1,125 @@
-# bunosh
+# 🍲 bunosh
 
-To install dependencies:
+> *Named after **banosh**, a traditional Ukrainian dish from cornmeal cooked with various ingredients such as mushrooms, cheese, sour cream*
+
+<p align="center">
+  <img src="assets/logo.jpg" alt="Logo">
+</p>
+
+## What it is?
+
+Bunosh is a task runner powered by [Bun](https://bun.sh). Bunosh is aimed to help you to write common scripts in JavaScript with less effort. Combines awesome tools: Bun, Commander.js, Ink, Inquirer in a the most compact way.
+
+What can you automate with Bunosh:
+
+* shell scripts → use JavaScript to write them (you know it better, anyway!)
+* boilerplate scripts → create new files from templates
+* deploy scripts → combine JS and Shell commands to build and deploy
+* parallel tasks → with native `Promise.all` execute multiple tasks at once
+* ...every other task you have previously written a custom `js` or `shell` script
+
+Bunosh will get your scripts cooked into a **single JavaScript file**.
+
+Each function of this file:
+```js
+/** Cleans up tmp & logs dir **/
+export async function cleanTmp() {
+  await $`rm -rf tmp/*`;
+  await $`rm -rf logs/*`;
+}
+
+/** Builds Docker images for project **/
+export async function build(opts = { push: false }) {
+  await Promise.all([
+    buildFrontend(),
+    buildBackend(),
+  ])
+
+  if (opts.push) {
+    await $`docker push frontend`;
+    await $`docker push backend`;
+  }
+}
+
+/** Deploys application **/
+export async function deploy(env = 'staging') {
+  await build();
+  // ...
+}
+
+/** Adds value to config **/
+export async function addToConfig(key, value) {}
+
+//....
+```
+
+Is turned into an executable command:
+```
+Commands:
+  add:to-config  Adds value to config
+    bunosh add:to-config [key] [value]
+  build          Builds Docker images for project
+    bunosh build --push
+  clean:tmp      Cleans up tmp & logs dir
+  deploy         Deploys application
+    bunosh deploy [env=staging]
+
+
+Special Commands:
+  📝 Edit bunosh file: bunosh edit
+  📥 Export scripts to package.json: bunosh export:scripts
+
+```
+
+### Command Rules:
+
+* each exported function is a command: 
+  * `function addUserModel` → `bunosh add:user-model`
+* each function argument is a command argument:
+  * `addUser(name)`  → `bunosh add:user <name>`
+  * `addUser(name='john')` → `bunosh add:user [name=john]`
+* last argument passed as an object defines options:
+  * `clean(opts = {tmp: false, logs: false})` → `bunosh clean --tmp --logs`
+  * `addUsers(opts = {num: 1})` → `bunosh add:users --num 1`
+* docblock or first-line comment of a function makes a command description
+* functions can call make fetch requests, exec shell commands or call other functions
+
+
+### Installation
+
+Install [Bun](https://bun.sh) (faster NodeJS alternative)
+
+Install Bunosh globally:
 
 ```bash
-bun install
+bun install -g bunosh 
 ```
 
-To run:
+Create a new tasks file in a project directory:
 
 ```bash
-bun run index.ts
+bunosh init
 ```
 
-This project was created using `bun init` in bun v1.0.20. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
+### API
+
+Commands can be written using classical NodeJS API using `fs` or `child_process` modules and print output using `console.log`. However, this doesn't unleash true Bunosh power.
+
+Bunosh ships with a built-in functions to simplify writing scripts:
+
+### Exec 
+
+`exec` or `$` is a wrapper around [Bun Shell](https://bun.sh/docs/runtime/shell). It is cross-platform bash-like shell with seamless JavaScript interop.
+
+```js
+import { exec } from `bunosh`
+
+export async function build()
+{
+  await exec`docker ps`
+  await exec`docker build -t api .`
+}
+```
+
+Bunosh wraps `$` to make a fancy realtime output with Ink:
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bunosh",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "module": "index.js",
   "bin": {
     "bunosh": "./run.js"
@@ -24,10 +24,18 @@
     "ink-spinner": "^5.0.0",
     "inquirer": "^9.2.13",
     "open-editor": "^4.1.1",
-    "picocolors": "^1.0.0",
     "react": "^18.2.0",
     "timer-node": "^5.0.7"
   },
+  "license": "ISC",
+  "files": [
+    "index.js",
+    "run.js",
+    "io.js",
+    "files.js",
+    "src",
+    "templates"
+  ],  
   "lint-staged": {
     "*.{js,css,md}": "prettier --write"
   },

package/run.js

@@ -1,10 +1,11 @@
-
+#!/usr/bin/env bun
 import program, { BUNOSHFILE, banner }  from "./src/program";
 import { existsSync, readFileSync } from "fs";
 import init from "./src/init";
+import path from "path";
 import { say, yell } from './io';
 
-const tasksFile = `./${BUNOSHFILE}`;
+const tasksFile = path.join(process.cwd(), BUNOSHFILE);
 
 if (!existsSync(tasksFile)) {
   console.log(banner);

package/src/init.js

@@ -1,11 +1,40 @@
 import { BUNOSHFILE } from "./program";
 import color from "picocolors";
-import fs from "fs";
-import templateFile from "../templates/init";
+import fs from 'fs';
+
+const template = `
+import { exec, fetch, ignoreFail } from 'bunosh';
+import { say, yell } from 'bunosh/io';
+import { writeToFile } from 'bunosh/files';
+
+/**
+ * 🎉 Hello world command
+ */
+export async function helloWorld() {
+  // use say() to print to the console
+  // say('Hello World!');
+
+  // use exec\`\` to execute shell scripts:
+  // await exec\`git status\`
+
+  // use fetch() to make HTTP requests
+  // await fetch('https://reqres.in/api/users')
+
+  // add arguments and options to this function if needed
+  // export async function helloWorld(userName, opts = { force: false })
+  //
+  // bunosh hello:world 'bob' --force
+
+  // use ignoreFail(true) to prevent the command from stopping on error
+
+  yell('Heloo Bunosh!');
+  say('Edit me with bunosh edit');
+}
+`;
 
 export default function init() {
   if (!fs.existsSync(BUNOSHFILE)) {
-    fs.writeFileSync(BUNOSHFILE, templateFile());
+    Bun.write(BUNOSHFILE, template);
     console.log(color.bold(`🎉 Bunosh ${BUNOSHFILE} file created`));
     console.log('   Edit it with "bunosh edit" command');
     console.log('   Or open it in your favorite editor');

package/src/program.js

@@ -16,7 +16,7 @@ export default function bunosh(commands, source) {
   const internalCommands = [];
 
   program.configureHelp({
-    commandDescription: _cmd => `${banner}\n  Commands are loaded from ${color.bold(BUNOSHFILE)} as JS functions`,
+    commandDescription: _cmd => `${banner}\n  Commands are loaded from exported functions in ${color.bold(BUNOSHFILE)}`,
     commandUsage: usg => 'bunosh <command> <args> [options]',
     showGlobalOptions: false,
     // visibleArguments: cmd => cmd.registeredArguments,
@@ -49,30 +49,50 @@ export default function bunosh(commands, source) {
     const fnBody = commands[fnName].toString();
 
     const ast = fetchFnAst();
-
     const args = parseArgs();
     const opts = parseOpts();
+
     const comment = comments[fnName];
 
-    const command = program.command(prepareCommandName(fnName));
-    command.hook('preAction', (thisCommand) => {
+    const commandName = prepareCommandName(fnName);
+
+    const command = program.command(commandName);
+    command.hook('preAction', (_thisCommand) => {
       process.env.BUNOSH_COMMAND_STARTED = true;
     })
     
-    args.filter(a => !!a).forEach((arg) => {
-      command.argument(`<${arg}>`);
+    let argsAndOptsDescription = [];
+
+    Object.entries(args).forEach(([arg, value]) => {
+      if (value === undefined) {
+        argsAndOptsDescription.push(`<${arg}>`);
+        return command.argument(`<${arg}>`);
+      }
+
+      if (value === null) {
+        argsAndOptsDescription.push(`[${arg}]`);
+        return command.argument(`[${arg}]`, '', null);
+      }
+      
+      argsAndOptsDescription.push(`[${arg}=${value}]`);
+      command.argument(`[${arg}]`, ``, value);
     });
+
     Object.entries(opts).forEach(([opt, value]) => {
-      if (value === false || value === null) command.option(`--${opt}`);
+      if (value === false || value === null) {
+        argsAndOptsDescription.push(`--${opt}`);
+        return command.option(`--${opt}`);
+      }
+      
+      argsAndOptsDescription.push(`--${opt}=${value}`);
       command.option(`--${opt} [${opt}]`, "", value);
+
     });
 
-    let description = comment || '';  
-    
-    let argsAndOpts = '';
-    if (args.length > 0) argsAndOpts += `${args.map(a => color.blueBright(`<${a}>`)).join(' ')}`
-    if (Object.keys(opts).length > 0) argsAndOpts += ` ${Object.keys(opts).map(opt => color.blueBright(`--${opt}`)).join(' ')}`    
-    if (comment && argsAndOpts) description += `\n  ${argsAndOpts.trim()}\n`;
+    let description = comment?.split('\n')[0] || '';  
+
+
+    if (comment && argsAndOptsDescription.length) description += `\n  ${color.gray(`bunosh ${commandName}`)} ${color.blue(argsAndOptsDescription.join(' ').trim())}`;
 
     command.description(description);
     command.action(commands[fnName].bind(commands));
@@ -97,7 +117,7 @@ export default function bunosh(commands, source) {
 
     // We parse command args from function args
     function parseArgs() {
-      const functionArguments = [];
+      const functionArguments = {};
 
       traverse(ast, {
         FunctionDeclaration(path) {
@@ -107,13 +127,20 @@ export default function bunosh(commands, source) {
             .filter((node) => {
               return node?.right?.type !== "ObjectExpression";
             })
-            .map((param) => param.name);
+            .forEach((param) => {
+              if (param.type === "AssignmentPattern") {
+                functionArguments[param.left.name] = param.right.value;
+                return;
+              }
+              if (!param.name) return;
+
+              return functionArguments[param.name] = null;
+            });
 
-          functionArguments.push(params);
         },
       });
 
-      return functionArguments.flat();
+      return functionArguments;
     }
 
     // We parse command options from the object of last function args
@@ -132,7 +159,8 @@ export default function bunosh(commands, source) {
           )
             return;
 
-          node.right.properties.forEach((p) => {
+
+          node?.right?.properties?.forEach((p) => {
             if (
               ["NumericLiteral", "StringLiteral", "BooleanLiteral"].includes(
                 p.value.type,
@@ -183,13 +211,10 @@ export default function bunosh(commands, source) {
   internalCommands.push(exoprtCmd);    
 
   program.addHelpText('after', `
-Example call:
-  bunosh ${program.commands.find(c => !internalCommands.includes(c)).name()} ${color.gray('<args>')} ${color.gray('[options]')}
 
 Special Commands:
   📝 Edit bunosh file: ${color.bold('bunosh edit')}
   📥 Export scripts to package.json: ${color.bold('bunosh export:scripts')}
-
 `);
 
 
@@ -220,6 +245,7 @@ Special Commands:
         if (matches && matches[1]) {
           comments[functionName] = matches[1]
             .replace(/^\s*\*\s*/gm, "") // remove * chars
+            .replace(/\s*\*\*\s*$/gm, "") // remove * chars
             .trim()
             .replace(/^@.*$/gm, "") // remove params from description
             .trim();

package/src/tasks/exec.jsx

@@ -19,32 +19,49 @@ export default function exec(strings, ...values) {
   });
 
   let envs = null
-  cmdPromise.env = (newEnvs) => envs = newEnvs;
+  cmdPromise.env = (newEnvs) => {
+    envs = newEnvs;
+    return cmdPromise;
+  }
 
   let cwd = null;
-  cmdPromise.cwd = (newCwd) => cwd = newCwd;
-  
-  const ExecOutput = () => {
-    let shell = $(strings, ...values);
-    if (cwd) {
-      shell = shell.cwd(cwd);
-    } 
-    if (envs) {
-      shell = shell.env(envs);
-    }
+  cmdPromise.cwd = (newCwd) => {
+    cwd = newCwd;
+    return cmdPromise;
+  }
 
+  const ExecOutput = () => {
     const stackOutput = [];
-    
+
     const [printedLines, setPrintedLines] = useState([]);
     const [exitCode, setExitCode] = useState(null);
-
+    
     const readNextChunk = async () => {
+      let shell = $(strings, ...values);
+
+      if (cwd) {
+        shell = shell.cwd(cwd);
+      } 
+      if (envs) {
+        shell = shell.env(envs);
+      }
+
+      // there should be API to read stderr line by line...
       for await (let line of shell.lines()) {
         debugTask(cmd, line);
         stackOutput.push(line);
         setPrintedLines(stackOutput.slice(-DEFAULT_OUTPUT_SIZE));
       }
-      const code = parseInt((await shell).exitCode, 10);
+
+      const { exitCode, stderr } = await shell;
+
+      if (stderr) {
+        debugTask(cmd, stderr.toString());
+        stackOutput.push(stderr.toString())
+        setPrintedLines(stackOutput.slice(-DEFAULT_OUTPUT_SIZE));
+      }
+
+      const code = parseInt(exitCode, 10);
       setExitCode(code);
       if (code == 0) resolve(TaskResult.success(stackOutput.join('\n')));
       if (code !== 0) resolve(TaskResult.fail(stackOutput.join('\n')));

package/templates/banner.js

@@ -1,12 +1,8 @@
-import color from "picocolors";
+import color from "chalk";
+import cfonts from "cfonts";
 
 export default `
-─╔══╗──╔╗─╔╗─╔═╗─╔╗─╔═══╗─╔═══╗─╔╗─╔╗
-─║╔╗║──║║─║║─║║╚╗║║─║╔═╗║─║╔═╗║─║║─║║
-─║╚╝╚╗─║║─║║─║╔╗╚╝║─║║─║║─║╚══╗─║╚═╝║
-─║╔═╗║─║║─║║─║║╚╗║║─║║─║║─╚══╗║─║╔═╗║
-─║╚═╝║─║╚═╝║─║║─║║║─║╚═╝║─║╚═╝║─║║─║║
-─╚═══╝─╚═══╝─╚╝─╚═╝─╚═══╝─╚═══╝─╚╝─╚╝
+${cfonts.render('Bunosh', { font: 'pallet', gradient: ['blue','yellow'], colors: ['system'], space: false}).string}
 
-  🍲 ${color.bold(color.white('Bunosh'))} - your ${color.bold('exceptional')} task runner powered by Bun  
+  🍲 ${color.bold(color.dim.white('Bunosh'))} - your ${color.bold('exceptional')} task runner powered by Bun  
 `.trim();

package/templates/{init.js → init.js.tpl}

@@ -1,14 +1,14 @@
 
-export default () => `import { exec, fetch, ignoreFail } from "bunosh";
-import { say, yell } from "bunosh/io";
-import { writeToFile } from "bunosh/files";
+import { exec, fetch, ignoreFail } from 'bunosh';
+import { say, yell } from 'bunosh/io';
+import { writeToFile } from 'bunosh/files';
 
 /**
  * 🎉 Hello world command
  */
 export async function helloWorld() {
   // use say() to print to the console
-  // say("Hello World!");
+  // say('Hello World!');
 
   // use exec`` to execute shell scripts:
   // await exec\`git status\`
@@ -23,7 +23,6 @@ export async function helloWorld() {
 
   // use ignoreFail(true) to prevent the command from stopping on error
 
-  yell("Heloo Bunosh!");
-  say('Edit me with "bunosh edit"');
+  yell('Heloo Bunosh!');
+  say('Edit me with bunosh edit');
 }
-`;

package/bunosh.tasks.js

@@ -1,83 +0,0 @@
-#!/usr/bin/env bun
-import { exec, fetch, task, ignoreFail } from "./index";
-import { ask, say, yell } from "./io";
-import fs from "fs";
-import { writeToFile } from "./files";
-
-/**
- * Builds binary file for Bunosh
- */
-export async function buildBinary() {
-  await exec`bun build ./run.js --compile --outfile bunosh`;  
-}
-
-/**
- * 🎉 Hello world
- * @param {*} arg1
- * @param {*} opts
- */
-export async function helloWorld(
-  arg1,
-  opts = { user: null, val: "ok", flag: false },
-) {
-  // console.log("Hello World!", arg1);
-  yell("I need all git status");
-  const pack = await task('read file', () => {
-    return fs.readFileSync("package.json").toString();
-  });
-  say(pack);
-  writeToFile('test.txt', l => {
-    l`lock file`
-    l('Hello world');
-    l.fromFile('package.json');
-  });
-  yell('done');
-  yell('ok');
-}
-
-/**
- * Hello other
- */
-export async function helloOther(opts = {
-  user: null,
-  val: "ok",
-  flag: false
-}) {
-  
-  yell('running everything!')
-
-  await fetch('https://reqres.in/api/users')
-
-  await Promise.all([
-    fetch('https://reqres.in/api/users/1'),
-    exec`ps aux | grep redis`,
-    fetch('https://reqres.in/api/users/2')
-  ])
-
-  ignoreFail(true);
-
-  await exec`ps aux | grep node`,
-  await exec`git status`.cwd('/home/davert/projects/codeceptjs');
-}
-
-/**
- * Deploys code to staging
-*/
-export async function updateToProduction() {
-  
-  await Promise.all([
-    exec`ps aux | grep redis`,    
-    exec`ps aux | grep clickhouse`,
-    fetch('https://reqres.in/api/users/2'),
-  ])
-}
-
-/**
- * Deploys code to production
- */
-export async function updateToStaging() {
-  // this is not ok
-  const env = await ask('Which environment we are in?');
-  say(env);
-}
-

package/io.jsx

@@ -1,47 +0,0 @@
-import React, {useState, useEffect} from 'react';
-import { Box, Text } from 'ink';
-import { renderOnce, isStaticOutput} from './src/output';
-import Gradient from 'ink-gradient';
-import BigText from 'ink-big-text';
-import inquirer from 'inquirer';
-
-export function say(...args) {
-  if (isStaticOutput) {
-    console.log(...args);
-    return;
-  };
-
-  const colors = ['yellow', 'magenta', 'cyan', 'blue', 'blueBright', 'magentaBright', 'cyanBright', 'whiteBright'];
-
-  renderOnce(
-    <Box gap={1} height={20} overflow='hidden' >
-      <Text color='white'>!</Text>
-      {args.map((arg, i) => <Text color={colors[i]} key={i}>{arg}</Text>)}
-    </Box>
-  );
-}
-
-export async function ask(question, opts = {}) {
-
-  const answers = await inquirer.prompt({ name: question, message: question, ...opts })
-
-  return Object.values(answers)[0];
-}
-
-export function yell(text) {
-  if (isStaticOutput) {
-    console.log();
-    console.log(text.toUpperCase());
-    console.log();
-    return;
-  };
-
-  renderOnce(
-    <Box gap={1} marginLeft={1}>
-      <Gradient name="teen">
-        <BigText text={text}/>
-      </Gradient>
-
-    </Box>
-  );
-}

package/test.txt

@@ -1,44 +0,0 @@
-lock file
-Hello world
-{
-  "name": "bunosh",
-  "module": "index.js",
-  "bin": {
-    "bunosh": "./run.js"
-  },
-  "devDependencies": {
-    "@types/bun": "latest",
-    "prettier": "^3.2.4",
-    "lint-staged": "^15.2.0"
-  },
-  "peerDependencies": {
-    "typescript": "^5.0.0"
-  },
-  "dependencies": {
-    "@babel/parser": "^7.23.6",
-    "@babel/traverse": "^7.23.7",
-    "cfonts": "^3.2.0",
-    "chalk": "^5.3.0",
-    "commander": "^11.1.0",
-    "debug": "^4.3.4",
-    "fs-extra": "^11.2.0",
-    "ink": "^4.4.1",
-    "ink-big-text": "^2.0.0",
-    "ink-gradient": "^3.0.0",
-    "ink-spinner": "^5.0.0",
-    "inquirer": "^9.2.13",
-    "open-editor": "^4.1.1",
-    "picocolors": "^1.0.0",
-    "react": "^18.2.0",
-    "timer-node": "^5.0.7"
-  },
-  "lint-staged": {
-    "*.{js,css,md}": "prettier --write"
-  },
-  "scripts": {
-    "hello:other": "bunosh hello:other",
-    "hello:world": "bunosh hello:world",
-    "update:to-production": "bunosh update:to-production",
-    "update:to-staging": "bunosh update:to-staging"
-  }
-}