create-astro 0.8.0 → 0.10.1

package/dist/index.js

@@ -26,6 +26,7 @@ import { FRAMEWORKS, COUNTER_COMPONENTS } from "./frameworks.js";
 import { TEMPLATES } from "./templates.js";
 import { createConfig } from "./config.js";
 import { logger, defaultLogLevel } from "./logger.js";
+import { execa } from "execa";
 const cleanArgv = process.argv.filter((arg) => arg !== "--");
 const args = yargs(cleanArgv);
 prompts.override(args);
@@ -38,32 +39,49 @@ function mkdirp(dir) {
     throw e;
   }
 }
+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 FILES_TO_REMOVE = [".stackblitzrc", "sandbox.config.json"];
 const POSTPROCESS_FILES = ["package.json", "astro.config.mjs", "CHANGELOG.md"];
 async function main() {
+  const pkgManager = pkgManagerFromUserAgent(process.env.npm_config_user_agent);
   logger.debug("Verbose logging turned on");
   console.log(`
 ${bold("Welcome to Astro!")} ${gray(`(create-astro v${version})`)}`);
-  console.log(`If you encounter a problem, visit ${cyan("https://github.com/withastro/astro/issues")} to search or file a new issue.
-`);
   let spinner = ora({ color: "green", text: "Prepare for liftoff." });
   spinner.succeed();
-  const cwd = args["_"][2] || ".";
-  if (fs.existsSync(cwd)) {
-    if (fs.readdirSync(cwd).length > 0) {
-      const response = await prompts({
-        type: "confirm",
-        name: "forceOverwrite",
-        message: "Directory not empty. Continue [force overwrite]?",
-        initial: false
-      });
-      if (!response.forceOverwrite) {
-        process.exit(1);
-      }
-      mkdirp(cwd);
+  let cwd = args["_"][2];
+  if (cwd && isEmpty(cwd)) {
+    let acknowledgeProjectDir = ora({
+      color: "green",
+      text: `Using ${bold(cwd)} as project directory.`
+    });
+    acknowledgeProjectDir.succeed();
+  }
+  if (!cwd || !isEmpty(cwd)) {
+    const notEmptyMsg = (dirPath) => `"${bold(dirPath)}" is not empty!`;
+    if (!isEmpty(cwd)) {
+      let rejectProjectDir = ora({ color: "red", text: notEmptyMsg(cwd) });
+      rejectProjectDir.fail();
     }
-  } else {
-    mkdirp(cwd);
+    const dirResponse = await prompts({
+      type: "text",
+      name: "directory",
+      message: "Where would you like to create your app?",
+      initial: "./my-astro-site",
+      validate(value) {
+        if (!isEmpty(value)) {
+          return notEmptyMsg(value);
+        }
+        return true;
+      }
+    });
+    cwd = dirResponse.directory;
+  }
+  if (!cwd) {
+    process.exit(1);
   }
   const options = await prompts([
     {
@@ -102,97 +120,144 @@ ${bold("Welcome to Astro!")} ${gray(`(create-astro v${version})`)}`);
     integrations = result.integrations;
   }
   spinner = ora({ color: "green", text: "Copying project files..." }).start();
-  try {
-    emitter.on("info", (info) => {
-      logger.debug(info.message);
-    });
-    await emitter.clone(cwd);
-  } catch (err) {
-    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.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"));
-    }
-    spinner.fail();
-    process.exit(1);
-  }
-  await Promise.all(POSTPROCESS_FILES.map(async (file) => {
-    const fileLoc = path.resolve(path.join(cwd, file));
-    switch (file) {
-      case "CHANGELOG.md": {
-        if (fs.existsSync(fileLoc)) {
-          await fs.promises.unlink(fileLoc);
-        }
-        break;
+  if (!args.dryrun) {
+    try {
+      emitter.on("info", (info) => {
+        logger.debug(info.message);
+      });
+      await emitter.clone(cwd);
+    } catch (err) {
+      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"));
       }
-      case "astro.config.mjs": {
-        if ((selectedTemplate == null ? void 0 : selectedTemplate.integrations) !== true) {
-          break;
-        }
-        await fs.promises.writeFile(fileLoc, createConfig({ integrations }));
-        break;
+      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"));
       }
-      case "package.json": {
-        const packageJSON = JSON.parse(await fs.promises.readFile(fileLoc, "utf8"));
-        delete packageJSON.snowpack;
-        const integrationEntries = (await Promise.all(integrations.map((integration) => fetch(`https://registry.npmjs.org/${integration.packageName}/latest`).then((res) => res.json()).then((res) => {
-          let dependencies = [[res["name"], `^${res["version"]}`]];
-          if (res["peerDependencies"]) {
-            for (const peer in res["peerDependencies"]) {
-              dependencies.push([peer, res["peerDependencies"][peer]]);
+      spinner.fail();
+      process.exit(1);
+    }
+    await Promise.all([
+      ...FILES_TO_REMOVE.map(async (file) => {
+        const fileLoc = path.resolve(path.join(cwd, file));
+        return fs.promises.rm(fileLoc);
+      }),
+      ...POSTPROCESS_FILES.map(async (file) => {
+        const fileLoc = path.resolve(path.join(cwd, file));
+        switch (file) {
+          case "CHANGELOG.md": {
+            if (fs.existsSync(fileLoc)) {
+              await fs.promises.unlink(fileLoc);
             }
+            break;
           }
-          return dependencies;
-        })))).flat(1);
-        packageJSON.devDependencies = __spreadValues(__spreadValues({}, packageJSON.devDependencies ?? {}), Object.fromEntries(integrationEntries));
-        packageJSON.devDependencies = Object.fromEntries(Object.entries(packageJSON.devDependencies).sort((a, b) => a[0].localeCompare(b[0])));
-        await fs.promises.writeFile(fileLoc, JSON.stringify(packageJSON, void 0, 2));
-        break;
-      }
+          case "astro.config.mjs": {
+            if ((selectedTemplate == null ? void 0 : selectedTemplate.integrations) !== true) {
+              break;
+            }
+            await fs.promises.writeFile(fileLoc, createConfig({ integrations }));
+            break;
+          }
+          case "package.json": {
+            const packageJSON = JSON.parse(await fs.promises.readFile(fileLoc, "utf8"));
+            delete packageJSON.snowpack;
+            const integrationEntries = (await Promise.all(integrations.map((integration) => fetch(`https://registry.npmjs.org/${integration.packageName}/latest`).then((res) => res.json()).then((res) => {
+              let dependencies = [[res["name"], `^${res["version"]}`]];
+              if (res["peerDependencies"]) {
+                for (const peer in res["peerDependencies"]) {
+                  dependencies.push([peer, res["peerDependencies"][peer]]);
+                }
+              }
+              return dependencies;
+            })))).flat(1);
+            packageJSON.devDependencies = __spreadValues(__spreadValues({}, packageJSON.devDependencies ?? {}), Object.fromEntries(integrationEntries));
+            packageJSON.devDependencies = Object.fromEntries(Object.entries(packageJSON.devDependencies).sort((a, b) => a[0].localeCompare(b[0])));
+            await fs.promises.writeFile(fileLoc, JSON.stringify(packageJSON, void 0, 2));
+            break;
+          }
+        }
+      })
+    ]);
+    if ((selectedTemplate == null ? void 0 : selectedTemplate.value) === "starter") {
+      let importStatements = [];
+      let components = [];
+      await Promise.all(integrations.map(async (integration) => {
+        const component = COUNTER_COMPONENTS[integration.id];
+        const componentName = path.basename(component.filename, path.extname(component.filename));
+        const absFileLoc = path.resolve(cwd, component.filename);
+        importStatements.push(`import ${componentName} from '${component.filename.replace(/^src/, "..")}';`);
+        components.push(`<${componentName} client:visible />`);
+        await fs.promises.writeFile(absFileLoc, component.content);
+      }));
+      const pageFileLoc = path.resolve(path.join(cwd, "src", "pages", "index.astro"));
+      const content = (await fs.promises.readFile(pageFileLoc)).toString();
+      const newContent = content.replace(/^(\s*)\/\* ASTRO\:COMPONENT_IMPORTS \*\//gm, (_, indent) => {
+        return indent + importStatements.join("\n");
+      }).replace(/^(\s*)<!-- ASTRO:COMPONENT_MARKUP -->/gm, (_, indent) => {
+        return components.map((ln) => indent + ln).join("\n");
+      });
+      await fs.promises.writeFile(pageFileLoc, newContent);
     }
