rowork 0.1.0 → 0.1.1

package/README.md

@@ -7,12 +7,12 @@ toolchain, runs it, generates code and keeps your architecture coherent.
 
 > ## ⚠️ This is only the very beginning
 >
-> Rowork is at **version 0.0.1**. The goal is big: a real **meta-framework for Roblox**, from the first
+> Rowork is at **version 0.1.0**. The goal is big: a real **meta-framework for Roblox**, from the first
 > line of a project to a live game. **What exists today is a small first step towards it**, and most of the
 > vision is not built yet.
 >
 > - **Expect missing features, bugs and breaking changes** without warning.
-> - **It is not on npm yet**, and it has been tried on very few games.
+> - **It has been tried on very few games so far**, and it is version 0.1.0.
 > - **Do not build a serious game on it yet.** Come and look, try it, and tell us what is wrong.
 >
 > The [roadmap](docs/roadmap.md) says what exists and what is missing, without promises.
@@ -57,13 +57,13 @@ editable files, and you can drop down to the bare tools at any time.
 
 ## Quick start
 
-Rowork is not on npm yet, so install it from the repository:
-
 ```bash
-git clone https://github.com/nokogoat/Rowork
-cd Rowork && npm install && npm run build && npm link
+npm install -g rowork
 ```
 
+Building it from the repository instead (for development or contributing) is documented under
+[Contributing](docs/contributing.md).
+
 Then:
 
 ```bash

package/dist/core/github-release.js

@@ -1,11 +1,22 @@
 import { createHash } from "node:crypto";
 const HEADERS = { "User-Agent": "rowork" };
+/**
+ * `api.github.com` allows 60 anonymous requests per hour, shared by every anonymous
+ * caller behind the same address — including every GitHub Actions runner in the world.
+ * A token (GitHub Actions gives every job one for free, no setup needed) raises that to
+ * 1,000 per hour, scoped to this run alone. Never required: without one, Rowork just
+ * falls back to the anonymous limit, same as always.
+ */
+function authHeader() {
+    const token = process.env["GITHUB_TOKEN"] ?? process.env["GH_TOKEN"];
+    return token === undefined || token === "" ? {} : { Authorization: `Bearer ${token}` };
+}
 /** Fetches a release of `owner/repo`: the latest one, or the one tagged `tag`. */
 export async function getRelease(repository, tag) {
     const path = tag === undefined ? "latest" : `tags/${tag}`;
     const url = `https://api.github.com/repos/${repository}/releases/${path}`;
     // A stalled connection must not hang the CLI: the API answers in well under a second.
-    const response = await fetch(url, { headers: HEADERS, signal: AbortSignal.timeout(20_000) });
+    const response = await fetch(url, { headers: { ...HEADERS, ...authHeader() }, signal: AbortSignal.timeout(20_000) });
     if (!response.ok)
         throw new Error(`${url} answered ${response.status}`);
     return (await response.json());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rowork",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "The meta-framework CLI for Roblox game development. Orchestrates Rojo, roblox-ts and Flamework, and scaffolds your game architecture.",
   "type": "module",
   "license": "MIT",

package/dist/commands/make-tool.d.ts

@@ -1,2 +0,0 @@
-export declare const makeToolCommand: import("../plugins/api.js").CommandDefinition;
-//# sourceMappingURL=make-tool.d.ts.map

package/dist/commands/make-tool.js

