@quilted/create 0.1.12 → 0.1.15

package/source/create.ts

@@ -1,420 +1,80 @@
 /* eslint no-console: off */
 
-import * as fs from 'fs';
-import * as path from 'path';
-import {EOL} from 'os';
-import {fileURLToPath} from 'url';
-
-import prompts from 'prompts';
-import type {Answers} from 'prompts';
 import arg from 'arg';
 import * as color from 'colorette';
-import {packageDirectory} from 'pkg-dir';
+import {stripIndent} from 'common-tags';
+import {AbortError} from '@quilted/events';
 
-class CancellationError extends Error {}
+import {printHelp} from './help';
+import {prompt} from './shared';
 
-const argv = arg({});
-const cwd = process.cwd();
+const VALID_PROJECT_KINDS = new Set(['app', 'package']);
 
 run().catch((error) => {
+  if (AbortError.test(error)) return;
+
   console.error(error);
   process.exitCode = 1;
 });
 
 async function run() {
-  const create = argv._[0];
-
-  if (!create) {
-    if (fs.existsSync('quilt.workspace.ts')) {
-      await createProject();
-    } else {
-      await createWorkspace();
-    }
-
-    return;
-  }
+  const permissiveArgs = arg(
+    {'--help': Boolean, '-h': '--help', '--package-manager': String},
+    {permissive: true},
+  );
 
-  switch (create) {
-    case 'workspace': {
-      await createWorkspace(argv._[1]);
-      break;
-    }
-    case 'package': {
-      await createPackage(argv._[1]);
-      break;
-    }
-    case 'app': {
-      await createApp();
-      break;
-    }
-    default: {
-      throw new Error(`Unknown argument: ${create}`);
-    }
-  }
-}
+  const firstArgument = permissiveArgs._[0]?.toLowerCase();
 
