@quilted/create 0.1.36 → 0.1.38

package/build/esm/package.mjs

@@ -1,7 +1,7 @@
 import * as fs from 'node:fs';
 import * as path from 'node:path';
-import { s as stripIndent, c as cyan_1, p as printHelp, b as bold_1, d as dim_1, u as underline_1, m as magenta_1, e as parseArguments, a as prompt } from './index.mjs';
-import { g as getCreateAsMonorepo, a as getShouldInstall, d as getPackageManager, e as getExtrasToSetup, t as toValidPackageName, f as emptyDirectory, h as format, m as mergeDependencies, l as loadTemplate, i as addToTsConfig, j as addToPackageManagerWorkspaces, r as relativeDirectoryForDisplay, o as isEmpty, p as createOutputTarget } from './shared/package-manager.mjs';
+import { s as stripIndent, c as cyan_1, d as dim_1, p as printHelp, b as bold_1, u as underline_1, m as magenta_1, e as parseArguments, a as prompt } from './index.mjs';
+import { g as getInWorkspace, a as getCreateAsMonorepo, d as getExtrasToSetup, e as getShouldInstall, f as getPackageManager, t as toValidPackageName, h as emptyDirectory, r as relativeDirectoryForDisplay, i as format, m as mergeWorkspaceAndProjectPackageJsons, l as loadTemplate, j as addToTsConfig, k as addToPackageManagerWorkspaces, p as isEmpty, q as createOutputTarget } from './shared/package-manager.mjs';
 import 'node:tty';
 import 'node:readline';
 import 'node:events';
@@ -12,6 +12,11 @@ async function createProject() {
   const args = getArguments();
   if (args['--help']) {
     const additionalOptions = stripIndent`
+      ${cyan_1(`--description`)}, ${cyan_1(`--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`)}
+
       ${cyan_1(`--react`)}, ${cyan_1(`--no-react`)}
       Whether this package will use React. If you don’t provide this option, the command
       will ask you about it later.
@@ -20,6 +25,11 @@ async function createProject() {
       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`)}
+      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`)}
+
       ${cyan_1(`--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.
@@ -31,22 +41,30 @@ async function createProject() {
     });
     return;
   }
-  const inWorkspace = fs.existsSync('quilt.workspace.ts');
   const name = await getName(args);
+  const description = await getDescription(args);
+  const inWorkspace = await getInWorkspace(args);
   const directory = await getDirectory(args, {
     name,
     inWorkspace
   });
   const isPublic = await getPublic(args);
