create-contentisland 0.0.1 → 0.0.3

package/README.md

@@ -0,0 +1,63 @@
+# create-contentisland
+
+## Overview
+
+The Content Island CLI allows you to quickly bootstrap codebase
+solutions and connect them to your Content Island projects.
+
+Currently, the following template is available:
+
+- **Starlight Template**
+
+> Additional templates will be added soon.
+
+## Using the Starlight Template
+
+### Prerequisites
+
+- A [Content Island](https://contentisland.net/) account (free plans are available).
+- A new [Content Island](https://contentisland.net/) project created with the **Starlight
+  template**.
+
+### Step 1 --- Create a Starlight project
+
+Run the following command to create a new [Starlight](https://starlight.astro.build/) project and install
+its dependencies:
+
+```bash
+npm create astro@latest -- --template starlight
+```
+
+### Step 2 --- Connect your Content Island project
+
+Once your Starlight project has been created, connect it to your Content
+Island project:
+
+```bash
+npm create contentisland@latest
+```
+
+When prompted, provide your **Content Island Project API token**. You
+can copy this token from the **General** tab of your Content Island
+project settings.
+
+### Step 3 --- Sync your content
+
+The CLI will automatically replace the contents of the `content/docs`
+folder with the content from your Content Island project.
+
+You can then run your project locally:
+
+```bash
+npm run dev
+```
+
+### Step 4 --- Update content
+
+Manage your content directly in Content Island---add, edit, or delete
+folders and pages. To update your local Starlight project with the
+latest content, run:
+
+```bash
+npm create contentisland@latest update
+```

package/dist/index.js

@@ -305,7 +305,7 @@ const x = ".content-island", G = "config.json", N = ".gitignore", M = {
     }
   }
   return i;
-}, E = async (e) => {
+}, v = async (e) => {
   const { filePath: n, property: t, startSymbol: a, endSymbol: s } = e, i = await l.readFile(n, "utf-8");
   let r = a;
   a === "[" && (r = "\\["), a === "{" && (r = "\\{"), a === "(" && (r = "\\(");
@@ -317,8 +317,8 @@ const x = ".content-island", G = "config.json", N = ".gitignore", M = {
 }, re = (e) => JSON.parse(
   e.replace(/'/g, '"').replace(/(\w+):/g, '"$1":').replace(/,\s*}/g, "}").replace(/,\s*]/g, "]")
 ), q = (e) => e.replace(/"/g, "'").replace(/'(\w+)':/g, "$1:"), ce = async (e, n, t, a) => {
-  let s = await E(t);
-  if (s || (s = await E(a)), !s)
+  let s = await v(t);
+  if (s || (s = await v(a)), !s)
     throw new Error(
       `Could not find property '${t.property}' or fallback property '${a.property}' in file ${t.filePath}`
     );
@@ -337,13 +337,13 @@ const x = ".content-island", G = "config.json", N = ".gitignore", M = {
   index: e.index,
   folders: T(e.folders, (t) => le(t, n))
 });
-let v = null;
+let E = null;
 const de = (e) => {
-  v = oe({ accessToken: e });
+  E = oe({ accessToken: e });
 }, F = () => {
-  if (!v)
+  if (!E)
     throw new Error("API client not initialized. Call initializeClient first.");
-  return v;
+  return E;
 }, ue = async () => await F().getProject(), O = async (e) => {
   const n = F(), t = await n.getContent({
     contentType: "Root",
@@ -367,8 +367,10 @@ const de = (e) => {
     return await F().getContent({
       contentType: "Meta"
     });
-  } catch {
-    o.error("The requested template is not of type StarLight, so the meta field could not be found."), process.exit(1);
+  } catch (e) {
+    e.message.includes("401") ? o.error(
+      "The Content Island API token is missing or malformed. Verify that you've copied the complete token and that you have sufficient permissions."
+    ) : o.error("The requested template is not of type StarLight, so the meta field could not be found."), process.exit(1);
   }
 }, U = "astro.config.mjs", P = () => g.join(process.cwd(), "src", "content", "docs"), L = () => g.join(process.cwd(), U), me = () => {
   const e = [], n = L();
@@ -420,7 +422,7 @@ const de = (e) => {
     t
   ) : t;
 }, D = async (e, n, t) => {
-  const a = L(), s = await E({
+  const a = L(), s = await v({
     filePath: a,
     property: n,
     startSymbol: h[n]?.start,
@@ -450,7 +452,7 @@ const de = (e) => {
   await l.writeFile(a, i, "utf-8");
 }, he = async (e, n, t) => {
   try {
-    let a = await E({
+    let a = await v({
       filePath: L(),
       property: "sidebar",
       startSymbol: h.sidebar.start,
@@ -480,20 +482,20 @@ title: "${a}"
 `;
   return o.warning(`Missing frontmatter in ${t}`), o.info(`Added default title: "${a}"`), o.warning("Please update the content in Content Island 🏝️  to include proper frontmatter"), o.newLine(), s + e;
 }
-const I = async (e, n) => {
+const $ = async (e, n) => {
   const t = P(), a = g.join(t, e), s = Ce(n, e, g.relative(process.cwd(), a)), i = g.dirname(a);
   w(i) || await l.mkdir(i, { recursive: !0 }), await l.writeFile(a, s, "utf-8");
 }, Se = async (e, n) => {
   try {
-    await I(e.index.filename, e.index.content);
+    await $(e.index.filename, e.index.content);
     for (const t of e.folders)
       for (const a of t.pages)
-        await I(g.join(t.name, a.filename), a.content);
+        await $(g.join(t.name, a.filename), a.content);
     for (const t of n) {
-      await I(g.join(t.language, t.index.filename), t.index.content);
+      await $(g.join(t.language, t.index.filename), t.index.content);
       for (const a of t.folders)
         for (const s of a.pages)
-          await I(g.join(t.language, a.name, s.filename), s.content);
+          await $(g.join(t.language, a.name, s.filename), s.content);
     }
   } catch (t) {
     o.error(`Error updating docs content: ${t.message}`), process.exit(1);
@@ -521,7 +523,7 @@ const I = async (e, n) => {
     initial: 0
   });
   return a.language || (o.error("Language selection is required to continue."), process.exit(1)), t !== a.language && (await b({ languageCode: a.language }), o.config(`Saving default language '${a.language}' to config`)), a.language;
-}, $e = () => {
+}, Ie = () => {
   o.detected(`
   ⭐ ✨ STARLIGHT PROJECT DETECTED ✨ ⭐
 
@@ -533,41 +535,41 @@ const I = async (e, n) => {
     ✨  ⭐     ✨  ⭐     ✨
      ⭐     ✨      ⭐     ✨
   `), o.success("All good! Starlight ⭐ project detected successfully."), o.loading("Launching process..."), o.newLine();
-}, Ie = (e) => {
+}, $e = (e) => {
   o.newLine(), o.error("Starlight ⭐ project not found!"), o.newLine(), o.error("Missing required items:"), e.forEach((n) => {
     o.error(`  • ${n}`);
   }), o.newLine(), o.error("Please make sure you are in the root directory of a Starlight ⭐ project."), o.warning("A Starlight ⭐ project should have:"), o.warning("  • astro.config.mjs file"), o.warning("  • src/content/docs directory"), o.newLine();
-}, Y = (e) => {
+}, V = (e) => {
   const n = e.reduce(
     (t, a) => ({ ...t, ...a }),
     {}
   );
   return Object.keys(n).length > 0 ? n : void 0;
-}, H = (e) => e.filename.replace(/\.(mdx?|md)$/, ""), _ = (e) => e.label ? e.label.trim() : H(e), Ee = (e, n) => {
-  const t = H(e), a = n.trim().toLowerCase();
+}, Y = (e) => e.filename.replace(/\.(mdx?|md)$/, ""), _ = (e) => e.label ? e.label.trim() : Y(e), ve = (e, n) => {
+  const t = Y(e), a = n.trim().toLowerCase();
   return t.toLocaleLowerCase() === "index" ? a : `${a}/${t}`;
 }, Te = (e, n, t) => {
   e.filename.replace(/\.(mdx?|md)$/, "");
   const a = t.filter((s) => s.id === e.id).map((s) => ({ [s.language]: _(s) }));
   return {
     label: _(e),
-    slug: Ee(e, n),
-    translations: Y(a)
+    slug: ve(e, n),
+    translations: V(a)
   };
-}, R = (e) => e.label ? e.label.trim() : e.name, ve = (e, n) => {
+}, R = (e) => e.label ? e.label.trim() : e.name, Ee = (e, n) => {
   const t = n.flatMap((i) => i.folders ?? []).filter((i) => i.id === e.id), a = t.flatMap((i) => i.pages ?? []).filter((i) => e.pages.some((r) => r.id === i.id)), s = t.map((i) => ({ [i.language]: R(i) }));
   return {
     label: R(e),
-    translations: Y(s),
+    translations: V(s),
     items: T(e.pages, (i) => Te(i, e.name, a))
   };
-}, xe = (e, n) => T(e.folders, (t) => ve(t, n)), Ae = () => ({
+}, xe = (e, n) => T(e.folders, (t) => Ee(t, n)), Ae = () => ({
   id: "starlight",
   syncProject: async (e) => {
     const { accessToken: n, askIfMultipleLanguages: t } = e;
     o.step("Checking for Starlight ⭐ project...");
     const { valid: a, missingItems: s } = me();
-    a || (Ie(s), process.exit(1)), $e(), o.connecting("Initializing Content Island 🏝️   client..."), de(n);
+    a || ($e(s), process.exit(1)), Ie(), o.connecting("Initializing Content Island 🏝️   client..."), de(n);
     const i = await fe();
     o.success(`Connected to project using template: ${i.template} (version: ${i.version})`), i.template !== "starlight" && (o.warning(
       "The project you are trying to sync is not using the Starlight ⭐ template. Please make sure you are using the correct template."
@@ -590,14 +592,14 @@ const I = async (e, n) => {
     const te = xe(p, d);
     await he(te, m, y), o.config("Sidebar configuration updated in astro.config.mjs");
   }
-}), V = {
+}), H = {
   starlight: Ae
 }, je = (e) => {
-  const n = V[e];
+  const n = H[e];
   if (!n)
     throw new Error(`Template "${e}" not found`);
   return n();
-}, Fe = () => Object.keys(V), Pe = async (e, n) => {
+}, Fe = () => Object.keys(H), Pe = async (e, n) => {
   let t;
   return t || (t = (await j())?.templateID), t && n && (o.info(`Existing template found: ${t}`), (await S({
     type: "confirm",
@@ -696,10 +698,10 @@ const I = async (e, n) => {
   } catch (e) {
     o.newLine(), o.error("Error during Content Island integration:"), o.error(e instanceof Error ? e.message : String(e)), process.exit(1);
   }
-}, _e = "0.0.1", Re = {
+}, _e = "0.0.3", Re = {
   version: _e
-}, $ = ae("create-contentisland");
-$.command("", "Initialize and validate a project").example("npm create contentisland").example("npm create contentisland --token <token>").example("npm create contentisland --token <token> --template starlight").option(
+}, I = ae("create-contentisland");
+I.command("", "Initialize and validate a project").example("npm create contentisland").example("npm create contentisland --token <token>").example("npm create contentisland --token <token> --template starlight").option(
   "--token <token>",
   "Your Content Island token (you can also set the CONTENT_ISLAND_ACCESS_TOKEN environment variable)",
   {
@@ -708,9 +710,9 @@ $.command("", "Initialize and validate a project").example("npm create contentis
 ).option("--template <template>", "The template to use: starlight.").action(async (e) => {
   await Oe(e);
 });
-$.command("update", "Update content from Content Island 🏝️  (preserves existing token)").example("npm create contentisland update").action(async () => {
+I.command("update", "Update content from Content Island 🏝️  (preserves existing token)").example("npm create contentisland update").action(async () => {
   await De();
 });
-$.help();
-$.version(Re.version);
-$.parse();
+I.help();
+I.version(Re.version);
+I.parse();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-contentisland",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Content Island - Starlight CLI",
   "private": false,
   "sideEffects": false,
@@ -27,7 +27,7 @@
     "test:watch": "vitest -c ./config/test/config.ts"
   },
   "dependencies": {
-    "@content-island/api-client": "0.11.0",
+    "@content-island/api-client": "0.12.0",
     "cac": "6.7.14",
     "prompts": "2.4.2"
   },