@aslomon/effectum 0.2.1 → 0.3.0

package/bin/lib/app-types.js

@@ -0,0 +1,96 @@
+/**
+ * App type definitions and intent-based tag mappings.
+ * Used by the recommendation engine to derive setup from project intent.
+ */
+"use strict";
+
+/** @type {Array<{ value: string, label: string, hint: string }>} */
+const APP_TYPE_CHOICES = [
+  {
+    value: "web-app",
+    label: "Web App",
+    hint: "Full-stack web application with UI",
+  },
+  {
+    value: "api-backend",
+    label: "API / Backend",
+    hint: "REST or GraphQL API service",
+  },
+  {
+    value: "mobile-app",
+    label: "Mobile App",
+    hint: "iOS, Android, or cross-platform",
+  },
+  {
+    value: "desktop-app",
+    label: "Desktop App",
+    hint: "Native or Electron desktop application",
+  },
+  {
+    value: "cli-tool",
+    label: "CLI Tool",
+    hint: "Command-line interface tool",
+  },
+  {
+    value: "automation-agent",
+    label: "Automation / Agent System",
+    hint: "AI agents, bots, automation workflows",
+  },
+  {
+    value: "data-ml",
+    label: "Data / ML Tool",
+    hint: "Data pipeline, ML model, analytics",
+  },
+  {
+    value: "library-sdk",
+    label: "Library / SDK",
+    hint: "Reusable package or framework",
+  },
+  {
+    value: "other",
+    label: "Other",
+    hint: "Something else entirely",
+  },
+];
+
+/**
+ * Tags implicitly associated with each app type.
+ * These are combined with stack and description tags to drive recommendations.
+ * @type {Record<string, string[]>}
+ */
+const APP_TYPE_TAGS = {
+  "web-app": [
+    "frontend-heavy",
+    "auth-needed",
+    "db-needed",
+    "multi-user",
+    "ui-design",
+  ],
+  "api-backend": [
+    "api-first",
+    "db-needed",
+    "auth-needed",
+    "backend-heavy",
+    "docs-needed",
+  ],
+  "mobile-app": ["frontend-heavy", "native-ui", "offline-capable", "ui-design"],
+  "desktop-app": ["frontend-heavy", "native-ui", "local-storage", "ui-design"],
+  "cli-tool": ["terminal-ui", "scripting", "no-frontend", "docs-needed"],
+  "automation-agent": [
+    "ai-agent",
+    "automation",
+    "api-first",
+    "background-jobs",
+  ],
+  "data-ml": [
+    "data-pipeline",
+    "analytics",
+    "backend-heavy",
+    "compute-heavy",
+    "docs-needed",
+  ],
+  "library-sdk": ["api-design", "testing-heavy", "docs-needed", "no-frontend"],
+  other: [],
+};
+
+module.exports = { APP_TYPE_CHOICES, APP_TYPE_TAGS };

package/bin/lib/config.js

@@ -1,5 +1,6 @@
 /**
  * Read/write .effectum.json configuration file.
+ * v0.4.0 schema — supports appType, description, recommended setup, mode.
  */
 "use strict";
 
@@ -7,6 +8,7 @@ const fs = require("fs");
 const path = require("path");
 
 const CONFIG_FILENAME = ".effectum.json";
