heymark 1.1.1 → 1.1.3

package/package.json

@@ -1,57 +1,56 @@
-{
-    "name": "heymark",
-    "version": "1.1.1",
-    "description": "Centralized AI coding tool conventions with auto-conversion to multiple formats",
-    "main": "scripts/sync.js",
-    "bin": {
-        "heymark": "scripts/sync.js"
-    },
-    "scripts": {
-        "sync": "node scripts/sync.js",
-        "init": "node scripts/sync.js init",
-        "test": "echo \"Error: no test specified\" && exit 1"
-    },
-    "keywords": [
-        "ai",
-        "coding",
-        "conventions",
-        "cursor",
-        "claude",
-        "copilot",
-        "codex",
-        "rules"
-    ],
-    "author": {
-        "name": "i2na",
-        "email": "yena.e121@gmail.com",
-        "url": "https://github.com/i2na"
-    },
-    "contributors": [
-        {
-            "name": "i2na",
-            "email": "yena.e121@gmail.com",
-            "url": "https://github.com/i2na"
-        },
-        {
-            "name": "yezzero",
-            "email": "yeyeonggim06@gmail.com",
-            "url": "https://github.com/yezzero"
-        }
-    ],
-    "license": "MIT",
-    "engines": {
-        "node": ">=14.0.0"
-    },
-    "files": [
-        "scripts/",
-        "rules/",
-        "README.md"
-    ],
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/MosslandOpenDevs/heymark.git"
-    },
-    "publishConfig": {
-        "access": "public"
-    }
-}
+{
+    "name": "heymark",
+    "version": "1.1.3",
+    "description": "Rules & Skills Hub for AI Coding Assistants",
+    "type": "commonjs",
+    "main": "scripts/sync.js",
+    "bin": "scripts/sync.js",
+    "keywords": [
+        "ai-coding-assistant",
+        "ai-agent",
+        "ai-skill",
+        "ai-rule",
+        "skill-management",
+        "cursor",
+        "claude-code",
+        "copilot",
+        "codex",
+        "antigravity"
+    ],
+    "homepage": "https://github.com/MosslandOpenDevs/heymark#readme",
+    "bugs": {
+        "url": "https://github.com/MosslandOpenDevs/heymark/issues",
+        "email": "yena@moss.land"
+    },
+    "license": "MIT",
+    "author": {
+        "name": "i-2na",
+        "email": "yena@moss.land",
+        "url": "https://github.com/i2na"
+    },
+    "contributors": [
+        {
+            "name": "i-2na",
+            "email": "yena@moss.land",
+            "url": "https://github.com/i2na"
+        },
+        {
+            "name": "yezzero",
+            "email": "yeyeonggim06@gmail.com",
+            "url": "https://github.com/yezzero"
+        }
+    ],
+    "engines": {
+        "node": ">=14.0.0"
+    },
+    "files": [
+        "scripts/"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/MosslandOpenDevs/heymark.git"
+    },
+    "publishConfig": {
+        "access": "public"
+    }
+}

package/scripts/lib/config.js

