@viglet/create-shio-app 2026.3.2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 discussing and improving the Work, but
+      excluding 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, patent, trademark, and
+          attribution 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 reasonable and customary use in 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 Additional Liability. 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 additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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,98 @@
+# @viglet/create-shio-app
+
+[![npm](https://img.shields.io/npm/v/@viglet/create-shio-app?logo=npm)](https://www.npmjs.com/package/@viglet/create-shio-app)
+[![License](https://img.shields.io/npm/l/@viglet/create-shio-app)](https://github.com/openviglet/shio/blob/HEAD/LICENSE)
+[![Website](https://img.shields.io/badge/shio.viglet.org-0ea5e9?logo=googlechrome&logoColor=white)](https://shio.viglet.org/)
+
+Scaffold a **Next.js (App Router)** site wired to the Content Delivery API of
+**[Viglet Shio](https://shio.viglet.org/)**, the open source **headless CMS built
+for coding agents**.
+
+The flagship "JS dev, zero Java" starter — a JavaScript/TypeScript developer
+builds a full site against Shio without ever touching the Java backend.
+
+## Usage
+
+Interactive:
+
+```bash
+npm create @viglet/shio-app@latest
+# or
+npx @viglet/create-shio-app
+```
+
+Non-interactive (CI / scripted):
+
+```bash
+npx @viglet/create-shio-app my-site \
+  --url https://cms.example.com \
+  --site <site-id> \
+  --token <cda-token> \
+  --yes
+```
+
+| Flag | Maps to |
+|---|---|
+| `--url` | `SHIO_URL` |
+| `--site` | `SHIO_SITE_ID` |
+| `--token` | `SHIO_CDA_TOKEN` |
+| `--yes`, `-y` | skip prompts (use defaults / flags) |
+
+## What you get
+
+```
+my-site/
+  app/
+    layout.tsx
+    page.tsx              # lists published posts (shio.query)
+    [...slug]/page.tsx    # CDA path → post (shio.getPostByUrl) + SSG/ISR
+  lib/shio.ts             # shared @viglet/shio-client instance
+  next.config.mjs
+  tsconfig.json
+  .env.local              # filled from your answers/flags
+  .env.example
+  .gitignore
+  README.md
+```
+
+The generated project depends on [`@viglet/shio-client`](https://www.npmjs.com/package/@viglet/shio-client)
+and talks only to the stable CDA contract (`/api/v2/cda/**`).
+
+## Next steps
+
+```bash
+npx @viglet/shio types     # generate a .d.ts so post.attrs.* autocompletes
+npx @viglet/shio dev       # types + dev server + model watch
+npx @viglet/shio pull --content   # the whole site as Markdown on disk
+```
+
+Driving the CMS from [Claude Code](https://claude.com/claude-code)? Add the MCP
+server and the agent gets the same surface:
+
+```bash
+claude mcp add shio -- npx -y @viglet/shio mcp
+```
+
+## Develop this generator
+
+```bash
+npm test   # node:test — scaffolds into a temp dir and asserts the output
+```
+
+## Related packages
+
+| Package | For |
+|---|---|
+| [`@viglet/shio`](https://www.npmjs.com/package/@viglet/shio) | The Shio CLI — content as files, type generation, and the MCP bridge |
+| [`@viglet/shio-client`](https://www.npmjs.com/package/@viglet/shio-client) | Zero-dependency Content Delivery API client (what the scaffold uses) |
+| [`@viglet/shio-react-sdk`](https://www.npmjs.com/package/@viglet/shio-react-sdk) | React hooks and render components |
+| [`@viglet/shio-sections`](https://www.npmjs.com/package/@viglet/shio-sections) | The page-section vocabulary |
+| [`@viglet/shio-model`](https://www.npmjs.com/package/@viglet/shio-model) | Author the content model as typed code |
+| [`@viglet/shio-editor-cors`](https://www.npmjs.com/package/@viglet/shio-editor-cors) | Inline visual editing with the Universal Editor |
+
+## License
+
+Apache-2.0 — [Viglet Shio](https://shio.viglet.org/) ·
+[github.com/openviglet/shio](https://github.com/openviglet/shio) ·
+[docs.viglet.org/shio](https://docs.viglet.org/shio/) ·
+part of the [Viglet](https://www.viglet.org) open source family.

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@viglet/create-shio-app",
+  "version": "2026.3.2",
+  "description": "Scaffold a Next.js (App Router) site wired to the Shio CMS Content Delivery API. The flagship 'JS dev, zero Java' starter.",
+  "homepage": "https://shio.viglet.org/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/openviglet/shio.git",
+    "directory": "create-shio-app"
+  },
+  "bugs": {
+    "url": "https://github.com/openviglet/shio/issues"
+  },
+  "type": "module",
+  "bin": {
+    "create-shio-app": "src/index.mjs"
+  },
+  "exports": {
+    "./scaffold": "./src/scaffold.mjs",
+    "./published": "./src/published.mjs",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "src",
+    "template"
+  ],
+  "keywords": [
+    "shio",
+    "viglet",
+    "cms",
+    "headless-cms",
+    "content-management-system",
+    "agent",
+    "ai",
+    "mcp",
+    "model-context-protocol",
+    "claude-code",
+    "nextjs",
+    "starter",
+    "create",
+    "scaffold",
+    "react",
+    "headless"
+  ],
+  "engines": {
+    "node": ">=26",
+    "npm": ">=11"
+  },
+  "author": {
+    "name": "Viglet Team",
+    "url": "https://www.viglet.org"
+  },
+  "license": "Apache-2.0",
+  "scripts": {
+    "emit": "node src/emit.mjs",
+    "test": "node --test \"test/*.test.mjs\"",
+    "emit:check": "node scripts/emit-guard.mjs"
+  }
+}

package/src/emit-guard.mjs

@@ -0,0 +1,98 @@
+/**
+ * What a release's re-emit is allowed to change (SH218).
+ *
+ * <h2>Why a release needs a guard the suite already provides</h2>
+ *
+ * <p>`publish-js-sdk.yml` bumps every publishable package, re-runs `emit` and commits the result.
+ * That step exists because without it the generated trees keep the old dependency range and
+ * `emit.test.mjs` turns the **next** push red — a release's side effect reported against whoever
+ * pushed after it, where the obvious reading of a red build ("what did I break?") is wrong.</p>
+ *
+ * <p>The drift test cannot do this job. It runs on a push and answers "the tree matches its
+ * source"; the release runs `emit` and then *commits whatever came out*, so the one thing nobody
+ * checks is whether that output was the output anybody expected. A job that regenerates content
+ * into `shio-app/src/main/resources/` and commits it unread is a job that can land anything.</p>
+ *
+ * <h2>The rule, and why it is about files rather than about lines</h2>
+ *
+ * <p>A release changes <b>versions</b>. It does not add or remove files: a package that gains or
+ * loses one during a release is either an overlay somebody edited without running `emit`, or a
+ * generator that broke — and in both cases the release is the worst possible place for it to land,
+ * because a release commit is the one nobody reviews.</p>
+ *
+ * <p>So: <b>an addition or a deletion under the generated trees fails the release; a modification
+ * is expected and reported.</b> Deliberately not "every changed line must be a semver range" —
+ * that reads the diff's *text*, and a rule that has to parse a diff to decide whether a release is
+ * sound is a rule that will one day be wrong about a quoted string. The file-level question is the
+ * one with a clean answer, and it is the one that catches the case that matters.</p>
+ *
+ * @module
+ */
+
+/** Where the generated trees live, relative to the repository root. */
+export const GENERATED = "shio-app/src/main/resources/blueprints/";
+
+/**
+ * Splits `git status --porcelain` into what a release may and may not have produced.
+ *
+ * <p>Porcelain v1, whose first two columns are the index and worktree status. Only paths under
+ * {@link GENERATED} are considered: the same command reports the bumped `package.json` files,
+ * which are exactly what the release is *for*.</p>
+ *
+ * @param {string} porcelain raw `git status --porcelain` output
+ */
+export function classify(porcelain) {
+  const added = [];
+  const deleted = [];
+  const modified = [];
+  for (const line of String(porcelain ?? "").split("\n")) {
+    if (line.length < 4) continue;
+    const status = line.slice(0, 2);
+    // A rename is reported as `R  old -> new`; the arrow form would otherwise be read as one
+    // path with an arrow in it, and a renamed generated file is exactly the surprise this catches.
+    const path = line.slice(3).replace(/^"|"$/g, "").split(" -> ").pop();
+    if (!path.startsWith(GENERATED)) continue;
+    if (status.includes("?") || status.includes("A") || status.includes("R")) added.push(path);
+    else if (status.includes("D")) deleted.push(path);
+    else modified.push(path);
+  }
+  return {
+    added: added.sort(),
+    deleted: deleted.sort(),
+    modified: modified.sort(),
+    surprising: added.length + deleted.length,
+  };
+}
+
+/**
+ * What the release prints, and the exit code it should carry.
+ *
+ * <p>The modified list is printed on success too. A release that says nothing about what it
+ * regenerated is one whose commit nobody can read afterwards, and "it changed six files" is the
+ * cheapest possible proof that the step ran at all (P9).</p>
+ */
+export function describe(result) {
+  const lines = [];
+  if (result.surprising === 0) {
+    lines.push(`emit: ${result.modified.length} generated file(s) changed, all modifications.`);
+    for (const path of result.modified) lines.push(`  M ${path}`);
+    return { ok: true, text: `${lines.join("\n")}\n` };
+  }
+
+  lines.push(
+    `emit: the release regenerated ${result.surprising} file(s) it was not supposed to.`,
+    "",
+    "A release changes versions. It does not add or remove generated files — one that does is",
+    "either an overlay somebody edited without running `emit`, or a generator that broke. Either",
+    "way a release commit is the worst place for it to land, because it is the one nobody reads.",
+    "",
+  );
+  for (const path of result.added) lines.push(`  + ${path}`);
+  for (const path of result.deleted) lines.push(`  - ${path}`);
+  lines.push(
+    "",
+    "Fix: run `pnpm -C create-shio-app run emit` on a branch, review what it produces, and commit",
+    "that as its own change. Then re-run the release.",
+  );
+  return { ok: false, text: `${lines.join("\n")}\n` };
+}