@savvy-web/changesets 0.1.0 → 0.1.1

package/{bin → esm/bin}/savvy-changesets.js

@@ -37,7 +37,12 @@ const checkCommand = Command.make("check", {
 }, ({ dir })=>runCheck(dir)).pipe(Command.withDescription("Full changeset validation with summary"));
 const CUSTOM_RULES_ENTRY = "@savvy-web/changesets/markdownlint";
 const CHANGELOG_ENTRY = "@savvy-web/changesets/changelog";
-const BASE_CONFIG_PATH = "lib/configs/.markdownlint-cli2.jsonc";
+const MARKDOWNLINT_CONFIG_PATHS = [
+    "lib/configs/.markdownlint-cli2.jsonc",
+    "lib/configs/.markdownlint-cli2.json",
+    ".markdownlint-cli2.jsonc",
+    ".markdownlint-cli2.json"
+];
 const RULE_NAMES = [
     "changeset-heading-hierarchy",
     "changeset-required-sections",
@@ -70,6 +75,7 @@ class InitError extends InitErrorBase {
 const forceOption = Options.boolean("force").pipe(Options.withAlias("f"), Options.withDescription("Overwrite existing config files"), Options.withDefault(false));
 const quietOption = Options.boolean("quiet").pipe(Options.withAlias("q"), Options.withDescription("Silence warnings, always exit 0"), Options.withDefault(false));
 const markdownlintOption = Options.boolean("markdownlint").pipe(Options.withDescription("Register rules in base markdownlint config"), Options.withDefault(true));
+const checkOption = Options.boolean("check").pipe(Options.withDescription("Check configuration without writing (for postinstall scripts)"), Options.withDefault(false));
 function detectGitHubRepo(cwd) {
     try {
         const url = execSync("git remote get-url origin", {
@@ -89,6 +95,10 @@ function stripJsoncComments(text) {
 function resolveWorkspaceRoot(cwd) {
     return findProjectRoot(cwd) ?? cwd;
 }
+function findMarkdownlintConfig(root) {
+    for (const configPath of MARKDOWNLINT_CONFIG_PATHS)if (existsSync(join(root, configPath))) return configPath;
+    return null;
+}
 function ensureChangesetDir(root) {
     return Effect["try"]({
         try: ()=>{
@@ -140,19 +150,20 @@ function handleConfig(changesetDir, repoSlug, force) {
 function handleBaseMarkdownlint(root) {
     return Effect["try"]({
         try: ()=>{
-            const baseConfigPath = join(root, BASE_CONFIG_PATH);
-            if (!existsSync(baseConfigPath)) return null;
-            const raw = readFileSync(baseConfigPath, "utf-8");
+            const foundPath = findMarkdownlintConfig(root);
+            if (!foundPath) return `Warning: no markdownlint config found (checked ${MARKDOWNLINT_CONFIG_PATHS.join(", ")})`;
+            const fullPath = join(root, foundPath);
+            const raw = readFileSync(fullPath, "utf-8");
             const parsed = JSON.parse(stripJsoncComments(raw));
             if (!Array.isArray(parsed.customRules)) parsed.customRules = [];
             if (!parsed.customRules.includes(CUSTOM_RULES_ENTRY)) parsed.customRules.push(CUSTOM_RULES_ENTRY);
             if ("object" != typeof parsed.config || null === parsed.config) parsed.config = {};
             for (const rule of RULE_NAMES)if (!(rule in parsed.config)) parsed.config[rule] = false;
-            writeFileSync(baseConfigPath, `${JSON.stringify(parsed, null, "\t")}\n`);
-            return "Updated lib/configs/.markdownlint-cli2.jsonc";
+            writeFileSync(fullPath, `${JSON.stringify(parsed, null, "\t")}\n`);
+            return `Updated ${foundPath}`;
         },
         catch: (error)=>new InitError({
-                step: "lib/configs/.markdownlint-cli2.jsonc",
+                step: "markdownlint config",
                 reason: error instanceof Error ? error.message : String(error)
             })
     });
@@ -161,10 +172,10 @@ function handleChangesetMarkdownlint(changesetDir, root, force) {
     return Effect["try"]({
         try: ()=>{
             const mdlintPath = join(changesetDir, ".markdownlint.json");
-            const hasBaseConfig = existsSync(join(root, BASE_CONFIG_PATH));
+            const baseConfig = findMarkdownlintConfig(root);
             if (force || !existsSync(mdlintPath)) {
                 const mdlintConfig = {};
-                if (hasBaseConfig) mdlintConfig.extends = `../${BASE_CONFIG_PATH}`;
+                if (baseConfig) mdlintConfig.extends = `../${baseConfig}`;
                 mdlintConfig.default = false;
                 mdlintConfig.MD041 = false;
                 for (const rule of RULE_NAMES)mdlintConfig[rule] = true;
@@ -182,15 +193,131 @@ function handleChangesetMarkdownlint(changesetDir, root, force) {
             })
     });
 }
+function checkChangesetDir(root) {
+    const dir = join(root, ".changeset");
+    if (!existsSync(dir)) return [
+        {
+            file: ".changeset/",
+            message: "directory does not exist"
+        }
+    ];
+    return [];
+}
+function checkConfig(changesetDir, repoSlug) {
+    const configPath = join(changesetDir, "config.json");
+    if (!existsSync(configPath)) return [
+        {
+            file: ".changeset/config.json",
+            message: "file does not exist"
+        }
+    ];
+    try {
+        const config = JSON.parse(readFileSync(configPath, "utf-8"));
+        const issues = [];
+        const changelog = config.changelog;
+        const entry = Array.isArray(changelog) ? changelog[0] : changelog;
+        const repo = Array.isArray(changelog) ? changelog[1]?.repo : void 0;
+        if (entry !== CHANGELOG_ENTRY) issues.push({
+            file: ".changeset/config.json",
+            message: `changelog formatter is "${entry}", expected "${CHANGELOG_ENTRY}"`
+        });
+        else if (repo !== repoSlug) issues.push({
+            file: ".changeset/config.json",
+            message: `changelog repo is "${repo ?? "(not set)"}", expected "${repoSlug}"`
+        });
+        return issues;
+    } catch  {
+        return [
+            {
+                file: ".changeset/config.json",
+                message: "could not parse file"
+            }
+        ];
+    }
+}
+function checkBaseMarkdownlint(root) {
+    const foundPath = findMarkdownlintConfig(root);
+    if (!foundPath) return [
+        {
+            file: "markdownlint config",
+            message: `not found (checked ${MARKDOWNLINT_CONFIG_PATHS.join(", ")})`
+        }
+    ];
+    try {
+        const raw = readFileSync(join(root, foundPath), "utf-8");
+        const parsed = JSON.parse(stripJsoncComments(raw));
+        const issues = [];
+        if (!Array.isArray(parsed.customRules) || !parsed.customRules.includes(CUSTOM_RULES_ENTRY)) issues.push({
+            file: foundPath,
+            message: `customRules does not include ${CUSTOM_RULES_ENTRY}`
+        });
+        const config = parsed.config;
+        if ("object" != typeof config || null === config) issues.push({
+            file: foundPath,
+            message: "config section is missing"
+        });
+        else for (const rule of RULE_NAMES)if (!(rule in config)) issues.push({
+            file: foundPath,
+            message: `rule "${rule}" is not configured`
+        });
+        return issues;
+    } catch  {
+        return [
+            {
+                file: foundPath,
+                message: "could not parse file"
+            }
+        ];
+    }
+}
+function checkChangesetMarkdownlint(changesetDir) {
+    const mdlintPath = join(changesetDir, ".markdownlint.json");
+    if (!existsSync(mdlintPath)) return [
+        {
+            file: ".changeset/.markdownlint.json",
+            message: "file does not exist"
+        }
+    ];
+    try {
+        const existing = JSON.parse(readFileSync(mdlintPath, "utf-8"));
+        const issues = [];
+        for (const rule of RULE_NAMES)if (true !== existing[rule]) issues.push({
+            file: ".changeset/.markdownlint.json",
+            message: `rule "${rule}" is not enabled`
+        });
+        return issues;
+    } catch  {
+        return [
+            {
+                file: ".changeset/.markdownlint.json",
+                message: "could not parse file"
+            }
+        ];
+    }
+}
 const initCommand = Command.make("init", {
     force: forceOption,
     quiet: quietOption,
-    markdownlint: markdownlintOption
-}, ({ force, quiet, markdownlint })=>Effect.gen(function*() {
+    markdownlint: markdownlintOption,
+    check: checkOption
+}, ({ force, quiet, markdownlint, check })=>Effect.gen(function*() {
         const root = resolveWorkspaceRoot(process.cwd());
         const repo = detectGitHubRepo(root);
         if (!repo && !quiet) yield* Effect.log("Warning: could not detect GitHub repo from git remote, using placeholder");
         const repoSlug = repo ?? "owner/repo";
+        if (check) {
+            const changesetDir = join(root, ".changeset");
+            const issues = [
+                ...checkChangesetDir(root),
+                ...checkConfig(changesetDir, repoSlug),
+                ...markdownlint ? checkBaseMarkdownlint(root) : [],
+                ...checkChangesetMarkdownlint(changesetDir)
+            ];
+            if (0 === issues.length) return void (yield* Effect.log("All @savvy-web/changesets config files are up to date."));
+            for (const issue of issues)yield* Effect.logWarning(`${issue.file}: ${issue.message}`);
+            yield* Effect.logWarning('Run "savvy-changesets init --force" to fix.');
+            return;
+        }
         const changesetDir = yield* ensureChangesetDir(root);
         yield* Effect.log("Ensured .changeset/ directory");
         const errors = [];
@@ -199,9 +326,8 @@ const initCommand = Command.make("init", {
         else errors.push(configResult.left);
         if (markdownlint) {
             const baseResult = yield* handleBaseMarkdownlint(root).pipe(Effect.either);
-            if ("Right" === baseResult._tag) {
-                if (baseResult.right) yield* Effect.log(baseResult.right);
-            } else errors.push(baseResult.left);
+            if ("Right" === baseResult._tag) yield* Effect.log(baseResult.right);
+            else errors.push(baseResult.left);
         }
         const mdlintResult = yield* handleChangesetMarkdownlint(changesetDir, root, force).pipe(Effect.either);
         if ("Right" === mdlintResult._tag) yield* Effect.log(mdlintResult.right);
@@ -239,7 +365,7 @@ const fileArg = Args.file({
     name: "file"
 }).pipe(Args.withDefault("CHANGELOG.md"));
 const dryRunOption = Options.boolean("dry-run").pipe(Options.withAlias("n"), Options.withDescription("Print transformed output instead of writing"), Options.withDefault(false));
-const checkOption = Options.boolean("check").pipe(Options.withAlias("c"), Options.withDescription("Exit 1 if file would change (for CI)"), Options.withDefault(false));
+const transform_checkOption = Options.boolean("check").pipe(Options.withAlias("c"), Options.withDescription("Exit 1 if file would change (for CI)"), Options.withDefault(false));
 function runTransform(file, dryRun, check) {
     return Effect.gen(function*() {
         const resolved = resolve(file);
@@ -260,7 +386,7 @@ function runTransform(file, dryRun, check) {
 const transformCommand = Command.make("transform", {
     file: fileArg,
     dryRun: dryRunOption,
-    check: checkOption
+    check: transform_checkOption
 }, ({ file, dryRun, check })=>runTransform(file, dryRun, check)).pipe(Command.withDescription("Post-process CHANGELOG.md"));
 class Workspace {
     static detectPackageManager(cwd = process.cwd()) {
@@ -366,7 +492,7 @@ const rootCommand = Command.make("savvy-changesets").pipe(Command.withSubcommand
 ]));
 const cli = Command.run(rootCommand, {
     name: "savvy-changesets",
-    version: "0.1.0"
+    version: "0.1.1"
 });
 function runCli() {
     const main = Effect.suspend(()=>cli(process.argv)).pipe(Effect.provide(NodeContext.layer));

package/esm/changelog.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Changesets API changelog formatter.
+ *
+ * This module exports the `ChangelogFunctions` required by the Changesets API.
+ * Configure in `.changeset/config.json`:
+ *
+ * ```json
+ * {
+ *   "changelog": ["\@savvy-web/changesets/changelog", { "repo": "savvy-web/package-name" }]
+ * }
+ * ```
+ *
+ * @packageDocumentation
+ */
+
+import { ChangelogFunctions } from '@changesets/types';
+
+declare const changelogFunctions: ChangelogFunctions;
+export default changelogFunctions;
+
+export { }