heymark 1.2.0 → 2.0.1

package/src/tools/skill-per-file.js

@@ -0,0 +1,29 @@
+const fs = require("fs");
+const path = require("path");
+
+function generate({ cwd, dir, skills, getFileName, createContent }) {
+    const destDir = path.join(cwd, dir);
+    fs.mkdirSync(destDir, { recursive: true });
+
+    for (const skill of skills) {
+        const filePath = path.join(destDir, getFileName(skill));
+        fs.writeFileSync(filePath, createContent(skill), "utf8");
+    }
+
+    return skills.length;
+}
+
+function clean(cwd, dir) {
+    const targetPath = path.join(cwd, dir);
+    if (!fs.existsSync(targetPath)) {
+        return [];
+    }
+
+    fs.rmSync(targetPath, { recursive: true, force: true });
+    return [dir];
+}
+
+module.exports = {
+    generate,
+    clean,
+};

package/src/tools/skill-per-folder.js

@@ -0,0 +1,18 @@
+const fs = require("fs");
+const path = require("path");
+const { clean } = require("@/tools/skill-per-file");
+
+function generate({ cwd, dir, fileName, skills, createContent }) {
+    for (const skill of skills) {
+        const skillDir = path.join(cwd, dir, skill.name);
+        fs.mkdirSync(skillDir, { recursive: true });
+        fs.writeFileSync(path.join(skillDir, fileName), createContent(skill), "utf8");
+    }
+
+    return skills.length;
+}
+
+module.exports = {
+    generate,
+    clean,
+};

package/scripts/lib/config.js

@@ -1,110 +0,0 @@
-"use strict";
-
-const fs = require("fs");
-const path = require("path");
-
-const CONFIG_DIR = ".heymark";
-const CONFIG_FILENAME = "config.json";
-const DEFAULT_BRANCH = "main";
-const CONFIG_RELATIVE = path.join(CONFIG_DIR, CONFIG_FILENAME);
-
-/**
- * @typedef {{ rulesSource: string, branch?: string, rulesSourceDir?: string }} RuleBookConfig
- */
-
-/**
- * Resolve config file path from project root.
- * @param {string} projectRoot
- * @returns {string}
- */
-function getConfigPath(projectRoot) {
-    return path.join(projectRoot, CONFIG_DIR, CONFIG_FILENAME);
-}
-
-/**
- * Normalize and validate config payload.
- * @param {unknown} value
- * @returns {RuleBookConfig | null}
- */
-function normalizeConfig(value) {
-    if (!value || typeof value !== "object") {
-        return null;
-    }
-
-    const raw =
-        /** @type {{ rulesSource?: unknown, branch?: unknown, rulesSourceDir?: unknown }} */ (
-            value
-        );
-    if (typeof raw.rulesSource !== "string" || !raw.rulesSource.trim()) {
-        return null;
-    }
-
-    return {
-        rulesSource: raw.rulesSource.trim(),
-        branch:
-            typeof raw.branch === "string" && raw.branch.trim()
-                ? raw.branch.trim()
-                : DEFAULT_BRANCH,
-        rulesSourceDir: typeof raw.rulesSourceDir === "string" ? raw.rulesSourceDir.trim() : "",
-    };
-}
-
-/**
- * Read config from project root.
- * @param {string} projectRoot
- * @returns {RuleBookConfig | null}
- */
-function loadConfig(projectRoot) {
-    const configPath = getConfigPath(projectRoot);
-    if (!fs.existsSync(configPath)) {
-        return null;
-    }
-
-    try {
-        const raw = fs.readFileSync(configPath, "utf8");
-        return normalizeConfig(JSON.parse(raw));
-    } catch {
-        return null;
-    }
-}
-
-/**
- * Create initial config file in .heymark/config.json.
- * @param {string} projectRoot
- * @param {RuleBookConfig} config
- * @returns {string}
- */
-function writeConfig(projectRoot, config) {
-    const configDir = path.join(projectRoot, CONFIG_DIR);
-    if (!fs.existsSync(configDir)) {
-        fs.mkdirSync(configDir, { recursive: true });
-    }
-
-    const normalized = normalizeConfig(config);
-    if (!normalized) {
-        throw new Error("Invalid config payload");
-    }
-
-    const configPath = path.join(configDir, CONFIG_FILENAME);
-    const toWrite = {
-        rulesSource: normalized.rulesSource,
-        branch: normalized.branch || DEFAULT_BRANCH,
-    };
-    if (normalized.rulesSourceDir) {
-        toWrite.rulesSourceDir = normalized.rulesSourceDir;
-    }
-
-    fs.writeFileSync(configPath, JSON.stringify(toWrite, null, 2), "utf8");
-    return configPath;
-}
-
-module.exports = {
-    CONFIG_DIR,
-    CONFIG_FILENAME,
-    CONFIG_RELATIVE,
-    DEFAULT_BRANCH,
-    getConfigPath,
-    loadConfig,
-    normalizeConfig,
-    writeConfig,
-};

