Merge pull request #13 from Autonomous-Finance/templates-refactor

Templates refactor

.changeset/bright-trains-leave.md

@@ -0,0 +1,12 @@
+---
+"create-ao-dapp": minor
+"site": patch
+---
+
+Refactor templates system and Build scripts.
+
+Implement new build scripts that enhance project scaffolding and DX.
+Build scripts now check for required dependencies and tries to install them via luarocks.
+
+Teal templates have been updated to use modules and clearer code splitting.
+

create-ao-dapp/src/init.ts

@@ -30,14 +30,9 @@ export async function init() {
           message: "Enter the name of your project",
           placeholder: "sparkling-solid",
         }),
-      processName: () =>
-        p.text({
-          message: "What should we name the backend process?",
-          placeholder: "my-process",
-        }),
       type: ({ results }) =>
         p.select({
-          message: `Pick a starter template within "${results.processName}"`,
+          message: `Pick a starter template within "${results.projectName}"`,
           initialValue: "lua",
           maxItems: 5,
           options: [
@@ -80,7 +75,6 @@ export async function init() {
           initialValue: "amalg.lua",
           options: [
             { value: "amalg.lua", label: "amalg.lua", hint: "recommended" },
-            { value: "squishy", label: "squishy" },
           ],
         }),
     },
@@ -94,7 +88,9 @@ export async function init() {
 
   // Change projectName and processName to kebab-case
   const projectName = kebabcase(project.projectName);
-  const processName = kebabcase(project.processName);
+  const processName = ["lua", "teal"].includes(project.type as string)
+    ? "counter"
+    : "books";
 
   const templatesDir = resolve(__dirname, "..", "templates");
   const destDir = resolve(process.cwd(), projectName);
@@ -116,38 +112,37 @@ export async function init() {
   // Copy process template contents
   fs.copySync(processTemplateBase, resolve(destDir, "ao", processName));
 
-  // Copy frontend template contents
-  const frontendTemplate = ["lua", "teal"].includes(project.type as string)
-    ? "lua"
-    : "lua-sqlite";
+  // Inject build script into the process dir
+  const buildSpinner = p.spinner();
+  buildSpinner.start("Adding build script...");
+
+  const baseType = ["teal", "teal-sqlite"].includes(project.type as string)
+    ? "teal"
+    : "lua";
 
+  // Copy the build-lua script
   fs.copySync(
-    resolve(templatesDir, "apps", frontendTemplate),
-    resolve(destDir, "apps", "frontend")
+    resolve(templatesDir, "scripts", `build-${baseType}.sh`),
+    resolve(destDir, "ao", processName, "scripts", "build-lua.sh")
   );
 
-  // Inject build script into the process dir
-  const buildSpinner = p.spinner();
-  buildSpinner.start("Adding build script...");
+  // Copy the build script
+  fs.copySync(
+    resolve(templatesDir, "scripts", "build.sh"),
+    resolve(destDir, "ao", processName, "scripts", "build.sh")
+  );
 
-  if (project.amalgamation === "squishy") {
-    fs.copySync(
-      resolve(templatesDir, "scripts", "build-squishy.sh"),
-      resolve(destDir, "ao", processName, "scripts", "build.sh")
-    );
-  } else {
-    const buildScriptPath = resolve(
-      templatesDir,
-      "scripts",
-      "build-amalg",
-      `${project.type}.sh`
-    );
+  // Copy the check_deps script
+  fs.copySync(
+    resolve(templatesDir, "scripts", `check_deps-${baseType}.sh`),
+    resolve(destDir, "ao", processName, "scripts", "check_deps.sh")
+  );
 
-    fs.copySync(
-      buildScriptPath,
-      resolve(destDir, "ao", processName, "scripts", "build.sh")
-    );
-  }
+  // Copy the install_deps script
+  fs.copySync(
+    resolve(templatesDir, "scripts", `install_deps-${baseType}.sh`),
+    resolve(destDir, "ao", processName, "scripts", "install_deps.sh")
+  );
 
   buildSpinner.stop("Added build script.");
 
@@ -180,6 +175,7 @@ export async function init() {
     projectPath: `./${projectName}`,
     processName: processName,
     packageManager: detectPackageManager(),
+    processType: project.type as string,
   });
 
   spinner.message("Generating aoform.yaml...");
@@ -192,6 +188,16 @@ export async function init() {
 
   spinner.stop("Added aoform.");
 
+  // Copy frontend template contents
+  const frontendTemplate = ["lua", "teal"].includes(project.type as string)
+    ? "lua"
+    : "lua-sqlite";
+
+  fs.copySync(
+    resolve(templatesDir, "apps", frontendTemplate),
+    resolve(destDir, "apps", "frontend")
+  );
+
   // Replace dotfiles
   for (const file of fs.readdirSync(destDir)) {
     if (!file.startsWith("_")) continue;

create-ao-dapp/src/utils/aoform.ts

@@ -2,34 +2,50 @@ import { writeFile } from "node:fs/promises";
 import { Document } from "yaml";
 import type { PackageManager } from "../types";
 
+const MODULE_BASIC = "bkjb55i07GUCUSWROtKK4HU1mBS_X0TyH3M5jMV6aPg";
+const MODULE_SQLITE = "EAIJew2R7aptjpyn7TD7S7ldVW4cTpUhZCaMvcerfWc";
+const SCHEDULER = "_GQ33BkPtZrqxA84vM8Zk-N2aO0toNNu_C-l-rawrBA";
+const AUTHORITY = "fcoN_xJeisVsPXA-trzVAuIiqO3ydLQxM-L4XbrQKzY";
+
 export default class AoFormGenerator {
   projectPath: string;
   processName: string;
   packageManager: PackageManager;
+  processType: string;
 
   constructor({
     projectPath,
     processName,
     packageManager,
+    processType,
   }: {
     projectPath: string;
     processName: string;
     packageManager: PackageManager;
+    processType: string;
   }) {
     this.projectPath = projectPath;
     this.processName = processName;
     this.packageManager = packageManager;
+    this.processType = processType;
   }
 
   async generateAoFormYaml() {
+    const module = ["lua-sqlite", "teal-sqlite"].includes(this.processType)
+      ? MODULE_SQLITE
+      : MODULE_BASIC;
+
     const doc = new Document([
       {
         name: this.processName,
         file: "build/process.lua",
-        prerun: "./src/reset_modules.lua",
-        scheduler: "_GQ33BkPtZrqxA84vM8Zk-N2aO0toNNu_C-l-rawrBA",
-        module: "GYrbbe0VbHim_7Hi6zrOpHQXrSQz07XNtwCnfbFo2I0",
+        scheduler: SCHEDULER,
+        module: module,
         tags: [
+          {
+            name: "Authority",
+            value: AUTHORITY,
+          },
           {
             name: "Name",
             value: this.processName,

create-ao-dapp/src/utils/package.ts

@@ -43,6 +43,9 @@ export function generateScripts({
   scripts["frontend:dev"] = `cd ./apps/frontend && ${packageManager} run dev`;
   scripts["frontend:build"] = `cd ./apps/frontend && ${packageManager} run build`;
   scripts["frontend:deploy"] = `cd ./apps/frontend && ${packageManager} run deploy`;
+
+  // Generate postinstall script to chmod scripts
+  scripts.postinstall = `chmod +x ./ao/${processName}/scripts/* && chmod +x ./apps/frontend/scripts/*`
 
   return scripts;
 }

create-ao-dapp/templates/ao/lua/base/src/lib/counter.lua

@@ -0,0 +1,31 @@
+local mod           = {}
+
+--- Handler to increase Counter
+--- @param msg Message
+--- @return nil
+mod.increaseCounter = function(msg)
+    Counter = Counter + 1
+
+    ao.send({
+        Target = msg.From,
+        Action = "Increase",
+        Counter = tostring(Counter),
+        Data = tostring(Counter)
+    })
+end
+
+--- Handler to reset Counter
+--- @param msg Message
+--- @return nil
+mod.resetCounter    = function(msg)
+    Counter = 0
+
+    ao.send({
+        Target = msg.From,
+        Action = "Reset",
+        Counter = tostring(Counter),
+        Data = tostring(Counter)
+    })
+end
+
+return mod

create-ao-dapp/templates/ao/lua/base/src/process.lua → create-ao-dapp/templates/ao/lua/base/src/main.lua

@@ -1,12 +1,26 @@
-local process = require "lib.process_lib"
+local process = require "lib.counter"
 
+--- @type string
 Version       = "0.0.1"
+
+--- @type number
 Counter       = Counter or 0
 
+--- Handler to get Info
+--- @param msg Message
+--- @return nil
+local function infoHandler(msg)
+    ao.send({
+        Target = msg.From,
+        Version = Version,
+        Counter = tostring(Counter)
+    })
+end
+
 -- Handler to get Info
 Handlers.add("info",
     Handlers.utils.hasMatchingTag("Action", "Info"),
-    process.getInfo
+    infoHandler
 )
 
 -- Handler to increase Counter