stacks 0.37.4 → 0.37.6

package/dist/cli/actions/types.mjs

@@ -0,0 +1,134 @@
+import consola from "consola";
+import Prompts from "prompts";
+import { runNpmScript } from "@stacksjs/helpers";
+import { ExitCode, NpmScript } from "@stacksjs/types";
+import { lintFix } from "./lint.mjs";
+const { prompts } = Prompts;
+export async function generateTypes() {
+  try {
+    await runNpmScript(NpmScript.TypesGenerate, "ignore");
+    consola.success("Types were generated successfully.");
+  } catch (error) {
+    consola.error("There was an error generating your types.");
+    consola.error(error);
+  }
+}
+export async function fixTypes() {
+  try {
+    await runNpmScript(NpmScript.TypesFix, "ignore");
+    consola.success("Types were generated successfully.");
+  } catch (error) {
+    consola.error("There was an error generating your types.");
+    consola.error(error);
+  }
+}
+export async function generateLibEntries() {
+  try {
+    await runNpmScript(NpmScript.GenerateEntries, "ignore");
+    consola.success("Library entry points were generated successfully.");
+  } catch (error) {
+    consola.error("There was an error generating your library entry points.");
+    consola.error(error);
+  }
+}
+export async function generateVueCompat() {
+  try {
+    await runNpmScript(NpmScript.GenerateVueCompat, "ignore");
+    consola.success("Vue 2 & 3 compatibility was generated successfully.");
+  } catch (error) {
+    consola.error("There was an error generating Vue compatibility.");
+    consola.error(error);
+  }
+}
+export async function generateWebTypes() {
+  try {
+    await runNpmScript(NpmScript.GenerateWebTypes, "ignore");
+    consola.success("Successfully generated the web-types.json file.");
+  } catch (error) {
+    consola.error("There was an error generating the web-types.json file");
+    consola.error(error);
+    process.exit(ExitCode.FatalError);
+  }
+}
+export async function generateVsCodeCustomData() {
+  try {
+    await runNpmScript(NpmScript.GenerateVsCodeCustomData, "ignore");
+    await lintFix("ignore");
+    consola.success("Successfully generated the custom-elements.json file.");
+  } catch (error) {
+    consola.error("There was an error generating the custom-elements.json file");
+    consola.error(error);
+    process.exit(ExitCode.FatalError);
+  }
+}
+export async function generateIdeHelpers() {
+  try {
+    await runNpmScript(NpmScript.GenerateIdeHelpers, "ignore");
+    await lintFix("ignore");
+    consola.success("Successfully generated IDE helpers.");
+  } catch (error) {
+    consola.error("There was an error generating IDE helpers.");
+    consola.error(error);
+    process.exit(ExitCode.FatalError);
+  }
+}
+export async function generateComponentMeta() {
+  try {
+    await runNpmScript(NpmScript.GenerateComponentMeta, "ignore");
+    await lintFix("ignore");
+    consola.success("Successfully generated component meta.");
+  } catch (error) {
+    consola.error("There was an error generating your component meta information.");
+    consola.error(error);
+    process.exit(ExitCode.FatalError);
+  }
+}
+export async function startGenerationProcess(options) {
+  if (options.types || options === "types") {
+    await generateTypes();
+  } else if (options.entries || options === "entries") {
+    await generateLibEntries();
+  } else if (options.webTypes || options === "web-types") {
+    await generateWebTypes();
+  } else if (options.customData || options === "custom-data") {
+    await generateVsCodeCustomData();
+  } else if (options.ideHelpers || options === "ide-helpers") {
+    await generateIdeHelpers();
+  } else if (options.vueCompatibility || options === "vue-compatibility") {
+    await generateVueCompat();
+  } else if (options.componentMeta || options === "component-meta") {
+    await generateComponentMeta();
+  } else {
+    const answer = await prompts.select({
+      type: "select",
+      name: "generate",
+      message: "What are you trying to generate?",
+      choices: [
+        { title: "1.) TypeScript Types", value: "types" },
+        { title: "2.) Library Entry Points", value: "entries" },
+        { title: "3.) Web Types", value: "web-types" },
+        { title: "4.) VS Code Custom Data", value: "custom-data" },
+        { title: "5.) IDE Helpers", value: "ide-helpers" },
+        { title: "6.) Vue 2 & 3 Compatibility", value: "vue-compatibility" },
+        { title: "7.) Component Meta", value: "component-meta" }
+      ],
+      initial: 0
+    });
+    if (answer === "types")
+      await generateTypes();
+    else if (answer === "entries")
+      await generateLibEntries();
+    else if (answer === "web-types")
+      await generateWebTypes();
+    else if (answer === "custom-data")
+      await generateVsCodeCustomData();
+    else if (answer === "ide-helpers")
+      await generateIdeHelpers();
+    else if (answer === "vue-compatibility")
+      await generateVueCompat();
+    else if (answer === "component-meta")
+      await generateComponentMeta();
+    else
+      process.exit(ExitCode.InvalidArgument);
+  }
+}

