agave-generator 0.1.28 → 0.2.0

package/README.md

@@ -2,13 +2,42 @@
 
 Minimal markdown to HTML for static sites with pretty URLs.
 
-## ☀️ Install
+Written in [ReasonML](https://reasonml.github.io/) with native OCaml toolchain (opam + dune).
 
+## Install
+
+### Via npm
+
+```
+npm install -g agave-generator
+```
+
+### Build from source
+
+Requires [opam](https://opam.ocaml.org/) and OCaml 5.1+.
+
+```console
+opam install . --deps-only -y
+dune build
+dune install
 ```
-yarn global add agave-generator
+
+### Link locally for development
+
+```console
+opam install . --deps-only -y
+dune build
+cp _build/default/bin/Agave.exe bin/agave-native
+npm link --ignore-scripts
+```
+
+Now `agave` is available globally. To unlink:
+
+```console
+npm unlink -g agave-generator
 ```
 
-## 🍯 Use
+## Use
 
 ```console
 mkdir blog
@@ -25,7 +54,7 @@ For the full list of options run `help`.
 agave --help
 ```
 
-## 🏜 Themes
+## Themes
 
 Simply pass the -t argument and the theme name
 
@@ -33,7 +62,7 @@ Simply pass the -t argument and the theme name
 agave -t desert
 ```
 
-## 🌿 Full Customization
+## Full Customization
 
 If you didn't find a theme for you you can add any base HTML and CSS you would like.
 
@@ -56,7 +85,7 @@ Here is an example of using custom `base.html`.
 
 [Repo](https://github.com/jottenlips/jottenlips.github.io)
 
-## 📂 File structure
+## File structure
 
 ```
 ./markdown
@@ -83,7 +112,7 @@ results in
     └──2021-1-1/index.html
 ```
 
-## 🧗‍♀️ Deploy your site
+## Deploy your site
 
 Github Pages
 
@@ -95,21 +124,40 @@ git push
 ```
 
 Setup your repo to look at the docs folder on your main branch in the repo settings.
-g
 
-## 🧪 Run your site locally
+## Run your site locally
 
 ```console
 agave -s
-# 🏃‍♀️ Running on localhost:8080
+# Server running at http://localhost:8080/
 ```
 
-🐛 TODO: fix CSP so remote images and fonts will show up when running locally.
+You can also serve any existing directory without generating:
 
-Want to support this project?
+```console
+agave -p ./docs -s
+```
 
-[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](code_of_conduct.md)
+## Release
+
+1. Commit and tag:
+
+```console
+git add -A && git commit -m "v0.2.0: description"
+git tag v0.2.0
+git push origin main --tags
+```
+
+2. GitHub Actions builds native binaries for `linux-x64`, `darwin-x64`, and `darwin-arm64` and attaches them to a GitHub Release.
 
-[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/K3K01P2WT)
+3. Publish to npm:
 
-      /* let _resp = Response.add_header(~name="content-security-policy", ~value="default-src 'self' style-src 'self' 'unsafe-inline';") */
+```console
+npm publish
+```
+
+## Support
+
+Want to support this project?
+
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](code_of_conduct.md)

package/bin/agave-wrapper.js

@@ -0,0 +1,16 @@
+#!/usr/bin/env node
+
+const { execFileSync } = require("child_process");
+const path = require("path");
+
+const binary = path.join(__dirname, "agave-native");
+
+try {
+  execFileSync(binary, process.argv.slice(2), { stdio: "inherit", cwd: process.cwd() });
+} catch (err) {
+  if (err.status !== undefined) {
+    process.exit(err.status);
+  }
+  console.error("Failed to run agave:", err.message);
+  process.exit(1);
+}

package/package.json

@@ -1,8 +1,22 @@
 {
-  "description": "Simple static site generator",
-  "license": "The Hippocratic License 2.1",
   "name": "agave-generator",
-  "version": "0.1.28",
-  "scripts": { "postinstall": "node ./esyInstallRelease.js" },
-  "bin": { "Agave": "bin/Agave" }
-}
+  "version": "0.2.0",
+  "description": "Minimal markdown to HTML static site generator",
+  "license": "Hippocratic-2.1",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jottenlips/agave.git"
+  },
+  "bin": {
+    "agave": "./bin/agave-wrapper.js"
+  },
+  "scripts": {
+    "postinstall": "node postinstall.js"
+  },
+  "files": [
+    "bin/agave-wrapper.js",
+    "postinstall.js",
+    "README.md",
+    "LICENSE"
+  ]
+}

package/postinstall.js

@@ -0,0 +1,70 @@
+#!/usr/bin/env node
+
+const https = require("https");
+const fs = require("fs");
+const path = require("path");
+const { execSync } = require("child_process");
+
+const VERSION = require("./package.json").version;
+const REPO = "jottenlips/agave";
+
+function getPlatformBinaryName() {
+  const platform = process.platform;
+  const arch = process.arch;
+
+  if (platform === "linux" && arch === "x64") return "agave-linux-x64";
+  if (platform === "darwin" && arch === "arm64") return "agave-darwin-arm64";
+
+  console.error(
+    `Unsupported platform: ${platform}-${arch}. You can build from source with opam + dune.`
+  );
+  process.exit(1);
+}
+
+function download(url, dest) {
+  return new Promise((resolve, reject) => {
+    const request = (url) => {
+      https
+        .get(url, (res) => {
+          if (res.statusCode >= 300 && res.statusCode < 400 && res.headers.location) {
+            request(res.headers.location);
+            return;
+          }
+          if (res.statusCode !== 200) {
+            reject(new Error(`Download failed with status ${res.statusCode}: ${url}`));
+            return;
+          }
+          const file = fs.createWriteStream(dest);
+          res.pipe(file);
+          file.on("finish", () => {
+            file.close();
+            resolve();
+          });
+        })
+        .on("error", reject);
+    };
+    request(url);
+  });
+}
+
+async function main() {
+  const binaryName = getPlatformBinaryName();
+  const url = `https://github.com/${REPO}/releases/download/v${VERSION}/${binaryName}`;
+  const dest = path.join(__dirname, "bin", "agave-native");
+
+  fs.mkdirSync(path.join(__dirname, "bin"), { recursive: true });
+
+  console.log(`Downloading agave binary for ${process.platform}-${process.arch}...`);
+
+  try {
+    await download(url, dest);
+    fs.chmodSync(dest, 0o755);
+    console.log("agave binary installed successfully.");
+  } catch (err) {
+    console.error(`Failed to download binary: ${err.message}`);
+    console.error("You can build from source with: opam install . --deps-only && dune build");
+    process.exit(1);
+  }
+}
+
+main();

package/bin/_storePath

@@ -1 +0,0 @@
-______________________________________________________________________________________