yavascript 0.0.5 → 0.0.7

package/README.md

@@ -1,37 +1,79 @@
 # yavascript
 
-<!-- NOTE: this file is also used as help text by the CLI. Don't use markdown syntax below this line unless said syntax would also be clearly readable as plain text. -->
+YavaScript is a cross-platform bash-like script runner and repl which is distributed as a single
+statically-linked binary. Scripts can be written in JavaScript, TypeScript, JSX/TSX, or CoffeeScript.
 
-YavaScript is a bash-like script runner which is distributed as a single
-statically-linked binary. Scripts are written in JavaScript. There are global
-APIs available for all the things you'd normally want to do in a bash script,
-such as:
+There are APIs available for all the things you'd normally want to do in
+a bash script, such as:
 
-- Running programs
-- Accessing environment variables
-- Reading and writing file contents
+- Running programs and getting their stdout/stderr/status
+- Reading/writing environment variables
 - Checking if files/folders exist
-- Removing files/folders
+- Removing/creating/copying files/folders
 - Reading and changing the current working directory
+- Reading and resolving symbolic links
 - Using globs to get large lists of files
-- Printing stylized text to the terminal
+- Printing stylized text
+- Clearing the terminal
+- Fetching files from the internet
 
-Additionally, since it's JavaScript, you get some other features that are
-either not present in bash or are cumbersome to use in bash, namely:
+Additionally, you can do other things that are either not present in bash or are cumbersome to use in bash, namely:
 
-- Arrays (lists) and Objects (key/value dictionaries)
-- Working with path strings
-- Working with JSON
+- Serialize and deserialize JSON, CSV, and YAML
+- Removing ANSI control characters from a string
+- Split path strings into a list of segments and rejoin them into a string
+- Check if a path is absolute and resolve relative paths
+- Parse command-line flags
+- Work with Arrays (lists)
+- Work with Objects (key/value dictionaries)
+- Work with Typed Arrays (byte buffers)
+- Reliably get the path to the currently-running file
+- Strongly-typed interfaces and functions (via TypeScript)
 - Cross-file import/export using ECMAScript Modules
-- Splitting strings on delimeters
-- Pretty-printing of objects
-- Getting the path to the currently-running script (via import.meta.url or `__filename`)
-- Getting the absolute path to the root folder of the current git/mercurial repo (repoRoot function)
+- Split strings on delimeters
+- Pretty-print complex structures
+- Call low-level POSIX C APIs like fputs, sprintf, isatty
+- Perform work in threads
+
+You'll also find analogues to familiar CLI tools, like:
+
+- dirname
+- basename
+- cat
+- ls
+- realpath
+- readlink
+
+...and more.
 
 To view the APIs, consult the file yavascript.d.ts which was distributed with
 this program, or online at https://github.com/suchipi/yavascript/blob/main/yavascript.d.ts.
 This file contains TypeScript type definitions which can be given to your IDE
-to assist you when writing scripts.
+to assist you when writing scripts, even if you aren't writing your scripts in TypeScript.
+
+Here's an example of a script using YavaScript:
+
+```js
+#!/usr/bin/env yavascript
+
+// This comment is optional; it tells VS Code to load the specified TypeScript definitions.
+/// <reference path="./yavascript.d.ts" />
+
+let isWorkingTreeDirty;
+try {
+  exec(`git diff --quiet`);
+  isWorkingTreeDirty = false;
+} catch (error) {
+  isWorkingTreeDirty = true;
+}
+
+const branchName = $(`git rev-parse --abbrev-ref HEAD`).stdout.trim();
+
+const gitInfo = { branchName, isWorkingTreeDirty };
+echo(gitInfo);
+
+writeFile("git-info.yml", YAML.stringify(gitInfo));
+```
 
 YavaScript is powered by a fork of the QuickJS JavaScript Engine, originally
 written by Fabrice Bellard. QuickJS is a small, fast JavaScript engine
@@ -40,4 +82,20 @@ supporting the ES2020 specification.
 - Original QuickJS engine: https://bellard.org/quickjs/
 - The fork we use: https://github.com/suchipi/quickjs/
 
-YavaScript is written with <3 by Lily Scott.
+## Compiling
+
+### Binaries (all platforms)
+
+You will need docker installed, then run `meta/docker/build-all.sh`.
+
+### Binaries (just for your machine)
+
+You will need node.js and ninja installed, then run `meta/build.sh`.
+
+### Docker image
+
+You will need docker installed, then run `docker build -t yourusername/yavascript .`.
+
+---
+
+YavaScript is written with <3 by Lily Skye.

package/lib/binary-path.js

@@ -1,30 +1,33 @@
 var path = require("path");
 
-var binaryPath;
-if (process.platform === "win32") {
-  binaryPath = path.resolve(
-    __dirname,
-    "..",
-    "bin",
-    "windows",
-    "yavascript.exe"
-  );
-} else if (process.platform === "darwin") {
-  if (process.arch.startsWith("arm")) {
-    binaryPath = path.resolve(
-      __dirname,
-      "..",
-      "bin",
-      "darwin-arm",
-      "yavascript"
-    );
-  } else {
-    binaryPath = path.resolve(__dirname, "..", "bin", "darwin", "yavascript");
+var binDir = path.resolve(__dirname, "..", "bin");
+
+function getBinaryPath(platformAndArch) {
+  switch (platformAndArch) {
+    case "darwin-arm64": {
+      return path.join(binDir, "darwin-arm64", "yavascript");
+    }
+    case "darwin-x64": {
+      return path.join(binDir, "darwin-x86_64", "yavascript");
+    }
+    case "linux-arm64": {
+      return path.join(binDir, "linux-aarch64", "yavascript");
+    }
+    case "linux-x64": {
+      return path.join(binDir, "linux-amd64", "yavascript");
+    }
+    case "win32-x64": {
+      return path.join(binDir, "windows-x86_64", "yavascript.exe");
+    }
+    default: {
+      throw new Error("Unsupported platform: " + platformAndArch);
+    }
   }
-} else if (process.platform === "linux") {
-  binaryPath = path.resolve(__dirname, "..", "bin", "linux", "yavascript");
-} else {
-  throw new Error("Unsupported platform: " + process.platform);
 }
 
-module.exports = binaryPath;
+var binaryPath = getBinaryPath(process.platform + "-" + process.arch);
+
+module.exports = {
+  getBinaryPath: getBinaryPath,
+  binaryPath: binaryPath,
+};

package/lib/cli.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 var child_process = require("child_process");
-var binaryPath = require("./binary-path");
+var binaryPath = require("./binary-path").binaryPath;
 
 try {
   child_process.execFileSync(binaryPath, process.argv.slice(2), {

package/lib/index.js

@@ -1,7 +1,9 @@
-const binaryPath = require("./binary-path");
-const version = require("./package.json").version;
+var getBinaryPath = require("./binary-path").getBinaryPath;
+var binaryPath = require("./binary-path").binaryPath;
+var version = require("../package.json").version;
 
 module.exports = {
+  getBinaryPath,
   binaryPath,
   version,
 };

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "yavascript",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "main": "lib/index.js",
   "bin": "lib/cli.js",
   "types": "yavascript.d.ts",
-  "author": "Lily Scott <me@suchipi.com>",
+  "author": "Lily Skye <me@suchipi.com>",
   "license": "MIT",
   "repository": "suchipi/yavascript"
 }