package/dist/cli/actions/update.d.ts

@@ -0,0 +1 @@
+export declare function stacks(options: any): Promise<void>;

package/dist/cli/actions/update.mjs

@@ -0,0 +1,59 @@
+import * as ezSpawn from "@jsdevtools/ez-spawn";
+import consola from "consola";
+import Prompts from "prompts";
+import { copyFolder, deleteEmptyFolders, deleteFiles, deleteFolder, doesFolderExist } from "@stacksjs/fs";
+import { resolve } from "@stacksjs/paths";
+import { runNpmScript } from "@stacksjs/helpers";
+import { ExitCode, NpmScript } from "@stacksjs/types";
+const { prompts } = Prompts;
+export async function stacks(options) {
+  if (options.framework) {
+    try {
+      await ezSpawn.async("git diff --quiet HEAD -- ./.stacks", { stdio: "inherit", cwd: process.cwd() });
+    } catch (error) {
+      if (error.status === 1) {
+        if (!options.force) {
+          const answer = await prompts.confirm({
+            type: "select",
+            name: "framework-update",
+            message: "Would you like to overwrite your ./stacks changes in favor of the Stacks update?"
+          });
+          if (!answer) {
+            consola.info("The framework was not updated.");
+            consola.info("Note: if you commit your changes and replay the update, you will see what has changed.");
+            process.exit(ExitCode.Success);
+          }
+        }
+      }
+    }
+    consola.info("Downloading framework updates...");
+    const tempFolderName = "updates";
+    const tempUpdatePath = resolve(process.cwd(), tempFolderName);
+    if (doesFolderExist(tempUpdatePath))
+      await deleteFolder(tempUpdatePath);
+    await ezSpawn.async(`giget stacks ${tempFolderName}`, { stdio: options.debug ? "inherit" : "ignore" });
+    consola.success("Downloaded framework updates.");
+    consola.info("Updating framework...");
+    const frameworkPath = resolve(process.cwd(), ".stacks");
+    const exclude = ["functions/package.json", "vue-components/package.json", "web-components/package.json", "auto-imports.d.ts", "components.d.ts", "dist"];
+    await deleteFiles(frameworkPath, exclude);
+    for (let i = 0; i < 5; i++)
+      await deleteEmptyFolders(frameworkPath);
+    const from = resolve(process.cwd(), "./updates/.stacks");
+    const to = frameworkPath;
+    await copyFolder(from, to, exclude);
+    consola.info("Cleanup...");
+    await deleteFolder(tempUpdatePath);
+    consola.success("Framework updated.");
+  }
+  if (options.dependencies) {
+    consola.info("Updating dependencies...");
+    await runNpmScript(NpmScript.Update);
+    consola.success("Updated dependencies.");
+  }
+  if (options.packageManager) {
+    consola.info("Updating pnpm...");
+    const version = await runNpmScript(NpmScript.UpdatePackageManager);
+    consola.success("Successfully updated pnpm to: ", version);
+  }
+}

