overlaify 0.1.0 → 0.1.2

package/README.md

@@ -46,8 +46,9 @@ npx overlaify publish my-alert.html --new       # a separate overlay instead
 npx overlaify publish my-alert.html --name neon # its address: overlaify.com/<your username>/neon
 ```
 
-The overlay must pass the spec. It gets its own page at `overlaify.com/<your username>/<name>` (named after
-its `<title>` unless you pass `--name`), shows up in My overlays with its OBS URL, and the
+The overlay must pass the spec. It gets its own page at `overlaify.com/<your username>/<name>`. The first publish
+names it after the file (`my-alert.html` → `my-alert`) and lets you change that at the prompt; `--name` sets it
+up front, shows up in My overlays with its OBS URL, and the
 settings you chose in `overlaify dev` come with it. Which overlay a file was published as is kept in
 `.overlaify/<name>.publish.json`.
 

package/lib/publish.js

@@ -148,6 +148,13 @@ const readJsonFile = (f) => {
   try { return JSON.parse(readFileSync(f, 'utf8')); } catch { return null; }
 };
 
+const NAME_RE = /^[a-z0-9](?:[a-z0-9-]{0,58}[a-z0-9])?$/;
+const NAME_RULE = 'must be 1–60 lowercase letters, digits or dashes, not at the start or end.';
+
+// The file name as an overlay name: my_Alert v2.html → my-alert-v2. Empty when nothing usable is left.
+const nameOf = (file) =>
+  basename(file).replace(/\.html?$/i, '').toLowerCase().replace(/[^a-z0-9]+/g, '-').slice(0, 60).replace(/^-+|-+$/g, '');
+
 const titleOf = (html, file) =>
   (/<title[^>]*>([^<]*)<\/title>/i.exec(html)?.[1] || '').replace(/\s+/g, ' ').trim() || basename(file).replace(/\.html?$/i, '');
 
@@ -155,16 +162,15 @@ const titleOf = (html, file) =>
  * overlaify publish [file] [--public | --private] [--name n] [--title t] [--kind k] [--new] [--site url]
  * Uploads the overlay to My overlays. The first publish of a file asks public or private; publishing it
  * again adds a new version to the same overlay (its OBS URL changes to the new version's) unless --new.
- * `name` is its address, overlaify.com/<handle>/<name>; a new overlay is otherwise named after its title.
+ * `name` is its address, overlaify.com/<handle>/<name>; a new overlay is otherwise named after its file
+ * (asked at a terminal, with the file name as the default), or after its title when the file name has no usable letters.
  */
 export async function publish(file, { site, visibility, name, title, kind, fresh, log = console.log } = {}) {
   site = siteUrl(site);
   file = resolve(file);
   if (!existsSync(file)) throw new Error(`No such file: ${file}`);
   if (kind && !KINDS.includes(kind)) throw new Error(`--kind must be one of ${KINDS.join(', ')}.`);
-  if (name != null && !/^[a-z0-9](?:[a-z0-9-]{0,58}[a-z0-9])?$/.test(name)) {
-    throw new Error('--name must be 1–60 lowercase letters, digits or dashes, not at the start or end.');
-  }
+  if (name != null && !NAME_RE.test(name)) throw new Error(`--name ${NAME_RULE}`);
   if (!tokenFor(site)) throw new Error(`Not logged in to ${site}. Run: overlaify login${site === DEFAULT_SITE ? '' : ` --site ${site}`}`);
 
   const html = readFileSync(file, 'utf8');
@@ -183,6 +189,17 @@ export async function publish(file, { site, visibility, name, title, kind, fresh
     visibility = a === '2' || a.startsWith('pub') ? 'public' : a === '' || a === '1' || a.startsWith('pri') ? 'private' : null;
     if (!visibility) throw new Error('Publishing cancelled.');
   }
+  // A new overlay is named after its file unless --name says otherwise; at a terminal the name can be changed.
+  if (name == null && !previous) {
+    const fallback = nameOf(file);
+    if (process.stdin.isTTY) {
+      const a = (await ask(`Name, its address overlaify.com/<you>/<name>${fallback ? ` [${fallback}]` : ''}: `)).toLowerCase();
+      name = a || fallback || undefined;
+      if (name && !NAME_RE.test(name)) throw new Error(`The name ${NAME_RULE}`);
+    } else {
+      name = fallback || undefined;
+    }
+  }
 
   const body = { html, title: title || titleOf(html, file), name, kind, visibility, config: readJsonFile(stateFile(file, '.json')) || undefined };
   let out;

package/package.json

@@ -1,16 +1,37 @@
 {
   "name": "overlaify",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Build Twitch/OBS overlays that follow the Overlaify Overlay Spec: start from a template, validate, preview with simulated events and control them live.",
   "type": "module",
-  "bin": { "overlaify": "bin/overlaify.js" },
-  "files": ["bin", "lib", "assets", "skill"],
-  "engines": { "node": ">=18" },
+  "bin": {
+    "overlaify": "bin/overlaify.js"
+  },
+  "files": [
+    "bin",
+    "lib",
+    "assets",
+    "skill"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
   "scripts": {
     "sync": "node scripts/sync.mjs"
   },
-  "keywords": ["twitch", "obs", "overlay", "stream", "alerts", "browser-source", "claude", "skill"],
+  "keywords": [
+    "twitch",
+    "obs",
+    "overlay",
+    "stream",
+    "alerts",
+    "browser-source",
+    "claude",
+    "skill"
+  ],
   "homepage": "https://www.overlaify.com",
-  "repository": { "type": "git", "url": "git+https://github.com/overlaify/overlaify.git" },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/overlaify/overlaify.git"
+  },
   "license": "MIT"
 }

package/skill/SKILL.md

@@ -30,7 +30,7 @@ The full rules are in `references/overlay-spec.md`. Read it before writing your
      when the file is saved, and the action keys reach it live.
    Tell the user to set their Twitch channel in the dev page's settings so real chat and events arrive.
 5. **Publish (only when the user asks).** `npx overlaify publish <file>.html --private` or `--public` puts it
-   on overlaify.com at `/<their username>/<name>` with a hosted OBS URL (`--name` sets the name). Ask the user which one they want; never pick for
+   on overlaify.com at `/<their username>/<name>` with a hosted OBS URL (named after the file, e.g. `my-alert.html` → `my-alert`; `--name` sets another). Ask the user which one they want; never pick for
    them. Private: only they can open it on the site, but the OBS URL still works. Public: anyone with a link
    can open and remix it, and it can be picked for the Overlaify Library. If it says they're not logged in,
    ask them to run `npx overlaify login` (it opens a browser to approve). Publishing the same file again