create-astro 1.0.1-next.0 → 1.0.2

package/README.md

@@ -5,7 +5,7 @@
 **With NPM:**
 
 ```bash
-npm init astro
+npm create astro@latest
 ```
 
 **With Yarn:**
@@ -18,10 +18,10 @@ yarn create astro
 
 ```bash
 # npm 6.x
-npm init astro my-astro-project --template starter
+npm create astro@latest my-astro-project --template starter
 
 # npm 7+, extra double-dash is needed:
-npm init astro my-astro-project -- --template starter
+npm create astro@latest my-astro-project -- --template starter
 
 # yarn
 yarn create astro my-astro-project --template starter
@@ -31,7 +31,7 @@ yarn create astro my-astro-project --template starter
 You can also use any GitHub repo as a template:
 
 ```bash
-npm init astro my-astro-project -- --template cassidoo/shopify-react-astro
+npm create astro@latest my-astro-project -- --template cassidoo/shopify-react-astro
 ```
 
 ### CLI Flags
@@ -49,10 +49,10 @@ To debug `create-astro`, you can use the `--verbose` flag which will log the out
 
 ```bash
 # npm 6.x
-npm init astro my-astro-project --verbose
+npm create astro@latest my-astro-project --verbose
 
 # npm 7+, extra double-dash is needed:
-npm init astro my-astro-project -- --verbose
+npm create astro@latest my-astro-project -- --verbose
 
 # yarn
 yarn create astro my-astro-project --verbose

package/dist/index.js

@@ -34,6 +34,40 @@ function mkdirp(dir) {
 function isEmpty(dirPath) {
   return !fs.existsSync(dirPath) || fs.readdirSync(dirPath).length === 0;
 }
+const VALID_PROJECT_DIRECTORY_SAFE_LIST = [
+  ".DS_Store",
+  ".git",
+  ".gitattributes",
+  ".gitignore",
+  ".gitlab-ci.yml",
+  ".hg",
+  ".hgcheck",
+  ".hgignore",
+  ".idea",
+  ".npmignore",
+  ".travis.yml",
+  ".yarn",
+  ".yarnrc.yml",
+  "docs",
+  "LICENSE",
+  "mkdocs.yml",
+  "Thumbs.db",
+  /\.iml$/,
+  /^npm-debug\.log/,
+  /^yarn-debug\.log/,
+  /^yarn-error\.log/
+];
+function isValidProjectDirectory(dirPath) {
+  if (!fs.existsSync(dirPath)) {
+    return true;
+  }
+  const conflicts = fs.readdirSync(dirPath).filter((content) => {
+    return !VALID_PROJECT_DIRECTORY_SAFE_LIST.some((safeContent) => {
+      return typeof safeContent === "string" ? content === safeContent : safeContent.test(content);
+    });
+  });
+  return conflicts.length === 0;
+}
 const { version } = JSON.parse(
   fs.readFileSync(new URL("../package.json", import.meta.url), "utf-8")
 );
@@ -47,16 +81,16 @@ ${bold("Welcome to Astro!")} ${gray(`(create-astro v${version})`)}`);
   console.log(`Lets walk through setting up your new Astro project.
 `);
   let cwd = args["_"][2];
-  if (cwd && isEmpty(cwd)) {
+  if (cwd && isValidProjectDirectory(cwd)) {
     let acknowledgeProjectDir = ora({
       color: "green",
       text: `Using ${bold(cwd)} as project directory.`
     });
     acknowledgeProjectDir.succeed();
   }
-  if (!cwd || !isEmpty(cwd)) {
+  if (!cwd || !isValidProjectDirectory(cwd)) {
     const notEmptyMsg = (dirPath) => `"${bold(dirPath)}" is not empty!`;
-    if (!isEmpty(cwd)) {
+    if (!isValidProjectDirectory(cwd)) {
       let rejectProjectDir = ora({ color: "red", text: notEmptyMsg(cwd) });
       rejectProjectDir.fail();
     }
@@ -67,7 +101,7 @@ ${bold("Welcome to Astro!")} ${gray(`(create-astro v${version})`)}`);
         message: "Where would you like to create your new project?",
         initial: "./my-astro-site",
         validate(value) {
-          if (!isEmpty(value)) {
+          if (!isValidProjectDirectory(value)) {
             return notEmptyMsg(value);
           }
           return true;
@@ -97,7 +131,7 @@ ${bold("Welcome to Astro!")} ${gray(`(create-astro v${version})`)}`);
   let templateSpinner = await loadWithRocketGradient("Copying project files...");
   const hash = args.commit ? `#${args.commit}` : "";
   const isThirdParty = options.template.includes("/");
-  const templateTarget = options.template.includes("/") ? options.template : `withastro/astro/examples/${options.template}#latest`;
+  const templateTarget = isThirdParty ? options.template : `withastro/astro/examples/${options.template}#latest`;
   const emitter = degit(`${templateTarget}${hash}`, {
     cache: false,
     force: true,
@@ -114,8 +148,10 @@ ${bold("Welcome to Astro!")} ${gray(`(create-astro v${version})`)}`);
         logger.debug(info.message);
       });
       await emitter.clone(cwd);
-      if (isEmpty(cwd)) {
-        fs.rmdirSync(cwd);
+      if (isValidProjectDirectory(cwd)) {
+        if (isEmpty(cwd)) {
+          fs.rmdirSync(cwd);
+        }
         throw new Error(`Error: The provided template (${cyan(options.template)}) does not exist`);
       }
     } catch (err) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-astro",
-  "version": "1.0.1-next.0",
+  "version": "1.0.2",
   "type": "module",
   "author": "withastro",
   "license": "MIT",