package/dist/cli/build.d.ts

@@ -0,0 +1,3 @@
+import type { CAC } from 'cac';
+declare function build(stacks: CAC): Promise<void>;
+export { build };

package/dist/cli/build.mjs

@@ -0,0 +1,22 @@
+import { startBuildProcess } from "./actions/build.mjs";
+async function build(stacks) {
+  stacks.command("build", "Automagically build any of your libraries/packages for production use. Select any of the following packages").option("-c, --components", "Build your component library").option("-w, --web-components", "Build your framework agnostic web component library").option("-e, --elements", "An alias to the -w flag").option("-f, --functions", "Build your function library").option("-d, --docs", "Build your documentation site").option("--debug", "Add additional debug logs", { default: false }).action(async (options) => {
+    await startBuildProcess(options);
+  });
+  stacks.command("build:components", "Automagically build your component libraries for production use & npm/CDN distribution.").action(async () => {
+    await startBuildProcess("components");
+  });
+  stacks.command("build:functions", "Automagically build your function library for production use & npm/CDN distribution.").action(async () => {
+    await startBuildProcess("functions");
+  });
+  stacks.command("build:web-components", "Automagically build web component library for production use & npm/CDN distribution.").action(async () => {
+    await startBuildProcess("web-components");
+  });
+  stacks.command("build:docs", "Automagically build your documentation site.").action(async () => {
+    await startBuildProcess("docs");
+  });
+  stacks.command("build:stacks", "Build the core Stacks framework.").action(async () => {
+    await startBuildProcess("stacks");
+  });
+}
+export { build };

package/dist/cli/create.d.ts

@@ -0,0 +1,3 @@
+import type { CAC } from 'cac';
+declare function create(stack: CAC): Promise<void>;
+export { create };

package/dist/cli/create.mjs

