heymark 2.0.0 → 2.1.0

package/scripts/lib/config.js

@@ -1,126 +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 {{ repoUrl: string, branch?: string, folder?: string }} THeymarkConfig
- */
-
-/**
- * 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 {THeymarkConfig | null}
- */
-function normalizeConfig(value) {
-    if (!value || typeof value !== "object") {
-        return null;
-    }
-
-    const raw = /** @type {{
-     *   repoUrl?: unknown,
-     *   branch?: unknown,
-     *   folder?: unknown,
-     *   rulesSource?: unknown,
-     *   rulesSourceDir?: unknown
-     * }} */ (value);
-
-    const repoUrl =
-        typeof raw.repoUrl === "string" && raw.repoUrl.trim()
-            ? raw.repoUrl.trim()
-            : typeof raw.rulesSource === "string" && raw.rulesSource.trim()
-              ? raw.rulesSource.trim()
-              : "";
-
-    if (!repoUrl) {
-        return null;
-    }
-
-    return {
-        repoUrl,
-        branch:
-            typeof raw.branch === "string" && raw.branch.trim()
-                ? raw.branch.trim()
-                : DEFAULT_BRANCH,
-        folder:
-            typeof raw.folder === "string"
-                ? raw.folder.trim()
-                : typeof raw.rulesSourceDir === "string"
-                  ? raw.rulesSourceDir.trim()
-                  : "",
-    };
-}
-
-/**
- * Read config from project root.
- * @param {string} projectRoot
- * @returns {THeymarkConfig | 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 {THeymarkConfig} 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 = {
-        repoUrl: normalized.repoUrl,
-        branch: normalized.branch || DEFAULT_BRANCH,
-    };
-    if (normalized.folder) {
-        toWrite.folder = normalized.folder;
-    }
-
-    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 cloneLinkedRepo(projectRoot, clonePath, branch, repoUrl) {
-    execSync(`git clone --depth 1 --branch "${branch}" "${repoUrl}" "${clonePath}"`, {
-        stdio: "inherit",
-        cwd: projectRoot,
-    });
-}
-
-function updateLinkedRepo(clonePath, branch) {
-    execSync(`git fetch origin && git checkout --quiet . && git pull --quiet origin "${branch}"`, {
-        stdio: "pipe",
-        cwd: clonePath,
-    });
-}
-
-function resolveLinkedFolder(clonePath, folder) {
-    const rulesDir = folder ? path.join(clonePath, folder) : clonePath;
-    if (!fs.existsSync(rulesDir) || !fs.statSync(rulesDir).isDirectory()) {
-        console.error(`[Error] Rules directory not found in repo: ${folder || "(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 {{ repoUrl: string, branch?: string, folder?: string }} config
- * @returns {string}
- */
-function getLinkedRulesDir(projectRoot, config) {
-    const repoUrl = config.repoUrl;
-    const branch = config.branch || DEFAULT_BRANCH;
-    const folder = config.folder || "";
-
-    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 {
-            cloneLinkedRepo(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 link https://github.com/org/repo.git");
-            process.exit(1);
-        }
-    } else {
-        try {
-            updateLinkedRepo(clonePath, branch);
-        } catch {
-            // Continue with cached clone when fetch or pull fails.
-        }
-    }
-
-    return resolveLinkedFolder(clonePath, folder);
-}
-
-module.exports = {
-    CACHE_DIR_NAME,
-    getLinkedRulesDir,
-    sanitizeRepoName,
-};

package/scripts/tools/antigravity.js

