@quilted/create 0.1.90 → 0.2.0

package/build/esnext/package.esnext

@@ -1,5 +1,5 @@
-import * as fs from 'node:fs';
-import * as path from 'node:path';
+import * as fs from 'fs';
+import * as path from 'path';
 import { printHelp } from './help.esnext';
 import { toValidPackageName, emptyDirectory, loadTemplate, format, mergeWorkspaceAndProjectPackageJsons, relativeDirectoryForDisplay, isEmpty, createOutputTarget } from './shared.esnext';
 import { getInWorkspace, getCreateAsMonorepo, getExtrasToSetup, getShouldInstall, getPackageManager } from './shared/prompts.esnext';
@@ -21,137 +21,150 @@ import './node_modules/.pnpm/common-tags@1.8.2/node_modules/common-tags/es/inlin
 import './node_modules/.pnpm/common-tags@1.8.2/node_modules/common-tags/es/oneLineInlineLists/oneLineInlineLists.esnext';
 import './node_modules/.pnpm/common-tags@1.8.2/node_modules/common-tags/es/stripIndents/stripIndents.esnext';
 import arg from './node_modules/.pnpm/arg@5.0.2/node_modules/arg/index.esnext';
-import { prompt } from './packages/cli-kit/source/prompt.esnext';
-import { cyan as cyan_1, dim as dim_1, bold as bold_1, underline as underline_1, magenta as magenta_1 } from './node_modules/.pnpm/colorette@2.0.19/node_modules/colorette/index.esnext';
+import { prompt } from './packages/cli-kit/build/esnext/prompt.esnext.esnext';
+import { cyan, dim, bold, underline, magenta } from './node_modules/.pnpm/colorette@2.0.19/node_modules/colorette/index.esnext';
 
 async function createProject() {
   const args = getArguments();
-  if (args['--help']) {
+  if (args["--help"]) {
     const additionalOptions = stripIndent`
-      ${cyan_1(`--description [description]`)}, ${cyan_1(`--no-description`)}
+      ${cyan(`--description [description]`)}, ${cyan(
+      `--no-description`
+    )}
       A short description of the package. If you don’t provide this option, the command will ask
       you for a description later.
-      ${dim_1(`@see https://docs.npmjs.com/cli/v9/configuring-npm/package-json#description`)}
+      ${dim(
+      `@see https://docs.npmjs.com/cli/v9/configuring-npm/package-json#description`
+    )}
 
-      ${cyan_1(`--public`)}, ${cyan_1(`--private`)}
+      ${cyan(`--public`)}, ${cyan(`--private`)}
       Whether this package will be published for other projects to install. If you do not
       provide this option, the command will ask you about it later.
 
-      ${cyan_1(`--repository`)}, ${cyan_1(`--no-repository`)}
+      ${cyan(`--repository`)}, ${cyan(`--no-repository`)}
       The URL of a git repository where your code lives. If you do not provide this option,
       this command will try to guess the correct repository to use based on existing packages.
-      ${dim_1(`@see https://docs.npmjs.com/cli/v9/configuring-npm/package-json#repository`)}
+      ${dim(
+      `@see https://docs.npmjs.com/cli/v9/configuring-npm/package-json#repository`
+    )}
 
-      ${cyan_1(`--registry [registry]`)}
+      ${cyan(`--registry [registry]`)}
       The package registry to publish this package to. This option only applies if you create
       a public package. If you do not provide this option, it will use the default NPM registry.
 
-      ${cyan_1(`--react`)}
+      ${cyan(`--react`)}
       Whether this package will use React. Defaults to false.
     `;
     printHelp({
-      kind: 'package',
+      kind: "package",
       options: additionalOptions,
-      packageManager: args['--package-manager']?.toLowerCase()
+      packageManager: args["--package-manager"]?.toLowerCase()
     });
     return;
   }
   const name = await getName(args);
   const description = await getDescription(args);
   const inWorkspace = await getInWorkspace(args);
-  const directory = await getDirectory(args, {
-    name,
-    inWorkspace
-  });
+  const directory = await getDirectory(args, { name, inWorkspace });
   const isPublic = await getPublic(args);
-  const repository = await getRepository(args, {
-    inWorkspace
-  });
+  const repository = await getRepository(args, { inWorkspace });
   const useReact = await getReact(args);
-  const createAsMonorepo = !inWorkspace && (await getCreateAsMonorepo(args, {
-    type: 'package'
-  }));
-  const setupExtras = await getExtrasToSetup(args, {
-    inWorkspace
-  });
+  const createAsMonorepo = !inWorkspace && await getCreateAsMonorepo(args, { type: "package" });
+  const setupExtras = await getExtrasToSetup(args, { inWorkspace });
   const shouldInstall = await getShouldInstall(args);
-  const packageManager = await getPackageManager(args, {
-    root: directory
-  });
+  const packageManager = await getPackageManager(args, { root: directory });
   const partOfMonorepo = inWorkspace || createAsMonorepo;
-  const packageDirectory = createAsMonorepo ? path.join(directory, `packages/${toValidPackageName(name.split('/').pop())}`) : directory;
+  const packageDirectory = createAsMonorepo ? path.join(
+    directory,
+    `packages/${toValidPackageName(name.split("/").pop())}`
+  ) : directory;
   if (fs.existsSync(directory)) {
     await emptyDirectory(directory);
     if (packageDirectory !== directory) {
-      fs.mkdirSync(packageDirectory, {
-        recursive: true
-      });
+      fs.mkdirSync(packageDirectory, { recursive: true });
     }
   } else {
-    fs.mkdirSync(packageDirectory, {
-      recursive: true
-    });
+    fs.mkdirSync(packageDirectory, { recursive: true });
   }
   const rootDirectory = inWorkspace ? process.cwd() : directory;
   const outputRoot = createOutputTarget(rootDirectory);
-  const packageTemplate = loadTemplate('package');
-  const workspaceTemplate = loadTemplate('workspace-simple');
+  const packageTemplate = loadTemplate("package");
+  const workspaceTemplate = loadTemplate("workspace-simple");
   if (!inWorkspace) {
-    await workspaceTemplate.copy(directory, file => {
-      // We will adjust the package.json before writing it
-      return file !== 'package.json';
+    await workspaceTemplate.copy(directory, (file) => {
+      return file !== "package.json";
     });
-    if (setupExtras.has('github')) {
-      await loadTemplate('github').copy(directory);
+    if (setupExtras.has("github")) {
+      await loadTemplate("github").copy(directory);
     }
-    if (setupExtras.has('vscode')) {
-      await loadTemplate('vscode').copy(directory);
+    if (setupExtras.has("vscode")) {
+      await loadTemplate("vscode").copy(directory);
     }
   }
   if (createAsMonorepo) {
-    const workspacePackageJson = JSON.parse(await workspaceTemplate.read('package.json'));
+    const workspacePackageJson = JSON.parse(
+      await workspaceTemplate.read("package.json")
+    );
     workspacePackageJson.name = toValidPackageName(name);
-    if (packageManager.type === 'pnpm') {
-      await outputRoot.write('pnpm-workspace.yaml', await format(`
+    if (packageManager.type === "pnpm") {
+      await outputRoot.write(
+        "pnpm-workspace.yaml",
+        await format(
+          `
             packages:
             - './packages/*'
-          `, {
-        as: 'yaml'
-      }));
+          `,
+          { as: "yaml" }
+        )
+      );
     }
-    await outputRoot.write('package.json', await format(JSON.stringify(workspacePackageJson), {
-      as: 'json-stringify'
-    }));
+    await outputRoot.write(
+      "package.json",
+      await format(JSON.stringify(workspacePackageJson), {
+        as: "json-stringify"
+      })
+    );
   }
-  await packageTemplate.copy(packageDirectory, file => {
-    // We will adjust the package.json and README.md before writing them
-    return file !== 'package.json' && file !== 'README.md';
+  await packageTemplate.copy(packageDirectory, (file) => {
+    return file !== "package.json" && file !== "README.md";
   });
-  await outputRoot.write(path.join(packageDirectory, 'README.md'), (await packageTemplate.read('README.md')).replaceAll('{{name}}', toValidPackageName(name)));
+  await outputRoot.write(
+    path.join(packageDirectory, "README.md"),
+    (await packageTemplate.read("README.md")).replaceAll(
+      "{{name}}",
+      toValidPackageName(name)
+    )
+  );
   if (partOfMonorepo) {
-    // Add the package to the workspace configuration files
-    await Promise.all([addToTsConfig(packageDirectory, outputRoot), addToPackageManagerWorkspaces(packageDirectory, outputRoot, packageManager.type)]);
-
-    // Write the package’s package.json (the root one was already created)
-    const projectPackageJson = JSON.parse(await packageTemplate.read('package.json'));
+    await Promise.all([
+      addToTsConfig(packageDirectory, outputRoot),
+      addToPackageManagerWorkspaces(
+        packageDirectory,
+        outputRoot,
+        packageManager.type
+      )
+    ]);
+    const projectPackageJson = JSON.parse(
+      await packageTemplate.read("package.json")
+    );
     if (repository === false) {
       delete projectPackageJson.repository;
     } else {
-      const directory = path.relative(rootDirectory, packageDirectory);
-      if (typeof repository === 'string') {
+      const directory2 = path.relative(rootDirectory, packageDirectory);
+      if (typeof repository === "string") {
         projectPackageJson.repository = {
-          type: 'git',
+          type: "git",
           url: repository,
-          directory
+          directory: directory2
         };
       } else if (repository != null) {
         projectPackageJson.repository = {
-          type: 'git',
+          type: "git",
           ...repository,
-          directory
+          directory: directory2
         };
       } else {
-        projectPackageJson.repository.directory = directory;
+        projectPackageJson.repository.directory = directory2;
       }
     }
     adjustPackageJson(projectPackageJson, {
@@ -159,163 +172,211 @@ async function createProject() {
       description,
       react: useReact,
       isPublic,
-      registry: args['--registry']
+      registry: args["--registry"]
     });
-    await outputRoot.write(path.join(packageDirectory, 'package.json'), await format(JSON.stringify(projectPackageJson), {
-      as: 'json-stringify'
-    }));
+    await outputRoot.write(
+      path.join(packageDirectory, "package.json"),
+      await format(JSON.stringify(projectPackageJson), {
+        as: "json-stringify"
+      })
+    );
   } else {
-    // Write the package’s package.json by combining elements of the root and
-    // package templates
-    const [projectPackageJson, workspacePackageJson] = await Promise.all([packageTemplate.read('package.json').then(content => JSON.parse(content)), workspaceTemplate.read('package.json').then(content => JSON.parse(content))]);
-    const mergedPackageJson = mergeWorkspaceAndProjectPackageJsons(projectPackageJson, workspacePackageJson);
+    const [projectPackageJson, workspacePackageJson] = await Promise.all([
+      packageTemplate.read("package.json").then((content) => JSON.parse(content)),
+      workspaceTemplate.read("package.json").then((content) => JSON.parse(content))
+    ]);
+    const mergedPackageJson = mergeWorkspaceAndProjectPackageJsons(
+      projectPackageJson,
+      workspacePackageJson
+    );
     adjustPackageJson(mergedPackageJson, {
       name: toValidPackageName(name),
       description,
       react: useReact,
       isPublic,
-      registry: args['--registry']
+      registry: args["--registry"]
     });
-    await outputRoot.write('package.json', await format(JSON.stringify(mergedPackageJson), {
-      as: 'json-stringify'
-    }));
+    await outputRoot.write(
+      "package.json",
+      await format(JSON.stringify(mergedPackageJson), {
+        as: "json-stringify"
+      })
+    );
   }
   if (shouldInstall) {
     console.log();
-    // TODO: better loading, handle errors
     await packageManager.install();
   }
   console.log();
-  console.log(stripIndent`
-      Your new package, ${bold_1(name)}, is ready to go! You can edit the code
-      for your package in ${cyan_1(relativeDirectoryForDisplay(path.relative(process.cwd(), path.join(packageDirectory, 'source'))))}.
-    `);
+  console.log(
+    stripIndent`
+      Your new package, ${bold(
+      name
+    )}, is ready to go! You can edit the code
+      for your package in ${cyan(
+      relativeDirectoryForDisplay(
+        path.relative(process.cwd(), path.join(packageDirectory, "source"))
+      )
+    )}.
+    `
+  );
   if (isPublic) {
     const needsPackageJsonKeys = [];
     if (!description) {
       needsPackageJsonKeys.push({
-        field: 'description',
-        url: 'https://docs.npmjs.com/cli/v9/configuring-npm/package-json#description'
+        field: "description",
+        url: "https://docs.npmjs.com/cli/v9/configuring-npm/package-json#description"
       });
     }
     if (repository == null) {
       needsPackageJsonKeys.push({
-        field: 'repository.url',
-        url: 'https://docs.npmjs.com/cli/v9/configuring-npm/package-json#repository'
+        field: "repository.url",
+        url: "https://docs.npmjs.com/cli/v9/configuring-npm/package-json#repository"
       });
     }
     console.log();
     const logPackageJsonField = (field, url) => {
-      console.log(`  - ${bold_1(JSON.stringify(field))} ${dim_1(`(${underline_1(url)})`)}`);
+      console.log(
+        `  - ${bold(JSON.stringify(field))} ${dim(
+          `(${underline(url)})`
+        )}`
+      );
     };
     if (needsPackageJsonKeys.length > 0) {
-      console.log(stripIndent`
-          Before you publish your package, you will need to add the following key${needsPackageJsonKeys.length > 1 ? 's' : ''}
-          to ${cyan_1(relativeDirectoryForDisplay(path.relative(process.cwd(), path.join(packageDirectory, 'package.json'))))}:
-        `);
+      console.log(
+        stripIndent`
+          Before you publish your package, you will need to add the following key${needsPackageJsonKeys.length > 1 ? "s" : ""}
+          to ${cyan(
+          relativeDirectoryForDisplay(
+            path.relative(
+              process.cwd(),
+              path.join(packageDirectory, "package.json")
+            )
+          )
+        )}:
+        `
+      );
       console.log();
-      for (const {
-        field,
-        url
-      } of needsPackageJsonKeys) {
+      for (const { field, url } of needsPackageJsonKeys) {
         logPackageJsonField(field, url);
       }
       console.log();
-      console.log('In that same file, make sure the contents of these fields are right for your package:');
+      console.log(
+        "In that same file, make sure the contents of these fields are right for your package:"
+      );
       console.log();
     } else {
-      console.log(stripIndent`
+      console.log(
+        stripIndent`
           Before you publish your package, make the following fields look right
-          in ${cyan_1(relativeDirectoryForDisplay(path.relative(process.cwd(), path.join(packageDirectory, 'package.json'))))}:
-        `);
+          in ${cyan(
+          relativeDirectoryForDisplay(
+            path.relative(
+              process.cwd(),
+              path.join(packageDirectory, "package.json")
+            )
+          )
+        )}:
+        `
+      );
       console.log();
     }
-    logPackageJsonField('version', 'https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version');
-    logPackageJsonField('license', 'https://docs.npmjs.com/cli/v9/configuring-npm/package-json#license');
-    logPackageJsonField('exports', 'https://nodejs.org/api/packages.html#package-entry-points');
+    logPackageJsonField(
+      "version",
+      "https://docs.npmjs.com/cli/v9/configuring-npm/package-json#version"
+    );
+    logPackageJsonField(
+      "license",
+      "https://docs.npmjs.com/cli/v9/configuring-npm/package-json#license"
+    );
+    logPackageJsonField(
+      "exports",
+      "https://nodejs.org/api/packages.html#package-entry-points"
+    );
   }
   const followUp = stripIndent`
     Quilt can help you build, test, lint, and type-check your new package. You
     can learn more about building packages with Quilt by reading the documentation:
-    ${underline_1(magenta_1('https://github.com/lemonmade/quilt/tree/main/documentation'))}
+    ${underline(
+    magenta(
+      "https://github.com/lemonmade/quilt/tree/main/documentation"
+    )
+  )}
 
     Have fun! 🎉
   `;
   console.log();
   console.log(followUp);
 }
-
-// Argument handling
-
 function getArguments() {
-  const args = arg({
-    '--yes': Boolean,
-    '-y': '--yes',
-    '--name': String,
-    '--directory': String,
-    '--description': String,
-    '--no-description': Boolean,
-    '--repository': String,
-    '--no-repository': Boolean,
-    '--install': Boolean,
-    '--no-install': Boolean,
-    '--monorepo': Boolean,
-    '--no-monorepo': Boolean,
-    '--package-manager': String,
-    '--extras': [String],
-    '--no-extras': Boolean,
-    '--react': Boolean,
-    '--public': Boolean,
-    '--private': Boolean,
-    '--registry': String,
-    '--help': Boolean,
-    '-h': '--help'
-  }, {
-    permissive: true
-  });
+  const args = arg(
+    {
+      "--yes": Boolean,
+      "-y": "--yes",
+      "--name": String,
+      "--directory": String,
+      "--description": String,
+      "--no-description": Boolean,
+      "--repository": String,
+      "--no-repository": Boolean,
+      "--install": Boolean,
+      "--no-install": Boolean,
+      "--monorepo": Boolean,
+      "--no-monorepo": Boolean,
+      "--package-manager": String,
+      "--extras": [String],
+      "--no-extras": Boolean,
+      "--react": Boolean,
+      "--public": Boolean,
+      "--private": Boolean,
+      "--registry": String,
+      "--help": Boolean,
+      "-h": "--help"
+    },
+    { permissive: true }
+  );
   return args;
 }
 async function getName(args) {
-  const {
-    _,
-    '--name': nameArgument
-  } = args;
+  const { _, "--name": nameArgument } = args;
   let name = nameArgument ?? _[1];
-  if (name == null || name.startsWith('--')) {
+  if (name == null || name.startsWith("--")) {
     name = await prompt({
-      type: 'text',
-      message: 'What would you like to name your new package?',
-      initial: '@my-team/package'
+      type: "text",
+      message: "What would you like to name your new package?",
+      initial: "@my-team/package"
     });
   }
   return name;
 }
-async function getDirectory(args, {
-  name,
-  inWorkspace
-}) {
-  let directory = args['--directory'] ? path.resolve(args['--directory']) : undefined;
+async function getDirectory(args, { name, inWorkspace }) {
+  let directory = args["--directory"] ? path.resolve(args["--directory"]) : void 0;
   if (directory == null) {
-    const basePackageName = toValidPackageName(name.split('/').pop());
+    const basePackageName = toValidPackageName(name.split("/").pop());
     const defaultDirectory = inWorkspace ? `packages/${basePackageName}` : basePackageName;
-    directory = path.resolve(await prompt({
-      type: 'text',
-      message: 'Where would you like to create your new package?',
-      initial: defaultDirectory
-    }));
+    directory = path.resolve(
+      await prompt({
+        type: "text",
+        message: "Where would you like to create your new package?",
+        initial: defaultDirectory
+      })
+    );
   }
-  while (!args['--yes']) {
-    if (fs.existsSync(directory) && !(await isEmpty(directory))) {
+  while (!args["--yes"]) {
+    if (fs.existsSync(directory) && !await isEmpty(directory)) {
       const relativeDirectory = path.relative(process.cwd(), directory);
       const empty = await prompt({
-        type: 'confirm',
-        message: `Directory ${bold_1(relativeDirectoryForDisplay(relativeDirectory))} is not empty, is it safe to empty it?`,
+        type: "confirm",
+        message: `Directory ${bold(
+          relativeDirectoryForDisplay(relativeDirectory)
+        )} is not empty, is it safe to empty it?`,
         initial: true
       });
-      if (empty) break;
+      if (empty)
+        break;
       const promptDirectory = await prompt({
-        type: 'text',
-        message: 'What directory do you want to create your package in?'
+        type: "text",
+        message: "What directory do you want to create your package in?"
       });
       directory = path.resolve(promptDirectory);
     } else {
@@ -325,52 +386,51 @@ async function getDirectory(args, {
   return directory;
 }
 async function getDescription(args) {
-  if (args['--description']) return args['--description'];
-  if (args['--no-description']) return false;
+  if (args["--description"])
+    return args["--description"];
+  if (args["--no-description"])
+    return false;
   const description = await prompt({
-    type: 'text',
-    message: 'What is a short description of what this package will do?'
+    type: "text",
+    message: "What is a short description of what this package will do?"
   });
   return description;
 }
-async function getRepository(args, {
-  inWorkspace = false
-} = {}) {
-  if (args['--repository']) return args['--repository'];
-  if (args['--no-repository']) return false;
-  if (!inWorkspace) return;
-  const {
-    globby
-  } = await import('./node_modules/.pnpm/globby@13.1.1/node_modules/globby/index.esnext');
-  const files = await globby('**/package.json', {
-    ignore: ['**/node_modules']
-  });
+async function getRepository(args, { inWorkspace = false } = {}) {
+  if (args["--repository"])
+    return args["--repository"];
+  if (args["--no-repository"])
+    return false;
+  if (!inWorkspace)
+    return;
+  const { globby } = await import('./node_modules/.pnpm/globby@13.1.1/node_modules/globby/index.esnext');
+  const files = await globby("**/package.json", { ignore: ["**/node_modules"] });
   for (const file of files) {
     try {
-      const json = JSON.parse(await fs.promises.readFile(file, 'utf8'));
-      if (json.repository) return json.repository;
+      const json = JSON.parse(await fs.promises.readFile(file, "utf8"));
+      if (json.repository)
+        return json.repository;
     } catch {
-      // noop
     }
   }
 }
 async function getPublic(args) {
   let isPublic;
-  if (args['--public'] || args['--yes']) {
+  if (args["--public"] || args["--yes"]) {
     isPublic = true;
-  } else if (args['--private']) {
+  } else if (args["--private"]) {
     isPublic = false;
   } else {
     isPublic = await prompt({
-      type: 'confirm',
-      message: 'Will you publish this package to use in other projects?',
+      type: "confirm",
+      message: "Will you publish this package to use in other projects?",
       initial: true
     });
   }
   return isPublic;
 }
 async function getReact(args) {
-  return Boolean(args['--react']);
+  return Boolean(args["--react"]);
 }
 function adjustPackageJson(packageJson, {
   name,
@@ -380,9 +440,9 @@ function adjustPackageJson(packageJson, {
   registry
 }) {
   packageJson.name = name;
-  const packageParts = name.split('/');
-  const scope = packageParts[0].startsWith('@') ? packageParts[0] : undefined;
-  const finalRegistry = registry ?? 'https://registry.npmjs.org';
+  const packageParts = name.split("/");
+  const scope = packageParts[0].startsWith("@") ? packageParts[0] : void 0;
+  const finalRegistry = registry ?? "https://registry.npmjs.org";
   if (description) {
     packageJson.description = description;
   } else {
@@ -399,25 +459,23 @@ function adjustPackageJson(packageJson, {
     delete packageJson.license;
     delete packageJson.repository;
     delete packageJson.publishConfig;
-
-    // in private packages, we just need to reference the source.
     const newExports = {};
     for (const [key, value] of Object.entries(packageJson.exports)) {
-      if (typeof value === 'string') {
+      if (typeof value === "string") {
         newExports[key] = value;
       }
-      const sourceEntry = value?.['quilt:source'];
-      if (typeof sourceEntry === 'string') {
+      const sourceEntry = value?.["quilt:source"];
+      if (typeof sourceEntry === "string") {
         newExports[key] = sourceEntry;
       }
     }
     packageJson.exports = newExports;
   }
   if (!react) {
-    delete packageJson.dependencies['@types/react'];
-    delete packageJson.devDependencies['react'];
-    delete packageJson.peerDependencies['react'];
-    delete packageJson.peerDependenciesMeta['react'];
+    delete packageJson.dependencies["@types/react"];
+    delete packageJson.devDependencies["react"];
+    delete packageJson.peerDependencies["react"];
+    delete packageJson.peerDependenciesMeta["react"];
   }
   return packageJson;
 }