@shawncheng888/plugin-scaffolder-backend-module-markdown-merge 0.1.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of tracking or otherwise improving the Work,
+      but excludes communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, attribution and other
+          notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Support. While redistributing the Work or
+      Derivative Works thereof, You may choose to offer, and charge a
+      fee for, acceptance of support, warranty, indemnity, or other
+      liability obligations and/or rights consistent with this License.
+      However, in accepting such obligations, You may act only on Your
+      own behalf and on Your sole responsibility, not on behalf of any
+      other Contributor, and only if You agree to indemnify, defend,
+      and hold each Contributor harmless for any liability incurred by,
+      or claims asserted against, such Contributor by reason of your
+      accepting any such warranty or support.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Shawn Cheng
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,250 @@
+# Backstage Scaffolder Markdown Merge
+
+[![CI](https://github.com/joint-song/plugin-scaffolder-backend-module-markdown-merge/actions/workflows/ci.yml/badge.svg)](https://github.com/joint-song/plugin-scaffolder-backend-module-markdown-merge/actions/workflows/ci.yml)
+
+A [Backstage](https://backstage.io) scaffolder action that merges multiple Markdown fragments into a target document at named slot markers. Useful for composing `AGENTS.md`, `README.md`, `CONTRIBUTING.md`, and other Markdown files from reusable, independently-maintained fragments during Software Template execution.
+
+The action id is `markdown:merge`.
+
+## Slot Markers
+
+The action looks for HTML-comment-style markers in the target file:
+
+```markdown
+<!-- MD_SLOT: NAME -->
+... content to be replaced or appended to ...
+<!-- /MD_SLOT: NAME -->
+```
+
+A single opening tag is also accepted; the closing tag is auto-generated on first merge:
+
+```markdown
+<!-- MD_SLOT: NAME -->
+```
+
+The marker name `MD_SLOT` was chosen to avoid collision with HTML `<slot>` elements and common templating engines.
+
+## Installation
+
+In your Backstage project, add this action to the backend:
+
+```console
+yarn workspace backend add @shawncheng888/plugin-scaffolder-backend-module-markdown-merge
+```
+
+Then register the action in `packages/backend/src/index.ts`:
+
+```ts
+// packages/backend/src/index.ts
+import { createBackend } from '@backstage/backend-defaults';
+
+const backend = createBackend();
+// ... other backend.add(...) calls
+backend.add(import('backstage-plugin-scaffolder-markdown-merge'));
+
+backend.start();
+```
+
+## Usage
+
+Add a step to your Software Template:
+
+```yaml
+# template.yaml
+spec:
+  type: markdown-merge
+  steps:
+    - id: merge-docs
+      action: markdown:merge
+      input:
+        path: AGENTS.md
+        slots:
+          - name: coding-standards
+            fragmentPath: fragments/coding-standards.md
+          - name: deployment
+            fragmentPath: fragments/deploy.md
+```
+
+### Input parameters
+
+| Name                 | Type                                       | Required | Default   | Description                                                                                                                                                                                                                                            |
+| -------------------- | ------------------------------------------ | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `path`               | `string`                                   | Yes      | —         | Path to the target Markdown file, relative to the scaffolder workspace (e.g. `AGENTS.md`).                                                                                                                                                            |
+| `slots`              | `Array<{ name, fragmentPath }>`            | Yes      | —         | Fragments to merge in. `name` is the slot marker name (matches `MD_SLOT: <name>`); `fragmentPath` is the path to the fragment file, relative to the workspace.                                                                                          |
+| `mode`               | `'replace' \| 'append'`                    | No       | `replace` | How to merge into a paired slot. `replace` overwrites the existing content between the markers; `append` keeps it and inserts the fragment after it. Has no effect for the single-tag fallback.                                                        |
+| `onFragmentMissing`  | `'error' \| 'warn' \| 'ignore'`            | No       | `warn`    | Behavior when a fragment file does not exist. `error` throws and fails the step; `warn` logs a warning and skips the slot; `ignore` skips silently.                                                                                                     |
+| `onSlotMissing`      | `'error' \| 'warn' \| 'ignore'`            | No       | `warn`    | Behavior when no slot marker is found in the target file. `error` throws and fails the step; `warn` logs a warning and continues with the next slot; `ignore` continues silently.                                                                    |
+
+The target file itself is always required; a missing target file fails the step regardless of these options.
+
+### Examples
+
+#### Replace mode (default)
+
+Target file before merge (`AGENTS.md`):
+
+```markdown
+# Project
+
+## Coding standards
+<!-- MD_SLOT: coding-standards -->
+PLACEHOLDER
+<!-- /MD_SLOT: coding-standards -->
+
+## Deployment
+<!-- MD_SLOT: deployment -->
+```
+
+Fragment file (`fragments/coding-standards.md`):
+
+```markdown
+- Use TypeScript
+- Run `yarn lint` before committing
+- Follow Conventional Commits for PR titles
+```
+
+After execution, `AGENTS.md` becomes:
+
+```markdown
+# Project
+
+## Coding standards
+<!-- MD_SLOT: coding-standards -->
+- Use TypeScript
+- Run `yarn lint` before committing
+- Follow Conventional Commits for PR titles
+<!-- /MD_SLOT: coding-standards -->
+
+## Deployment
+<!-- MD_SLOT: deployment -->
+```
+
+#### Append mode
+
+With `mode: append`, the existing content between paired markers is preserved and the fragment is appended after it:
+
+```yaml
+- id: merge-docs
+  action: markdown:merge
+  input:
+    path: AGENTS.md
+    mode: append
+    slots:
+      - name: deployment
+        fragmentPath: fragments/deploy.md
+```
+
+If the target previously contained:
+
+```markdown
+<!-- MD_SLOT: deployment -->
+Existing step 1
+Existing step 2
+<!-- /MD_SLOT: deployment -->
+```
+
+After append, it becomes:
+
+```markdown
+<!-- MD_SLOT: deployment -->
+Existing step 1
+Existing step 2
+New fragment content
+<!-- /MD_SLOT: deployment -->
+```
+
+#### Single-tag fallback
+
+If the target contains only an opening tag:
+
+```markdown
+<!-- MD_SLOT: optional-section -->
+```
+
+After merge, the action auto-completes it:
+
+```markdown
+<!-- MD_SLOT: optional-section -->
+<fragment content>
+<!-- /MD_SLOT: optional-section -->
+```
+
+This is convenient for templates that minimize placeholder boilerplate.
+
+#### Strict mode
+
+To fail loudly on configuration mistakes:
+
+```yaml
+- id: merge-docs
+  action: markdown:merge
+  input:
+    path: AGENTS.md
+    onFragmentMissing: error
+    onSlotMissing: error
+    slots:
+      - name: coding-standards
+        fragmentPath: fragments/coding-standards.md
+```
+
+Any missing fragment or unmatched slot marker will fail the step, surfacing typos and broken paths during template execution rather than silently producing a half-merged document.
+
+## Development
+
+### Build
+
+```console
+yarn install
+yarn build
+```
+
+### Test
+
+```console
+yarn test
+```
+
+Tests use Jest with `@swc/jest` for fast TypeScript transformation. The pure functions in `src/actions/merge.ts` (`mergeSlot`, `handleMissing`) are unit-tested directly without mocks.
+
+### Project layout
+
+```
+src/
+├── index.ts                        # Re-exports
+└── actions/
+    ├── merge.ts                    # Pure: mergeSlot, handleMissing
+    ├── merge.test.ts               # Unit tests
+    └── markdownMerge.ts            # Backstage action factory + filesystem IO
+```
+
+The core merge logic is intentionally split from the Backstage action factory so it can be unit-tested without spinning up a scaffolder context.
+
+## Releasing
+
+Publishing is automated via GitHub Actions and **npm Trusted Publishing (OIDC)** — no long-lived npm token is stored as a repository secret.
+
+### One-time setup
+
+The package must exist on npm before Trusted Publishing can be configured against it. For the very first release:
+
+1. Log in locally: `npm login`
+2. Build and publish once with provenance enabled, which both creates the package and primes the provenance chain:
+   ```console
+   yarn install
+   yarn build
+   yarn npm publish --provenance --access public
+   ```
+3. On [npmjs.com](https://www.npmjs.com/package/@shawncheng888/plugin-scaffolder-backend-module-markdown-merge) → Settings → **Trusted publishers** → Add a trusted publisher:
+   - Provider: **GitHub Actions**
+   - Repository owner: **joint-song**
+   - Repository name: **backstage-plugin-scaffolder-markdown-merge**
+   - Workflow filename: **release.yml**
+   - Environment name: **npm** (must match the `environment` block in the workflow, or leave blank if you remove it)
+
+### Cutting a release
+
+1. Bump the version locally: `yarn version --new-version <patch|minor|major>` (or edit `package.json` by hand).
+2. Commit and push: `git push && git push --tags`.
+3. On GitHub, go to **Releases** → **Draft a new release** → pick the tag (`v0.1.1` etc.) → **Publish**.
+
+The `Release` workflow runs, attaches a signed provenance attestation, and the new version appears on npm within ~30 seconds.

package/dist/actions/markdownMerge.cjs.js

@@ -0,0 +1,99 @@
+'use strict';
+
+var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
+var promises = require('node:fs/promises');
+var path = require('node:path');
+var merge = require('./merge.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var path__default = /*#__PURE__*/_interopDefaultCompat(path);
+
+const createMarkdownMergeAction = () => {
+  return pluginScaffolderNode.createTemplateAction({
+    id: "markdown:merge",
+    description: "Markdown Slot Injector - Merges multiple fragments into defined slots.",
+    schema: {
+      input: (z) => z.object({
+        path: z.string().describe("Target File Path, e.g., AGENTS.md"),
+        slots: z.array(
+          z.object({
+            name: z.string().describe("Slot Name"),
+            fragmentPath: z.string().describe("Path to Fragment File")
+          })
+        ),
+        mode: z.enum(["replace", "append"]).optional().describe(
+          'How to merge the fragment into an existing paired slot. "replace" (default) overwrites the existing content. "append" keeps the existing content and inserts the fragment after it. Has no effect for single-tag (auto-completed) markers.'
+        ),
+        onFragmentMissing: z.enum(["error", "warn", "ignore"]).optional().describe(
+          'Behavior when a fragment file is not found. Default: "warn" (log a warning and skip the slot).'
+        ),
+        onSlotMissing: z.enum(["error", "warn", "ignore"]).optional().describe(
+          'Behavior when no slot marker is found in the target file. Default: "warn" (log a warning and continue).'
+        )
+      })
+    },
+    async handler(ctx) {
+      const {
+        path: targetRelPath,
+        slots,
+        mode = "replace",
+        onFragmentMissing = "warn",
+        onSlotMissing = "warn"
+      } = ctx.input;
+      const targetPath = path__default.default.resolve(ctx.workspacePath, targetRelPath);
+      let content;
+      try {
+        content = await promises.readFile(targetPath, "utf-8");
+      } catch (e) {
+        if (e?.code === "ENOENT") {
+          throw new Error(
+            `Target file ${targetRelPath} not found.`
+          );
+        }
+        throw e;
+      }
+      for (const slot of slots) {
+        const fragPath = path__default.default.resolve(
+          ctx.workspacePath,
+          slot.fragmentPath
+        );
+        let fragmentContent;
+        try {
+          fragmentContent = await promises.readFile(fragPath, "utf-8");
+        } catch (e) {
+          if (e?.code === "ENOENT") {
+            merge.handleMissing(
+              onFragmentMissing,
+              ctx,
+              `Fragment file ${slot.fragmentPath} not found, skipping slot "${slot.name}".`
+            );
+            continue;
+          }
+          throw e;
+        }
+        const result = merge.mergeSlot(
+          content,
+          slot.name,
+          fragmentContent,
+          mode
+        );
+        content = result.content;
+        if (result.match.kind === "none") {
+          merge.handleMissing(
+            onSlotMissing,
+            ctx,
+            `Slot "${slot.name}" not found in ${targetRelPath}.`
+          );
+        }
+      }
+      await promises.writeFile(targetPath, content, "utf-8");
+      ctx.logger.info(
+        `Successfully injected fragments into ${targetRelPath}`
+      );
+    }
+  });
+};
+
+exports.createMarkdownMergeAction = createMarkdownMergeAction;
+//# sourceMappingURL=markdownMerge.cjs.js.map

package/dist/actions/markdownMerge.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdownMerge.cjs.js","sources":["../../src/actions/markdownMerge.ts"],"sourcesContent":["import { createTemplateAction } from '@backstage/plugin-scaffolder-node';\nimport { readFile, writeFile } from 'node:fs/promises';\nimport path from 'node:path';\nimport { handleMissing, mergeSlot } from './merge';\n\nexport const createMarkdownMergeAction = () => {\n    return createTemplateAction({\n        id: 'markdown:merge',\n        description:\n            'Markdown Slot Injector - Merges multiple fragments into defined slots.',\n        schema: {\n            input: z =>\n                z.object({\n                    path: z\n                        .string()\n                        .describe('Target File Path, e.g., AGENTS.md'),\n                    slots: z.array(\n                        z.object({\n                            name: z.string().describe('Slot Name'),\n                            fragmentPath: z\n                                .string()\n                                .describe('Path to Fragment File'),\n                        }),\n                    ),\n                    mode: z\n                        .enum(['replace', 'append'])\n                        .optional()\n                        .describe(\n                            'How to merge the fragment into an existing paired slot. ' +\n                                '\"replace\" (default) overwrites the existing content. ' +\n                                '\"append\" keeps the existing content and inserts the fragment after it. ' +\n                                'Has no effect for single-tag (auto-completed) markers.',\n                        ),\n                    onFragmentMissing: z\n                        .enum(['error', 'warn', 'ignore'])\n                        .optional()\n                        .describe(\n                            'Behavior when a fragment file is not found. ' +\n                                'Default: \"warn\" (log a warning and skip the slot).',\n                        ),\n                    onSlotMissing: z\n                        .enum(['error', 'warn', 'ignore'])\n                        .optional()\n                        .describe(\n                            'Behavior when no slot marker is found in the target file. ' +\n                                'Default: \"warn\" (log a warning and continue).',\n                        ),\n                }),\n        },\n        async handler(ctx) {\n            const {\n                path: targetRelPath,\n                slots,\n                mode = 'replace',\n                onFragmentMissing = 'warn',\n                onSlotMissing = 'warn',\n            } = ctx.input;\n            const targetPath = path.resolve(ctx.workspacePath, targetRelPath);\n\n            // Target file: must exist; hard error otherwise.\n            let content: string;\n            try {\n                content = await readFile(targetPath, 'utf-8');\n            } catch (e: any) {\n                if (e?.code === 'ENOENT') {\n                    throw new Error(\n                        `Target file ${targetRelPath} not found.`,\n                    );\n                }\n                throw e;\n            }\n\n            for (const slot of slots) {\n                const fragPath = path.resolve(\n                    ctx.workspacePath,\n                    slot.fragmentPath,\n                );\n\n                // Fragment file: behavior on missing is configurable.\n                let fragmentContent: string;\n                try {\n                    fragmentContent = await readFile(fragPath, 'utf-8');\n                } catch (e: any) {\n                    if (e?.code === 'ENOENT') {\n                        handleMissing(\n                            onFragmentMissing,\n                            ctx,\n                            `Fragment file ${slot.fragmentPath} not found, skipping slot \"${slot.name}\".`,\n                        );\n                        continue;\n                    }\n                    throw e;\n                }\n\n                const result = mergeSlot(\n                    content,\n                    slot.name,\n                    fragmentContent,\n                    mode,\n                );\n                content = result.content;\n\n                if (result.match.kind === 'none') {\n                    handleMissing(\n                        onSlotMissing,\n                        ctx,\n                        `Slot \"${slot.name}\" not found in ${targetRelPath}.`,\n                    );\n                }\n            }\n\n            await writeFile(targetPath, content, 'utf-8');\n            ctx.logger.info(\n                `Successfully injected fragments into ${targetRelPath}`,\n            );\n        },\n    });\n};\n"],"names":["createTemplateAction","path","readFile","handleMissing","mergeSlot","writeFile"],"mappings":";;;;;;;;;;;AAKO,MAAM,4BAA4B,MAAM;AAC3C,EAAA,OAAOA,yCAAA,CAAqB;AAAA,IACxB,EAAA,EAAI,gBAAA;AAAA,IACJ,WAAA,EACI,wEAAA;AAAA,IACJ,MAAA,EAAQ;AAAA,MACJ,KAAA,EAAO,CAAA,CAAA,KACH,CAAA,CAAE,MAAA,CAAO;AAAA,QACL,IAAA,EAAM,CAAA,CACD,MAAA,EAAO,CACP,SAAS,mCAAmC,CAAA;AAAA,QACjD,OAAO,CAAA,CAAE,KAAA;AAAA,UACL,EAAE,MAAA,CAAO;AAAA,YACL,IAAA,EAAM,CAAA,CAAE,MAAA,EAAO,CAAE,SAAS,WAAW,CAAA;AAAA,YACrC,YAAA,EAAc,CAAA,CACT,MAAA,EAAO,CACP,SAAS,uBAAuB;AAAA,WACxC;AAAA,SACL;AAAA,QACA,IAAA,EAAM,EACD,IAAA,CAAK,CAAC,WAAW,QAAQ,CAAC,CAAA,CAC1B,QAAA,EAAS,CACT,QAAA;AAAA,UACG;AAAA,SAIJ;AAAA,QACJ,iBAAA,EAAmB,CAAA,CACd,IAAA,CAAK,CAAC,OAAA,EAAS,QAAQ,QAAQ,CAAC,CAAA,CAChC,QAAA,EAAS,CACT,QAAA;AAAA,UACG;AAAA,SAEJ;AAAA,QACJ,aAAA,EAAe,CAAA,CACV,IAAA,CAAK,CAAC,OAAA,EAAS,QAAQ,QAAQ,CAAC,CAAA,CAChC,QAAA,EAAS,CACT,QAAA;AAAA,UACG;AAAA;AAEJ,OACP;AAAA,KACT;AAAA,IACA,MAAM,QAAQ,GAAA,EAAK;AACf,MAAA,MAAM;AAAA,QACF,IAAA,EAAM,aAAA;AAAA,QACN,KAAA;AAAA,QACA,IAAA,GAAO,SAAA;AAAA,QACP,iBAAA,GAAoB,MAAA;AAAA,QACpB,aAAA,GAAgB;AAAA,UAChB,GAAA,CAAI,KAAA;AACR,MAAA,MAAM,UAAA,GAAaC,qBAAA,CAAK,OAAA,CAAQ,GAAA,CAAI,eAAe,aAAa,CAAA;AAGhE,MAAA,IAAI,OAAA;AACJ,MAAA,IAAI;AACA,QAAA,OAAA,GAAU,MAAMC,iBAAA,CAAS,UAAA,EAAY,OAAO,CAAA;AAAA,MAChD,SAAS,CAAA,EAAQ;AACb,QAAA,IAAI,CAAA,EAAG,SAAS,QAAA,EAAU;AACtB,UAAA,MAAM,IAAI,KAAA;AAAA,YACN,eAAe,aAAa,CAAA,WAAA;AAAA,WAChC;AAAA,QACJ;AACA,QAAA,MAAM,CAAA;AAAA,MACV;AAEA,MAAA,KAAA,MAAW,QAAQ,KAAA,EAAO;AACtB,QAAA,MAAM,WAAWD,qBAAA,CAAK,OAAA;AAAA,UAClB,GAAA,CAAI,aAAA;AAAA,UACJ,IAAA,CAAK;AAAA,SACT;AAGA,QAAA,IAAI,eAAA;AACJ,QAAA,IAAI;AACA,UAAA,eAAA,GAAkB,MAAMC,iBAAA,CAAS,QAAA,EAAU,OAAO,CAAA;AAAA,QACtD,SAAS,CAAA,EAAQ;AACb,UAAA,IAAI,CAAA,EAAG,SAAS,QAAA,EAAU;AACtB,YAAAC,mBAAA;AAAA,cACI,iBAAA;AAAA,cACA,GAAA;AAAA,cACA,CAAA,cAAA,EAAiB,IAAA,CAAK,YAAY,CAAA,2BAAA,EAA8B,KAAK,IAAI,CAAA,EAAA;AAAA,aAC7E;AACA,YAAA;AAAA,UACJ;AACA,UAAA,MAAM,CAAA;AAAA,QACV;AAEA,QAAA,MAAM,MAAA,GAASC,eAAA;AAAA,UACX,OAAA;AAAA,UACA,IAAA,CAAK,IAAA;AAAA,UACL,eAAA;AAAA,UACA;AAAA,SACJ;AACA,QAAA,OAAA,GAAU,MAAA,CAAO,OAAA;AAEjB,QAAA,IAAI,MAAA,CAAO,KAAA,CAAM,IAAA,KAAS,MAAA,EAAQ;AAC9B,UAAAD,mBAAA;AAAA,YACI,aAAA;AAAA,YACA,GAAA;AAAA,YACA,CAAA,MAAA,EAAS,IAAA,CAAK,IAAI,CAAA,eAAA,EAAkB,aAAa,CAAA,CAAA;AAAA,WACrD;AAAA,QACJ;AAAA,MACJ;AAEA,MAAA,MAAME,kBAAA,CAAU,UAAA,EAAY,OAAA,EAAS,OAAO,CAAA;AAC5C,MAAA,GAAA,CAAI,MAAA,CAAO,IAAA;AAAA,QACP,wCAAwC,aAAa,CAAA;AAAA,OACzD;AAAA,IACJ;AAAA,GACH,CAAA;AACL;;;;"}

package/dist/actions/merge.cjs.js

@@ -0,0 +1,65 @@
+'use strict';
+
+var escapeRegExp = require('lodash/escapeRegExp');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var escapeRegExp__default = /*#__PURE__*/_interopDefaultCompat(escapeRegExp);
+
+const SLOT_TAG_NAME = "MD_SLOT";
+function mergeSlot(content, slotName, fragmentContent, mode) {
+  const safeName = escapeRegExp__default.default(slotName);
+  const openTagRe = `<!--\\s*${SLOT_TAG_NAME}\\s*:\\s*${safeName}\\s*-->`;
+  const closeTagRe = `<!--\\s*/\\s*${SLOT_TAG_NAME}\\s*:\\s*${safeName}\\s*-->`;
+  const pairPattern = new RegExp(
+    `(${openTagRe})([\\s\\S]*?)(${closeTagRe})`
+  );
+  const singlePattern = new RegExp(openTagRe);
+  if (pairPattern.test(content)) {
+    if (mode === "append") {
+      const next = content.replace(
+        pairPattern,
+        (_match, open, existing, close) => `${open}${existing.replace(
+          /\s+$/,
+          ""
+        )}
+${fragmentContent}
+${close}`
+      );
+      return { content: next, match: { kind: "pair" } };
+    }
+    return {
+      content: content.replace(
+        pairPattern,
+        `$1
+${fragmentContent}
+$3`
+      ),
+      match: { kind: "pair" }
+    };
+  }
+  if (singlePattern.test(content)) {
+    const openTagPlain = `<!-- ${SLOT_TAG_NAME}: ${slotName} -->`;
+    const closeTagPlain = `<!-- /${SLOT_TAG_NAME}: ${slotName} -->`;
+    return {
+      content: content.replace(
+        singlePattern,
+        `${openTagPlain}
+${fragmentContent}
+${closeTagPlain}`
+      ),
+      match: { kind: "single" }
+    };
+  }
+  return { content, match: { kind: "none" } };
+}
+function handleMissing(behavior, ctx, message) {
+  if (behavior === "ignore") return;
+  if (behavior === "error") throw new Error(message);
+  ctx.logger.warn(message);
+}
+
+exports.SLOT_TAG_NAME = SLOT_TAG_NAME;
+exports.handleMissing = handleMissing;
+exports.mergeSlot = mergeSlot;
+//# sourceMappingURL=merge.cjs.js.map

package/dist/actions/merge.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"merge.cjs.js","sources":["../../src/actions/merge.ts"],"sourcesContent":["import escapeRegExp from 'lodash/escapeRegExp';\n\nexport type MergeMode = 'replace' | 'append';\n\nexport type MissingBehavior = 'error' | 'warn' | 'ignore';\n\nexport type SlotMatch =\n    | { kind: 'pair' }\n    | { kind: 'single' }\n    | { kind: 'none' };\n\nexport type MergeResult = {\n    content: string;\n    match: SlotMatch;\n};\n\n/**\n * Canonical slot tag name embedded in markdown markers.\n *\n *   Paired:   <!-- MD_SLOT: NAME -->...content...<!-- /MD_SLOT: NAME -->\n *   Single:   <!-- MD_SLOT: NAME -->     (closing tag is auto-added)\n *\n * Exported so consumers and tests can refer to the same constant.\n */\nexport const SLOT_TAG_NAME = 'MD_SLOT';\n\n/**\n * Pure: merge a fragment into a slot marker in `content`.\n *\n * Pair pattern (preferred):  <!-- MD_SLOT: NAME -->...existing...<!-- /MD_SLOT: NAME -->\n * Single pattern (fallback): <!-- MD_SLOT: NAME -->  (closing tag is auto-added)\n *\n * - `mode: 'replace'` overwrites the existing content between paired markers.\n * - `mode: 'append'`  keeps the existing content and inserts the fragment after it.\n *   Has no effect for the single-tag fallback (no existing content to keep).\n *\n * No filesystem access. `slotName` is regex-escaped via lodash/escapeRegExp.\n */\nexport function mergeSlot(\n    content: string,\n    slotName: string,\n    fragmentContent: string,\n    mode: MergeMode,\n): MergeResult {\n    const safeName = escapeRegExp(slotName);\n    const openTagRe = `<!--\\\\s*${SLOT_TAG_NAME}\\\\s*:\\\\s*${safeName}\\\\s*-->`;\n    const closeTagRe = `<!--\\\\s*/\\\\s*${SLOT_TAG_NAME}\\\\s*:\\\\s*${safeName}\\\\s*-->`;\n    const pairPattern = new RegExp(\n        `(${openTagRe})([\\\\s\\\\S]*?)(${closeTagRe})`,\n    );\n    const singlePattern = new RegExp(openTagRe);\n\n    if (pairPattern.test(content)) {\n        if (mode === 'append') {\n            const next = content.replace(\n                pairPattern,\n                (_match, open: string, existing: string, close: string) =>\n                    `${open}${existing.replace(\n                        /\\s+$/,\n                        '',\n                    )}\\n${fragmentContent}\\n${close}`,\n            );\n            return { content: next, match: { kind: 'pair' } };\n        }\n        return {\n            content: content.replace(\n                pairPattern,\n                `$1\\n${fragmentContent}\\n$3`,\n            ),\n            match: { kind: 'pair' },\n        };\n    }\n\n    if (singlePattern.test(content)) {\n        const openTagPlain = `<!-- ${SLOT_TAG_NAME}: ${slotName} -->`;\n        const closeTagPlain = `<!-- /${SLOT_TAG_NAME}: ${slotName} -->`;\n        return {\n            content: content.replace(\n                singlePattern,\n                `${openTagPlain}\\n${fragmentContent}\\n${closeTagPlain}`,\n            ),\n            match: { kind: 'single' },\n        };\n    }\n\n    return { content, match: { kind: 'none' } };\n}\n\nexport type LoggerLike = {\n    warn: (msg: string) => void;\n};\n\n/**\n * Apply the configured behavior when a slot/fragment is missing.\n * - 'error'  → throws an Error with the given message\n * - 'warn'   → logs a warning and returns\n * - 'ignore' → returns silently\n */\nexport function handleMissing(\n    behavior: MissingBehavior,\n    ctx: { logger: LoggerLike },\n    message: string,\n): void {\n    if (behavior === 'ignore') return;\n    if (behavior === 'error') throw new Error(message);\n    ctx.logger.warn(message);\n}\n"],"names":["escapeRegExp"],"mappings":";;;;;;;;AAwBO,MAAM,aAAA,GAAgB;AActB,SAAS,SAAA,CACZ,OAAA,EACA,QAAA,EACA,eAAA,EACA,IAAA,EACW;AACX,EAAA,MAAM,QAAA,GAAWA,8BAAa,QAAQ,CAAA;AACtC,EAAA,MAAM,SAAA,GAAY,CAAA,QAAA,EAAW,aAAa,CAAA,SAAA,EAAY,QAAQ,CAAA,OAAA,CAAA;AAC9D,EAAA,MAAM,UAAA,GAAa,CAAA,aAAA,EAAgB,aAAa,CAAA,SAAA,EAAY,QAAQ,CAAA,OAAA,CAAA;AACpE,EAAA,MAAM,cAAc,IAAI,MAAA;AAAA,IACpB,CAAA,CAAA,EAAI,SAAS,CAAA,cAAA,EAAiB,UAAU,CAAA,CAAA;AAAA,GAC5C;AACA,EAAA,MAAM,aAAA,GAAgB,IAAI,MAAA,CAAO,SAAS,CAAA;AAE1C,EAAA,IAAI,WAAA,CAAY,IAAA,CAAK,OAAO,CAAA,EAAG;AAC3B,IAAA,IAAI,SAAS,QAAA,EAAU;AACnB,MAAA,MAAM,OAAO,OAAA,CAAQ,OAAA;AAAA,QACjB,WAAA;AAAA,QACA,CAAC,QAAQ,IAAA,EAAc,QAAA,EAAkB,UACrC,CAAA,EAAG,IAAI,GAAG,QAAA,CAAS,OAAA;AAAA,UACf,MAAA;AAAA,UACA;AAAA,SACH;AAAA,EAAK,eAAe;AAAA,EAAK,KAAK,CAAA;AAAA,OACvC;AACA,MAAA,OAAO,EAAE,OAAA,EAAS,IAAA,EAAM,OAAO,EAAE,IAAA,EAAM,QAAO,EAAE;AAAA,IACpD;AACA,IAAA,OAAO;AAAA,MACH,SAAS,OAAA,CAAQ,OAAA;AAAA,QACb,WAAA;AAAA,QACA,CAAA;AAAA,EAAO,eAAe;AAAA,EAAA;AAAA,OAC1B;AAAA,MACA,KAAA,EAAO,EAAE,IAAA,EAAM,MAAA;AAAO,KAC1B;AAAA,EACJ;AAEA,EAAA,IAAI,aAAA,CAAc,IAAA,CAAK,OAAO,CAAA,EAAG;AAC7B,IAAA,MAAM,YAAA,GAAe,CAAA,KAAA,EAAQ,aAAa,CAAA,EAAA,EAAK,QAAQ,CAAA,IAAA,CAAA;AACvD,IAAA,MAAM,aAAA,GAAgB,CAAA,MAAA,EAAS,aAAa,CAAA,EAAA,EAAK,QAAQ,CAAA,IAAA,CAAA;AACzD,IAAA,OAAO;AAAA,MACH,SAAS,OAAA,CAAQ,OAAA;AAAA,QACb,aAAA;AAAA,QACA,GAAG,YAAY;AAAA,EAAK,eAAe;AAAA,EAAK,aAAa,CAAA;AAAA,OACzD;AAAA,MACA,KAAA,EAAO,EAAE,IAAA,EAAM,QAAA;AAAS,KAC5B;AAAA,EACJ;AAEA,EAAA,OAAO,EAAE,OAAA,EAAS,KAAA,EAAO,EAAE,IAAA,EAAM,QAAO,EAAE;AAC9C;AAYO,SAAS,aAAA,CACZ,QAAA,EACA,GAAA,EACA,OAAA,EACI;AACJ,EAAA,IAAI,aAAa,QAAA,EAAU;AAC3B,EAAA,IAAI,QAAA,KAAa,OAAA,EAAS,MAAM,IAAI,MAAM,OAAO,CAAA;AACjD,EAAA,GAAA,CAAI,MAAA,CAAO,KAAK,OAAO,CAAA;AAC3B;;;;;;"}

package/dist/index.cjs.js

@@ -0,0 +1,12 @@
+'use strict';
+
+var merge = require('./actions/merge.cjs.js');
+var markdownMerge = require('./actions/markdownMerge.cjs.js');
+
+
+
+exports.SLOT_TAG_NAME = merge.SLOT_TAG_NAME;
+exports.handleMissing = merge.handleMissing;
+exports.mergeSlot = merge.mergeSlot;
+exports.createMarkdownMergeAction = markdownMerge.createMarkdownMergeAction;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,65 @@
+import * as _backstage_plugin_scaffolder_node from '@backstage/plugin-scaffolder-node';
+
+type MergeMode = 'replace' | 'append';
+type MissingBehavior = 'error' | 'warn' | 'ignore';
+type SlotMatch = {
+    kind: 'pair';
+} | {
+    kind: 'single';
+} | {
+    kind: 'none';
+};
+type MergeResult = {
+    content: string;
+    match: SlotMatch;
+};
+/**
+ * Canonical slot tag name embedded in markdown markers.
+ *
+ *   Paired:   <!-- MD_SLOT: NAME -->...content...<!-- /MD_SLOT: NAME -->
+ *   Single:   <!-- MD_SLOT: NAME -->     (closing tag is auto-added)
+ *
+ * Exported so consumers and tests can refer to the same constant.
+ */
+declare const SLOT_TAG_NAME = "MD_SLOT";
+/**
+ * Pure: merge a fragment into a slot marker in `content`.
+ *
+ * Pair pattern (preferred):  <!-- MD_SLOT: NAME -->...existing...<!-- /MD_SLOT: NAME -->
+ * Single pattern (fallback): <!-- MD_SLOT: NAME -->  (closing tag is auto-added)
+ *
+ * - `mode: 'replace'` overwrites the existing content between paired markers.
+ * - `mode: 'append'`  keeps the existing content and inserts the fragment after it.
+ *   Has no effect for the single-tag fallback (no existing content to keep).
+ *
+ * No filesystem access. `slotName` is regex-escaped via lodash/escapeRegExp.
+ */
+declare function mergeSlot(content: string, slotName: string, fragmentContent: string, mode: MergeMode): MergeResult;
+type LoggerLike = {
+    warn: (msg: string) => void;
+};
+/**
+ * Apply the configured behavior when a slot/fragment is missing.
+ * - 'error'  → throws an Error with the given message
+ * - 'warn'   → logs a warning and returns
+ * - 'ignore' → returns silently
+ */
+declare function handleMissing(behavior: MissingBehavior, ctx: {
+    logger: LoggerLike;
+}, message: string): void;
+
+declare const createMarkdownMergeAction: () => _backstage_plugin_scaffolder_node.TemplateAction<{
+    path: string;
+    slots: {
+        name: string;
+        fragmentPath: string;
+    }[];
+    mode?: "replace" | "append" | undefined;
+    onFragmentMissing?: "error" | "warn" | "ignore" | undefined;
+    onSlotMissing?: "error" | "warn" | "ignore" | undefined;
+}, {
+    [x: string]: any;
+}, "v2">;
+
+export { SLOT_TAG_NAME, createMarkdownMergeAction, handleMissing, mergeSlot };
+export type { LoggerLike, MergeMode, MergeResult, MissingBehavior, SlotMatch };

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "@shawncheng888/plugin-scaffolder-backend-module-markdown-merge",
+  "version": "0.1.0",
+  "description": "Backstage scaffolder action that merges Markdown fragments into named slot markers in a target file.",
+  "license": "Apache-2.0",
+  "packageManager": "yarn@4.12.0",
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "keywords": [
+    "backstage",
+    "scaffolder",
+    "scaffolder-action",
+    "markdown",
+    "scaffolder-backend-module"
+  ],
+  "author": {
+    "name": "Shawn Cheng",
+    "url": "https://github.com/joint-song"
+  },
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "homepage": "https://github.com/joint-song/plugin-scaffolder-backend-module-markdown-merge#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/joint-song/plugin-scaffolder-backend-module-markdown-merge.git"
+  },
+  "bugs": {
+    "url": "https://github.com/joint-song/plugin-scaffolder-backend-module-markdown-merge/issues"
+  },
+  "backstage": {
+    "role": "backend-plugin-module",
+    "pluginId": "scaffolder",
+    "pluginPackage": "@backstage/plugin-scaffolder-backend"
+  },
+  "scripts": {
+    "build": "yarn tsc && backstage-cli package build",
+    "tsc": "tsc -p tsconfig.build.json",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack",
+    "lint": "backstage-cli package lint",
+    "test": "jest --passWithNoTests"
+  },
+  "dependencies": {
+    "@backstage/cli": "^0.36.2",
+    "@backstage/plugin-scaffolder-node": "^0.13.3",
+    "lodash": "^4.17.21",
+    "zod": "4.4.3"
+  },
+  "devDependencies": {
+    "@swc/jest": "^0.2.0",
+    "@types/jest": "^30.0.0",
+    "@types/lodash": "^4",
+    "@types/node": "^25.9.2",
+    "jest": "^30.0.0",
+    "jest-environment-node": "^30.0.0",
+    "prettier": "^3.4.0",
+    "typescript": "^6.0.3"
+  },
+  "typesVersions": {
+    "*": {
+      "package.json": [
+        "package.json"
+      ]
+    }
+  }
+}