create-cloudflare 0.0.1 → 0.0.4

package/bin.js

@@ -1,64 +1,2 @@
 #!/usr/bin/env node
-const argv = require('mri')(process.argv.slice(2), {
-	alias: {
-		v: 'version',
-		h: 'help',
-	},
-	default: {
-		init: true,
-		force: false,
-		debug: false
-	}
-});
-
-/**
- * @param {string} msg
- * @returns {never}
- */
-function exit(msg, code = 1) {
-	if (code) process.stderr.write(msg + '\n');
-	else process.stdout.write(msg + '\n');
-	process.exit(code);
-}
-
-if (argv.help) {
-	let output = '';
-
-	output += '\n  Usage';
-	output += '\n    npm init cloudflare <directory> -- [options]';
-	output += '\n    pnpm create cloudflare <directory> [options]';
-	output += '\n    yarn create cloudflare <directory> [options]';
-	output += '\n';
-	output += '\n  Options';
-	output += '\n        --force        Force overwrite target directory';
-	output += '\n        --no-init      Do not initialize a git repository';
-	output += '\n        --debug        Print additional error details';
-	output += '\n    -v, --version      Displays current version';
-	output += '\n    -h, --help         Displays this message';
-	output += '\n';
-	output += '\n  Examples';
-	output += '\n    $ npm init cloudflare my-project';
-	output += '\n    $ npm init cloudflare my-project -- --no-init';
-	output += '\n    $ npm init cloudflare my-project -- pages svelte-kit';
-	output += '\n    $ npm init cloudflare my-project -- https://github.com/user/repo.git';
-	output += '\n    $ npm init cloudflare my-project -- https://github.com/user/repo.git#branch';
-	output += '\n';
-
-	exit(output, 0);
-}
-
-if (argv.version) {
-	let pkg = require('./package.json');
-	exit(`${pkg.name}, v${pkg.version}`, 0);
-}
-
-(async function () {
-	try {
-		console.log(argv);
-		let dir = argv._.join('-').trim().replace(/[\s_]+/g, '-');
-		if (!dir) return exit('Missing <name> argument', 1);
-		await require('.').setup(dir, argv);
-	} catch (err) {
-		exit(err && err.stack || err, 1);
-	}
-})();
+const r=require("mri")(process.argv.slice(2),{alias:{v:"version",h:"help"},default:{init:!0,force:!1,debug:!1}});function e(r,e=1){e?process.stderr.write(r+"\n"):process.stdout.write(r+"\n"),process.exit(e)}if(r.help){let r="";r+="\n  Usage",r+="\n    npm init cloudflare <directory> <source> -- [options]",r+="\n    pnpm create cloudflare <directory> <source> [options]",r+="\n    yarn create cloudflare <directory> <source> [options]",r+="\n",r+="\n  Sources",r+="\n    • Example — A name or path to an official example subdirectory.",r+="\n        Visit https://github.com/cloudflare/templates for options",r+="\n    • URL — Any valid git repository address.",r+="\n        [user@]host.xz:path/to/repo.git[#branch]",r+="\n        git://host.xz[:port]/path/to/repo.git[#branch]",r+="\n        ssh://[user@]host.xz[:port]/path/to/repo.git[#branch]",r+="\n        http[s]://host.xz[:port]/path/to/repo.git[#branch]",r+="\n        ftp[s]://host.xz[:port]/path/to/repo.git[#branch]",r+="\n",r+="\n  Options",r+="\n    --force         Force overwrite target directory",r+="\n    --no-init       Do not initialize a git repository",r+="\n    --debug         Print additional error details",r+="\n    --version, -v   Displays current version",r+="\n    --help, -h      Displays this message",r+="\n",r+="\n  Examples",r+="\n    $ npm init cloudflare my-project pages/svelte-kit -- --debug",r+="\n    $ yarn create cloudflare my-project workshops/intro-workers --force",r+="\n    $ pnpm create cloudflare my-project https://github.com/user/repo.git#branch",r+="\n    $ npm init cloudflare my-project https://github.com/user/repo.git",r+="\n",e(r,0)}if(r.version){let r=require("./package.json");e(`${r.name}, v${r.version}`,0)}!async function(){try{let[t,o]=r._;if(!t)return e("Missing <directory> argument",1);if(!o)return e("Missing <source> argument",1);await require(".").setup(t,o,r)}catch(r){e(r instanceof Error?r.stack||r.message:r,1)}}();

