create-tina-app 1.0.3 → 1.0.5

package/LICENSE

@@ -1,12 +1,4 @@
-Copyright (c) 2023-present Forestry.io Holdings Inc. 
-
-Portions of the TinaCMS software are licensed as follows:
-
-* All software that resides under the "packages/@tinacms/datalayer/" and the "packages/@tinacms/graphql/" directories (the "Tina Data Layer"), is licensed under the license defined in "packages/@tinacms/datalayer/LICENSE".
-
-* All software outside of the above-mentioned directories is available under the "Apache 2.0" license as set forth below.
-
-Apache License
+                                Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/
 

package/README.md

@@ -1,3 +1,11 @@
 # Create Tina App
 
-> TODO 
+Create Tina App is a powerful command-line interface (CLI) tool designed to kickstart your Tina project. It sets up a new Tina project with a simple command, saving you the hassle of manual configuration. This tool provides a solid foundation, allowing you to focus on building your unique content management system. With Create Tina App, starting a new Tina project has never been easier.
+
+## Getting Started
+
+To get started, you need to first build the code - see [contributing](https://github.com/tinacms/tinacms/blob/main/CONTRIBUTING.md).
+
+1. run `pnpm link create-tina-app`
+1. Test your changes by running `npx create-tina-app`
+1. Run `pnpm unlink` when done to unlink the local build

package/dist/examples.d.ts

@@ -3,6 +3,7 @@
 */
 declare type BaseExample = {
     title: string;
+    description?: string;
     value: string;
 };
 export declare type InternalExample = BaseExample & {

package/dist/index.js

@@ -1,61 +1,46 @@
 var __create = Object.create;
 var __defProp = Object.defineProperty;
-var __defProps = Object.defineProperties;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
 var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getOwnPropSymbols = Object.getOwnPropertySymbols;
 var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __propIsEnum = Object.prototype.propertyIsEnumerable;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues = (a, b) => {
-  for (var prop in b || (b = {}))
-    if (__hasOwnProp.call(b, prop))
-      __defNormalProp(a, prop, b[prop]);
-  if (__getOwnPropSymbols)
-    for (var prop of __getOwnPropSymbols(b)) {
-      if (__propIsEnum.call(b, prop))
-        __defNormalProp(a, prop, b[prop]);
-    }
-  return a;
-};
-var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
-var __markAsModule = (target) => __defProp(target, "__esModule", { value: true });
 var __export = (target, all) => {
-  __markAsModule(target);
   for (var name2 in all)
     __defProp(target, name2, { get: all[name2], enumerable: true });
 };
-var __reExport = (target, module2, desc) => {
-  if (module2 && typeof module2 === "object" || typeof module2 === "function") {
-    for (let key of __getOwnPropNames(module2))
-      if (!__hasOwnProp.call(target, key) && key !== "default")
-        __defProp(target, key, { get: () => module2[key], enumerable: !(desc = __getOwnPropDesc(module2, key)) || desc.enumerable });
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
   }
-  return target;
-};
-var __toModule = (module2) => {
-  return __reExport(__markAsModule(__defProp(module2 != null ? __create(__getProtoOf(module2)) : {}, "default", module2 && module2.__esModule && "default" in module2 ? { get: () => module2.default, enumerable: true } : { value: module2, enumerable: true })), module2);
+  return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
-__export(exports, {
+var src_exports = {};
+__export(src_exports, {
   run: () => run
 });
-var import_metrics = __toModule(require("@tinacms/metrics"));
-var import_commander = __toModule(require("commander"));
-var import_prompts = __toModule(require("prompts"));
-var import_path4 = __toModule(require("path"));
+module.exports = __toCommonJS(src_exports);
+var import_metrics = require("@tinacms/metrics");
+var import_commander = require("commander");
+var import_prompts = __toESM(require("prompts"));
+var import_path4 = __toESM(require("path"));
 
 // package.json
 var name = "create-tina-app";
-var version = "1.0.3";
+var version = "1.0.5";
 
 // src/util/fileUtil.ts
-var import_fs_extra = __toModule(require("fs-extra"));
-var import_path = __toModule(require("path"));
-var import_chalk = __toModule(require("chalk"));
+var import_fs_extra = __toESM(require("fs-extra"));
+var import_path = __toESM(require("path"));
+var import_chalk = __toESM(require("chalk"));
 async function isWriteable(directory) {
   try {
     await import_fs_extra.default.promises.access(directory, (import_fs_extra.default.constants || import_fs_extra.default).W_OK);
@@ -90,7 +75,9 @@ function isFolderEmpty(root, name2) {
   ];
   const conflicts = import_fs_extra.default.readdirSync(root).filter((file) => !validFiles.includes(file)).filter((file) => !/\.iml$/.test(file));
   if (conflicts.length > 0) {
-    console.log(`The directory ${import_chalk.default.green(name2)} contains files that could conflict:`);
+    console.log(
+      `The directory ${import_chalk.default.green(name2)} contains files that could conflict:`
+    );
     console.log();
     for (const file of conflicts) {
       try {
@@ -105,7 +92,9 @@ function isFolderEmpty(root, name2) {
       }
     }
     console.log();
-    console.log("Either try using a new directory name, or remove the files listed above.");
+    console.log(
+      "Either try using a new directory name, or remove the files listed above."
+    );
     console.log();
     return false;
   }
@@ -113,14 +102,14 @@ function isFolderEmpty(root, name2) {
 }
 
 // src/util/install.ts
-var import_chalk2 = __toModule(require("chalk"));
-var import_cross_spawn = __toModule(require("cross-spawn"));
+var import_chalk2 = __toESM(require("chalk"));
+var import_cross_spawn = __toESM(require("cross-spawn"));
 function install(root, dependencies, { useYarn, isOnline, devDependencies }) {
   const npmFlags = [];
   const yarnFlags = [];
   return new Promise((resolve, reject) => {
     let args;
-    let command = useYarn ? "yarnpkg" : "npm";
+    const command = useYarn ? "yarnpkg" : "npm";
     if (dependencies && dependencies.length) {
       if (useYarn) {
         args = ["add", "--exact"];
@@ -158,7 +147,7 @@ function install(root, dependencies, { useYarn, isOnline, devDependencies }) {
     }
     const child = (0, import_cross_spawn.default)(command, args, {
       stdio: "inherit",
-      env: __spreadProps(__spreadValues({}, process.env), { ADBLOCK: "1", DISABLE_OPENCOLLECTIVE: "1" })
+      env: { ...process.env, ADBLOCK: "1", DISABLE_OPENCOLLECTIVE: "1" }
     });
     child.on("close", (code) => {
       if (code !== 0) {
@@ -171,14 +160,14 @@ function install(root, dependencies, { useYarn, isOnline, devDependencies }) {
 }
 
 // src/index.ts
-var import_chalk5 = __toModule(require("chalk"));
+var import_chalk5 = __toESM(require("chalk"));
 
 // src/util/git.ts
-var import_child_process = __toModule(require("child_process"));
-var import_path2 = __toModule(require("path"));
-var import_rimraf = __toModule(require("rimraf"));
-var import_fs_extra2 = __toModule(require("fs-extra"));
-var import_chalk3 = __toModule(require("chalk"));
+var import_child_process = require("child_process");
+var import_path2 = __toESM(require("path"));
+var import_rimraf = __toESM(require("rimraf"));
+var import_fs_extra2 = __toESM(require("fs-extra"));
+var import_chalk3 = __toESM(require("chalk"));
 function isInGitRepository() {
   try {
     (0, import_child_process.execSync)("git rev-parse --is-inside-work-tree", { stdio: "ignore" });
@@ -203,13 +192,20 @@ function tryGitInit(root) {
       return false;
     }
     if (!import_fs_extra2.default.existsSync(".gitignore")) {
-      console.warn(import_chalk3.default.yellow("There is no .gitignore file in this repository, creating one..."));
-      import_fs_extra2.default.writeFileSync(".gitignore", `node_modules
+      console.warn(
+        import_chalk3.default.yellow(
+          "There is no .gitignore file in this repository, creating one..."
+        )
+      );
+      import_fs_extra2.default.writeFileSync(
+        ".gitignore",
+        `node_modules
 .yarn/*
 .DS_Store
 .cache
 .next/
-`);
+`
+      );
     }
     (0, import_child_process.execSync)("git init", { stdio: "ignore" });
     didInit = true;
@@ -231,19 +227,21 @@ function tryGitInit(root) {
 }
 
 // src/index.ts
-var import_process = __toModule(require("process"));
+var import_process = require("process");
 
 // src/util/examples.ts
-var import_got = __toModule(require("got"));
-var import_stream = __toModule(require("stream"));
-var import_util = __toModule(require("util"));
-var import_tar = __toModule(require("tar"));
+var import_got = __toESM(require("got"));
+var import_stream = require("stream");
+var import_util = require("util");
+var import_tar = __toESM(require("tar"));
 var pipeline = (0, import_util.promisify)(import_stream.Stream.pipeline);
 async function getRepoInfo(url, examplePath) {
   const [, username, name2, t, _branch, ...file] = url.pathname.split("/");
   const filePath = examplePath ? examplePath.replace(/^\//, "") : file.join("/");
   if (t === void 0) {
-    const infoResponse = await (0, import_got.default)(`https://api.github.com/repos/${username}/${name2}`).catch((e) => e);
+    const infoResponse = await (0, import_got.default)(
+      `https://api.github.com/repos/${username}/${name2}`
+    ).catch((e) => e);
     if (infoResponse.statusCode !== 200) {
       return;
     }
@@ -256,37 +254,56 @@ async function getRepoInfo(url, examplePath) {
   }
 }
 function downloadAndExtractRepo(root, { username, name: name2, branch, filePath }) {
-  return pipeline(import_got.default.stream(`https://codeload.github.com/${username}/${name2}/tar.gz/${branch}`), import_tar.default.extract({ cwd: root, strip: filePath ? filePath.split("/").length + 1 : 1 }, [`${name2}-${branch}${filePath ? `/${filePath}` : ""}`]));
+  return pipeline(
+    import_got.default.stream(
+      `https://codeload.github.com/${username}/${name2}/tar.gz/${branch}`
+    ),
+    import_tar.default.extract(
+      { cwd: root, strip: filePath ? filePath.split("/").length + 1 : 1 },
+      [`${name2}-${branch}${filePath ? `/${filePath}` : ""}`]
+    )
+  );
 }
 
 // src/examples.ts
-var import_chalk4 = __toModule(require("chalk"));
-var import_fs_extra3 = __toModule(require("fs-extra"));
-var import_path3 = __toModule(require("path"));
+var import_chalk4 = __toESM(require("chalk"));
+var import_fs_extra3 = require("fs-extra");
+var import_path3 = __toESM(require("path"));
 var EXAMPLES = [
   {
     title: "Bare bones starter",
+    description: "Stripped down to essentials, this starter is the canvas for pure, unadulterated code creativity.",
     value: "basic",
     isInternal: false,
     gitURL: "https://github.com/tinacms/tina-barebones-starter"
   },
   {
-    title: "Tailwind Starter",
+    title: "\u2B50 Tailwind Starter",
+    description: "Choosing Tailwind makes you feel like you are god with CSS. You can do anything.",
     value: "tina-cloud-starter",
     isInternal: false,
     gitURL: "https://github.com/tinacms/tina-cloud-starter"
   },
   {
     title: "Hugo Starter",
+    description: "With Hugo, you wield the power of lightning-fast site generation, crafting web experiences at the speed of thought.",
     value: "tina-hugo-starter",
     isInternal: false,
     gitURL: "https://github.com/tinacms/tina-hugo-starter"
   },
   {
     title: "Remix Starter",
+    description: "Dive into Remix to orchestrate seamless, interactive user journeys like a maestro of the web.",
     value: "tina-remix-starter",
     isInternal: false,
     gitURL: "https://github.com/tinacms/tina-remix-starter"
+  },
+  {
+    title: "Docusaurus Starter",
+    description: "Docusaurus empowers you to build and evolve documentation like crafting a living, breathing knowledge repository.",
+    value: "tinasaurus",
+    isInternal: false,
+    gitURL: "https://github.com/tinacms/tinasaurus"
   }
 ];
 var downloadExample = async (example, root) => {
@@ -294,7 +311,11 @@ var downloadExample = async (example, root) => {
     const repoURL = new URL(example.gitURL);
     const repoInfo = await getRepoInfo(repoURL);
     const repoInfo2 = repoInfo;
-    console.log(`Downloading files from repo ${import_chalk4.default.cyan(repoInfo.username + "/" + repoInfo.name)}. This might take a moment.`);
+    console.log(
+      `Downloading files from repo ${import_chalk4.default.cyan(
+        repoInfo.username + "/" + repoInfo.name
+      )}. This might take a moment.`
+    );
     await downloadAndExtractRepo(root, repoInfo2);
   } else {
     const exampleFile = import_path3.default.join(__dirname, "..", "examples", example.value);
@@ -305,7 +326,9 @@ var downloadExample = async (example, root) => {
 // src/util/preRunChecks.ts
 var preRunChecks = () => {
   if (process.version.startsWith("v15")) {
-    console.warn("WARNING: Version 15 of Node.js is not supported in create-tina-app, please update to the latest LTS version. See https://nodejs.org/en/download/ for more details");
+    console.warn(
+      "WARNING: Version 15 of Node.js is not supported in create-tina-app, please update to the latest LTS version. See https://nodejs.org/en/download/ for more details"
+    );
   }
 };
 
@@ -364,7 +387,11 @@ var run = async () => {
   }
   const chosenExample = EXAMPLES.find((x) => x.value === example);
   if (!chosenExample) {
-    console.error(`The example provided is not a valid example. Please provide one of the following; ${EXAMPLES.map((x) => x.value)}`);
+    console.error(
+      `The example provided is not a valid example. Please provide one of the following; ${EXAMPLES.map(
+        (x) => x.value
+      )}`
+    );
   }
   await telemetry.submitRecord({
     event: {
@@ -375,8 +402,12 @@ var run = async () => {
   });
   const root = import_path4.default.join(process.cwd(), dirName);
   if (!await isWriteable(import_path4.default.dirname(root))) {
-    console.error("The application path is not writable, please check folder permissions and try again.");
-    console.error("It is likely you do not have write permissions for this folder.");
+    console.error(
+      "The application path is not writable, please check folder permissions and try again."
+    );
+    console.error(
+      "It is likely you do not have write permissions for this folder."
+    );
     process.exit(1);
   }
   const appName = import_path4.default.basename(root);
@@ -386,7 +417,9 @@ var run = async () => {
     process.exit(1);
   }
   await downloadExample(chosenExample, root);
-  console.log(logText("Installing packages. This might take a couple of minutes."));
+  console.log(
+    logText("Installing packages. This might take a couple of minutes.")
+  );
   console.log();
   await install(root, null, { useYarn, isOnline: true });
   if (tryGitInit(root)) {
@@ -396,14 +429,28 @@ var run = async () => {
   console.log(`${successText("Starter successfully created!")}`);
   console.log(import_chalk5.default.bold("\nTo launch your app, run:\n"));
   console.log("  " + cmdText(`cd ${appName}`));
-  console.log(`  ${cmdText(`${displayedCommand} ${useYarn ? "" : "run "}dev`)}`);
+  console.log(
+    `  ${cmdText(`${displayedCommand} ${useYarn ? "" : "run "}dev`)}`
+  );
   console.log();
   console.log("Next steps:");
   console.log();
-  console.log(`\u2022 \u{1F4DD} Edit some content on ${linkText("http://localhost:3000")} (See ${linkText("https://tina.io/docs/using-tina-editor")})`);
-  console.log(`\u2022 \u{1F4D6} Learn the basics: ${linkText("https://tina.io/docs/schema/")}`);
-  console.log(`\u2022 \u{1F58C}\uFE0F Extend Tina with custom field components: ${linkText("https://tina.io/docs/advanced/extending-tina/")}`);
-  console.log(`\u2022 \u{1F680} Deploy to Production: ${linkText("https://tina.io/docs/tina-cloud/")}`);
+  console.log(
+    `\u2022 \u{1F4DD} Edit some content on ${linkText(
+      "http://localhost:3000"
+    )} (See ${linkText("https://tina.io/docs/using-tina-editor")})`
+  );
+  console.log(
+    `\u2022 \u{1F4D6} Learn the basics: ${linkText("https://tina.io/docs/schema/")}`
+  );
+  console.log(
+    `\u2022 \u{1F58C}\uFE0F Extend Tina with custom field components: ${linkText(
+      "https://tina.io/docs/advanced/extending-tina/"
+    )}`
+  );
+  console.log(
+    `\u2022 \u{1F680} Deploy to Production: ${linkText("https://tina.io/docs/tina-cloud/")}`
+  );
 };
 run();
 // Annotate the CommonJS export names for ESM import in node:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-tina-app",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "main": "dist/index.js",
   "files": [
     "dist",
@@ -26,7 +26,7 @@
     "directory": "packages/create-tina-app"
   },
   "devDependencies": {
-    "@tinacms/scripts": "1.0.2",
+    "@tinacms/scripts": "1.1.3",
     "@types/fs-extra": "^9.0.13",
     "@types/node": "^16.11.7",
     "@types/prompts": "^2.0.14",