-async function createWorkspace(explicitName?: string) {
-  if (fs.existsSync('quilt.workspace.ts')) {
-    console.log(`\nYou’re already in a Quilt workspace!`);
-    console.log();
-    console.log(`Run one of the following to add projects to your workspace:`);
-    console.log(`  pnpm create @quilted app # create a new app`);
-    console.log(`  pnpm create @quilted package # create a new package`);
+  if (
+    firstArgument != null &&
+    !firstArgument.startsWith('-') &&
+    !VALID_PROJECT_KINDS.has(firstArgument)
+  ) {
+    // TODO: show help with error message
+    process.exitCode = 1;
     return;
   }
 
-  let targetDirectory = explicitName;
-  const defaultName = targetDirectory || 'my-project';
-
-  let result: Answers<'name' | 'overwrite'>;
-
-  try {
-    result = await prompts<'name' | 'overwrite'>(
-      [
-        {
-          type: targetDirectory ? null : 'text',
-          name: 'name',
-          message: 'What would you like to name this workspace?',
-          initial: defaultName,
-          onState: (state) => {
-            targetDirectory = state.value.trim() || defaultName;
-          },
-        },
-        {
-          type: () =>
-            !fs.existsSync(targetDirectory!) || isEmpty(targetDirectory!)
-              ? (null as any)
-              : 'confirm',
-          name: 'overwrite',
-          message: () =>
-            `Target directory (${
-              targetDirectory === '.' ? 'current directory' : targetDirectory
-            }) is not empty. Remove existing files and continue?`,
-          onState: (overwrite: boolean) => {
-            if (overwrite === false) {
-              throw new CancellationError();
-            }
-          },
-        },
-      ],
-      {
-        onCancel: () => {
-          throw new CancellationError();
-        },
-      },
-    );
-  } catch (cancelled) {
-    if (cancelled instanceof CancellationError) return;
-    throw cancelled;
-  }
-
-  const {overwrite} = result;
-  const root = path.join(cwd, targetDirectory!);
-  const packageName = toValidPackageName(targetDirectory!);
+  let kind =
+    firstArgument == null || !VALID_PROJECT_KINDS.has(firstArgument)
+      ? undefined
+      : firstArgument;
 
-  if (overwrite) {
-    emptyDirectory(root);
-  } else if (!fs.existsSync(root)) {
-    fs.mkdirSync(root, {recursive: true});
-  }
-
-  console.log(
-    `\nCreating Quilt workspace in ${color.cyan(path.relative(cwd, root))}...`,
-  );
+  const header = stripIndent`
+      🧵 ${color.bold('quilt create')}
+    `;
 
-  const templateRoot = await templateDirectory('workspace');
-  const template = createTemplateFileSystem(templateRoot, root);
-
-  for (const file of template.files()) {
-    if (file === 'package.json') {
-      const packageJson = JSON.parse(template.read(file));
-      packageJson.name = packageName;
-      template.write(file, JSON.stringify(packageJson, null, 2) + EOL);
-      continue;
-    }
-
-    template.copy(file);
-  }
-
-  console.log(`\nDone! Here’s what you’ll need to do next:\n`);
+  console.log(header);
   console.log();
-  if (root !== cwd) {
-    console.log(`  cd ${path.relative(cwd, root)}`);
+
+  if (permissiveArgs['--help'] && !kind) {
+    printHelp({
+      packageManager: permissiveArgs['--package-manager']?.toLowerCase(),
+    });
+    return;
   }
-  console.log(`  pnpm install # install dependencies`);
-  console.log(
-    `  git init && git add --all && git commit --message "Initial commit" # start your git history`,
-  );
-  console.log(
-    `  pnpm create @quilted app # create an app in your workspace, or`,
-  );
-  console.log(
-    `  pnpm create @quilted package # create a package in your workspace`,
-  );
-  console.log();
-}
 
-async function createProject() {
-  const result = await prompts<'type'>([
-    {
+  if (kind == null) {
+    kind = await prompt({
       type: 'select',
-      name: 'type',
       message: 'What kind of project would you like to create?',
       choices: [
         {title: 'App', value: 'app'},
         {title: 'Package', value: 'package'},
       ],
-    },
-  ]);
+    });
+  }
 
-  switch (result.type) {
-    case 'package': {
-      await createPackage();
-      break;
-    }
+  switch (kind) {
     case 'app': {
+      const {createApp} = await import('./app');
       await createApp();
       break;
     }
-  }
-}
-
-async function createPackage(explicitName?: string) {
-  let name!: string;
-  let scope: string | undefined;
-  let targetDirectory!: string;
-
-  let result: Answers<'name' | 'overwrite'>;
-
-  try {
-    result = await prompts<'name' | 'overwrite'>(
-      [
-        {
-          type: 'text',
-          name: 'name',
-          message: 'What would you like to name this package?',
-          initial: toValidPackageName(explicitName ?? ''),
-          onState: (state) => {
-            name = toValidPackageName(state.value);
-            scope = name.match(/^@[^/]+/)?.[0] ?? undefined;
-            targetDirectory = path.join(
-              'packages',
-              scope ? name.replace(`${scope}/`, '') : name,
-            );
-          },
-        },
-        {
-          type: () =>
-            !fs.existsSync(targetDirectory!) || isEmpty(targetDirectory!)
-              ? (null as any)
-              : 'confirm',
-          name: 'overwrite',
-          message: () =>
-            `Target directory (${targetDirectory}) is not empty. Remove existing files and continue?`,
-          onState: (overwrite: boolean) => {
-            if (overwrite === false) {
-              throw new CancellationError();
-            }
-          },
-        },
-      ],
-      {
-        onCancel: () => {
-          throw new CancellationError();
-        },
-      },
-    );
-  } catch (cancelled) {
-    if (cancelled instanceof CancellationError) return;
-    throw cancelled;
-  }
-
-  const {overwrite} = result;
-
-  const root = path.join(cwd, targetDirectory!);
-
-  if (overwrite) {
-    emptyDirectory(root);
-  } else if (!fs.existsSync(root)) {
-    fs.mkdirSync(root, {recursive: true});
-  }
-
-  console.log(
-    `\nCreating ${color.cyan(name)} package in ${color.cyan(
-      path.relative(cwd, root),
-    )}...`,
-  );
-
-  const templateRoot = await templateDirectory('package');
-  const template = createTemplateFileSystem(templateRoot, root);
-
-  for (const file of template.files()) {
-    switch (file) {
-      case 'package.json': {
-        const packageJson = JSON.parse(template.read(file));
-        packageJson.name = name;
-
-        if (scope) {
-          packageJson.publishConfig[`${scope}:registry`] =
-            'https://registry.npmjs.org';
-        }
-
-        template.write(file, JSON.stringify(packageJson, null, 2) + EOL);
-        break;
-      }
-      case 'README.md': {
-        template.write(
-          file,
-          template.read(file).replace('# Package', `# ${name}`),
-        );
-        break;
-      }
-      default: {
-        template.copy(file);
-      }
-    }
-
-    if (file === 'package.json') {
-      const packageJson = JSON.parse(template.read(file));
-      packageJson.name = name;
-
-      if (scope) {
-        packageJson.publishConfig[`${scope}:registry`] =
-          'https://registry.npmjs.org';
-      }
-
-      template.write(file, JSON.stringify(packageJson, null, 2) + EOL);
-      continue;
-    }
-
-    template.copy(file);
-  }
-
-  console.log(`\nDone! Your new package has been created.`);
-  console.log(`Get started by adding source code in the \`source\` directory.`);
-  console.log(
-    `Make sure to edit the \`description\` and \`repository\` sections of your \`package.json\` before publishing.`,
-  );
-  console.log(`Have fun!`);
-  console.log();
-}
-
-async function createApp() {
-  const root = path.join(cwd, 'app');
-
-  if (fs.existsSync(root)) {
-    const {overwrite} = await prompts<'overwrite'>([
-      {
-        type: 'confirm',
-        name: 'overwrite',
-        message: () =>
-          `Target directory (./app) is not empty. Remove existing files and continue?`,
-      },
-    ]);
-
-    if (!overwrite) return;
-
-    emptyDirectory(root);
-  } else if (!fs.existsSync(root)) {
-    fs.mkdirSync(root, {recursive: true});
-  }
-
-  console.log(`\nCreating app in ${color.cyan(path.relative(cwd, root))}...`);
-
-  const templateRoot = await templateDirectory('app');
-  const template = createTemplateFileSystem(templateRoot, root);
-
-  for (const file of template.files()) {
-    if (file === 'package.json') {
-      const packageJson = JSON.parse(template.read(file));
-      packageJson.name = 'app';
-      template.write(file, JSON.stringify(packageJson, null, 2) + EOL);
-      continue;
+    case 'package': {
+      const {createPackage} = await import('./package');
+      await createPackage();
+      break;
     }
-
-    template.copy(file);
-  }
-
-  console.log(`\nDone! Your new app has been created.`);
-  console.log(`Get started by:`);
-  console.log(`  * running \`pnpm develop\` to start the development server`);
-  console.log(`  * editing code in the \`app\` directory`);
-  console.log(`Have fun!`);
-  console.log();
-}
-
-// Utilities
-
-function createTemplateFileSystem(templateRoot: string, targetRoot: string) {
-  return {
-    write(file: string, content: string) {
-      const targetPath = path.join(
-        targetRoot,
-        file.startsWith('_') ? `.${file.slice(1)}` : file,
-      );
-      fs.writeFileSync(targetPath, content);
-    },
-    copy(file: string) {
-      const targetPath = path.join(
-        targetRoot,
-        file.startsWith('_') ? `.${file.slice(1)}` : file,
-      );
-      copy(path.join(templateRoot, file), targetPath);
-    },
-    read(file: string) {
-      return fs.readFileSync(path.join(templateRoot, file), {encoding: 'utf8'});
-    },
-    files() {
-      return fs.readdirSync(templateRoot);
-    },
-  };
-}
-
-async function templateDirectory(name: 'package' | 'app' | 'workspace') {
-  const packageRoot = await packageDirectory({
-    cwd: path.dirname(fileURLToPath(import.meta.url)),
-  });
-
-  return path.join(packageRoot, 'templates', name);
-}
-
-function toValidPackageName(projectName: string) {
-  return projectName
-    .trim()
-    .toLowerCase()
-    .replace(/\s+/g, '-')
-    .replace(/^[._]/, '')
-    .replace(/[^a-z0-9-~@/]+/g, '-');
-}
-
-function copy(source: string, destination: string) {
-  const stat = fs.statSync(source);
-  if (stat.isDirectory()) {
-    copyDirectory(source, destination);
-  } else {
-    fs.copyFileSync(source, destination);
-  }
-}
-
-function copyDirectory(source: string, destination: string) {
-  fs.mkdirSync(destination, {recursive: true});
-  for (const file of fs.readdirSync(source)) {
-    const srcFile = path.resolve(source, file);
-    const destFile = path.resolve(destination, file);
-    copy(srcFile, destFile);
-  }
-}
-
-function isEmpty(path: string) {
-  return fs.readdirSync(path).length === 0;
-}
-
-function emptyDirectory(dir: string) {
-  if (!fs.existsSync(dir)) {
-    return;
-  }
-
-  for (const file of fs.readdirSync(dir)) {
-    fs.rmSync(path.resolve(dir, file), {force: true, recursive: true});
   }
 }

package/source/help.ts

@@ -0,0 +1,132 @@
+import * as color from 'colorette';
+import {stripIndent} from 'common-tags';
+
+export function printHelp({
+  kind,
+  options: customOptions,
+  packageManager,
+}: {kind?: 'app' | 'package'; options?: string; packageManager?: string} = {}) {
+  const command = createCommand(packageManager);
+
+  const usage = stripIndent`
+    ${color.bold('Usage:')}   ${command} ${
+    kind ? color.magenta(kind) : color.magenta('[kind]')
+  } ${color.green('[name]')} ${color.cyan('[options]')}
+  `;
+
+  console.log(usage);
+
+  const example = stripIndent`
+    ${color.bold('Example:')} ${command} ${color.magenta(
+    kind ?? 'app',
+  )} ${color.green(`my-${kind ?? 'app'}`)} ${color.cyan('--install')}
+  `;
+
+  console.log(color.dim(example));
+
+  if (!kind) {
+    const kindSection = stripIndent`
+    ${color.bold(
+      color.magenta('kind'),
+    )} can be one of the following project types:
+
+     - ${color.magenta('app')}, a web application
+     - ${color.magenta('package')}, a shared library of code
+
+    You’ll be asked a few additional questions based on the kind you choose.
+  `;
+
+    console.log();
+    console.log(kindSection);
+  }
+
+  const optionsSection = stripIndent`
+    ${color.cyan('--name')}
+    The name of the project. When creating a package, you should use the public name you
+    want for the package, including any scope you want to use (example: ${color.bold(
+      '@my-org/my-package',
+    )}).
+    If you don’t provide a name with this flag, this command will ask you for one later.
+
+    ${color.cyan('--directory')}
+    The directory to create the project in. If you don’t provide this flag, Quilt will pick
+    a default directory based on the kind of the project and the name you provided.
+
+    ${color.cyan(`--monorepo`)}, ${color.cyan(`--no-monorepo`)}
+    If you aren’t already in a monorepo, this flag will create your new project with some
+    additional structure that allows it to be a monorepo — that is, you will be able to add
+    multiple projects to a single repository.
+
+    ${color.cyan(`--install`)}, ${color.cyan(`--no-install`)}
+    Whether to install dependencies in the newly created project. If you do not provide this
+    flag, Quilt will ask you about it later.
+
+    ${color.cyan('--package-manager')}
+    The package manager to use for your new project. This choice will be used to populate
+    some commands, and will be used to install dependencies if the ${color.cyan(
+      '--install',
+    )} flag is set.
+
+    Must be one of the following: ${color.bold('pnpm')}, ${color.bold(
+    'npm',
+  )}, or ${color.bold('yarn')}.
+
+    ${color.cyan(`--extras`)}, ${color.cyan(`--no-extras`)}
+    Extra developer tools to configure when creating your new project. This option only
+    applies when creating a brand new project, not when adding a project to an existing
+    workspace. You can include this flag multiple times to add multiple tools. You can
+    enable any of the following tools:
+
+     - ${color.bold(
+       'github',
+     )}, which adds a continuous integration (CI) GitHub Action to your project.
+     - ${color.bold(
+       'vscode',
+     )}, which adds some basic VSCode settings to your project.
+
+    ${color.cyan('--yes')}, ${color.cyan('-y')}
+    Answers “yes” to any question this command would have asked.
+
+    ${color.cyan('--help')}, ${color.cyan('-h')}
+    Prints this help documentation.
+  `;
+
+  console.log();
+  console.log(
+    `${color.bold(color.cyan('options'))} can include any of these flags:`,
+  );
+
+  if (customOptions) {
+    console.log();
+    console.log(printOptionsSection(customOptions));
+  }
+
+  console.log();
+  console.log(printOptionsSection(optionsSection));
+}
+
+function printOptionsSection(section: string) {
+  return section
+    .split('\n')
+    .map((line) => (line.length > 0 ? ` ${line}` : line))
+    .join('\n');
+}
+
+function createCommand(explicitPackageManager?: string) {
+  let packageManager: string;
+
+  const npmUserAgent = process.env['npm_config_user_agent'] ?? 'npm';
+
+  if (npmUserAgent.includes('pnpm') || explicitPackageManager === 'pnpm') {
+    packageManager = 'pnpm';
+  } else if (
+    npmUserAgent.includes('yarn') ||
+    explicitPackageManager === 'yarn'
+  ) {
+    packageManager = 'yarn';
+  } else {
+    packageManager = 'npm';
+  }
+
+  return `${packageManager} create @quilted`;
+}