package/index.d.ts

@@ -0,0 +1,7 @@
+export interface Argv {
+	init?: boolean;
+	force?: boolean;
+	debug?: boolean;
+}
+
+export function setup(dest: string, source: string, argv: Argv): Promise<void>;

package/index.js

@@ -1 +1 @@
-const e = require('path');const r = require('fs');const { join:t } = require('path');const { promisify:s } = require('util');const { exec:o } = require('child_process');s(o);var i=r.existsSync;function f(e){return r.promises.rm(e,{recursive:!0})}async function a(r,t){let s=process.cwd(),o=e.join(s,r);if(console.log({target:o}),i(o)){if(!t.force){let r=`Refusing to overwrite existing "${e.relative(s,o)}" directory.\n`;throw r+="Please specify a different directory or use the `--force` flag.",new Error(r)}if(!o.startsWith(s))throw new Error("Refusing to manipulate the file system outside the PWD location.\nPlease specify a different target directory.");await f(o)}let a=!1,[l,n]=t._||[];if(console.log({source:l,filter:n}),!l)throw new Error("Missing source value(s).\nPlease view the `--help` text.");if(/^(https?|ftps?|file|git|ssh):\/\//.test(l))a=!0;else if(!n&&l.includes(":"))a=!0;else{if(l=l.toLowerCase(),!n)throw new Error("Missing filter");if(/^workers?/.test(l))n="workers/"+n;else{if("pages"!==l)throw new Error(`Invalid "${l}" source.`);n="pages/"+n}l="https://github.com/cloudflare/worker-examples.git"}return console.log({target:o,source:l,filter:n})}exports.setup=a;
+const t = require('fs');const { tmpdir:r } = require('os');const { promisify:i } = require('util');const { join:e, relative:s } = require('path');const { exec:o } = require('child_process');const n = require('semiver');var a=i(o),c=t.existsSync;async function f(r){c(r)&&t.promises.rm(r,{recursive:!0})}var u=(...t)=>a(`git ${t.join(" ")}`),l=()=>Math.random().toString(16).substring(2),p=t=>/^(https?|ftps?|file|git|ssh):\/\//.test(t)||t.includes(":");async function h(i,o,h){let g=process.cwd();p(i)&&([i,o]=[o,i]);let m=e(g,i);if(c(m)){if(!h.force){let t=`Refusing to overwrite existing "${s(g,m)}" directory.\n`;throw t+="Please specify a different directory or use the `--force` flag.",t}m.startsWith(g)&&await f(m)}let d="",w="";p(o)?d=o:(d="https://github.com/cloudflare/templates.git",w=o),await async function(i,s,o){let c=["clone --depth 1"],{source:p,filter:h}=i,g=s,m=!1;function d(t,r){if(o.debug&&r&&r instanceof Error){let i=r.stack||r.message;t+="\n"+(i.includes("\n")?i.replace(/(\r?\n)/g,"$1    "):i)}throw t}try{var{stdout:w}=await u("version")}catch(t){return d("Missing `git` executable",t)}let[y]=/\d+.\d+.\d+/.exec(w)||[];if(!y)throw"Unknown `git` version";h&&(m=-1!==n(y,"2.26.0"),g=e(r(),l()+"-"+l()),m&&c.push("--filter=blob:none --sparse"));let b=p.lastIndexOf("#");-1===b?c.push(p):(c.push(`-b ${p.substring(b+1)}`),c.push(p.substring(0,b)));try{c.push(g),await u(...c)}catch(t){return d(`Error cloning "${p}" repository`,t)}if(h){if(m)try{await a(`git sparse-checkout set "${h}"`,{cwd:g})}catch(t){return d(`Error with "${h}" checkout`,t)}await t.promises.rename(e(g,h),s),await f(g)}if(await f(e(s,".git")),o.init){c=["init"],b=n(y,"2.26.0"),-1!==b&&c.push("-b main");try{await u(...c,s)}catch(t){return d("Error initializing repository",t)}}}({source:d,filter:w},m,h),console.log("Done~!")}exports.setup=h;

package/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Luke Edwards <luke.edwards05@gmail.com> (lukeed.com)
+
+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.

package/package.json

@@ -1,8 +1,9 @@
 {
-  "version": "0.0.1",
+  "version": "0.0.4",
   "name": "create-cloudflare",
   "repository": "lukeed/create-cloudflare",
-  "description": "TODO",
+  "description": "Create new Cloudflare projects with one command",
+  "types": "index.d.ts",
   "license": "MIT",
   "bin": "bin.js",
   "author": {
@@ -13,7 +14,8 @@
   "exports": "./index.js",
   "files": [
     "bin.js",
-    "index.js"
+    "index.js",
+    "index.d.ts"
   ],
   "engines": {
     "node": ">=12"
@@ -24,11 +26,12 @@
   },
   "dependencies": {
     "kleur": "^4.0.0",
-    "mri": "^1.2.0"
+    "mri": "^1.2.0",
+    "semiver": "^1.1.0"
   },
   "devDependencies": {
-    "@types/node": "17.0.29",
-    "bundt": "2.0.0-next.2",
-    "typescript": "4.6.3"
+    "@types/node": "17.0.31",
+    "bundt": "2.0.0-next.5",
+    "typescript": "4.6.4"
   }
 }

package/readme.md

@@ -0,0 +1,72 @@
+# create-cloudflare [![CI](https://github.com/lukeed/create-cloudflare/workflows/CI/badge.svg)](https://github.com/lukeed/clsx/actions?query=workflow%3ACI)
+
+> Create new Cloudflare projects with one command
+
+## Usage
+
+You may use `yarn`, `pnpm`, or `npm` to invoke the [`create-cloudflare`](https://www.npmjs.com/package/create-cloudflare) package:
+
+
+```
+$ npm init cloudflare <directory> <source> -- [options]
+# or
+$ pnpm create cloudflare <directory> <source> [options]
+# or
+$ yarn create cloudflare <directory> <source> [options]
+```
+
+> **Note:** All recent versions of `npm`, `yarn`, and `pnpm` support this feature!
+
+
+### Sources
+
+You may select the name of any subdirectory within the [`cloudflare/templates`](https://github.com/cloudflare/templates) repository to create your project; for example, `worker-typescript` and `examples/fast-google-fonts` are both valid subdirectory names.
+
+You may also use any valid git repository address; for example:
+
+> **Note:** Optional segments are denoted within `[]` characters.
+
+- `[user@]host.xz:path/to/repo.git[#branch]`
+- `git://host.xz[:port]/path/to/repo.git[#branch]`
+- `ssh://[user@]host.xz[:port]/path/to/repo.git[#branch]`
+- `http[s]://host.xz[:port]/path/to/repo.git[#branch]`
+- `ftp[s]://host.xz[:port]/path/to/repo.git[#branch]`
+
+
+### Examples
+
+To create a `my-project` directory using the [`worker-typescript`](https://github.com/cloudflare/templates/tree/main/worker-typescript) template, you may run one of the following commands:
+
+```sh
+$ npm init cloudflare my-project worker-typescript
+# or
+$ yarn create cloudflare my-project worker-typescript
+# or
+$ pnpm create cloudflare my-project worker-typescript
+```
+
+Other examples include:
+
+```sh
+$ yarn create cloudflare my-project worker --force
+$ npm init cloudflare my-project worker-router -- --debug
+$ pnpm create cloudflare my-project https://github.com/user/repo.git#branch
+```
+
+
+### Options
+
+* `--force` — Allow target directory overwrite
+* `--no-init` — Do not initialize a git repository
+* `--debug` — Print additional error details
+* `--version` or `-v` — Displays current version
+* `--help` or `-h — Displays help text
+
+## Related
+
+- [`cloudflare/templates`](https://github.com/cloudflare/templates) - A collection of stater templates and examples for Cloudflare Workers and Pages
+
+
+## License
+
+MIT © [Luke Edwards](https://lukeed.com)