create-astro 0.14.1 → 0.15.0

package/dist/gradient.js

@@ -25,14 +25,19 @@ function getGradientAnimFrames() {
   const frames = [];
   for (let start = 0; start < gradientColors.length * 2; start++) {
     const end = start + gradientColors.length - 1;
-    frames.push(referenceGradient.slice(start, end).map((g) => chalk.bgHex(g)(" ")).join(""));
+    frames.push(
+      referenceGradient.slice(start, end).map((g) => chalk.bgHex(g)(" ")).join("")
+    );
   }
   return frames;
 }
 function getIntroAnimFrames() {
   const frames = [];
   for (let end = 1; end <= gradientColors.length; end++) {
-    const leadingSpacesArr = Array.from(new Array(Math.abs(gradientColors.length - end - 1)), () => " ");
+    const leadingSpacesArr = Array.from(
+      new Array(Math.abs(gradientColors.length - end - 1)),
+      () => " "
+    );
     const gradientArr = gradientColors.slice(0, end).map((g) => chalk.bgHex(g)(" "));
     frames.push([...leadingSpacesArr, ...gradientArr].join(""));
   }

package/dist/index.js

@@ -3,8 +3,10 @@ import { execa, execaCommand } from "execa";
 import fs from "fs";
 import { bgCyan, black, bold, cyan, dim, gray, green, red, reset, yellow } from "kleur/colors";
 import ora from "ora";
+import os from "os";
 import path from "path";
 import prompts from "prompts";
+import url from "url";
 import detectPackageManager from "which-pm-runs";
 import yargs from "yargs-parser";
 import { loadWithRocketGradient, rocketAscii } from "./gradient.js";
@@ -32,7 +34,9 @@ function mkdirp(dir) {
 function isEmpty(dirPath) {
   return !fs.existsSync(dirPath) || fs.readdirSync(dirPath).length === 0;
 }
-const { version } = JSON.parse(fs.readFileSync(new URL("../package.json", import.meta.url), "utf-8"));
+const { version } = JSON.parse(
+  fs.readFileSync(new URL("../package.json", import.meta.url), "utf-8")
+);
 const FILES_TO_REMOVE = [".stackblitzrc", "sandbox.config.json", "CHANGELOG.md"];
 async function main() {
   var _a;
@@ -56,37 +60,43 @@ ${bold("Welcome to Astro!")} ${gray(`(create-astro v${version})`)}`);
       let rejectProjectDir = ora({ color: "red", text: notEmptyMsg(cwd) });
       rejectProjectDir.fail();
     }
-    const dirResponse = await prompts({
-      type: "text",
-      name: "directory",
-      message: "Where would you like to create your new project?",
-      initial: "./my-astro-site",
-      validate(value) {
-        if (!isEmpty(value)) {
-          return notEmptyMsg(value);
+    const dirResponse = await prompts(
+      {
+        type: "text",
+        name: "directory",
+        message: "Where would you like to create your new project?",
+        initial: "./my-astro-site",
+        validate(value) {
+          if (!isEmpty(value)) {
+            return notEmptyMsg(value);
+          }
+          return true;
         }
-        return true;
-      }
-    });
+      },
+      { onCancel: () => ora().info(dim("Operation cancelled. See you later, astronaut!")) }
+    );
     cwd = dirResponse.directory;
   }
   if (!cwd) {
     process.exit(1);
   }
-  const options = await prompts([
-    {
-      type: "select",
-      name: "template",
-      message: "Which template would you like to use?",
-      choices: TEMPLATES
-    }
-  ]);
+  const options = await prompts(
+    [
+      {
+        type: "select",
+        name: "template",
+        message: "Which template would you like to use?",
+        choices: TEMPLATES
+      }
+    ],
+    { onCancel: () => ora().info(dim("Operation cancelled. See you later, astronaut!")) }
+  );
   if (!options.template) {
     process.exit(1);
   }
-  const templateSpinner = await loadWithRocketGradient("Copying project files...");
+  let templateSpinner = await loadWithRocketGradient("Copying project files...");
   const hash = args.commit ? `#${args.commit}` : "";
-  const templateTarget = `withastro/astro/examples/${options.template}#latest`;
+  const templateTarget = options.template.includes("/") ? options.template : `withastro/astro/examples/${options.template}#latest`;
   const emitter = degit(`${templateTarget}${hash}`, {
     cache: false,
     force: true,
@@ -103,35 +113,88 @@ ${bold("Welcome to Astro!")} ${gray(`(create-astro v${version})`)}`);
         logger.debug(info.message);
       });
       await emitter.clone(cwd);
+      if (isEmpty(cwd)) {
+        fs.rmdirSync(cwd);
+        throw new Error(`Error: The provided template (${cyan(options.template)}) does not exist`);
+      }
     } catch (err) {
+      templateSpinner.fail();
       logger.debug(err);
       console.error(red(err.message));
-      if (err.message === "zlib: unexpected end of file") {
-        console.log(yellow("This seems to be a cache related problem. Remove the folder '~/.degit/github/withastro' to fix this error."));
-        console.log(yellow("For more information check out this issue: https://github.com/withastro/astro/issues/655"));
+      if (err.message === "zlib: unexpected end of file" || err.message === "TAR_BAD_ARCHIVE: Unrecognized archive format") {
+        console.log(
+          yellow(
+            "Local degit cache seems to be corrupted. For more information check out this issue: https://github.com/withastro/astro/issues/655. "
+          )
+        );
+        const cacheIssueResponse = await prompts({
+          type: "confirm",
+          name: "cache",
+          message: "Would you like us to clear the cache and try again?",
+          initial: true
+        });
+        if (cacheIssueResponse.cache) {
+          const homeDirectory = os.homedir();
+          const cacheDir = path.join(homeDirectory, ".degit", "github", "withastro");
+          fs.rmSync(cacheDir, { recursive: true, force: true, maxRetries: 3 });
+          templateSpinner = await loadWithRocketGradient("Copying project files...");
+          try {
+            await emitter.clone(cwd);
+          } catch (e) {
+            logger.debug(e);
+            console.error(red(e.message));
+          }
+        } else {
+          console.log(
+            "Okay, no worries! To fix this manually, remove the folder '~/.degit/github/withastro' and rerun the command."
+          );
+        }
       }
       if (err.code === "MISSING_REF") {
-        console.log(yellow("This seems to be an issue with degit. Please check if you have 'git' installed on your system, and install it if you don't have (https://git-scm.com)."));
-        console.log(yellow("If you do have 'git' installed, please run this command with the --verbose flag and file a new issue with the command output here: https://github.com/withastro/astro/issues"));
+        console.log(
+          yellow(
+            "This seems to be an issue with degit. Please check if you have 'git' installed on your system, and install it if you don't have (https://git-scm.com)."
+          )
+        );
+        console.log(
+          yellow(
+            "If you do have 'git' installed, please run this command with the --verbose flag and file a new issue with the command output here: https://github.com/withastro/astro/issues"
+          )
+        );
       }
-      templateSpinner.fail();
       process.exit(1);
     }
-    await Promise.all(FILES_TO_REMOVE.map(async (file) => {
-      const fileLoc = path.resolve(path.join(cwd, file));
-      if (fs.existsSync(fileLoc)) {
-        return fs.promises.rm(fileLoc, {});
-      }
-    }));
+    await Promise.all(
+      FILES_TO_REMOVE.map(async (file) => {
+        const fileLoc = path.resolve(path.join(cwd, file));
+        if (fs.existsSync(fileLoc)) {
+          return fs.promises.rm(fileLoc, {});
+        }
+      })
+    );
   }
   templateSpinner.text = green("Template copied!");
   templateSpinner.succeed();
-  const installResponse = await prompts({
-    type: "confirm",
-    name: "install",
-    message: `Would you like to install ${pkgManager} dependencies? ${reset(dim("(recommended)"))}`,
-    initial: true
-  });
+  const installResponse = await prompts(
+    {
+      type: "confirm",
+      name: "install",
+      message: `Would you like to install ${pkgManager} dependencies? ${reset(
+        dim("(recommended)")
+      )}`,
+      initial: true
+    },
+    {
+      onCancel: () => {
+        ora().info(
+          dim(
+            "Operation cancelled. Your project folder has already been created, however no dependencies have been installed"
+          )
+        );
+        process.exit(1);
+      }
+    }
+  );
   if (args.dryRun) {
     ora().info(dim(`--dry-run enabled, skipping.`));
   } else if (installResponse.install) {
@@ -142,7 +205,9 @@ ${bold("Welcome to Astro!")} ${gray(`(create-astro v${version})`)}`);
       var _a2;
       (_a2 = installExec.stdout) == null ? void 0 : _a2.on("data", function(data) {
         installSpinner.text = `${rocketAscii} ${installingPackagesMsg}
-${bold(`[${pkgManager}]`)} ${data}`;
+${bold(
+          `[${pkgManager}]`
+        )} ${data}`;
       });
       installExec.on("error", (error) => reject(error));
       installExec.on("close", () => resolve());
@@ -152,19 +217,92 @@ ${bold(`[${pkgManager}]`)} ${data}`;
   } else {
     ora().info(dim(`No problem! Remember to install dependencies after setup.`));
   }
-  const gitResponse = await prompts({
-    type: "confirm",
-    name: "git",
-    message: `Would you like to initialize a new git repository? ${reset(dim("(optional)"))}`,
-    initial: true
-  });
+  const gitResponse = await prompts(
+    {
+      type: "confirm",
+      name: "git",
+      message: `Would you like to initialize a new git repository? ${reset(dim("(optional)"))}`,
+      initial: true
+    },
+    {
+      onCancel: () => {
+        ora().info(
+          dim("Operation cancelled. No worries, your project folder has already been created")
+        );
+        process.exit(1);
+      }
+    }
+  );
   if (args.dryRun) {
     ora().info(dim(`--dry-run enabled, skipping.`));
   } else if (gitResponse.git) {
     await execaCommand("git init", { cwd });
+    ora().succeed("Git repository created!");
   } else {
     ora().info(dim(`Sounds good! You can come back and run ${cyan(`git init`)} later.`));
   }
+  const tsResponse = await prompts(
+    {
+      type: "select",
+      name: "typescript",
+      message: "How would you like to setup TypeScript?",
+      choices: [
+        {
+          title: "Relaxed",
+          value: "default"
+        },
+        {
+          title: "Strict (recommended)",
+          description: "Enable `strict` typechecking rules",
+          value: "strict"
+        },
+        {
+          title: "Strictest",
+          description: "Enable all typechecking rules",
+          value: "stricter"
+        },
+        {
+          title: "I prefer not to use TypeScript",
+          description: `That's cool too!`,
+          value: "optout"
+        }
+      ]
+    },
+    {
+      onCancel: () => {
+        ora().info(
+          dim(
+            "Operation cancelled. Your project folder has been created but no TypeScript configuration file was created."
+          )
+        );
+        process.exit(1);
+      }
+    }
+  );
+  if (tsResponse.typescript === "optout") {
+    console.log(``);
+    ora().warn(yellow(bold(`Astro \u2764\uFE0F TypeScript!`)));
+    console.log(`  Astro supports TypeScript inside of ".astro" component scripts, so`);
+    console.log(`  we still need to create some TypeScript-related files in your project.`);
+    console.log(`  You can safely ignore these files, but don't delete them!`);
+    console.log(dim("  (ex: tsconfig.json, src/types.d.ts)"));
+    console.log(``);
+    tsResponse.typescript = "default";
+    await wait(300);
+  }
+  if (args.dryRun) {
+    ora().info(dim(`--dry-run enabled, skipping.`));
+  } else if (tsResponse.typescript) {
+    fs.copyFileSync(
+      path.join(
+        url.fileURLToPath(new URL("..", import.meta.url)),
+        "tsconfigs",
+        `tsconfig.${tsResponse.typescript}.json`
+      ),
+      path.join(cwd, "tsconfig.json")
+    );
+    ora().succeed("TypeScript settings applied!");
+  }
   ora().succeed("Setup complete.");
   ora({ text: green("Ready for liftoff!") }).succeed();
   await wait(300);
@@ -173,11 +311,21 @@ ${bgCyan(black(" Next steps "))}
 `);
   let projectDir = path.relative(process.cwd(), cwd);
   const devCmd = pkgManager === "npm" ? "npm run dev" : `${pkgManager} dev`;
-  await logAndWait(`You can now ${bold(cyan("cd"))} into the ${bold(cyan(projectDir))} project directory.`);
-  await logAndWait(`Run ${bold(cyan(devCmd))} to start the Astro dev server. ${bold(cyan("CTRL-C"))} to close.`);
-  await logAndWait(`Add frameworks like ${bold(cyan("react"))} and ${bold(cyan("tailwind"))} to your project using ${bold(cyan("astro add"))}`);
+  if (projectDir !== "/") {
+    await logAndWait(
+      `You can now ${bold(cyan("cd"))} into the ${bold(cyan(projectDir))} project directory.`
+    );
+  }
+  await logAndWait(
+    `Run ${bold(cyan(devCmd))} to start the Astro dev server. ${bold(cyan("CTRL-C"))} to close.`
+  );
+  await logAndWait(
+    `Add frameworks like ${bold(cyan("react"))} and ${bold(
+      cyan("tailwind")
+    )} to your project using ${bold(cyan("astro add"))}`
+  );
   await logAndWait("");
-  await logAndWait(`Stuck? Come join us at ${bold(cyan("https://astro.build/chat"))}`, 1e3);
+  await logAndWait(`Stuck? Come join us at ${bold(cyan("https://astro.build/chat"))}`, 750);
   await logAndWait(dim("Good luck out there, astronaut."));
   await logAndWait("", 300);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-astro",
-  "version": "0.14.1",
+  "version": "0.15.0",
   "type": "module",
   "author": "withastro",
   "license": "MIT",
@@ -19,7 +19,8 @@
   },
   "files": [
     "dist",
-    "create-astro.js"
+    "create-astro.js",
+    "tsconfigs"
   ],
   "dependencies": {
     "chalk": "^5.0.1",

package/tsconfigs/tsconfig.strict.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    // Enable top-level await, and other modern ESM features.
+    "target": "ESNext",
+    "module": "ESNext",
+    // Enable node-style module resolution, for things like npm package imports.
+    "moduleResolution": "node",
+    // Enable JSON imports.
+    "resolveJsonModule": true,
+    // Enable stricter transpilation for better output.
+    "isolatedModules": true,
+    // Astro will directly run your TypeScript code, no transpilation needed.
+    "noEmit": true,
+    // Enable strict type checking.
+    "strict": true,
+    // Error when a value import is only used as a type.
+    "importsNotUsedAsValues": "error"
+  }
+}

package/tsconfigs/tsconfig.stricter.json

@@ -0,0 +1,33 @@
+{
+  "compilerOptions": {
+    // Enable top-level await, and other modern ESM features.
+    "target": "ESNext",
+    "module": "ESNext",
+    // Enable node-style module resolution, for things like npm package imports.
+    "moduleResolution": "node",
+    // Enable JSON imports.
+    "resolveJsonModule": true,
+    // Enable stricter transpilation for better output.
+    "isolatedModules": true,
+    // Astro will directly run your TypeScript code, no transpilation needed.
+    "noEmit": true,
+    // Enable strict type checking.
+    "strict": true,
+    // Error when a value import is only used as a type.
+    "importsNotUsedAsValues": "error",
+    // Report errors for fallthrough cases in switch statements
+    "noFallthroughCasesInSwitch": true,
+    // Force functions designed to override their parent class to be specified as `override`.
+    "noImplicitOverride": true,
+    // Force functions to specify that they can return `undefined` if a possibe code path does not return a value.
+    "noImplicitReturns": true,
+    // Report an error when a variable is declared but never used.
+    "noUnusedLocals": true,
+    // Report an error when a parameter is declared but never used.
+    "noUnusedParameters": true,
+    // Force the usage of the indexed syntax to access fields declared using an index signature.
+    "noUncheckedIndexedAccess": true,
+    // Report an error when the value `undefined` is given to an optional property that doesn't specify `undefined` as a valid value.
+    "exactOptionalPropertyTypes": true
+  }
+}