+const CONFIG_VERSION = "0.4.0";
 
 /**
  * Read .effectum.json from a directory.
@@ -27,17 +29,28 @@ function readConfig(dir) {
  * Write .effectum.json to a directory.
  * @param {string} dir
  * @param {object} config
+ * @returns {string} path to the written file
  */
 function writeConfig(dir, config) {
   const filePath = path.join(dir, CONFIG_FILENAME);
   const now = new Date().toISOString();
+
+  // Preserve createdAt from existing config if upgrading
+  let existingCreatedAt;
+  if (fs.existsSync(filePath)) {
+    try {
+      const existing = JSON.parse(fs.readFileSync(filePath, "utf8"));
+      existingCreatedAt = existing.createdAt;
+    } catch (_) {}
+  }
+
   const data = {
-    version: "0.2.0",
+    version: CONFIG_VERSION,
     ...config,
     updatedAt: now,
   };
   if (!data.createdAt) {
-    data.createdAt = now;
+    data.createdAt = existingCreatedAt || now;
   }
   fs.writeFileSync(filePath, JSON.stringify(data, null, 2) + "\n", "utf8");
   return filePath;
@@ -52,4 +65,10 @@ function configExists(dir) {
   return fs.existsSync(path.join(dir, CONFIG_FILENAME));
 }
 
-module.exports = { readConfig, writeConfig, configExists, CONFIG_FILENAME };
+module.exports = {
+  readConfig,
+  writeConfig,
+  configExists,
+  CONFIG_FILENAME,
+  CONFIG_VERSION,
+};

package/bin/lib/constants.js

@@ -1,9 +1,17 @@
 /**
  * Shared constants for the Effectum CLI.
- * Autonomy levels, formatter mappings, MCP server definitions, stack choices, language choices.
+ * Autonomy levels, formatter mappings, MCP server definitions, stack choices.
+ *
+ * Language and app-type definitions have moved to their own modules:
+ *   - languages.js  (LANGUAGE_CHOICES, LANGUAGE_INSTRUCTIONS)
+ *   - app-types.js  (APP_TYPE_CHOICES, APP_TYPE_TAGS)
  */
 "use strict";
 
+// Re-export from new modules for backward compatibility
+const { LANGUAGE_CHOICES, LANGUAGE_INSTRUCTIONS } = require("./languages");
+const { APP_TYPE_CHOICES, APP_TYPE_TAGS } = require("./app-types");
+
 /** @type {Record<string, { defaultMode: string, permissions: { allow: string[] } }>} */
 const AUTONOMY_MAP = {
   conservative: {
@@ -72,7 +80,7 @@ const FORMATTER_MAP = {
   },
 };
 
-/** @type {Array<{ key: string, label: string, package: string, desc: string, config: object }>} */
+/** @type {Array<{ key: string, label: string, package: string, desc: string, config?: object, configFn?: function }>} */
 const MCP_SERVERS = [
   {
     key: "context7",
@@ -140,33 +148,6 @@ const STACK_CHOICES = [
   },
 ];
 
-/** @type {Array<{ value: string, label: string, hint: string }>} */
-const LANGUAGE_CHOICES = [
-  {
-    value: "english",
-    label: "English",
-    hint: "Communicate in English",
-  },
-  {
-    value: "german",
-    label: "Deutsch (du/informal)",
-    hint: "German, informal",
-  },
-  {
-    value: "custom",
-    label: "Custom",
-    hint: "Enter your own language instruction",
-  },
-];
-
-/** @type {Record<string, string>} */
-const LANGUAGE_INSTRUCTIONS = {
-  english:
-    "Speak English with the user. All code, comments, commits, and docs in English.",
-  german:
-    "Speak German (du/informal) with the user. All code, comments, commits, and docs in English.",
-};
-
 /** @type {Array<{ value: string, label: string, hint: string }>} */
 const AUTONOMY_CHOICES = [
   {
@@ -191,7 +172,10 @@ module.exports = {
   FORMATTER_MAP,
   MCP_SERVERS,
   STACK_CHOICES,
+  AUTONOMY_CHOICES,
+  // Re-exported from languages.js / app-types.js
   LANGUAGE_CHOICES,
   LANGUAGE_INSTRUCTIONS,
-  AUTONOMY_CHOICES,
+  APP_TYPE_CHOICES,
+  APP_TYPE_TAGS,
 };

package/bin/lib/foundation.js

@@ -0,0 +1,63 @@
+/**
+ * Foundation modules — always installed, not toggleable.
+ * These are the safety and context hooks that every Effectum setup requires.
+ */
+"use strict";
+
+/**
+ * Foundation hooks that are always active in every Effectum installation.
+ * Users cannot deselect these — they are not part of the recommendation flow.
+ * @type {Array<{ key: string, label: string, desc: string }>}
+ */
+const FOUNDATION_HOOKS = [
+  {
+    key: "file-protection",
+    label: "File Protection",
+    desc: "Block writes to .env, .git, lock files, secrets/",
+  },
+  {
+    key: "destructive-blocker",
+    label: "Destructive Command Blocker",
+    desc: "Block rm -rf /, DROP TABLE, force push, reset --hard",
+  },
+  {
+    key: "git-context",
+    label: "Git Context Loader",
+    desc: "Load git status and recent commits at session start",
+  },
+  {
+    key: "guardrails-injection",
+    label: "Guardrails Injection",
+    desc: "Inject guardrails.md at session start and after compaction",
+  },
+  {
+    key: "post-compaction",
+    label: "Post-Compaction Context",
+    desc: "Restore context after memory compaction",
+  },
+  {
+    key: "error-logger",
+    label: "Error Logger",
+    desc: "Log tool failures to .claude/logs/tool-failures.jsonl",
+  },
+  {
+    key: "transcript-backup",
+    label: "Transcript Backup",
+    desc: "Backup transcripts before context compaction",
+  },
+  {
+    key: "auto-formatter",
+    label: "Auto-Formatter",
+    desc: "Stack-aware code formatting on every Edit/Write",
+  },
+];
+
+/**
+ * Format the foundation hooks for display.
+ * @returns {string}
+ */
+function formatFoundationDisplay() {
+  return FOUNDATION_HOOKS.map((h) => `  ${h.label} — ${h.desc}`).join("\n");
+}
+
+module.exports = { FOUNDATION_HOOKS, formatFoundationDisplay };

package/bin/lib/languages.js

@@ -0,0 +1,77 @@
+/**
+ * Extended language definitions for the Effectum CLI.
+ * Supports 15+ languages plus custom instructions.
+ */
+"use strict";
+
+/** @type {Array<{ value: string, label: string, hint: string }>} */
+const LANGUAGE_CHOICES = [
+  { value: "english", label: "English", hint: "English" },
+  { value: "german", label: "Deutsch", hint: "German (du/informal)" },
+  { value: "french", label: "Fran\u00e7ais", hint: "French" },
+  { value: "spanish", label: "Espa\u00f1ol", hint: "Spanish" },
+  { value: "italian", label: "Italiano", hint: "Italian" },
+  { value: "portuguese", label: "Portugu\u00eas", hint: "Portuguese" },
+  { value: "dutch", label: "Nederlands", hint: "Dutch" },
+  { value: "polish", label: "Polski", hint: "Polish" },
+  { value: "turkish", label: "T\u00fcrk\u00e7e", hint: "Turkish" },
+  {
+    value: "arabic",
+    label: "\u0627\u0644\u0639\u0631\u0628\u064a\u0629",
+    hint: "Arabic",
+  },
+  {
+    value: "hindi",
+    label: "\u0939\u093f\u0928\u094d\u0926\u0940",
+    hint: "Hindi",
+  },
+  { value: "chinese", label: "\u4e2d\u6587", hint: "Chinese (Simplified)" },
+  { value: "japanese", label: "\u65e5\u672c\u8a9e", hint: "Japanese" },
+  { value: "korean", label: "\ud55c\uad6d\uc5b4", hint: "Korean" },
+  {
+    value: "russian",
+    label: "\u0420\u0443\u0441\u0441\u043a\u0438\u0439",
+    hint: "Russian",
+  },
+  {
+    value: "custom",
+    label: "Custom",
+    hint: "Enter your own language instruction",
+  },
+];
+
+/** @type {Record<string, string>} */
+const LANGUAGE_INSTRUCTIONS = {
+  english:
+    "Speak English with the user. All code, comments, commits, and docs in English.",
+  german:
+    "Speak German (du/informal) with the user. All code, comments, commits, and docs in English.",
+  french:
+    "Speak French with the user. All code, comments, commits, and docs in English.",
+  spanish:
+    "Speak Spanish with the user. All code, comments, commits, and docs in English.",
+  italian:
+    "Speak Italian with the user. All code, comments, commits, and docs in English.",
+  portuguese:
+    "Speak Portuguese with the user. All code, comments, commits, and docs in English.",
+  dutch:
+    "Speak Dutch with the user. All code, comments, commits, and docs in English.",
+  polish:
+    "Speak Polish with the user. All code, comments, commits, and docs in English.",
+  turkish:
+    "Speak Turkish with the user. All code, comments, commits, and docs in English.",
+  arabic:
+    "Speak Arabic with the user. All code, comments, commits, and docs in English.",
+  hindi:
+    "Speak Hindi with the user. All code, comments, commits, and docs in English.",
+  chinese:
+    "Speak Chinese (Simplified) with the user. All code, comments, commits, and docs in English.",
+  japanese:
+    "Speak Japanese with the user. All code, comments, commits, and docs in English.",
+  korean:
+    "Speak Korean with the user. All code, comments, commits, and docs in English.",
+  russian:
+    "Speak Russian with the user. All code, comments, commits, and docs in English.",
+};
+
+module.exports = { LANGUAGE_CHOICES, LANGUAGE_INSTRUCTIONS };