@@ -1,49 +0,0 @@
-"use strict";
-
-const fs = require("fs");
-const path = require("path");
-
-const SKILLS_DIR = path.join(".agent", "skills");
-const SKILL_FILE_NAME = "SKILL.md";
-
-function getSkillDir(projectRoot, ruleName) {
-    return path.join(projectRoot, SKILLS_DIR, ruleName);
-}
-
-function createSkillContent(rule) {
-    const frontmatterLines = [
-        "---",
-        `name: ${rule.name}`,
-        `description: "${rule.description}"`,
-        "---",
-    ];
-
-    return `${frontmatterLines.join("\n")}\n\n${rule.body}\n`;
-}
-
-module.exports = {
-    name: "Antigravity",
-    output: ".agent/skills/*/SKILL.md",
-
-    generate(rules, projectRoot) {
-        for (const rule of rules) {
-            const skillDir = getSkillDir(projectRoot, rule.name);
-            fs.mkdirSync(skillDir, { recursive: true });
-            const filePath = path.join(skillDir, SKILL_FILE_NAME);
-            const content = createSkillContent(rule);
-            fs.writeFileSync(filePath, content, "utf8");
-        }
-
-        return rules.length;
-    },
-
-    clean(ruleNames, projectRoot) {
-        const skillsDirPath = path.join(projectRoot, SKILLS_DIR);
-        if (!fs.existsSync(skillsDirPath)) {
-            return [];
-        }
-
-        fs.rmSync(skillsDirPath, { recursive: true, force: true });
-        return [SKILLS_DIR];
-    },
-};

package/scripts/tools/claude.js

@@ -1,49 +0,0 @@
-"use strict";
-
-const fs = require("fs");
-const path = require("path");
-
-const SKILLS_DIR = path.join(".claude", "skills");
-const SKILL_FILE_NAME = "SKILL.md";
-
-function getSkillDir(projectRoot, ruleName) {
-    return path.join(projectRoot, SKILLS_DIR, ruleName);
-}
-
-function createSkillContent(rule) {
-    const frontmatterLines = [
-        "---",
-        `name: ${rule.name}`,
-        `description: "${rule.description}"`,
-        "---",
-    ];
-
-    return `${frontmatterLines.join("\n")}\n\n${rule.body}\n`;
-}
-
-module.exports = {
-    name: "Claude Code",
-    output: ".claude/skills/*/SKILL.md",
-
-    generate(rules, projectRoot) {
-        for (const rule of rules) {
-            const skillDir = getSkillDir(projectRoot, rule.name);
-            fs.mkdirSync(skillDir, { recursive: true });
-            const filePath = path.join(skillDir, SKILL_FILE_NAME);
-            const content = createSkillContent(rule);
-            fs.writeFileSync(filePath, content, "utf8");
-        }
-
-        return rules.length;
-    },
-
-    clean(ruleNames, projectRoot) {
-        const skillsDirPath = path.join(projectRoot, SKILLS_DIR);
-        if (!fs.existsSync(skillsDirPath)) {
-            return [];
-        }
-
-        fs.rmSync(skillsDirPath, { recursive: true, force: true });
-        return [SKILLS_DIR];
-    },
-};

package/scripts/tools/codex.js

@@ -1,49 +0,0 @@
-"use strict";
-
-const fs = require("fs");
-const path = require("path");
-
-const SKILLS_DIR = path.join(".agents", "skills");
-const SKILL_FILE_NAME = "SKILL.md";
-
-function getSkillDir(projectRoot, ruleName) {
-    return path.join(projectRoot, SKILLS_DIR, ruleName);
-}
-
-function createSkillContent(rule) {
-    const frontmatterLines = [
-        "---",
-        `name: ${rule.name}`,
-        `description: "${rule.description}"`,
-        "---",
-    ];
-
-    return `${frontmatterLines.join("\n")}\n\n${rule.body}\n`;
-}
-
-module.exports = {
-    name: "OpenAI Codex",
-    output: ".agents/skills/*/SKILL.md",
-
-    generate(rules, projectRoot) {
-        for (const rule of rules) {
-            const skillDir = getSkillDir(projectRoot, rule.name);
-            fs.mkdirSync(skillDir, { recursive: true });
-            const filePath = path.join(skillDir, SKILL_FILE_NAME);
-            const content = createSkillContent(rule);
-            fs.writeFileSync(filePath, content, "utf8");
-        }
-
-        return rules.length;
-    },
-
-    clean(ruleNames, projectRoot) {
-        const skillsDirPath = path.join(projectRoot, SKILLS_DIR);
-        if (!fs.existsSync(skillsDirPath)) {
-            return [];
-        }
-
-        fs.rmSync(skillsDirPath, { recursive: true, force: true });
-        return [SKILLS_DIR];
-    },
-};

