create-cloudflare 0.0.0-a027b57e → 0.0.0-a1c9f43f

package/README.md

@@ -2,58 +2,7 @@
 
 A CLI for creating and deploying new applications to [Cloudflare](https://developers.cloudflare.com/).
 
-## Usage
-
-### Setup via Interactive CLI
-
-To create new applications via interactive CLI, run:
-
-```bash
-npm create cloudflare@latest
-# or
-pnpm create cloudflare@latest
-# or
-yarn create cloudflare
-```
-
-### Setup via CLI Arguments
-
-#### New Websites or Web applications via Frameworks
-
-To create a new website or web framework without interaction, run:
-
-```bash
-npm create cloudflare@latest -- --type webFramework --framework <frameworkName>
-# or
-pnpm create cloudflare@latest ...
-# or
-yarn create cloudflare ...
-```
-
-Currently supported framework options: `angular`, `astro`, `docusaurus`, `gatsby`, `hono`, `next`, `nuxt`, `qwik`, `react`, `remix`, `solid`, `svelte`, `vue`.
-
-#### New Workers via Templates
-
-To create a new Javascript "Hello World" worker, run:
-
-```bash
-npm create cloudflare@latest hello-world -- --type hello-world --no-ts
-```
-
-To create a new Typescript "Hello World" worker, run:
-
-```bash
-npm create cloudflare@latest hello-world -- --type hello-world --ts
-```
-
-Current template options are: `hello-world`, `common`, `chatgptPlugin`, or `openapi`.
-
-#### Additional arguments
-
-|               |                                                                         |
-| ------------- | :---------------------------------------------------------------------: |
-| `--deploy`    | deploy your application automatically, bypassing the interactive prompt |
-| `--no-deploy` |   create and scaffold a new application and bypass deployment prompt    |
+For more details on how to use the create-cloudflare CLI (C3) please visit the [official C3 documentation](https://developers.cloudflare.com/pages/get-started/c3).
 
 ### Community
 

package/dist/cli.js

@@ -60107,7 +60107,7 @@ var Yargs = YargsFactory(esm_default);
 var yargs_default = Yargs;
 
 // package.json
-var version = "0.0.0-a027b57e";
+var version = "0.0.0-a1c9f43f";
 var devDependencies = {
   "@babel/parser": "^7.21.3",
   "@babel/types": "^7.21.4",
@@ -61004,18 +61004,18 @@ var package_default = {
   ],
   dependencies: {
     "@angular/cli": "16.2.2",
-    "create-astro": "4.3.0",
+    "create-astro": "4.4.1",
     "create-docusaurus": "2.4.3",
     "create-hono": "0.3.2",
     "create-next-app": "13.4.19",
-    "create-qwik": "1.2.14",
+    "create-qwik": "1.2.15",
     "create-react-app": "5.0.1",
     "create-remix": "2.1.0",
     "create-solid": "0.3.8",
     "create-svelte": "5.1.1",
     "create-vue": "3.8.0",
     gatsby: "5.12.8",
-    nuxi: "3.9.0"
+    nuxi: "3.9.1"
   },
   frameworkCliMap: {
     angular: "@angular/cli",
@@ -61423,9 +61423,12 @@ var { name, npm: npm12 } = detectPackageManager();
 var validateProjectDirectory = (relativePath, args) => {
   const path3 = (0, import_path7.resolve)(relativePath);
   const existsAlready = (0, import_fs8.existsSync)(path3);
-  const isEmpty = existsAlready && (0, import_fs8.readdirSync)(path3).length === 0;
-  if (existsAlready && !isEmpty) {
-    return `Directory \`${relativePath}\` already exists and is not empty. Please choose a new name.`;
+  if (existsAlready) {
+    for (const file of (0, import_fs8.readdirSync)(path3)) {
+      if (!isAllowedExistingFile(file)) {
+        return `Directory \`${relativePath}\` already exists and contains files that might conflict. Please choose a new name.`;
+      }
+    }
   }
   if (!args.existingScript) {
     const projectName = (0, import_path7.basename)(path3);
@@ -61442,6 +61445,46 @@ var validateProjectDirectory = (relativePath, args) => {
     }
   }
 };
+var isAllowedExistingFile = (file) => {
+  const allowedExistingFiles = /* @__PURE__ */ new Set([
+    ".DS_Store",
+    ".git",
+    ".gitattributes",
+    ".gitignore",
+    ".gitlab-ci.yml",
+    ".hg",
+    ".hgcheck",
+    ".hgignore",
+    ".idea",
+    ".npmignore",
+    ".travis.yml",
+    ".vscode",
+    "Thumbs.db",
+    "docs",
+    "mkdocs.yml",
+    "npm-debug.log",
+    "yarn-debug.log",
+    "yarn-error.log",
+    "yarnrc.yml",
+    ".yarn",
+    ".gitkeep"
+  ]);
+  if (allowedExistingFiles.has(file))
+    return true;
+  const allowedExistingPatters = [
+    /readme(\.md)?$/i,
+    /license(\.md)?$/i,
+    /\.iml$/,
+    /^npm-debug\.log/,
+    /^yarn-debug\.log/,
+    /^yarn-error\.log/
+  ];
+  for (const regex2 of allowedExistingPatters) {
+    if (regex2.test(file))
+      return true;
+  }
+  return false;
+};
 var setupProjectDirectory = (args) => {
   const path3 = (0, import_path7.resolve)(args.projectName);
   const err = validateProjectDirectory(path3, args);
@@ -62105,26 +62148,61 @@ var parseArgs = async (argv) => {
     doubleDashesIdx < 0 ? void 0 : doubleDashesIdx
   );
   const additionalArgs = doubleDashesIdx < 0 ? [] : argv.slice(doubleDashesIdx + 1);
-  const yargsObj = yargs_default(hideBin(c3Args)).scriptName("create-cloudflare").usage("$0 [args]").positional("name", { type: "string" }).option("type", { type: "string" }).option("framework", { type: "string" }).option("deploy", { type: "boolean" }).option("ts", { type: "boolean" }).option("git", { type: "boolean" }).option("open", {
+  const yargsObj = yargs_default(hideBin(c3Args)).scriptName("create-cloudflare").usage("$0 [args]").positional("directory", {
+    type: "string",
+    description: "The directory where the application should be created. The name of the application is taken from the directory name"
+  }).option("type", {
+    type: "string",
+    description: "The type of application that should be created"
+  }).option("framework", {
+    type: "string",
+    description: "The type of framework to use to create a web application (when using this option `--type` is ignored)"
+  }).option("deploy", {
+    type: "boolean",
+    description: "Deploy your application after it has been created"
+  }).option("ts", {
+    type: "boolean",
+    description: "Use TypeScript in your application"
+  }).option("git", {
+    type: "boolean",
+    description: "Initialize a local git repository for your application"
+  }).option("open", {
     type: "boolean",
     default: true,
-    description: "opens your browser after your deployment, set --no-open to disable"
+    description: "Opens the deployed application in your browser (this option is ignored if the application is not deployed)"
   }).option("existing-script", {
     type: "string",
     hidden: templateMap["pre-existing"].hidden
   }).option("accept-defaults", {
     alias: "y",
-    type: "boolean"
+    type: "boolean",
+    description: "Use all the default C3 options (each can also be overridden by specifying it)"
   }).option("auto-update", {
     type: "boolean",
     default: C3_DEFAULTS.autoUpdate,
-    description: "Automatically uses the latest version of `create-cloudflare`. Set --no-auto-update to disable"
-  }).option("wrangler-defaults", { type: "boolean", hidden: true }).version(version).strictOptions().alias("h", "help").help();
-  const args = await yargsObj.argv;
+    description: "Automatically uses the latest version of C3"
+  }).option("wrangler-defaults", { type: "boolean", hidden: true }).version(version).alias("v", "version").strictOptions().exitProcess(false).alias("h", "help").help();
+  let args = null;
+  try {
+    args = await yargsObj.argv;
+  } catch {
+  }
+  if (args === null) {
+    showMoreInfoNote();
+    process.exit(1);
+  }
+  if (args.version) {
+    process.exit(0);
+  }
+  if (args.help) {
+    showMoreInfoNote();
+    process.exit(0);
+  }
   const positionalArgs = args._;
   if (positionalArgs.length > 1) {
     yargsObj.showHelp();
     console.error("\nToo many positional arguments provided");
+    showMoreInfoNote();
     process.exit(1);
   }
   return {
@@ -62150,6 +62228,13 @@ var processArgument = async (args, name2, promptConfig) => {
   value = await inputPrompt(promptConfig);
   return value;
 };
+var showMoreInfoNote = () => {
+  const c3CliArgsDocsPage = "https://developers.cloudflare.com/pages/get-started/c3/#cli-arguments";
+  console.log(
+    `
+For more information regarding how to invoke C3 please visit ${c3CliArgsDocsPage}`
+  );
+};
 
 // src/cli.ts
 var import_semver2 = __toESM(require_semver2());
@@ -62209,9 +62294,12 @@ var runCli = async (args) => {
     options: templateOptions,
     defaultValue: C3_DEFAULTS.type
   });
-  if (!type || !Object.keys(templateMap).includes(type)) {
+  if (!type) {
     return crash("An application type must be specified to continue.");
   }
+  if (!Object.keys(templateMap).includes(type)) {
+    return crash(`Unknown application type provided: ${type}.`);
+  }
   const validatedArgs = {
     ...args,
     type,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-cloudflare",
-  "version": "0.0.0-a027b57e",
+  "version": "0.0.0-a1c9f43f",
   "description": "A CLI for creating and deploying new applications to Cloudflare.",
   "keywords": [
     "cloudflare",

package/templates/scheduled/ts/wrangler.toml

@@ -1,6 +1,6 @@
 name = "<TBD>"
 main = "src/index.ts"
-compatibility_date = "2023-05-15"
+compatibility_date = "<TBD>"
 
 # Cron Triggers
 # Docs: https://developers.cloudflare.com/workers/platform/triggers/cron-triggers/