@@ -1,124 +0,0 @@
-import { join } from "node:path";
-import { RoworkError } from "../cli/errors.js";
-import { resolveProjectPath } from "../core/config.js";
-import { ensureFlameworkPath, generateFile, importPath, toClassBase, writeToolRegistry, } from "../core/generate.js";
-import { defineCommand } from "../plugins/api.js";
-import { answered, prompts } from "../ui/prompt.js";
-import { nameOrAsk, requireProject } from "./make.js";
-function parseCooldown(value) {
-    const number = Number(value.replace(",", "."));
-    return value.trim() !== "" && Number.isFinite(number) && number >= 0 && number <= 3600
-        ? number
-        : undefined;
-}
-async function askSettings() {
-    const cooldown = answered(await prompts.text({
-        message: "Seconds to wait between two uses?",
-        placeholder: "0.5",
-        defaultValue: "0.5",
-        validate: (value) => parseCooldown(value || "0.5") === undefined ? "A number between 0 and 3600." : undefined,
-    }));
-    const canBeDropped = answered(await prompts.confirm({ message: "Can the player drop it on the ground?", initialValue: false }));
-    const giveOnSpawn = answered(await prompts.confirm({
-        message: "Give it to every player when they spawn?",
-        initialValue: true,
-    }));
-    return { cooldown: parseCooldown(cooldown || "0.5") ?? 0.5, canBeDropped, giveOnSpawn };
-}
-function settingsFromOptions(context) {
-    const raw = context.options["cooldown"];
-    const cooldown = typeof raw === "string" ? parseCooldown(raw) : 0.5;
-    if (cooldown === undefined) {
-        throw new RoworkError(`\`${String(raw)}\` is not a valid cooldown.`, {
-            hint: "Use a number of seconds between 0 and 3600, e.g. --cooldown 0.5",
-        });
-    }
-    return {
-        cooldown,
-        canBeDropped: context.options["droppable"] === true,
-        giveOnSpawn: context.options["giveOnSpawn"] !== false,
-    };
-}
-export const makeToolCommand = defineCommand({
-    name: "make:tool",
-    guided: true,
-    description: "Create a tool players hold: settings, behaviour, and automatic delivery.",
-    arguments: [
-        {
-            name: "name",
-            description: "name of the tool, e.g. Pickaxe (omit it for the guided version)",
-            required: false,
-        },
-    ],
-    options: [
-        { flags: "--cooldown <seconds>", description: "seconds between two uses (default 0.5)" },
-        { flags: "--droppable", description: "the player can drop it" },
-        { flags: "--no-give-on-spawn", description: "do not give it to players automatically" },
-        { flags: "-f, --force", description: "overwrite the tool's own files if they exist" },
-    ],
-    async run(context) {
-        const { root, config } = requireProject(context, "make:tool");
-        const { name, guided } = await nameOrAsk(context, "make:tool", "What is the tool called?", "Pickaxe");
-        const settings = guided ? await askSettings() : settingsFromOptions(context);
-        // `Pickaxe` and `PickaxeTool` both mean the same tool.
-        const base = toClassBase(name).replace(/(?<=.)Tool$/, "");
-        const constName = `${base}Tool`;
-        const force = context.options["force"] === true;
-        const sharedDirectory = `${config.paths.shared}/tools`;
-        const componentsDirectory = `${config.paths.source}/server/components`;
-        const servicesDirectory = config.paths.services;
-        const created = [];
-        const write = (directory, fileName, template, variables, own) => {
-            const written = generateFile({
-                projectRoot: root,
-                directory,
-                fileName,
-                template,
-                variables,
-                force: own && force,
-                ifExists: own ? "fail" : "skip",
-            });
-            if (written !== undefined)
-                created.push(written);
-        };
-        // Shared files first, created once and never overwritten: a failure on
-        // the tool's own files then leaves nothing harmful behind.
-        write(sharedDirectory, "ToolDefinition.ts", "tool-definition", {}, false);
-        write(servicesDirectory, "ToolService.ts", "tool-service", {
-            definitionImport: importPath(root, servicesDirectory, `${sharedDirectory}/ToolDefinition`),
-            registryImport: importPath(root, servicesDirectory, `${sharedDirectory}/index`),
-        }, false);
-        write(sharedDirectory, `${constName}.ts`, "tool-config", {
-            constName,
-            base,
-            tag: constName,
-            cooldown: String(settings.cooldown),
-            canBeDropped: String(settings.canBeDropped),
-            giveOnSpawn: String(settings.giveOnSpawn),
-        }, true);
-        write(componentsDirectory, `${constName}Component.ts`, "tool-component", {
-            constName,
-            base,
-            tag: constName,
-            className: `${constName}Component`,
-            configImport: importPath(root, componentsDirectory, `${sharedDirectory}/${constName}`),
-        }, true);
-        writeToolRegistry(root, sharedDirectory);
-        const runtime = resolveProjectPath(root, join(config.paths.source, "server", "runtime.server.ts"));
-        for (const directory of [servicesDirectory, componentsDirectory]) {
-            if (ensureFlameworkPath(runtime, directory, context.logger)) {
-                context.logger.step(`registered ${directory} in runtime.server.ts`);
-            }
-        }
-        for (const file of created)
-            context.logger.step(file);
-        context.logger.success(`Created tool ${base}`);
-        context.logger.blank();
-        context.logger.info(settings.giveOnSpawn
-            ? `Every player gets the ${base} when they spawn.`
-            : `The ${base} is not given automatically: settings are in ${sharedDirectory}/${constName}.ts.`);
-        context.logger.info(`Write what it does in ${componentsDirectory}/${constName}Component.ts (activate).`);
-        context.logger.info(`Change its settings later in ${sharedDirectory}/${constName}.ts.`);
-    },
-});
-//# sourceMappingURL=make-tool.js.map