package/scripts/lib/parser.js

@@ -1,125 +0,0 @@
-"use strict";
-
-const fs = require("fs");
-const path = require("path");
-
-const GENERATED_MARKER = "<!-- @generated by sync-rules - DO NOT EDIT -->";
-const FRONTMATTER_REGEX = /^---\r?\n([\s\S]+?)\r?\n---\r?\n?([\s\S]*)$/;
-const MARKDOWN_EXTENSION = ".md";
-const RULE_SEPARATOR = "\n\n---\n\n";
-
-/**
- * @param {string} rawValue
- * @returns {string | boolean}
- */
-function parseMetadataValue(rawValue) {
-    let value = rawValue.trim();
-    if (
-        (value.startsWith('"') && value.endsWith('"')) ||
-        (value.startsWith("'") && value.endsWith("'"))
-    ) {
-        value = value.slice(1, -1);
-    }
-
-    if (value === "true") {
-        return true;
-    }
-    if (value === "false") {
-        return false;
-    }
-
-    return value;
-}
-
-/**
- * @param {string} metadataBlock
- * @returns {Record<string, string | boolean>}
- */
-function parseMetadataBlock(metadataBlock) {
-    const metadata = {};
-
-    metadataBlock.split(/\r?\n/).forEach((line) => {
-        const separatorIndex = line.indexOf(":");
-        if (separatorIndex === -1) {
-            return;
-        }
-
-        const key = line.slice(0, separatorIndex).trim();
-        const rawValue = line.slice(separatorIndex + 1);
-        metadata[key] = parseMetadataValue(rawValue);
-    });
-
-    return metadata;
-}
-
-function parseFrontmatter(content) {
-    const match = content.match(FRONTMATTER_REGEX);
-    if (!match) {
-        return { metadata: {}, body: content.trim() };
-    }
-
-    const [, metadataBlock, body] = match;
-    return {
-        metadata: parseMetadataBlock(metadataBlock),
-        body: body.trim(),
-    };
-}
-
-function loadMarkdownFiles(rulesDir) {
-    return fs
-        .readdirSync(rulesDir)
-        .filter((fileName) => fileName.endsWith(MARKDOWN_EXTENSION))
-        .sort();
-}
-
-function createRuleFromFile(rulesDir, fileName) {
-    const filePath = path.join(rulesDir, fileName);
-    const raw = fs.readFileSync(filePath, "utf8");
-    const { metadata, body } = parseFrontmatter(raw);
-    const baseName = path.basename(fileName, MARKDOWN_EXTENSION);
-
-    return {
-        fileName,
-        name: metadata.name || baseName,
-        description: metadata.description || baseName,
-        globs: metadata.globs || "",
-        alwaysApply: metadata.alwaysApply === true,
-        metadata,
-        body,
-    };
-}
-
-function loadRules(rulesDir) {
-    if (!fs.existsSync(rulesDir)) {
-        console.error(`[Error] Rules directory not found: ${rulesDir}`);
-        console.error("  Ensure 'rules/' exists relative to the script location.");
-        process.exit(1);
-    }
-
-    const files = loadMarkdownFiles(rulesDir);
-
-    if (files.length === 0) {
-        console.error(`[Error] No .md files found in: ${rulesDir}`);
-        process.exit(1);
-    }
-
-    return files.map((fileName) => createRuleFromFile(rulesDir, fileName));
-}
-
-function mergeRuleBodies(rules) {
-    return rules.map((rule) => rule.body).join(RULE_SEPARATOR);
-}
-
-function writeMergedFile(filePath, rules) {
-    fs.mkdirSync(path.dirname(filePath), { recursive: true });
-    const content = `${GENERATED_MARKER}\n\n${mergeRuleBodies(rules)}\n`;
-    fs.writeFileSync(filePath, content, "utf8");
-}
-
-module.exports = {
-    GENERATED_MARKER,
-    parseFrontmatter,
-    loadRules,
-    mergeRuleBodies,
-    writeMergedFile,
-};

