Add run command (#373)

Author: lemonmade

.changeset/flat-gorillas-grab.md

@@ -0,0 +1,7 @@
+---
+'@quilted/craft': patch
+'@quilted/create': patch
+'@quilted/sewing-kit': patch
+---
+
+Add quilt run command

.gitignore

@@ -5,3 +5,4 @@ node_modules/
 packages/*/bin/
 *.log
 tests/e2e/output/
+coverage

.vscode/settings.json

@@ -27,5 +27,5 @@
     "**/build": true
   },
   "typescript.tsdk": "node_modules/typescript/lib",
-  "jest.jestCommandLine": "./node_modules/@quilted/craft/node_modules/.bin/jest --config ./.quilt/temp/jest/config.mjs"
+  "jest.jestCommandLine": "node ./scripts/quilt-from-source.js run jest"
 }

documentation/cli/run.md

@@ -0,0 +1,87 @@
+# `quilt run`
+
+The `quilt run` command allows you to run some tools that are packaged with [Craft](../craft.md), Quilt’s optional development tool. Using `quilt run` is an alternative to using the `quilt` `test`, `type-check`, and `lint` commands, which automatically run theQuilt’s preferred set of [tools](TODO) that are relevant for a given development task. `quilt run` allows you to use the underlying tools more directly, while still benefitting from Craft’s smart defaults (and its [plugin-based configuration system](../craft.md#configuring-hooks)).
+
+To use `quilt run`, you must provide an additional argument: the name of the tool to run. The following tools can be run directly using `quilt run`:
+
+- [TypeScript](TODO), using [`quilt run typescript` or `quilt run tsc`](#quilt-run-typescript)
+- [Jest](TODO), using [`quilt run jest`](#quilt-run-jest)
+- [ESLint](TODO), using [`quilt run eslint`](#quilt-run-eslint)
+- [Prettier](TODO), using [`quilt run prettier`](#quilt-run-prettier)
+
+## `quilt run typescript`
+
+`quilt run typescript` (aliased as `quilt run tsc`) allows you to run the TypeScript compiler, `tsc`. You can pass this command any of the [flags accepted by the `tsc` executable](https://www.typescriptlang.org/docs/handbook/compiler-options.html):
+
+```sh
+# Run TypeScript in watch mode
+pnpm exec quilt run typescript --watch
+```
+
+By default, this command will run `tsc` with the [`--build` flag, which enables Project References](https://www.typescriptlang.org/docs/handbook/project-references.html). This matches the default way Quilt runs `tsc` when you use the [`quilt type-check` command](TODO). To disable this behavior, pass a `--no-build` flag to this command:
+
+```sh
+pnpm exec quilt run typescript --no-build
+```
+
+## `quilt run jest`
+
+`quilt run jest` allows you to run the Jest test runner. You can pass this command any of the [flags accepted by the `jest` executable](https://jestjs.io/docs/cli):
+
+```sh
+# Run Jest on test files matching /app/, with test coverage enabled,
+# and without tests being able to print to the console
+pnpm exec quilt run jest app --silent --coverage
+```
+
+Unlike when running the [`quilt test` command](TODO), Using `quilt run jest` does not automatically run Jest in watch mode. To enable watch mode, you must run this command with the [`--watch`](https://jestjs.io/docs/cli#--watch) or [`--watchAll`](https://jestjs.io/docs/cli#--watchall) Jest flags:
+
+```sh
+pnpm exec quilt run jest --watch
+```
+
+## `quilt run eslint`
+
+`quilt run eslint` allows you to run the ESLint linter. You can pass this command any of the [flags accepted by the `eslint` executable](https://eslint.org/docs/latest/user-guide/command-line-interface):
+
+```sh
+# Run `eslint` with a dry run of fixable errors
+pnpm exec quilt run eslint --fix-dry-run
+```
+
+By default, this command runs on the entire contents of the directory you run this command from, just like when running [`quilt lint`](TODO). You can run ESLint on only a subset of your project by passing additional positional arguments:
+
+```sh
+# Run `eslint` on the ./app directory, relative to where you are running this command
+pnpm exec quilt run eslint ./app
+```
+
+This command runs on JavaScript and TypeScript files, using the same configurable hooks as `quilt lint`. You can run ESLint on a different set of extensions by explicitly passing the [ESLint `--ext` flag](https://eslint.org/docs/latest/user-guide/command-line-interface#--ext):
+
+```sh
+# Run `eslint` only on JavaScript files
+pnpm exec quilt run eslint --ext .js
+```
+
+Like `quilt lint`, this command defaults to running with ESLint’s [cache enabled](https://eslint.org/docs/latest/user-guide/command-line-interface#--cache). To disable this behavior, pass a `--no-cache` flag:
+
+```sh
+# Run `eslint` without cache
+pnpm exec quilt run eslint --no-cache
+```
+
+## `quilt run prettier`
+
+`quilt run prettier` allows you to run the Prettier linter. You can pass this command any of the [flags accepted by the `prettier` executable](https://prettier.io/docs/en/cli.html):
+
+```sh
+# Run `prettier`, preferring single quotes over double quotes
+pnpm exec quilt run prettier --single-quote
+```
+
+By default, this command runs on a set of extensions that includes all the file types [Prettier is able to format](https://prettier.io/docs/en/index.html), except for JavaScript and TypeScript files, which are assumed to be run Prettier through ESLint. You can customize the files that will be checked with prettier by passing an explicit glob pattern to this command:
+
+```sh
+# Run `prettier` on GraphQL files in the app directory.
+pnpm exec quilt run prettier "./app/**/*.graphql"
+```

package.json

@@ -8,6 +8,7 @@
     "node": ">=14.0.0"
   },
   "scripts": {
+    "quilt-from-source": "node ./scripts/quilt-from-source.js",
     "create": "node --no-warnings --experimental-specifier-resolution=node --loader ./scripts/esbuild-module-loader.js ./packages/create/source/index.ts",
     "test": "node ./scripts/quilt-from-source.js test",
     "test:unit": "node ./scripts/quilt-from-source.js test --exclude-pattern tests/e2e",

packages/craft/source/cli/cli.ts

@@ -1,12 +1,15 @@
+import arg from 'arg';
 import {Task} from '../kit';
 
 run();
 
 async function run() {
   const [, , ...args] = process.argv;
-  const [task, ...argv] = args;
+  const {
+    _: [command, ...argv],
+  } = arg({}, {argv: args, stopAtPositional: true});
 
-  if (!task) {
+  if (!command) {
     // eslint-disable-next-line no-console
     console.log(
       `You must run quilt with one of the following commands: build, develop, lint, test, or type-check.`,
@@ -15,7 +18,7 @@ async function run() {
     return;
   }
 
-  switch (task.toLowerCase()) {
+  switch (command.toLowerCase()) {
     case Task.Build: {
       const {build} = await import('./tasks/build');
       await build(argv);
@@ -41,9 +44,14 @@ async function run() {
       await typeCheck(argv);
       break;
     }
+    case 'run': {
+      const {run} = await import('./tasks/run');
+      await run(argv);
+      break;
+    }
     default: {
       // eslint-disable-next-line no-console
-      console.log(`Task not found: ${task} (${argv.join(' ')})`);
+      console.log(`Command not found: ${command} (${argv.join(' ')})`);
       process.exitCode = 1;
     }
   }