-  }));
-  if ((selectedTemplate == null ? void 0 : selectedTemplate.value) === "starter") {
-    let importStatements = [];
-    let components = [];
-    await Promise.all(integrations.map(async (integration) => {
-      const component = COUNTER_COMPONENTS[integration.id];
-      const componentName = path.basename(component.filename, path.extname(component.filename));
-      const absFileLoc = path.resolve(cwd, component.filename);
-      importStatements.push(`import ${componentName} from '${component.filename.replace(/^src/, "..")}';`);
-      components.push(`<${componentName} client:visible />`);
-      await fs.promises.writeFile(absFileLoc, component.content);
-    }));
-    const pageFileLoc = path.resolve(path.join(cwd, "src", "pages", "index.astro"));
-    const content = (await fs.promises.readFile(pageFileLoc)).toString();
-    const newContent = content.replace(/^(\s*)\/\* ASTRO\:COMPONENT_IMPORTS \*\//gm, (_, indent) => {
-      return indent + importStatements.join("\n");
-    }).replace(/^(\s*)<!-- ASTRO:COMPONENT_MARKUP -->/gm, (_, indent) => {
-      return components.map((ln) => indent + ln).join("\n");
-    });
-    await fs.promises.writeFile(pageFileLoc, newContent);
   }
   spinner.succeed();
   console.log(bold(green("\u2714") + " Done!"));