@@ -1,73 +1,110 @@
-"use strict";
-
-const fs = require("fs");
-const path = require("path");
-
-const CONFIG_DIR = ".heymark";
-const CONFIG_FILENAME = "config.json";
-/** 프로젝트 루트 기준 설정 파일 경로 (표시용) */
-const CONFIG_RELATIVE = path.join(CONFIG_DIR, CONFIG_FILENAME);
-
-/**
- * rulesSource: GitHub 저장소 URL (https://github.com/org/repo 또는 git@github.com:org/repo.git)
- * branch: 브랜치 (기본 main)
- * rulesSourceDir: 저장소 내부에서 .md가 있는 하위 디렉터리 (기본 "" = 루트)
- * @typedef {{ rulesSource: string, branch?: string, rulesSourceDir?: string }} RuleBookConfig
- */
-
-/**
- * 프로젝트 루트에서 .heymark/config.json을 읽습니다.
- * @param {string} projectRoot - 프로젝트 루트 (보통 process.cwd())
- * @returns {RuleBookConfig | null}
- */
-function loadConfig(projectRoot) {
-    const configPath = path.join(projectRoot, CONFIG_DIR, CONFIG_FILENAME);
-    if (!fs.existsSync(configPath)) return null;
-
-    try {
-        const raw = fs.readFileSync(configPath, "utf8");
-        const data = JSON.parse(raw);
-        if (!data || typeof data.rulesSource !== "string" || !data.rulesSource.trim()) {
-            return null;
-        }
-        return {
-            rulesSource: data.rulesSource.trim(),
-            branch:
-                typeof data.branch === "string" && data.branch.trim() ? data.branch.trim() : "main",
-            rulesSourceDir:
-                typeof data.rulesSourceDir === "string" ? data.rulesSourceDir.trim() : "",
-        };
-    } catch {
-        return null;
-    }
-}
-
-/**
- * 초기 설정 파일을 생성합니다. (원격 GitHub 저장소 URL 사용) .heymark/config.json에 저장합니다.
- * @param {string} projectRoot
- * @param {RuleBookConfig} config - { rulesSource: repoUrl, branch?, rulesSourceDir? }
- */
-function writeConfig(projectRoot, config) {
-    const configDir = path.join(projectRoot, CONFIG_DIR);
-    if (!fs.existsSync(configDir)) {
-        fs.mkdirSync(configDir, { recursive: true });
-    }
-    const configPath = path.join(configDir, CONFIG_FILENAME);
-    const toWrite = {
-        rulesSource: config.rulesSource,
-        branch: config.branch || "main",
-    };
-    if (config.rulesSourceDir) {
-        toWrite.rulesSourceDir = config.rulesSourceDir;
-    }
-    fs.writeFileSync(configPath, JSON.stringify(toWrite, null, 2), "utf8");
-    return configPath;
-}
-
-module.exports = {
-    CONFIG_DIR,
-    CONFIG_FILENAME,
-    CONFIG_RELATIVE,
-    loadConfig,
-    writeConfig,
-};
+"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,82 +1,125 @@
-"use strict";
-
-const fs = require("fs");
-const path = require("path");
-
-const GENERATED_MARKER = "<!-- @generated by sync-rules - DO NOT EDIT -->";
-
-function parseFrontmatter(content) {
-    const match = content.match(/^---\r?\n([\s\S]+?)\r?\n---\r?\n?([\s\S]*)$/);
-    if (!match) return { metadata: {}, body: content.trim() };
-
-    const metadata = {};
-    match[1].split(/\r?\n/).forEach((line) => {
-        const idx = line.indexOf(":");
-        if (idx === -1) return;
-        const key = line.slice(0, idx).trim();
-        let value = line.slice(idx + 1).trim();
-        if (
-            (value.startsWith('"') && value.endsWith('"')) ||
-            (value.startsWith("'") && value.endsWith("'"))
-        ) {
-            value = value.slice(1, -1);
-        }
-        if (value === "true") value = true;
-        else if (value === "false") value = false;
-        metadata[key] = value;
-    });
-
-    return { metadata, body: match[2].trim() };
-}
-
-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 = fs
-        .readdirSync(rulesDir)
-        .filter((f) => f.endsWith(".md"))
-        .sort();
-
-    if (files.length === 0) {
-        console.error(`[Error] No .md files found in: ${rulesDir}`);
-        process.exit(1);
-    }
-
-    return files.map((file) => {
-        const raw = fs.readFileSync(path.join(rulesDir, file), "utf8");
-        const { metadata, body } = parseFrontmatter(raw);
-        const baseName = path.basename(file, ".md");
-
-        return {
-            fileName: file,
-            name: metadata.name || baseName,
-            description: metadata.description || baseName,
-            globs: metadata.globs || "",
-            alwaysApply: metadata.alwaysApply === true,
-            metadata,
-            body,
-        };
-    });
-}
-
-function mergeRuleBodies(rules) {
-    return rules.map((r) => r.body).join("\n\n---\n\n");
-}
-
-function writeMergedFile(filePath, rules) {
-    fs.mkdirSync(path.dirname(filePath), { recursive: true });
-    const content = `${GENERATED_MARKER}\n\n${mergeRuleBodies(rules)}\n`;
-    fs.writeFileSync(filePath, content);
-}
-
-module.exports = {
-    GENERATED_MARKER,
-    parseFrontmatter,
-    loadRules,
-    mergeRuleBodies,
-    writeMergedFile,
-};
+"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,
+};