package/scripts/tools/copilot.js

@@ -1,61 +0,0 @@
-"use strict";
-
-const fs = require("fs");
-const path = require("path");
-
-const INSTRUCTIONS_DIR = path.join(".github", "instructions");
-const FILE_SUFFIX = ".instructions.md";
-const DEFAULT_GLOB = "**";
-
-function getInstructionPath(projectRoot, ruleName) {
-    return path.join(projectRoot, INSTRUCTIONS_DIR, `${ruleName}${FILE_SUFFIX}`);
-}
-
-function normalizeGlobs(globsValue) {
-    if (!globsValue) {
-        return [DEFAULT_GLOB];
-    }
-
-    const globs = globsValue
-        .split(",")
-        .map((glob) => glob.trim())
-        .filter(Boolean);
-
-    return globs.length > 0 ? globs : [DEFAULT_GLOB];
-}
-
-function createInstructionContent(rule) {
-    const applyToLines = normalizeGlobs(rule.globs)
-        .map((glob) => `  - "${glob}"`)
-        .join("\n");
-    const header = `applyTo:\n${applyToLines}\n---`;
-    return `${header}\n\n${rule.body}\n`;
-}
-
-module.exports = {
-    name: "GitHub Copilot",
-    output: ".github/instructions/*.instructions.md",
-
-    generate(rules, projectRoot) {
-        const destDir = path.join(projectRoot, INSTRUCTIONS_DIR);
-        fs.mkdirSync(destDir, { recursive: true });
-
-        for (const rule of rules) {
-            const filePath = getInstructionPath(projectRoot, rule.name);
-            const content = createInstructionContent(rule);
-            fs.writeFileSync(filePath, content, "utf8");
-        }
-
-        return rules.length;
-    },
-
-    clean(ruleNames, projectRoot) {
-        const instructionsDirPath = path.join(projectRoot, INSTRUCTIONS_DIR);
-        if (!fs.existsSync(instructionsDirPath)) {
-            return [];
-        }
-
-        fs.rmSync(instructionsDirPath, { recursive: true, force: true });
-        return [INSTRUCTIONS_DIR];
-    },
-};

package/scripts/tools/cursor.js

@@ -1,48 +0,0 @@
-"use strict";
-
-const fs = require("fs");
-const path = require("path");
-
-const RULES_DIR = path.join(".cursor", "rules");
-const FILE_SUFFIX = ".mdc";
-
-function getRulePath(projectRoot, ruleName) {
-    return path.join(projectRoot, RULES_DIR, `${ruleName}${FILE_SUFFIX}`);
-}
-
-function createRuleContent(rule) {
-    const frontmatterLines = ["---", `description: "${rule.description}"`];
-    if (rule.globs) {
-        frontmatterLines.push(`globs: "${rule.globs}"`);
-    }
-    frontmatterLines.push(`alwaysApply: ${rule.alwaysApply}`);
-    frontmatterLines.push("---");
-
-    return `${frontmatterLines.join("\n")}\n\n${rule.body}\n`;
-}
-
-module.exports = {
-    name: "Cursor",
-    output: ".cursor/rules/*.mdc",
-
-    generate(rules, projectRoot) {
-        const destDir = path.join(projectRoot, RULES_DIR);
-        fs.mkdirSync(destDir, { recursive: true });
-
-        for (const rule of rules) {
-            fs.writeFileSync(getRulePath(projectRoot, rule.name), createRuleContent(rule), "utf8");
-        }
-
-        return rules.length;
-    },
-
-    clean(ruleNames, projectRoot) {
-        const rulesDirPath = path.join(projectRoot, RULES_DIR);
-        if (!fs.existsSync(rulesDirPath)) {
-            return [];
-        }
-
-        fs.rmSync(rulesDirPath, { recursive: true, force: true });
-        return [RULES_DIR];
-    },
-};