+  const installResponse = await prompts({
+    type: "confirm",
+    name: "install",
+    message: `Would you like us to run "${pkgManager} install?"`,
+    initial: true
+  });
+  if (!installResponse) {
+    process.exit(0);
+  }
+  if (installResponse.install) {
+    const installExec = execa(pkgManager, ["install"], { cwd });
+    const installingPackagesMsg = `Installing packages${emojiWithFallback(" \u{1F4E6}", "...")}`;
+    spinner = ora({ color: "green", text: installingPackagesMsg }).start();
+    if (!args.dryrun) {
+      await new Promise((resolve, reject) => {
+        var _a;
+        (_a = installExec.stdout) == null ? void 0 : _a.on("data", function(data) {
+          spinner.text = `${installingPackagesMsg}
+${bold(`[${pkgManager}]`)} ${data}`;
+        });
+        installExec.on("error", (error) => reject(error));
+        installExec.on("close", () => resolve());
+      });
+    }
+    spinner.succeed();
+  }
   console.log("\nNext steps:");
   let i = 1;
   const relative = path.relative(process.cwd(), cwd);
   if (relative !== "") {
     console.log(`  ${i++}: ${bold(cyan(`cd ${relative}`))}`);
   }
-  console.log(`  ${i++}: ${bold(cyan("npm install"))} (or pnpm install, yarn, etc)`);
+  if (!installResponse.install) {
+    console.log(`  ${i++}: ${bold(cyan(`${pkgManager} install`))}`);
+  }
   console.log(`  ${i++}: ${bold(cyan('git init && git add -A && git commit -m "Initial commit"'))} (optional step)`);
-  console.log(`  ${i++}: ${bold(cyan("npm run dev"))} (or pnpm, yarn, etc)`);
+  const runCommand = pkgManager === "npm" ? "npm run dev" : `${pkgManager} dev`;
+  console.log(`  ${i++}: ${bold(cyan(runCommand))}`);
   console.log(`
 To close the dev server, hit ${bold(cyan("Ctrl-C"))}`);
   console.log(`
 Stuck? Visit us at ${cyan("https://astro.build/chat")}
 `);
 }
