wrangler 0.0.2 → 0.0.6

package/README.md

@@ -1,55 +1,51 @@
-# Wrangler
-`Wrangler` is a very small CommonJS module that smoothes over some of the gotchas in JavaScript type checking and casting. It behaves the way you (or rather, I) would expect type checking and casting to work -- e.g., `is.object()` only works on objects that are neither arrays nor regular expressions. It also makes `indexOf()` easier to use, and provides search functions. Works in Node; should work in browser as well, exporting the objects `is` and `to` into the global namespace.
-
-None of these techniques are earth-shattering; most people will use these in their daily work. I just didn't want to have to remember all of them while I was banging out code.
-
-Test coverage is as thorough as my imagination allows. I used Jasmine for unit testing.
-
-## API
-
-### Type checking
-
-All checking is strict, unless otherwise noted. Each function returns either true or false.
-
-* `is.undefined( value )`
-* `is.null( value )`
-* `is.empty( value )` - checks for null or undefined
-* `is.empty.array( value )` or `is.emptyArray( value )` - must be an array-like object and have no items
-* `is.empty.arguments( value )` or `is.emptyArguments( value )` - identical to above
-* `is.empty.object( value )` or `is.emptyObject( value )` - must be an object and have no properties of its own; objects with properties in their prototype chains will also fail
-* `is.null( value )`
-* `is.boolean( value )`
-* `is.nan( value )` - really not necessary, since it merely calls `isNan()`. But I just included it to be thorough.
-* `is.infinite( value )` - opposite of `isFinite()`. I didn't include an `isFinite()` function because `is.number()` performs this check.
-* `is.number( value )` - includes all the sensible numbers (e.g., not `NaN` or `Infinity`).
-* `is.integer( value )` - we all know JavaScript doesn't have integers or floats, so this fills half that gap.
-* `is.float( value )` - and this fills the other half of the gap.
-* `is.string( value )`
-* `is.object( value )` - anything considered to be an object, except `null`, regular expressions, arrays, or array-like objects. Functions are considered objects, of course.
-* `is.array( value )` - any good old honest 'true' array.
-* `is.enumerable( value )` - arrays, array-like objects, and strings. Anything that can be iterated upon. (Yes, that does include strings!)
-* `is.arrayLike( value )` - array-like objects (but not arrays).
-* `is.arguments( value )` - the `arguments` array-like object.
-* `is.function( value )`
-* `is.regexp( value )`
-* `is.in( needle [, haystack] )` - takes a needle and performs a strict search on the haystack. If the haystack is not supplied, `this` is assumed as the haystack. The haystack can be an object, array-like object, or string. In case of objects, only the self-owned, direct descendants are searched.
-* `is.in.array( needle [, haystack] )` or `is.inArray( needle [, haystack] )` - works on array-like objects only.
-* `is.in.object( needle [, haystack] )` or `is.inObject( needle [, haystack] )` - works only on haystacks that pass the `is.object()` test.
-* `is.in.string( needle [, haystack] )` or `is.inString( needle [, haystack] )` - string search; converts non-strings to strings.
-* `is.ownProperty( property [, object] )` - calls `Object.prototype.hasOwnProperty()` on the object. If the object is not supplied, `this` is assumed.
-
-### Type casting
-
-* `to.boolean( value )`
-* `to.number( value )` or `to.float( value )` - calls `parseFloat()` on the value; therefore, it may return `NaN`.
-* `to.integer( value )` - returns the integral part of the value. Acts as floor for positive numbers and ceiling for negative integers.
-* `to.string( value )`
-* `to.array( value )` - casts array-like objects to arrays and everything else to an array containing a single element, which happens to be the passed value.
-* `to.regexp( value )` - if the value is a string, returns a regular expression using the `new RegExp()` constructor. Returns `undefined` if the value is not a string.
-* `to.date( value )` - returns a new date object using the `new Date()` constructor.
-
-More typecasting to follow, as I think of cases that need it!
-
-## The other `is`
-
-Note: This is not the same as the `is` by Enrico Marino, which is another interesting JavaScript type checking library. He uses some neat techniques, and also adds functions for comparison (e.g., `is.gt()`, `is.odd()`, `is.divisibleBy()`) which I had no interest in. You can find his library at https://github.com/onirame/is
+## 🤠 wrangler
+
+`wrangler` is a command line tool for building [Cloudflare Workers](https://workers.cloudflare.com/).
+
+[(Read the full stack week launch blog post.)](https://blog.cloudflare.com/wrangler-v2-beta/)
+
+**DISCLAIMER**: This is a work in progress, and is NOT recommended for use in production. We are opening this preview for feedback from the community, and to openly share our [roadmap](https://github.com/cloudflare/wrangler2/issues/12) for the future. As such, expect APIs and documentation to change before the end of the preview.
+
+Further, we will NOT do a general release until we are both feature complete, and have a full backward compatibility and incremental migration plan in place. For more details, follow the [parent roadmap issue](https://github.com/cloudflare/wrangler2/issues/12).
+
+## Quick Start
+
+```bash
+# Make a javascript file
+$ echo "export default { fetch() { return new Response('hello world') } }" > index.js
+# try it out
+$ npx wrangler@beta dev index.js
+# and then publish it
+$ npx wrangler@beta publish index.js --name my-worker
+# visit https://my-worker.<your workers subdomain>.workers.dev
+```
+
+## Installation:
+
+```bash
+$ npm install wrangler@beta
+```
+
+## Commands
+
+### `wrangler init [name]`
+
+Creates a `wrangler.toml` configuration file. For more details on the configuration keys and values, refer to the [documentation](https://developers.cloudflare.com/workers/cli-wrangler/configuration).
+
+### `wrangler dev [script]`
+
+Start a local development server, with live reloading and devtools.
+
+### `wrangler publish [script] --name [name]`
+
+Publish the given script to the worldwide Cloudflare network.
+
+For more commands and options, refer to the [documentation](https://developers.cloudflare.com/workers/cli-wrangler/commands).
+
+### `wrangler pages dev [directory] [-- command]`
+
+Either serves a static build asset directory, or proxies itself in front of a command.
+
+Builds and runs functions from a `./functions` directory or uses a `_worker.js` file inside the static build asset directory.
+
+For more commands and options, refer to the [documentation](https://developers.cloudflare.com/pages/platform/functions#develop-and-preview-locally) or run `wrangler pages dev --help`.

package/bin/wrangler.js

@@ -0,0 +1,36 @@
+#!/usr/bin/env node
+const { spawn } = require("child_process");
+const { join } = require("path");
+const semiver = require("semiver");
+
+const MIN_NODE_VERSION = "16.7.0";
+
+async function main() {
+  if (semiver(process.versions.node, MIN_NODE_VERSION) < 0) {
+    // Note Volta and nvm are also recommended in the official docs:
+    // https://developers.cloudflare.com/workers/get-started/guide#2-install-the-workers-cli
+    console.error(
+      `Wrangler requires at least Node.js v${MIN_NODE_VERSION}. You are using v${process.versions.node}.
+You should use the latest Node.js version if possible, as Cloudflare Workers use a very up-to-date version of V8.
+Consider using a Node.js version manager such as https://volta.sh/ or https://github.com/nvm-sh/nvm.`
+    );
+    process.exitCode = 1;
+    return;
+  }
+
+  spawn(
+    process.execPath,
+    [
+      "--no-warnings",
+      "--experimental-vm-modules",
+      ...process.execArgv,
+      join(__dirname, "../wrangler-dist/cli.js"),
+      ...process.argv.slice(2),
+    ],
+    { stdio: "inherit" }
+  ).on("exit", (code) =>
+    process.exit(code === undefined || code === null ? 0 : code)
+  );
+}
+
+void main();

package/import_meta_url.js

@@ -0,0 +1,3 @@
+// as per https://github.com/evanw/esbuild/issues/1492
+// to make some libs work
+export const import_meta_url = require("url").pathToFileURL(__filename);

package/miniflare-config-stubs/package.empty.json

@@ -0,0 +1 @@
+{}

package/package.json

@@ -1,16 +1,118 @@
 {
-  "author": "Paul d'Aoust <paul@heliosstudio.ca> (http://heliosstudio.ca/)",
   "name": "wrangler",
-  "description": "'Wrangler' is a very small module that smoothes over some of the gotchas in JavaScript type checking and casting. It behaves the way you (or perhaps just I) would expect type checking to work -- e.g., is.object() only works on objects that are neither arrays nor regular expressions. It also makes indexOf() easier to use, and provides search functions. Works in Node; should work in browser as well, exporting a variable 'is' into the global namespace.",
-  "version": "0.0.2",
-  "main": "index.js",
+  "version": "0.0.6",
+  "author": "wrangler@cloudflare.com",
+  "description": "Command-line interface for all things Cloudflare Workers",
+  "bin": {
+    "wrangler": "./bin/wrangler.js",
+    "wrangler2": "./bin/wrangler.js"
+  },
+  "license": "MIT OR Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/cloudflare/wrangler/issues"
+  },
+  "homepage": "https://github.com/cloudflare/wrangler#readme",
+  "keywords": [
+    "wrangler",
+    "cloudflare",
+    "workers",
+    "cloudflare workers",
+    "edge",
+    "compute",
+    "serverless",
+    "serverless application",
+    "serverless module",
+    "wasm",
+    "web",
+    "assembly",
+    "webassembly",
+    "rust",
+    "emscripten",
+    "rust",
+    "typescript",
+    "graphql",
+    "router",
+    "http",
+    "cli"
+  ],
+  "dependencies": {
+    "@cloudflare/pages-functions-compiler": "0.3.8",
+    "esbuild": "0.14.1",
+    "miniflare": "2.0.0-rc.4",
+    "semiver": "^1.1.0"
+  },
+  "optionalDependencies": {
+    "fsevents": "~2.3.2"
+  },
+  "devDependencies": {
+    "@iarna/toml": "^2.2.5",
+    "@types/react": "^17.0.37",
+    "@types/serve-static": "^1.13.10",
+    "@types/signal-exit": "^3.0.1",
+    "@types/ws": "^8.2.1",
+    "@types/yargs": "^17.0.7",
+    "chokidar": "^3.5.2",
+    "clipboardy": "^3.0.0",
+    "command-exists": "^1.2.9",
+    "execa": "^6.0.0",
+    "faye-websocket": "^0.11.4",
+    "finalhandler": "^1.1.2",
+    "find-up": "^6.2.0",
+    "formdata-node": "^4.3.1",
+    "ink": "^3.2.0",
+    "ink-select-input": "^4.2.1",
+    "ink-table": "^3.0.0",
+    "ink-text-input": "^4.0.2",
+    "node-fetch": "^3.1.0",
+    "open": "^8.4.0",
+    "path-to-regexp": "^6.2.0",
+    "react": "^17.0.2",
+    "react-error-boundary": "^3.1.4",
+    "serve-static": "^1.14.1",
+    "signal-exit": "^3.0.6",
+    "tmp-promise": "^3.0.3",
+    "undici": "^4.11.1",
+    "ws": "^8.3.0",
+    "yargs": "^17.3.0"
+  },
+  "files": [
+    "src",
+    "bin",
+    "miniflare-config-stubs",
+    "wrangler-dist",
+    "static-asset-facade.js",
+    "vendor",
+    "import_meta_url.js"
+  ],
   "scripts": {
-    "test": "jasmine-node tests/*.spec.js"
+    "clean": "rm -rf wrangler-dist",
+    "bundle": "node -r esbuild-register scripts/bundle.ts",
+    "build": "npm run clean && npm run bundle",
+    "start": "npm run bundle && NODE_OPTIONS=--enable-source-maps ./bin/wrangler.js",
+    "test": "CF_API_TOKEN=some-api-token CF_ACCOUNT_ID=some-account-id jest --silent=false --verbose=true"
   },
-  "dependencies": {},
-  "devDependencies": {},
-  "optionalDependencies": {},
   "engines": {
-    "node": "*"
+    "node": ">=16.7.0"
+  },
+  "jest": {
+    "restoreMocks": true,
+    "testRegex": ".*.(test|spec)\\.[jt]sx?$",
+    "transformIgnorePatterns": [
+      "node_modules/(?!node-fetch|fetch-blob|find-up|locate-path|p-locate|p-limit|yocto-queue|path-exists|data-uri-to-buffer|formdata-polyfill|execa|strip-final-newline|npm-run-path|path-key|onetime|mimic-fn|human-signals|is-stream)"
+    ],
+    "moduleNameMapper": {
+      "clipboardy": "<rootDir>/src/__tests__/clipboardy-mock.js"
+    },
+    "transform": {
+      "^.+\\.c?(t|j)sx?$": [
+        "esbuild-jest",
+        {
+          "sourcemap": true
+        }
+      ]
+    },
+    "setupFilesAfterEnv": [
+      "<rootDir>/src/__tests__/jest.setup.ts"
+    ]
   }
 }

package/src/__tests__/clipboardy-mock.js

@@ -0,0 +1,4 @@
+// We use this mock during tests because we're having trouble
+// properly compiling clipboardy for jest
+// We can revisit this if and when we write tests that test
+// the copying part of `dev`