@@ -0,0 +1,46 @@
+import consola from "consola";
+import * as ezSpawn from "@jsdevtools/ez-spawn";
+import { resolve } from "pathe";
+import { bold, cyan, dim, link } from "kolorist";
+import { useOnline } from "@vueuse/core";
+import { isFolder } from "@stacksjs/fs";
+import { ExitCode } from "@stacksjs/types";
+import { version } from "../../package.json";
+import { generate as generateAppKey } from "./actions/key.mjs";
+async function create(stack) {
+  stack.option("-n, --name <name>", "Name of the stack").option("-u, --ui", "Are you building a UI?", { default: true }).option("-c, --components", "Are you building UI components?", { default: true }).option("-w, --web-components", "Automagically built optimized custom elements/web components?", { default: true }).option("-v, --vue", "Automagically built a Vue component library?", { default: true }).option("-p, --pages", "How about pages?", { default: true }).option("-f, --functions", "Are you developing functions/composables?", { default: true }).option("-a, --api", "Are you building an API?", { default: true }).option("-d, --database", "Do you need a database?", { default: true }).option("--debug", "Add additional debug logs", { default: false });
+  stack.command("").action(async (args) => {
+    const name = stack.args[0] || args.name || ".";
+    const path = resolve(process.cwd(), name);
+    console.log();
+    console.log(cyan(bold("Stacks CLI")) + dim(` v${version}`));
+    console.log();
+    if (await isFolder(path)) {
+      consola.error(`Path ${path} already exists`);
+      process.exit(ExitCode.FatalError);
+    }
+    const online = useOnline();
+    if (!online) {
+      consola.info("It appears you are disconnected from the internet. The Stacks setup requires a brief internet connection for setup.");
+      process.exit(ExitCode.FatalError);
+    }
+    consola.info("Setting up your stack.");
+    await ezSpawn.async(`giget stacks ${name}`, { stdio: args.debug ? "inherit" : "ignore" });
+    consola.success(`Successfully scaffolded your project at ${cyan(path)}`);
+    consola.info("Ensuring your environment is ready...");
+    await ezSpawn.async("fnm use", { stdio: args.debug ? "inherit" : "ignore", cwd: path });
+    consola.success("Environment is ready.");
+    consola.info("Installing & setting up Stacks.");
+    await ezSpawn.async("pnpm install", { stdio: args.debug ? "inherit" : "ignore", cwd: path });
+    await ezSpawn.async("cp .env.example .env", { stdio: args.debug ? "inherit" : "ignore", cwd: path });
+    await generateAppKey();
+    await ezSpawn.async("git init", { stdio: args.debug ? "inherit" : "ignore", cwd: path });
+    consola.success("Installed & set-up \u{1F680}");
+    console.log();
+    consola.info(bold("Welcome to the Stacks Framework! \u269B\uFE0F"));
+    console.log(`cd ${link(path, `vscode://file/${path}:1`)} && code .`);
+    console.log();
+    consola.log("To learn more, visit https://stacksjs.dev");
+  });
+}
+export { create };

package/dist/cli/dev.d.ts

@@ -0,0 +1,3 @@
+import type { CAC } from 'cac';
+declare function dev(stacks: CAC): Promise<void>;
+export { dev };

package/dist/cli/dev.mjs

@@ -0,0 +1,13 @@
+import { startDevelopmentServer } from "./actions/dev.mjs";
+async function dev(stacks) {
+  stacks.command("dev", "Start the development server for any of the following packages").option("-c, --components", "Start the Components development server").option("-f, --functions", "Start the Functions development server").option("-d, --docs", "Start the Documentation development server").action(async (options) => {
+    await startDevelopmentServer(options);
+  });
+  stacks.command("dev:components", "Start the development server for your component library").action(async () => {
+    await startDevelopmentServer("components");
+  });
+  stacks.command("dev:docs", "Start the development server for your documentation").action(async () => {
+    await startDevelopmentServer("docs");
+  });
+}
+export { dev };

package/dist/cli/example.d.ts

@@ -0,0 +1,3 @@
+import type { CAC } from 'cac';
+declare function example(stacks: CAC): Promise<void>;
+export { example };

package/dist/cli/example.mjs

@@ -0,0 +1,13 @@
+import { runExample } from "./actions/examples.mjs";
+async function example(stacks) {
+  stacks.command("example", "Test your libraries against your built bundle.").option("-c, --components", "Test your Vue component library").option("-v, --vue", "Test your Vue component library").option("-w, --web-components", "Test your web component library").action(async (options) => {
+    await runExample(options);
+  });
+  stacks.command("example:vue", "Test your Vue component library.").alias("example:components").action(async () => {
+    await runExample("vue");
+  });
+  stacks.command("example:web-components", "Test your Web Component library.").action(async () => {
+    await runExample("web-components");
+  });
+}
+export { example };

package/dist/cli/generate.d.ts

@@ -0,0 +1,3 @@
+import type { CAC } from 'cac';
+declare function generate(stacks: CAC): Promise<void>;
+export { generate };

package/dist/cli/generate.mjs

@@ -0,0 +1,29 @@
+import { generateComponentMeta, generateIdeHelpers, generateLibEntries, generateVsCodeCustomData, generateVueCompat, generateWebTypes, startGenerationProcess } from "./actions/generate.mjs";
+import { generateTypes } from "./actions/types.mjs";
+async function generate(stacks) {
+  stacks.command("generate", "Automagically build any of your libraries/packages for production use. Select any of the following packages").option("-t, --types", "Generate your TypeScript types").option("-e, --entries", "Generate your function & component library entry points").option("-w, --web-types", "Generate web-types.json for IDEs").option("-c, --custom-data", "Generate VS Code custom data (custom-elements.json) for IDEs").option("-i, --ide-helpers", "Generate IDE helpers").option("-v, --vue-compatibility", "Generate Vue 2 & 3 compatibility").option("-c, --component-meta", "Generate component meta information").option("--debug", "Add additional debug logs", { default: false }).action(async (options) => {
+    await startGenerationProcess(options);
+  });
+  stacks.command("generate:types", "Generate the types of & for your library/libraries").action(async () => {
+    await generateTypes();
+  });
+  stacks.command("generate:entries", "Generate the entry points for your libraries").action(async () => {
+    await generateLibEntries();
+  });
+  stacks.command("generate:vue-compatibility", "Generate Vue 2 & 3 compatibility").action(async () => {
+    await generateVueCompat();
+  });
+  stacks.command("generate:web-types", "Generate web-types.json for IDEs").action(async () => {
+    await generateWebTypes();
+  });
+  stacks.command("generate:vscode-custom-data", "Generate VS Code custom data (custom-elements.json) for IDEs").action(async () => {
+    await generateVsCodeCustomData();
+  });
+  stacks.command("generate:ide-helpers", "Generate IDE helpers").action(async () => {
+    await generateIdeHelpers();
+  });
+  stacks.command("generate:component-meta", "Generate component meta information").action(async () => {
+    await generateComponentMeta();
+  });
+}
+export { generate };

package/dist/cli/index.d.ts

@@ -0,0 +1,12 @@
+import { build } from './build';
+import { dev } from './dev';
+import { example } from './example';
+import { generate } from './generate';
+import { utility } from './utility';
+import { make } from './make';
+import { test } from './test';
+import { create } from './create';
+import { update } from './update';
+import { types } from './types';
+import { key } from './key';
+export { dev, build, utility, make, example, test, create, update, generate, key, types };

package/dist/cli/index.mjs

@@ -0,0 +1,12 @@
+import { build } from "./build.mjs";
+import { dev } from "./dev.mjs";
+import { example } from "./example.mjs";
+import { generate } from "./generate.mjs";
+import { utility } from "./utility.mjs";
+import { make } from "./make.mjs";
+import { test } from "./test.mjs";
+import { create } from "./create.mjs";
+import { update } from "./update.mjs";
+import { types } from "./types.mjs";
+import { key } from "./key.mjs";
+export { dev, build, utility, make, example, test, create, update, generate, key, types };

package/dist/cli/key.d.ts

@@ -0,0 +1,3 @@
+import type { CAC } from 'cac';
+declare function key(stacks: CAC): Promise<void>;
+export { key };

package/dist/cli/key.mjs

@@ -0,0 +1,7 @@
+import { generate as generateAppKey } from "./actions/key.mjs";
+async function key(stacks) {
+  stacks.command("key:generate", "Generate & set the application key.").action(async () => {
+    await generateAppKey();
+  });
+}
+export { key };

package/dist/cli/make.d.ts

@@ -0,0 +1,3 @@
+import type { CAC } from 'cac';
+declare function make(stacks: CAC): Promise<void>;
+export { make };

package/dist/cli/make.mjs

@@ -0,0 +1,22 @@
+import { component as makeComponent, fx as makeFunction, language as makeLanguage, page as makePage, stack as makeStack } from "./actions/make.mjs";
+async function make(stacks) {
+  stacks.command("make", "Test your libraries against your built bundle.").option("-c, --component", "Scaffolds a component.").option("-p, --page", "Scaffolds a page.").option("-f, --function", "Scaffolds a function.").option("-l, --language", "Scaffolds a language.").option("-s, --stack", "Scaffolds a new stack.").action(async (options) => {
+    await runMake(stacks.args[0], options);
+  });
+  stacks.command("make:component", "Scaffolds a component.").action(async () => {
+    await makeComponent(stacks.args[0]);
+  });
+  stacks.command("make:page", "Scaffolds a page.").action(async () => {
+    await makePage(stacks.args[0]);
+  });
+  stacks.command("make:function", "Scaffolds a function.").action(async () => {
+    await makeFunction(stacks.args[0]);
+  });
+  stacks.command("make:lang", "Scaffolds a language file.").action(async () => {
+    await makeLanguage(stacks.args[0]);
+  });
+  stacks.command("make:stack", "Scaffolds a new stack.").action(async () => {
+    await makeStack(stacks.args[0]);
+  });
+}
+export { make };

package/dist/cli/test.d.ts

@@ -0,0 +1,3 @@
+import type { CAC } from 'cac';
+declare function test(stacks: CAC): Promise<void>;
+export { test };

package/dist/cli/test.mjs

@@ -0,0 +1,13 @@
+import { generateTestCoverageReport, runTestSuite, typecheck } from "./actions/test.mjs";
+async function test(stacks) {
+  stacks.command("test", "Runs your test suite.").action(async () => {
+    await runTestSuite();
+  });
+  stacks.command("test:types", "Typechecks your codebase.").action(async () => {
+    await typecheck();
+  });
+  stacks.command("test:coverage", "Generates a test coverage report.").action(async () => {
+    await generateTestCoverageReport();
+  });
+}
+export { test };

package/dist/cli/types.d.ts

@@ -0,0 +1,3 @@
+import type { CAC } from 'cac';
+declare function types(stacks: CAC): Promise<void>;
+export { types };

package/dist/cli/types.mjs

@@ -0,0 +1,9 @@
+import { generateTypes } from "./actions/types.mjs";
+async function types(stacks) {
+  stacks.command("types:generate", "Generate the types of & for your library/libraries").action(async () => {
+    await generateTypes();
+  });
+  stacks.command("types:fix", "Generate the types of & for your library/libraries").action(async () => {
+  });
+}
+export { types };

package/dist/cli/update.d.ts

@@ -0,0 +1,3 @@
+import type { CAC } from 'cac';
+declare function update(stacks: CAC): Promise<void>;
+export { update };

package/dist/cli/update.mjs

@@ -0,0 +1,7 @@
+import { stacks as updateStacks } from "./actions/update.mjs";
+async function update(stacks) {
+  stacks.command("update", "Updates dependencies & framework.").option("-c, --framework", "Update the Stacks framework", { default: true }).option("-d, --dependencies", "Update your dependencies", { default: true }).option("-p, --package-manager", "Update your package manager, i.e. pnpm", { default: true }).option("-f, --force", "Overwrite possible local updates with remote framework updates", { default: false }).option("--debug", "Add additional debug logs", { default: false }).action(async (options) => {
+    await updateStacks(options);
+  });
+}
+export { update };

package/dist/cli/utility.d.ts

@@ -0,0 +1,3 @@
+import type { CAC } from 'cac';
+declare function utility(stacks: CAC): Promise<void>;
+export { utility };

package/dist/cli/utility.mjs

@@ -0,0 +1,22 @@
+import { reinstallNpmDependencies } from "./actions/fresh.mjs";
+import { lint, lintFix } from "./actions/lint.mjs";
+import { release } from "./actions/release.mjs";
+import { commit } from "./actions/commit.mjs";
+async function utility(stacks) {
+  stacks.command("fresh", "Reinstalls your npm dependencies.").action(async () => {
+    await reinstallNpmDependencies();
+  });
+  stacks.command("lint", "Automagically lints your codebase.").action(async () => {
+    await lint();
+  });
+  stacks.command("lint:fix", "Automagically fixes lint errors.").action(async () => {
+    await lintFix();
+  });
+  stacks.command("release", "Releases a new version of your libraries/packages.").action(async () => {
+    await release();
+  });
+  stacks.command("commit", "Commit your stashed changes.").action(async () => {
+    await commit();
+  });
+}
+export { utility };

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};