+function emojiWithFallback(char, fallback) {
+  return process.platform !== "win32" ? char : fallback;
+}
+function pkgManagerFromUserAgent(userAgent) {
+  if (!userAgent)
+    return "npm";
+  const pkgSpec = userAgent.split(" ")[0];
+  const pkgSpecArr = pkgSpec.split("/");
+  return pkgSpecArr[0];
+}
 export {
   main,
   mkdirp

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-astro",
-  "version": "0.8.0",
+  "version": "0.10.1",
   "type": "module",
   "author": "withastro",
   "license": "MIT",
@@ -17,6 +17,12 @@
   "bin": {
     "create-astro": "./create-astro.mjs"
   },
+  "scripts": {
+    "build": "astro-scripts build \"src/**/*.ts\" && tsc",
+    "build:ci": "astro-scripts build \"src/**/*.ts\"",
+    "dev": "astro-scripts dev \"src/**/*.ts\"",
+    "test": "mocha --exit --timeout 20000"
+  },
   "files": [
     "dist",
     "create-astro.js"
@@ -25,6 +31,7 @@
     "@types/degit": "^2.8.3",
     "@types/prompts": "^2.0.14",
     "degit": "^2.8.4",
+    "execa": "^6.1.0",
     "kleur": "^4.1.4",
     "node-fetch": "^3.2.3",
     "ora": "^6.1.0",
@@ -32,18 +39,15 @@
     "yargs-parser": "^21.0.1"
   },
   "devDependencies": {
+    "@types/chai": "^4.3.1",
+    "@types/mocha": "^9.1.1",
     "@types/yargs-parser": "^21.0.0",
-    "astro-scripts": "0.0.2",
+    "astro-scripts": "workspace:*",
+    "chai": "^4.3.6",
+    "mocha": "^9.2.2",
     "uvu": "^0.5.3"
   },
   "engines": {
     "node": "^14.15.0 || >=16.0.0"
-  },
-  "scripts": {
-    "build": "astro-scripts build \"src/**/*.ts\" && tsc",
-    "build:ci": "astro-scripts build \"src/**/*.ts\"",
-    "dev": "astro-scripts dev \"src/**/*.ts\"",
-    "test": "rm -rf test/fixtures && mkdir test/fixtures && node --unhandled-rejections=strict test/create-astro.test.js"
-  },
-  "readme": "# create-astro\n\n## Scaffolding for Astro projects\n\n**With NPM:**\n\n```bash\nnpm init astro\n```\n\n**With Yarn:**\n\n```bash\nyarn create astro\n```\n\n`create-astro` automatically runs in _interactive_ mode, but you can also specify your project name and template with command line arguments.\n\n```bash\n# npm 6.x\nnpm init astro my-astro-project --template starter\n\n# npm 7+, extra double-dash is needed:\nnpm init astro my-astro-project -- --template starter\n\n# yarn\nyarn create astro my-astro-project --template starter\n```\n[Check out the full list][examples] of example starter templates, available on GitHub.\n\nYou can also use any GitHub repo as a template:\n\n```bash\nnpm init astro my-astro-project -- --template cassidoo/shopify-react-astro\n```\n\n### CLI Flags\n\nMay be provided in place of prompts\n\n| Name         | Description                                         |\n|:-------------|:----------------------------------------------------|\n| `--template` | Specify the template name ([list][examples])        |\n| `--commit`   | Specify a specific Git commit or branch to use from this repo (by default, `main` branch of this repo will be used) |\n\n### Debugging\n\nTo debug `create-astro`, you can use the `--verbose` flag which will log the output of degit and some more information about the command, this can be useful when you encounter an error and want to report it.\n\n```bash\n# npm 6.x\nnpm init astro my-astro-project --verbose\n\n# npm 7+, extra double-dash is needed:\nnpm init astro my-astro-project -- --verbose\n\n# yarn\nyarn create astro my-astro-project --verbose\n```\n\n[examples]: https://github.com/withastro/astro/tree/main/examples\n"
-}
+  }
+}

package/LICENSE

@@ -1,34 +0,0 @@
-MIT License
-
-Copyright (c) 2021 Fred K. Schott
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
-
-"""
-This license applies to parts of the `packages/create-astro` and `packages/astro` subdirectories originating from the https://github.com/sveltejs/kit repository:
-
-Copyright (c) 2020 [these people](https://github.com/sveltejs/kit/graphs/contributors)
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-"""