@quilted/create 0.1.68 → 0.1.70

package/source/cli.ts

@@ -5,7 +5,7 @@ import {AbortError, stripIndent, color, parseArguments} from '@quilted/cli-kit';
 import {printHelp} from './help.ts';
 import {prompt} from './shared.ts';
 
-const VALID_PROJECT_KINDS = new Set(['app', 'package', 'module']);
+const VALID_PROJECT_KINDS = new Set(['app', 'package', 'module', 'service']);
 
 run().catch((error) => {
   if (AbortError.test(error)) return;
@@ -59,6 +59,7 @@ async function run() {
         {title: 'App', value: 'app'},
         {title: 'Module', value: 'module'},
         {title: 'Package', value: 'package'},
+        {title: 'Backend service', value: 'service'},
       ],
     });
   }
@@ -79,5 +80,10 @@ async function run() {
       await createProject();
       break;
     }
+    case 'service': {
+      const {createService} = await import('./service.ts');
+      await createService();
+      break;
+    }
   }
 }

package/source/help.ts

@@ -5,7 +5,7 @@ export function printHelp({
   options: customOptions,
   packageManager,
 }: {
-  kind?: 'app' | 'package' | 'module';
+  kind?: 'app' | 'package' | 'module' | 'service';
   options?: string;
   packageManager?: string;
 } = {}) {

package/source/module.ts

@@ -60,7 +60,7 @@ export async function createModule() {
   const partOfMonorepo = inWorkspace || createAsMonorepo;
 
   const moduleDirectory = createAsMonorepo
-    ? path.join(directory, 'app')
+    ? path.join(directory, toValidPackageName(name))
     : directory;
 
   if (fs.existsSync(directory)) {
@@ -335,10 +335,16 @@ async function getEntry(argv: Arguments, {name}: {name: string}) {
     return argv['--entry'];
   }
 
+  const defaultEntry = `${toValidPackageName(name)}.ts`;
+
+  if (argv['--yes']) {
+    return defaultEntry;
+  }
+
   const entry = await prompt({
     type: 'text',
     message: 'What do you want to name your entry file?',
-    initial: `${toValidPackageName(name)}.ts`,
+    initial: defaultEntry,
   });
 
   return entry;

package/source/service.ts

@@ -0,0 +1,396 @@
+import * as fs from 'fs';
+import * as path from 'path';
+
+import arg from 'arg';
+import * as color from 'colorette';
+import {stripIndent} from 'common-tags';
+
+import {printHelp} from './help.ts';
+import {
+  format,
+  loadTemplate,
+  createOutputTarget,
+  isEmpty,
+  emptyDirectory,
+  toValidPackageName,
+  relativeDirectoryForDisplay,
+  mergeWorkspaceAndProjectPackageJsons,
+} from './shared.ts';
+import {
+  prompt,
+  getInWorkspace,
+  getCreateAsMonorepo,
+  getExtrasToSetup,
+  getPackageManager,
+  getShouldInstall,
+} from './shared/prompts.ts';
+import {addToTsConfig} from './shared/tsconfig.ts';
+import {addToPackageManagerWorkspaces} from './shared/package-manager.ts';
+
+type Arguments = ReturnType<typeof getArgv>;
+
+export async function createService() {
+  const argv = getArgv();
+
+  if (argv['--help']) {
+    printHelp({
+      kind: 'service',
+      packageManager: argv['--package-manager']?.toLowerCase(),
+    });
+    return;
+  }
+
+  const inWorkspace = await getInWorkspace(argv);
+  const name = await getName(argv);
+  const directory = await getDirectory(argv, {name});
+  const entry = await getEntry(argv, {name});
+
+  const createAsMonorepo =
+    !inWorkspace &&
+    (await getCreateAsMonorepo(argv, {
+      type: 'service',
+      default: false,
+    }));
+  const setupExtras = await getExtrasToSetup(argv, {inWorkspace});
+  const shouldInstall = await getShouldInstall(argv);
+  const packageManager = await getPackageManager(argv, {root: directory});
+
+  const partOfMonorepo = inWorkspace || createAsMonorepo;
+
+  const serviceDirectory = createAsMonorepo
+    ? path.join(directory, toValidPackageName(name))
+    : directory;
+
+  if (fs.existsSync(directory)) {
+    await emptyDirectory(directory);
+
+    if (serviceDirectory !== directory) {
+      fs.mkdirSync(serviceDirectory, {recursive: true});
+    }
+  } else {
+    fs.mkdirSync(serviceDirectory, {recursive: true});
+  }
+
+  const rootDirectory = inWorkspace ? process.cwd() : directory;
+  const outputRoot = createOutputTarget(rootDirectory);
+  const serviceTemplate = loadTemplate('service-basic');
+  const workspaceTemplate = loadTemplate('workspace');
+
+  // If we aren’t already in a workspace, copy the workspace files over, which
+  // are needed if we are making a monorepo or not.
+  if (!inWorkspace) {
+    await workspaceTemplate.copy(directory, (file) => {
+      // When this is a single project, we use the project’s Quilt  configuration as the base.
+      if (file === 'quilt.workspace.ts') return createAsMonorepo;
+
+      // We need to make some adjustments to the root package.json
+      if (file === 'package.json') return false;
+
+      return true;
+    });
+
+    // If we are creating a monorepo, we need to add the root package.json and
+    // package manager workspace configuration.
+    if (createAsMonorepo) {
+      const serviceRelativeToRoot = relativeDirectoryForDisplay(
+        path.relative(directory, serviceDirectory),
+      );
+
+      const workspacePackageJson = JSON.parse(
+        await workspaceTemplate.read('package.json'),
+      );
+
+      workspacePackageJson.name = toValidPackageName(name!);
+      workspacePackageJson.workspaces = [serviceRelativeToRoot, './packages/*'];
+
+      if (packageManager.type === 'pnpm') {
+        await outputRoot.write(
+          'pnpm-workspace.yaml',
+          await format(
+            `
+              packages:
+              - '${serviceRelativeToRoot}'
+              - './packages/*'
+            `,
+            {as: 'yaml'},
+          ),
+        );
+      }
+
+      await outputRoot.write(
+        'package.json',
+        await format(JSON.stringify(workspacePackageJson), {
+          as: 'json-stringify',
+        }),
+      );
+    } else {
+      const [projectPackageJson, projectTSConfig, workspacePackageJson] =
+        await Promise.all([
+          serviceTemplate
+            .read('package.json')
+            .then((content) => JSON.parse(content)),
+          serviceTemplate
+            .read('tsconfig.json')
+            .then((content) => JSON.parse(content)),
+          workspaceTemplate
+            .read('package.json')
+            .then((content) => JSON.parse(content)),
+        ]);
+
+      const combinedPackageJson = mergeWorkspaceAndProjectPackageJsons(
+        projectPackageJson,
+        workspacePackageJson,
+      );
+
+      adjustPackageJson(combinedPackageJson, {name, entry});
+      delete combinedPackageJson.workspaces;
+
+      let quiltProject = await serviceTemplate.read('quilt.project.ts');
+      quiltProject = quiltProject
+        .replace('quiltService', 'quiltWorkspace, quiltService')
+        .replace('quiltService(', 'quiltWorkspace(), quiltService(')
+        .replace('service.ts', entry.replace(/^\.[/]/, ''));
+
+      await outputRoot.write(
+        'quilt.project.ts',
+        await format(quiltProject, {as: 'typescript'}),
+      );
+
+      await outputRoot.write(
+        'package.json',
+        await format(JSON.stringify(combinedPackageJson), {
+          as: 'json-stringify',
+        }),
+      );
+
+      await outputRoot.write(
+        'tsconfig.json',
+        await format(JSON.stringify(projectTSConfig), {as: 'json'}),
+      );
+    }
+
+    if (setupExtras.has('github')) {
+      await loadTemplate('github').copy(directory);
+    }
+
+    if (setupExtras.has('vscode')) {
+      await loadTemplate('vscode').copy(directory);
+    }
+  }
+
+  await serviceTemplate.copy(serviceDirectory, (file) => {
+    // If we are in a monorepo, we can use all the template files as they are
+    if (file === 'tsconfig.json') {
+      return partOfMonorepo;
+    }
+
+    // We will adjust the entry file and quilt project file
+    if (file === 'service.ts' || file === 'quilt.project.ts') {
+      return false;
+    }
+
+    // We need to make some adjustments the project’s package.json
+    return file !== 'package.json';
+  });
+
+  await outputRoot.write(
+    path.join(serviceDirectory, entry),
+    await serviceTemplate.read('service.ts'),
+  );
+
+  let quiltProject = await serviceTemplate.read('quilt.project.ts');
+  quiltProject = quiltProject.replace(
+    'service.ts',
+    entry.replace(/^\.[/]/, ''),
+  );
+
+  await outputRoot.write(
+    path.join(serviceDirectory, 'quilt.project.ts'),
+    await format(quiltProject, {as: 'typescript'}),
+  );
+
+  if (partOfMonorepo) {
+    // Write the app’s package.json (the root one was already created)
+    const projectPackageJson = JSON.parse(
+      await serviceTemplate.read('package.json'),
+    );
+
+    adjustPackageJson(projectPackageJson, {name, entry});
+
+    await outputRoot.write(
+      path.join(serviceDirectory, 'package.json'),
+      await format(JSON.stringify(projectPackageJson), {
+        as: 'json-stringify',
+      }),
+    );
+
+    await Promise.all([
+      addToTsConfig(serviceDirectory, outputRoot),
+      addToPackageManagerWorkspaces(
+        serviceDirectory,
+        outputRoot,
+        packageManager.type,
+      ),
+    ]);
+  }
+
+  if (shouldInstall) {
+    console.log();
+    // TODO: better loading, handle errors
+    await packageManager.install();
+  }
+
+  const commands: string[] = [];
+
+  if (!inWorkspace && directory !== process.cwd()) {
+    commands.push(
+      `cd ${color.cyan(
+        relativeDirectoryForDisplay(path.relative(process.cwd(), directory)),
+      )} ${color.dim('# Move into your new service’s directory')}`,
+    );
+  }
+
+  if (!shouldInstall) {
+    commands.push(
+      `${packageManager.commands.install()} ${color.dim(
+        '# Install all your dependencies',
+      )}`,
+    );
+  }
+
+  if (commands.length === 0) {
+    console.log();
+    console.log('Your new service is ready to go!');
+  } else {
+    const whatsNext = stripIndent`
+      Your new service is ready to go! There’s just ${
+        commands.length > 1 ? 'a few more steps' : 'one more step'
+      } you’ll need to take
+      in order to start developing:
+    `;
+
+    console.log();
+    console.log(whatsNext);
+    console.log();
+    console.log(commands.map((command) => `  ${command}`).join('\n'));
+  }
+
+  const followUp = stripIndent`
+    Quilt can also help you build, develop, test, lint, and type-check your new service.
+    You can learn more about building services with Quilt by reading the documentation:
+    ${color.underline(
+      color.magenta(
+        'https://github.com/lemonmade/quilt/tree/main/documentation',
+      ),
+    )}
+
+    Have fun! 🎉
+  `;
+
+  console.log();
+  console.log(followUp);
+}
+
+// Argument handling
+
+function getArgv() {
+  const argv = arg(
+    {
+      '--yes': Boolean,
+      '-y': '--yes',
+      '--name': String,
+      '--directory': String,
+      '--entry': String,
+      '--install': Boolean,
+      '--no-install': Boolean,
+      '--monorepo': Boolean,
+      '--no-monorepo': Boolean,
+      '--package-manager': String,
+      '--extras': [String],
+      '--no-extras': Boolean,
+      '--help': Boolean,
+      '-h': '--help',
+    },
+    {permissive: true},
+  );
+
+  return argv;
+}
+
+async function getName(argv: Arguments) {
+  let {'--name': name} = argv;
+
+  if (name == null) {
+    name = await prompt({
+      type: 'text',
+      message: 'What would you like to name your new service?',
+      initial: 'my-service',
+    });
+  }
+
+  return name!;
+}
+
+async function getEntry(argv: Arguments, {name}: {name: string}) {
+  if (argv['--entry']) {
+    return argv['--entry'];
+  }
+
+  const defaultEntry = `${toValidPackageName(name)}.ts`;
+
+  const entry = await prompt({
+    type: 'text',
+    message: 'What do you want to name your entry file?',
+    initial: defaultEntry,
+  });
+
+  return entry;
+}
+
+async function getDirectory(argv: Arguments, {name}: {name: string}) {
+  let directory = path.resolve(
+    argv['--directory'] ?? toValidPackageName(name!),
+  );
+
+  while (!argv['--yes']) {
+    if (fs.existsSync(directory) && !(await isEmpty(directory))) {
+      const relativeDirectory = path.relative(process.cwd(), directory);
+
+      const empty = await prompt({
+        type: 'confirm',
+        message: `Directory ${color.bold(
+          relativeDirectoryForDisplay(relativeDirectory),
+        )} is not empty, is it safe to empty it?`,
+        initial: true,
+      });
+
+      if (empty) break;
+
+      const promptDirectory = await prompt({
+        type: 'text',
+        message: 'What directory do you want to create your new service in?',
+      });
+
+      directory = path.resolve(promptDirectory);
+    } else {
+      break;
+    }
+  }
+
+  return directory;
+}
+
+function adjustPackageJson(
+  packageJson: Record<string, any>,
+  {
+    name,
+  }: {
+    name: string;
+    entry: string;
+  },
+) {
+  packageJson.name = name;
+  packageJson.main = `./build/runtime/runtime.js`;
+
+  return packageJson;
+}

package/source/shared/prompts.ts

@@ -35,7 +35,7 @@ export async function getCreateAsMonorepo(
   {
     type,
     default: defaultCreateAsMonorepo = true,
-  }: {type: 'app' | 'package' | 'module'; default?: boolean},
+  }: {type: 'app' | 'package' | 'module' | 'service'; default?: boolean},
 ) {
   let createAsMonorepo: boolean;
 

package/source/shared.ts

@@ -13,6 +13,7 @@ export function loadTemplate(
     | 'app-graphql'
     | 'app-trpc'
     | 'module'
+    | 'service-basic'
     | 'workspace'
     | 'github'
     | 'vscode',
@@ -84,6 +85,7 @@ async function templateDirectory(
     | 'app-graphql'
     | 'app-trpc'
     | 'module'
+    | 'service-basic'
     | 'workspace'
     | 'github'
     | 'vscode',

package/templates/service-basic/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "template-service-basic",
+  "version": "0.0.0",
+  "type": "module",
+  "private": true,
+  "devDependencies": {
+    "@quilted/quilt": "^0.5.0"
+  },
+  "eslintConfig": {
+    "extends": "@quilted/eslint-config/project"
+  }
+}

package/templates/service-basic/quilt.project.ts

@@ -0,0 +1,9 @@
+import {createProject, quiltService} from '@quilted/craft';
+
+export default createProject((project) => {
+  project.use(
+    quiltService({
+      entry: './service.ts',
+    }),
+  );
+});

package/templates/service-basic/service.ts

@@ -0,0 +1,7 @@
+import {createRequestRouter} from '@quilted/quilt/request-router';
+
+const app = createRequestRouter();
+
+app.get('/', () => new Response('Hello, world!'));
+
+export default app;

package/templates/service-basic/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "@quilted/typescript/project.json",
+  "compilerOptions": {
+    "outDir": "build/typescript"
+  },
+  "include": ["**/*"],
+  "exclude": ["build"],
+  "references": []
+}