package/scripts/lib/repo.js

@@ -1,97 +0,0 @@
-"use strict";
-
-const fs = require("fs");
-const path = require("path");
-const { execSync } = require("child_process");
-
-const CACHE_DIR_NAME = path.join(".heymark", "cache");
-const DEFAULT_BRANCH = "main";
-const GITHUB_REPO_PATTERN = /github\.com[:/]([^/]+\/[^/]+?)(?:\/|$)/;
-const GENERIC_REPO_PATTERN = /([^/]+\/[^/]+?)(?:\/|$)/;
-
-/**
- * Convert repository URL to a stable cache directory name.
- * https://github.com/org/repo -> org-repo
- * git@github.com:org/repo.git -> org-repo
- * @param {string} repoUrl
- * @returns {string}
- */
-function sanitizeRepoName(repoUrl) {
-    let normalized = repoUrl.trim();
-    if (normalized.endsWith(".git")) {
-        normalized = normalized.slice(0, -4);
-    }
-
-    const match = normalized.match(GITHUB_REPO_PATTERN) || normalized.match(GENERIC_REPO_PATTERN);
-    if (match) {
-        return match[1].replace(/\//g, "-");
-    }
-
-    return normalized.replace(/[^a-zA-Z0-9._-]/g, "-") || "repo";
-}
-
-function cloneRulesRepo(projectRoot, clonePath, branch, repoUrl) {
-    execSync(`git clone --depth 1 --branch "${branch}" "${repoUrl}" "${clonePath}"`, {
-        stdio: "inherit",
-        cwd: projectRoot,
-    });
-}
-
-function updateRulesRepo(clonePath, branch) {
-    execSync(`git fetch origin && git checkout --quiet . && git pull --quiet origin "${branch}"`, {
-        stdio: "pipe",
-        cwd: clonePath,
-    });
-}
-
-function resolveRulesDirectory(clonePath, rulesSourceDir) {
-    const rulesDir = rulesSourceDir ? path.join(clonePath, rulesSourceDir) : clonePath;
-    if (!fs.existsSync(rulesDir) || !fs.statSync(rulesDir).isDirectory()) {
-        console.error(`[Error] Rules directory not found in repo: ${rulesSourceDir || "(root)"}`);
-        process.exit(1);
-    }
-    return rulesDir;
-}
-
-/**
- * Clone or update remote repository and return local rules directory.
- * Private repositories require user git credentials (SSH key or token).
- * @param {string} projectRoot
- * @param {{ rulesSource: string, branch?: string, rulesSourceDir?: string }} config
- * @returns {string}
- */
-function getRulesDirFromRepo(projectRoot, config) {
-    const repoUrl = config.rulesSource;
-    const branch = config.branch || DEFAULT_BRANCH;
-    const rulesSourceDir = config.rulesSourceDir || "";
-
-    const cacheBase = path.join(projectRoot, CACHE_DIR_NAME);
-    const repoName = sanitizeRepoName(repoUrl);
-    const clonePath = path.join(cacheBase, repoName);
-
-    if (!fs.existsSync(clonePath)) {
-        fs.mkdirSync(cacheBase, { recursive: true });
-        try {
-            cloneRulesRepo(projectRoot, clonePath, branch, repoUrl);
-        } catch {
-            console.error("[Error] Failed to clone rules repository.");
-            console.error("  For private repos, ensure you have access (SSH key or HTTPS token).");
-            console.error("  Example: heymark init https://github.com/org/repo.git");
-            process.exit(1);
-        }
-    } else {
-        try {
-            updateRulesRepo(clonePath, branch);
-        } catch {
-            // Continue with cached clone when fetch or pull fails.
-        }
-    }
-
-    return resolveRulesDirectory(clonePath, rulesSourceDir);
-}
-
-module.exports = {
-    CACHE_DIR_NAME,
-    getRulesDirFromRepo,
-    sanitizeRepoName,
-};

package/scripts/sync.js

@@ -1,330 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-
-const fs = require("fs");
-const path = require("path");
-const { CONFIG_RELATIVE, DEFAULT_BRANCH, loadConfig, writeConfig } = require("./lib/config");
-const { loadRules } = require("./lib/parser");
-const { getRulesDirFromRepo } = require("./lib/repo");
-
-const SCRIPT_DIR = __dirname;
-const PROJECT_ROOT = process.cwd();
-
-const INIT_SUBCOMMAND = "init";
-const OPTION_TOOLS = "--tools";
-const OPTION_SOURCE = "--source";
-const OPTION_CLEAN = "--clean";
-const OPTION_PREVIEW = "--preview";
-const OPTION_HELP = "--help";
-const SHORT_TOOLS = "-t";
-const SHORT_SOURCE = "-s";
-const SHORT_CLEAN = "-c";
-const SHORT_PREVIEW = "-p";
-const SHORT_HELP = "-h";
-const OPTION_BRANCH = "--branch";
-const OPTION_DIR = "--dir";
-const OPTION_SAMPLES = "--samples";
-const SHORT_BRANCH = "-b";
-const SHORT_DIR = "-d";
-const SAMPLES_REPO_URL = "https://github.com/MosslandOpenDevs/heymark.git";
-const SAMPLES_SOURCE_DIR = "samples";
-
-function exitWithError(message, details = []) {
-    console.error(`[Error] ${message}`);
-    details.forEach((detail) => console.error(`  ${detail}`));
-    process.exit(1);
-}
-
-function discoverTools() {
-    const toolsDir = path.join(SCRIPT_DIR, "tools");
-    const registry = {};
-
-    fs.readdirSync(toolsDir)
-        .filter((fileName) => fileName.endsWith(".js"))
-        .sort()
-        .forEach((file) => {
-            const key = path.basename(file, ".js");
-            registry[key] = require(path.join(toolsDir, file));
-        });
-
-    return registry;
-}
-
-function parseToolList(rawValue) {
-    const parsed = rawValue
-        .split(",")
-        .map((tool) => tool.trim().toLowerCase())
-        .filter(Boolean);
-
-    if (parsed.length === 0) {
-        exitWithError("--tools requires a comma-separated list.");
-    }
-
-    return parsed;
-}
-
-function parseArgs(availableTools) {
-    const args = process.argv.slice(2);
-    const config = {
-        tools: Object.keys(availableTools),
-        clean: false,
-        preview: false,
-        help: false,
-        source: null,
-    };
-
-    for (let i = 0; i < args.length; i++) {
-        const arg = args[i];
-
-        if (arg === OPTION_TOOLS || arg === SHORT_TOOLS) {
-            const value = args[++i];
-            if (!value) {
-                exitWithError("--tools requires a comma-separated list.");
-            }
-            config.tools = parseToolList(value);
-        } else if (arg === OPTION_CLEAN || arg === SHORT_CLEAN) {
-            config.clean = true;
-        } else if (arg === OPTION_PREVIEW || arg === SHORT_PREVIEW) {
-            config.preview = true;
-        } else if (arg === OPTION_SOURCE || arg === SHORT_SOURCE) {
-            const value = args[++i];
-            if (!value) {
-                exitWithError("--source requires a GitHub repository URL.");
-            }
-            config.source = value.trim();
-        } else if (arg === OPTION_HELP || arg === SHORT_HELP) {
-            config.help = true;
-        } else {
-            exitWithError(`Unknown option: ${arg}`, ["Use --help for usage information."]);
-        }
-    }
-
-    const invalidTools = config.tools.filter((tool) => !availableTools[tool]);
-    if (invalidTools.length > 0) {
-        exitWithError(`Unknown tool(s): ${invalidTools.join(", ")}`, [
-            `Available: ${Object.keys(availableTools).join(", ")}`,
-        ]);
-    }
-
-    return config;
-}
-
-function showHelp(tools) {
-    const toolLines = Object.entries(tools)
-        .map(([toolKey, toolDefinition]) => {
-            const paddedKey = toolKey.padEnd(10);
-            const paddedName = toolDefinition.name.padEnd(16);
-            return `  ${paddedKey} ${paddedName} -> ${toolDefinition.output}`;
-        })
-        .join("\n");
-
-    console.log(`
-AI Coding Tool Convention Sync
-
-Reads *.md from a GitHub repository (public or private) and generates
-tool-specific configuration files for various AI coding assistants.
-Same rules everywhere: A computer, B computer, same remote repo.
-
-Usage:
-  heymark init <repo-url>     Set rules source (creates ${CONFIG_RELATIVE})
-  heymark [options]           Sync from configured or --source repo
-
-Options:
-  --source, -s <url>   GitHub repo URL for this run (overrides ${CONFIG_RELATIVE})
-  --tools, -t <list>   Comma-separated tool names (default: all)
-  --clean, -c          Remove all generated files
-  --preview, -p        Preview what will be generated without writing
-  --help, -h           Show this help message
-
-Rules source (in order):
-  1. --source <repo-url>
-  2. ${CONFIG_RELATIVE} (set via 'heymark init <repo-url>')
-  Private repos: use SSH (git@github.com:org/repo.git) or HTTPS with token.
-
-Available tools:
-${toolLines}
-
-Examples:
-  heymark init https://github.com/org/my-rules.git
-  heymark init https://github.com/org/my-rules.git --dir rules --branch main
-  heymark
-  heymark -s https://github.com/org/other-rules.git
-  heymark -t cursor,claude
-  heymark -c
-  heymark -p
-`);
-}
-
-function parseInitArgs(initArgs) {
-    if (initArgs.length === 1 && initArgs[0] === OPTION_SAMPLES) {
-        return {
-            rulesSource: SAMPLES_REPO_URL,
-            branch: DEFAULT_BRANCH,
-            rulesSourceDir: SAMPLES_SOURCE_DIR,
-        };
-    }
-
-    if (initArgs.includes(OPTION_SAMPLES)) {
-        exitWithError("--samples cannot be combined with other init arguments.", [
-            "Use: heymark init --samples",
-        ]);
-    }
-
-    const repoUrl = initArgs[0];
-    if (!repoUrl || repoUrl.startsWith("--")) {
-        exitWithError("init requires a GitHub repository URL.", [
-            "Sample preset: heymark init --samples",
-            "Example: heymark init https://github.com/org/my-rules.git",
-            "Example: heymark init git@github.com:org/my-rules.git",
-            "Optional: --branch <branch>  --dir <subdir>  (e.g. --dir rules)",
-        ]);
-    }
-
-    let branch = DEFAULT_BRANCH;
-    let rulesSourceDir = "";
-
-    for (let i = 1; i < initArgs.length; i++) {
-        const arg = initArgs[i];
-
-        if (arg === OPTION_BRANCH || arg === SHORT_BRANCH) {
-            const value = initArgs[++i];
-            if (!value) {
-                exitWithError("--branch requires a branch name.");
-            }
-            branch = value.trim();
-            continue;
-        }
-
-        if (arg === OPTION_DIR || arg === SHORT_DIR) {
-            const value = initArgs[++i];
-            if (!value) {
-                exitWithError("--dir requires a directory path.");
-            }
-            rulesSourceDir = value.trim();
-            continue;
-        }
-
-        exitWithError(`Unknown option for init: ${arg}`);
-    }
-
-    return { rulesSource: repoUrl.trim(), branch, rulesSourceDir };
-}
-
-function runInit(initArgs) {
-    const config = parseInitArgs(initArgs);
-    const configPath = writeConfig(PROJECT_ROOT, config);
-
-    console.log(
-        `[Init] Rules source saved to ${path.relative(PROJECT_ROOT, configPath) || configPath}`
-    );
-    console.log(`  rulesSource: ${config.rulesSource}`);
-    if (config.branch !== DEFAULT_BRANCH) {
-        console.log(`  branch: ${config.branch}`);
-    }
-    if (config.rulesSourceDir) {
-        console.log(`  rulesSourceDir: ${config.rulesSourceDir}`);
-    }
-    console.log("");
-    console.log("Run 'heymark' to fetch rules from the repo and generate tool configs.");
-}
-
-function resolveRulesDir(config) {
-    const repoConfig = config.source
-        ? { rulesSource: config.source, branch: DEFAULT_BRANCH, rulesSourceDir: "" }
-        : loadConfig(PROJECT_ROOT);
-
-    if (!repoConfig) {
-        return null;
-    }
-
-    return getRulesDirFromRepo(PROJECT_ROOT, repoConfig);
-}
-
-function cleanGeneratedFiles(tools, selectedTools, ruleNames, onlyPrintWhenDeleted) {
-    for (const toolKey of selectedTools) {
-        const cleanedPaths = tools[toolKey].clean(ruleNames, PROJECT_ROOT);
-        if (onlyPrintWhenDeleted && cleanedPaths.length === 0) {
-            continue;
-        }
-
-        cleanedPaths.forEach((filePath) => {
-            console.log(`  Deleted: ${filePath}`);
-        });
-    }
-}
-
-function main() {
-    const args = process.argv.slice(2);
-    const subcommand = args[0];
-    if (subcommand === INIT_SUBCOMMAND) {
-        runInit(args.slice(1));
-        return;
-    }
-
-    const tools = discoverTools();
-    const config = parseArgs(tools);
-
-    if (config.help) {
-        showHelp(tools);
-        return;
-    }
-
-    const rulesSourceDir = resolveRulesDir(config);
-    if (!rulesSourceDir) {
-        console.error("[Error] Rules source not set.");
-        console.error("  Run: heymark init <github-repo-url>");
-        console.error("  Example: heymark init https://github.com/org/my-rules.git");
-        console.error("  Or use: heymark --source <repo-url>");
-        process.exit(1);
-    }
-
-    const rulesRelPath = path.relative(PROJECT_ROOT, rulesSourceDir) || ".";
-
-    console.log("[Sync] Starting convention sync...");
-    console.log(`  Source:  ${rulesRelPath} (from remote repo)`);
-    console.log(`  Target:  ${PROJECT_ROOT}`);
-    console.log(`  Tools:   ${config.tools.join(", ")}`);
-    console.log("");
-
-    const rules = loadRules(rulesSourceDir);
-    console.log(`[Load] ${rules.length} rule(s): ${rules.map((rule) => rule.name).join(", ")}`);
-    console.log("");
-
-    const ruleNames = rules.map((rule) => rule.name);
-
-    if (config.clean) {
-        console.log("[Clean] Removing generated files...");
-        cleanGeneratedFiles(tools, config.tools, ruleNames, false);
-        console.log("");
-        console.log(`[Done] Cleaned ${config.tools.length} tool(s) successfully.`);
-        return;
-    }
-
-    if (config.preview) {
-        console.log("[Preview] Would generate:");
-        for (const toolKey of config.tools) {
-            const toolDefinition = tools[toolKey];
-            const summary = `${toolDefinition.name.padEnd(16)} -> ${toolDefinition.output}`;
-            console.log(`  ${summary} (${rules.length} rules)`);
-        }
-        return;
-    }
-
-    // Ensure regenerated output is always fresh.
-    console.log("[Clean] Removing existing generated files...");
-    cleanGeneratedFiles(tools, config.tools, ruleNames, true);
-    console.log("");
-
-    console.log("[Generate]");
-    for (const toolKey of config.tools) {
-        const toolDefinition = tools[toolKey];
-        const count = toolDefinition.generate(rules, PROJECT_ROOT);
-        const summary = `${toolDefinition.name.padEnd(16)} -> ${toolDefinition.output}`;
-        console.log(`  ${summary} (${count} rules)`);
-    }
-
-    console.log("");
-    console.log(`[Done] ${config.tools.length} tool(s) synced successfully.`);
-}
-
-main();