@flare-desktop/cli 0.0.0-stage → 0.1.0

package/src/templates/project.js

@@ -0,0 +1,284 @@
+import { SCHEMA_URL } from "../schema.js";
+
+export function embeddedIdentifier(name) {
+  const segments = String(name).split("-").filter(Boolean);
+  return segments
+    .map((segment) => segment.charAt(0).toUpperCase() + segment.slice(1))
+    .join("");
+}
+
+export function configTemplate({ name, identifier, version }) {
+  return {
+    $schema: SCHEMA_URL,
+    package: { productName: name, version },
+    app: {
+      identifier,
+      productName: name,
+      mainBinaryName: name,
+      version
+    },
+    build: {
+      frontendDist: "frontend",
+      devUrl: "",
+      beforeDevCommand: "",
+      afterDevCommand: "",
+      beforeBuildCommand: "",
+      afterBuildCommand: ""
+    },
+    bundle: {
+      active: true,
+      identifier,
+      icon: "icons/icon.png",
+      category: "DeveloperTool",
+      shortDescription: `${name} built with flare`,
+      targets: []
+    },
+    security: {
+      csp: "default-src 'self'",
+      freezePrototype: true
+    },
+    windows: [
+      {
+        label: "main",
+        title: name,
+        width: 960,
+        height: 640,
+        resizable: true,
+        center: true,
+        theme: "automatic"
+      }
+    ]
+  };
+}
+
+export function packageJsonTemplate({ name, version, cliVersion }) {
+  return {
+    name,
+    version,
+    private: true,
+    type: "module",
+    scripts: {
+      dev: "flare dev",
+      build: "flare build",
+      bundle: "flare bundle",
+      icon: "flare icon icons/icon.png"
+    },
+    devDependencies: {
+      "@flare-desktop/cli": `^${cliVersion}`
+    }
+  };
+}
+
+export function cmakeTemplate({ name, version, coreVersion }) {
+  return `cmake_minimum_required(VERSION 3.24)
+
+project(${name} VERSION ${version} LANGUAGES CXX)
+
+set(CMAKE_CXX_STANDARD 20)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+include(FetchContent)
+
+FetchContent_Declare(
+    flare
+    GIT_REPOSITORY https://github.com/flare-desktop/flare.git
+    GIT_TAG v${coreVersion}
+    GIT_SHALLOW TRUE)
+FetchContent_MakeAvailable(flare)
+
+add_executable(${name} source/main.cpp)
+target_link_libraries(${name} PRIVATE flare::core flare::assets)
+
+set(FLARE_FRONTEND_DIR "frontend" CACHE PATH "Frontend directory")
+file(TO_CMAKE_PATH "\${FLARE_FRONTEND_DIR}" FLARE_FRONTEND_DIR)
+target_compile_definitions(${name} PRIVATE FLARE_FRONTEND_DIR="\${FLARE_FRONTEND_DIR}")
+FlareEmbedFrontend(${name} "\${FLARE_FRONTEND_DIR}")
+`;
+}
+
+export function sourceTemplate({ name, identifier, version }) {
+  const embedded = embeddedIdentifier(name);
+  return `#include <flare/config/config.h>
+#include <flare/core/application.h>
+#include <flare/log/log.h>
+
+#include <${name}-frontend.h>
+
+#include <cstdlib>
+#include <string>
+
+#ifndef FLARE_FRONTEND_DIR
+#define FLARE_FRONTEND_DIR "frontend"
+#endif
+
+int main() {
+    const bool development = std::getenv("FLARE_DEV") != nullptr;
+
+    Flare::ApplicationOptions options;
+    options.config = Flare::Config::Defaults("${identifier}", "${version}");
+    options.config.app.productName = "${name}";
+    options.config.windows.front().title = "${name}";
+    options.development = development;
+
+    std::string error;
+    Flare::ConfigLoader loader(
+        Flare::ConfigMergeOptions{"flare.config.json", development ? "development" : "production", "", {}});
+    if (const auto loaded = loader.Load(error); loaded.has_value()) {
+        options.config = *loaded;
+    } else {
+        Flare::LogWarn("using the built-in configuration: {}", error);
+    }
+
+    const char* devUrl = std::getenv("FLARE_DEV_URL");
+    if (devUrl != nullptr) options.devUrl = devUrl;
+    if (development && options.devUrl.empty()) options.frontendDirectory = FLARE_FRONTEND_DIR;
+
+    Flare::Application application(options);
+    if (!development) Flare::Embedded::Insert${embedded}(application.Assets());
+
+    application.RegisterCommand("greet", [](const Flare::InvokeRequest& request) {
+        const std::string name =
+            request.payload.contains("name") ? request.payload["name"].get<std::string>() : "world";
+        return Flare::JSON("hello, " + name);
+    });
+
+    application.CreateWindow(application.Config().MainWindow());
+    Flare::LogInfo("${name} started");
+    application.Run();
+    return EXIT_SUCCESS;
+}
+`;
+}
+
+export function indexHtmlTemplate(name) {
+  return `<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<title>${name}</title>
+<link rel="stylesheet" href="style.css">
+</head>
+<body>
+<main>
+<h1>${name}</h1>
+<p>the frontend runs in the system webview, the backend in C++.</p>
+<button id="greet">call the backend</button>
+<pre id="output"></pre>
+</main>
+<script type="module" src="main.js"></script>
+</body>
+</html>
+`;
+}
+
+export function styleTemplate() {
+  return `:root {
+  color-scheme: light dark;
+  --background: #f4f1ec;
+  --foreground: #2c2328;
+  --accent: #d8a7b1;
+}
+
+@media (prefers-color-scheme: dark) {
+  :root {
+    --background: #201918;
+    --foreground: #f4f1ec;
+  }
+}
+
+* {
+  box-sizing: border-box;
+}
+
+body {
+  margin: 0;
+  min-height: 100vh;
+  display: grid;
+  place-items: center;
+  background: var(--background);
+  color: var(--foreground);
+  font-family: system-ui, sans-serif;
+}
+
+main {
+  text-align: center;
+  padding: 2rem;
+}
+
+h1 {
+  margin: 0 0 0.5rem;
+  letter-spacing: -0.02em;
+}
+
+p {
+  margin: 0 0 1.5rem;
+  opacity: 0.7;
+}
+
+button {
+  padding: 0.65rem 1.3rem;
+  border: 0;
+  border-radius: 0.6rem;
+  background: var(--accent);
+  color: #201918;
+  font-weight: 600;
+  cursor: pointer;
+}
+
+pre {
+  margin-top: 1rem;
+  opacity: 0.8;
+}
+`;
+}
+
+export function scriptTemplate() {
+  return `import { app, invoke } from "/core.js";
+
+const output = document.querySelector("#output");
+
+document.querySelector("#greet").addEventListener("click", async () => {
+  const message = await invoke("greet", { name: "flare" });
+  const version = await app.version();
+  output.textContent = \`\${message} (\${version})\`;
+});
+`;
+}
+
+export function gitignoreTemplate() {
+  return "build/\ntarget/\nnode_modules/\n.DS_Store\n";
+}
+
+export function readmeTemplate(name) {
+  return `# ${name}
+
+A desktop application built with [flare](https://github.com/flare-desktop/flare).
+
+## Development
+
+\`\`\`bash
+npm install
+npm run dev
+\`\`\`
+
+## Build
+
+\`\`\`bash
+npm run build
+npm run bundle
+\`\`\`
+
+\`npm run dev\` builds the C++ core and serves \`frontend/\` in the system webview.
+\`npm run build\` compiles the frontend into the executable and produces a release build.
+\`npm run bundle\` assembles the configured bundle targets under \`target/bundle\`.
+
+## Icons
+
+\`\`\`bash
+npm run icon
+\`\`\`
+
+The command reads \`icons/icon.png\` and writes the png, ico and icns sets next to it.
+`;
+}

package/src/version.js

@@ -0,0 +1,6 @@
+import { readFileSync } from "node:fs";
+
+const manifest = JSON.parse(readFileSync(new URL("../package.json", import.meta.url), "utf8"));
+
+export const VERSION = manifest.version;
+export const PACKAGE_NAME = manifest.name;