-  const useReact = await getReact(args);
-  const createAsMonorepo = !inWorkspace && (await getCreateAsMonorepo(args));
-  const shouldInstall = await getShouldInstall(args);
-  const packageManager = await getPackageManager(args, {
-    root: directory
+  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 shouldInstall = await getShouldInstall(args, {
+    type: 'package'
+  });
+  const packageManager = await getPackageManager(args, {
+    root: directory
+  });
   const partOfMonorepo = inWorkspace || createAsMonorepo;
   const packageDirectory = createAsMonorepo ? path.join(directory, `packages/${toValidPackageName(name.split('/').pop())}`) : directory;
   if (fs.existsSync(directory)) {
@@ -66,12 +84,15 @@ async function createProject() {
   const packageTemplate = loadTemplate('package');
   const workspaceTemplate = loadTemplate('workspace');
   let quiltProject = await packageTemplate.read('quilt.project.ts');
+  if (!useReact) {
+    quiltProject = quiltProject.replace('quiltPackage()', 'quiltPackage({react: false})');
+  }
 
   // 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.
+      // 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
@@ -81,41 +102,28 @@ async function createProject() {
     // If we are creating a monorepo, we need to add the root package.json and
     // package manager workspace configuration.
     if (createAsMonorepo) {
+      const packageRelativeToRoot = path.relative(rootDirectory, packageDirectory);
+      const packageGlobRelativeToRoot = relativeDirectoryForDisplay(path.join(packageRelativeToRoot, '*'));
       const workspacePackageJson = JSON.parse(await workspaceTemplate.read('package.json'));
       workspacePackageJson.name = toValidPackageName(name);
+      workspacePackageJson.workspaces = [packageGlobRelativeToRoot];
       if (packageManager.type === 'pnpm') {
         await outputRoot.write('pnpm-workspace.yaml', await format(`
               packages:
-              - './packages/*'
+              - '${packageGlobRelativeToRoot}'
             `, {
           as: 'yaml'
         }));
-      } else {
-        workspacePackageJson.workspaces = ['packages/*'];
       }
       await outputRoot.write('package.json', await format(JSON.stringify(workspacePackageJson), {
         as: 'json-stringify'
       }));
     } else {
       const [projectPackageJson, projectTSConfig, workspacePackageJson] = await Promise.all([packageTemplate.read('package.json').then(content => JSON.parse(content)), packageTemplate.read('tsconfig.json').then(content => JSON.parse(content)), workspaceTemplate.read('package.json').then(content => JSON.parse(content))]);
-      workspacePackageJson.eslintConfig = projectPackageJson.eslintConfig;
-      workspacePackageJson.browserslist = projectPackageJson.browserslist;
-      const newPackageJson = {};
-
-      // We want to put the project’s dependencies in the package.json, respecting
-      // the preferred ordering (dependencies, peer dependencies, dev dependencies).
-      for (const [key, value] of Object.entries(projectPackageJson)) {
-        if (key !== 'devDependencies') {
-          newPackageJson[key] = value;
-          continue;
-        }
-        newPackageJson.dependencies = projectPackageJson.dependencies;
-        newPackageJson.peerDependencies = projectPackageJson.peerDependencies;
-        newPackageJson.peerDependenciesMeta = projectPackageJson.peerDependenciesMeta;
-        newPackageJson.devDependencies = mergeDependencies(workspacePackageJson.devDependencies, projectPackageJson.devDependencies);
-      }
-      adjustPackageJson(newPackageJson, {
+      const mergedPackageJson = mergeWorkspaceAndProjectPackageJsons(projectPackageJson, workspacePackageJson);
+      adjustPackageJson(mergedPackageJson, {
         name: toValidPackageName(name),
+        description,
         react: useReact,
         isPublic,
         registry: args['--registry']
@@ -124,7 +132,7 @@ async function createProject() {
       await outputRoot.write('quilt.project.ts', await format(quiltProject, {
         as: 'typescript'
       }));
-      await outputRoot.write('package.json', await format(JSON.stringify(newPackageJson), {
+      await outputRoot.write('package.json', await format(JSON.stringify(mergedPackageJson), {
         as: 'json-stringify'
       }));
       await outputRoot.write('tsconfig.json', await format(JSON.stringify(projectTSConfig), {
@@ -144,15 +152,36 @@ async function createProject() {
       return partOfMonorepo;
     }
 
-    // We need to make some adjustments the project’s package.json and Quilt config
-    return file !== 'package.json' && file !== 'quilt.project.ts';
+    // We need to make some adjustments the project’s package.json, README, and Quilt config
+    return file !== 'package.json' && file !== 'quilt.project.ts' && file !== 'README.md';
   });
+  await outputRoot.write(path.join(packageDirectory, 'package.json'), (await packageTemplate.read('README.md')).replaceAll('{{name}}', toValidPackageName(name)));
   if (partOfMonorepo) {
     // Write the package’s package.json (the root one was already created)
     const projectPackageJson = JSON.parse(await packageTemplate.read('package.json'));
-    projectPackageJson.repository.directory = path.relative(rootDirectory, packageDirectory);
+    if (repository === false) {
+      delete projectPackageJson.repository;
+    } else {
+      const directory = path.relative(rootDirectory, packageDirectory);
+      if (typeof repository === 'string') {
+        projectPackageJson.repository = {
+          type: 'git',
+          url: repository,
+          directory
+        };
+      } else if (repository != null) {
+        projectPackageJson.repository = {
+          type: 'git',
+          ...repository,
+          directory
+        };
+      } else {
+        projectPackageJson.repository.directory = directory;
+      }
+    }
     adjustPackageJson(projectPackageJson, {
       name: toValidPackageName(name),
+      description,
       react: useReact,
       isPublic,
       registry: args['--registry']
@@ -164,45 +193,58 @@ async function createProject() {
     await Promise.all([addToTsConfig(packageDirectory, outputRoot), addToPackageManagerWorkspaces(packageDirectory, outputRoot, packageManager.type)]);
   }
   if (shouldInstall) {
-    process.stdout.write('\nInstalling dependencies...\n');
+    console.log();
     // TODO: better loading, handle errors
     await packageManager.install();
-    process.stdout.moveCursor(0, -1);
-    process.stdout.clearLine(1);
-    console.log('Installed dependencies.');
   }
-  const packageJsonInstructions = stripIndent`
-    Your new package is ready to go! However, before you go too much further,
-    you should update the following fields in ${cyan_1(relativeDirectoryForDisplay(path.relative(process.cwd(), path.join(packageDirectory, 'package.json'))))}:
-
-     - ${bold_1(`"description"`)}, where you provide a description of what your package does
-     - ${bold_1(`"repository"`)}, where you should include the ${bold_1(`"url"`)} of your project’s repo
-
-    Before you publish your package, you will also want to update the ${bold_1(`"version"`)}
-    field in the package.json file.
-  `;
   console.log();
-  console.log(packageJsonInstructions);
-  const commands = [];
-  if (!inWorkspace && directory !== process.cwd()) {
-    commands.push(`cd ${cyan_1(relativeDirectoryForDisplay(path.relative(process.cwd(), directory)))} ${dim_1('# Move into your new package’s directory')}`);
-  }
-  if (!shouldInstall) {
-    commands.push(`${packageManager.commands.install()} ${dim_1('# Install all your dependencies')}`);
-  }
-  if (!inWorkspace) {
-    // TODO: change this condition to check if git was initialized already
-    commands.push(`git init && git add -A && git commit -m "Initial commit" ${dim_1('# Start your git history (optional)')}`);
-  }
-  if (commands.length > 0) {
-    const whatsNext = stripIndent`
-      After you update your package.json, there’s ${commands.length > 1 ? 'a few more steps' : 'one more step'} you’ll need to take
-      in order to start building:
-    `;
-    console.log();
-    console.log(whatsNext);
+  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'))))}.
+    `);
+  if (isPublic) {
+    const needsPackageJsonKeys = [];
+    if (!description) {
+      needsPackageJsonKeys.push({
+        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'
+      });
+    }
     console.log();
-    console.log(commands.map(command => `  ${command}`).join('\n'));
+    const logPackageJsonField = (field, url) => {
+      console.log(`  ${bold_1(JSON.stringify(field))} ${dim_1(`(${underline_1(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();
+      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();
+    } else {
+      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'))))}:
+        `);
+      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');
   }
   const followUp = stripIndent`
     Quilt can help you build, test, lint, and type-check your new package. You
@@ -223,6 +265,10 @@ function getArguments() {
     '-y': '--yes',
     '--name': String,
     '--directory': String,
+    '--description': String,
+    '--no-description': Boolean,
+    '--repository': String,
+    '--no-repository': Boolean,
     '--install': Boolean,
     '--no-install': Boolean,
     '--monorepo': Boolean,
@@ -289,6 +335,36 @@ async function getDirectory(args, {
   }
   return directory;
 }
+async function getDescription(args) {
+  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?'
+  });
+  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('./index4.mjs');
+  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;
+    } catch {
+      // noop
+    }
+  }
+}
 async function getPublic(args) {
   let isPublic;
   if (args['--public'] || args['--yes']) {
@@ -321,6 +397,7 @@ async function getReact(args) {
 }
 function adjustPackageJson(packageJson, {
   name,
+  description,
   react,
   isPublic,
   registry
@@ -329,6 +406,11 @@ function adjustPackageJson(packageJson, {
   const packageParts = name.split('/');
   const scope = packageParts[0].startsWith('@') ? packageParts[0] : undefined;
   const finalRegistry = registry ?? 'https://registry.npmjs.org';
+  if (description) {
+    packageJson.description = description;
+  } else {
+    delete packageJson.description;
+  }
   if (scope) {
     packageJson.publishConfig[`${scope}/registry`] = finalRegistry;
   } else if (registry) {
@@ -337,7 +419,22 @@ function adjustPackageJson(packageJson, {
   if (isPublic) {
     delete packageJson.private;
   } else {
+    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') {
+        newExports[key] = value;
+      }
+      const sourceEntry = value?.['quilt:source'];
+      if (typeof sourceEntry === 'string') {
+        newExports[key] = sourceEntry;
+      }
+    }
+    packageJson.exports = newExports;
   }
   if (!react) {
     delete packageJson.dependencies['@types/react'];

package/build/esm/shared/package-manager.mjs

@@ -1,7 +1,7 @@
-import require$$0 from 'node:tty';
-import { a as prompt } from '../index.mjs';
 import * as fs from 'node:fs';
 import { existsSync } from 'node:fs';
+import require$$0 from 'node:tty';
+import { a as prompt } from '../index.mjs';
 import { execSync } from 'node:child_process';
 import * as path from 'node:path';
 import { relative } from 'node:path';
@@ -155,7 +155,8 @@ async function format(content, {
   as: parser
 }) {
   const [{
-    format
+    format: rootFormat,
+    default: prettier
   }, {
     default: babel
   }, {
@@ -163,6 +164,9 @@ async function format(content, {
   }, {
     default: yaml
   }] = await Promise.all([import('../standalone.mjs').then(function (n) { return n.s; }), import('../parser-babel.mjs').then(function (n) { return n.p; }), import('../parser-typescript.mjs').then(function (n) { return n.p; }), import('../parser-yaml.mjs').then(function (n) { return n.p; })]);
+
+  // CJS workaround
+  const format = rootFormat ?? prettier.format;
   return format(content, {
     arrowParens: 'always',
     bracketSpacing: false,
@@ -183,6 +187,42 @@ function mergeDependencies(first = {}, second = {}) {
   }
   return merged;
 }
+const PACKAGE_JSON_DEPENDENCY_KEYS = new Set(['dependencies', 'devDependencies', 'peerDependencies', 'peerDependenciesMeta']);
+
+// Merges a project and workspace package.json together, with the following nitpicky preferences:
+//
+// - Take all the project’s fields in the order they appear by default
+// - Merge the relevant dependencies together
+// - Projects don’t come with `scripts` by default, but that should go before the first dependency list
+// - If there are other keys in the workspace package.json, they should go last, in the order they appeared
+function mergeWorkspaceAndProjectPackageJsons(projectPackageJson, workspacePackageJson) {
+  const newPackageJson = {};
+  const seenKeys = new Set();
+  let hasHandledScriptsField = false;
+  for (const [key, value] of Object.entries(projectPackageJson)) {
+    seenKeys.add(key);
+    const isDependencyKey = PACKAGE_JSON_DEPENDENCY_KEYS.has(key);
+    if (key === 'scripts' || isDependencyKey && !hasHandledScriptsField) {
+      newPackageJson.scripts = {
+        ...workspacePackageJson.scripts,
+        ...projectPackageJson.scripts
+      };
+      hasHandledScriptsField = true;
+    }
+    if (isDependencyKey) {
+      newPackageJson[key] = mergeDependencies(value, workspacePackageJson[key]);
+    } else {
+      newPackageJson[key] = value;
+    }
+  }
+  for (const [key, value] of Object.entries(workspacePackageJson)) {
+    if (seenKeys.has(key)) continue;
+    // Merged workspace + project package.json means we are not in a monorepo
+    if (key === 'workspaces') continue;
+    newPackageJson[key] = value;
+  }
+  return newPackageJson;
+}
 
 var colorette = {};
 
@@ -400,7 +440,14 @@ colorette.whiteBright = whiteBright;
 colorette.yellow = yellow;
 colorette.yellowBright = yellowBright;
 
-async function getCreateAsMonorepo(argv) {
+async function getInWorkspace(argv) {
+  if (argv['--in-workspace']) return true;
+  if (argv['--not-in-workspace']) return false;
+  return fs.existsSync('quilt.workspace.ts');
+}
+async function getCreateAsMonorepo(argv, {
+  type
+}) {
   let createAsMonorepo;
   if (argv['--monorepo' ]) {
     createAsMonorepo = true;
@@ -409,13 +456,15 @@ async function getCreateAsMonorepo(argv) {
   } else {
     createAsMonorepo = await prompt({
       type: 'confirm',
-      message: 'Do you want to create this app as a monorepo, with room for more projects?',
+      message: `Do you want to create this ${type} as a monorepo, with room for more projects?`,
       initial: true
     });
   }
   return createAsMonorepo;
 }
-async function getShouldInstall(argv) {
+async function getShouldInstall(argv, {
+  type
+}) {
   let shouldInstall;
   if (argv['--install'] || argv['--yes']) {
     shouldInstall = true;
@@ -424,7 +473,7 @@ async function getShouldInstall(argv) {
   } else {
     shouldInstall = await prompt({
       type: 'confirm',
-      message: 'Do you want to install dependencies for this app after creating it?',
+      message: `Do you want to install dependencies for this ${type} after creating it?`,
       initial: true
     });
   }
@@ -574,4 +623,4 @@ async function addToWorkspaces(relative, workspaces) {
   return [...workspaces, pretty ? relativeDirectoryForDisplay(relative) : relative].sort((patternOne, patternTwo) => patternOne.localeCompare(patternTwo));
 }
 
-export { getShouldInstall as a, bold_1 as b, cyan_1 as c, getPackageManager as d, getExtrasToSetup as e, emptyDirectory as f, getCreateAsMonorepo as g, format as h, addToTsConfig as i, addToPackageManagerWorkspaces as j, dim_1 as k, loadTemplate as l, mergeDependencies as m, magenta_1 as n, isEmpty as o, createOutputTarget as p, relativeDirectoryForDisplay as r, toValidPackageName as t, underline_1 as u };
+export { getCreateAsMonorepo as a, bold_1 as b, cyan_1 as c, getExtrasToSetup as d, getShouldInstall as e, getPackageManager as f, getInWorkspace as g, emptyDirectory as h, format as i, addToTsConfig as j, addToPackageManagerWorkspaces as k, loadTemplate as l, mergeWorkspaceAndProjectPackageJsons as m, dim_1 as n, magenta_1 as o, isEmpty as p, createOutputTarget as q, relativeDirectoryForDisplay as r, toValidPackageName as t, underline_1 as u };