@quilted/create 0.1.20 → 0.1.23

package/build/cjs/package.cjs

@@ -0,0 +1,432 @@
+'use strict';
+
+var fs = require('fs');
+var path = require('path');
+var child_process = require('child_process');
+var index = require('./index.cjs');
+var packageManager = require('./package-manager.cjs');
+require('tty');
+require('url');
+require('readline');
+require('events');
+
+function _interopNamespace(e) {
+  if (e && e.__esModule) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n["default"] = e;
+  return Object.freeze(n);
+}
+
+var fs__namespace = /*#__PURE__*/_interopNamespace(fs);
+var path__namespace = /*#__PURE__*/_interopNamespace(path);
+
+let _ = t => t,
+    _t,
+    _t2,
+    _t3,
+    _t4;
+async function createProject() {
+  const argv = getArgv();
+
+  if (argv['--help']) {
+    var _argv$PackageManag;
+
+    const additionalOptions = index.stripIndent(_t || (_t = _`
+      ${0}, ${0}
+      Whether this package will use React. If you don’t provide this option, the command
+      will ask you about it later.
+
+      ${0}, ${0}
+      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.
+
+      ${0}
+      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.
+    `), index.cyan_1(`--react`), index.cyan_1(`--no-react`), index.cyan_1(`--public`), index.cyan_1(`--private`), index.cyan_1(`--registry`));
+    index.printHelp({
+      kind: 'package',
+      options: additionalOptions,
+      packageManager: (_argv$PackageManag = argv['--package-manager']) === null || _argv$PackageManag === void 0 ? void 0 : _argv$PackageManag.toLowerCase()
+    });
+    return;
+  }
+
+  const inWorkspace = fs__namespace.existsSync('quilt.workspace.ts');
+  const name = await getName(argv);
+  const directory = await getDirectory(argv, {
+    name,
+    inWorkspace
+  });
+  const isPublic = await getPublic(argv);
+  const useReact = await getReact(argv);
+  const createAsMonorepo = !inWorkspace && (await index.getCreateAsMonorepo(argv));
+  const shouldInstall = await index.getShouldInstall(argv);
+  const packageManager$1 = await index.getPackageManager(argv);
+  const setupExtras = await index.getExtrasToSetup(argv, {
+    inWorkspace
+  });
+  const partOfMonorepo = inWorkspace || createAsMonorepo;
+  const packageDirectory = createAsMonorepo ? path__namespace.join(directory, `packages/${packageManager.toValidPackageName(name.split('/').pop())}`) : directory;
+
+  if (fs__namespace.existsSync(directory)) {
+    await packageManager.emptyDirectory(directory);
+
+    if (packageDirectory !== directory) {
+      fs__namespace.mkdirSync(packageDirectory, {
+        recursive: true
+      });
+    }
+  } else {
+    fs__namespace.mkdirSync(packageDirectory, {
+      recursive: true
+    });
+  }
+
+  const rootDirectory = inWorkspace ? process.cwd() : directory;
+  const outputRoot = packageManager.createOutputTarget(rootDirectory);
+  const packageTemplate = packageManager.loadTemplate('package');
+  const workspaceTemplate = packageManager.loadTemplate('workspace');
+  let quiltProject = await packageTemplate.read('quilt.project.ts');
+
+  if (useReact) {
+    quiltProject = quiltProject.replace('react: false', 'react: true');
+  } // 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
+
+      return file !== 'package.json';
+    }); // If we are creating a monorepo, we need to add the root package.json and
+    // package manager workspace configuration.
+
+    if (createAsMonorepo) {
+      const workspacePackageJson = JSON.parse(await workspaceTemplate.read('package.json'));
+      workspacePackageJson.name = packageManager.toValidPackageName(name);
+
+      if (packageManager$1 === 'pnpm') {
+        await outputRoot.write('pnpm-workspace.yaml', await packageManager.format(`
+              packages:
+              - './packages/*'
+            `, {
+          as: 'yaml'
+        }));
+      } else {
+        workspacePackageJson.workspaces = ['packages/*'];
+      }
+
+      await outputRoot.write('package.json', await packageManager.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 = sortKeys({ ...workspacePackageJson.devDependencies,
+          ...projectPackageJson.devDependencies
+        });
+      }
+
+      adjustPackageJson(newPackageJson, {
+        name: packageManager.toValidPackageName(name),
+        react: useReact,
+        isPublic,
+        registry: argv['--registry']
+      });
+      quiltProject = quiltProject.replace('quiltPackage', 'quiltWorkspace, quiltPackage').replace('quiltPackage(', 'quiltWorkspace(), quiltPackage(');
+      await outputRoot.write('quilt.project.ts', await packageManager.format(quiltProject, {
+        as: 'typescript'
+      }));
+      await outputRoot.write('package.json', await packageManager.format(JSON.stringify(newPackageJson), {
+        as: 'json-stringify'
+      }));
+      await outputRoot.write('tsconfig.json', await packageManager.format(JSON.stringify(projectTSConfig), {
+        as: 'json'
+      }));
+    }
+
+    if (setupExtras.has('github')) {
+      await packageManager.loadTemplate('github').copy(directory);
+    }
+
+    if (setupExtras.has('vscode')) {
+      await packageManager.loadTemplate('vscode').copy(directory);
+    }
+  }
+
+  await packageTemplate.copy(packageDirectory, file => {
+    // If we are in a monorepo, we can use all the template files as they are
+    if (file === 'tsconfig.json') {
+      return partOfMonorepo;
+    } // We need to make some adjustments the project’s package.json and Quilt config
+
+
+    return file !== 'package.json' && file !== 'quilt.project.ts';
+  });
+
+  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__namespace.relative(directory, packageDirectory);
+    adjustPackageJson(projectPackageJson, {
+      name: packageManager.toValidPackageName(name),
+      react: useReact,
+      isPublic,
+      registry: argv['--registry']
+    });
+    await outputRoot.write(path__namespace.join(packageDirectory, 'package.json'), await packageManager.format(JSON.stringify(projectPackageJson), {
+      as: 'json-stringify'
+    }));
+    await outputRoot.write(path__namespace.join(packageDirectory, 'quilt.project.ts'), quiltProject);
+    await Promise.all([packageManager.addToTsConfig(packageDirectory, outputRoot), packageManager.addToPackageManagerWorkspaces(packageDirectory, outputRoot, packageManager$1)]);
+  }
+
+  if (shouldInstall) {
+    process.stdout.write('\nInstalling dependencies...\n'); // TODO: better loading, handle errors
+
+    child_process.execSync(`${packageManager$1} install`, {
+      cwd: rootDirectory
+    });
+    process.stdout.moveCursor(0, -1);
+    process.stdout.clearLine(1);
+    console.log('Installed dependencies.');
+  }
+
+  const packageJsonInstructions = index.stripIndent(_t2 || (_t2 = _`
+    Your new package is ready to go! However, before you go too much further,
+    you should update the following fields in ${0}:
+
+     - ${0}, where you provide a description of what your package does
+     - ${0}, where you should include the ${0} of your project’s repo
+
+    Before you publish your package, you will also want to update the ${0}
+    field in the package.json file.
+  `), index.cyan_1(packageManager.relativeDirectoryForDisplay(path__namespace.relative(process.cwd(), path__namespace.join(packageDirectory, 'package.json')))), index.bold_1(`"description"`), index.bold_1(`"repository"`), index.bold_1(`"url"`), index.bold_1(`"version"`));
+  console.log();
+  console.log(packageJsonInstructions);
+  const commands = [];
+
+  if (!inWorkspace && directory !== process.cwd()) {
+    commands.push(`cd ${index.cyan_1(packageManager.relativeDirectoryForDisplay(path__namespace.relative(process.cwd(), directory)))} ${index.dim_1('# Move into your new package’s directory')}`);
+  }
+
+  if (!shouldInstall) {
+    commands.push(`pnpm install ${index.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" ${index.dim_1('# Start your git history (optional)')}`);
+  }
+
+  if (commands.length > 0) {
+    const whatsNext = index.stripIndent(_t3 || (_t3 = _`
+      After you update your package.json, there’s ${0} you’ll need to take
+      in order to start building:
+    `), commands.length > 1 ? 'a few more steps' : 'one more step');
+    console.log();
+    console.log(whatsNext);
+    console.log();
+    console.log(commands.map(command => `  ${command}`).join('\n'));
+  }
+
+  const followUp = index.stripIndent(_t4 || (_t4 = _`
+    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:
+    ${0}
+
+    Have fun! 🎉
+  `), index.underline_1(index.magenta_1('https://github.com/lemonmade/quilt/tree/main/documentation')));
+  console.log();
+  console.log(followUp);
+} // Argument handling
+
+function getArgv() {
+  const argv = index.arg_1({
+    '--yes': Boolean,
+    '-y': '--yes',
+    '--name': String,
+    '--directory': String,
+    '--install': Boolean,
+    '--no-install': Boolean,
+    '--monorepo': Boolean,
+    '--no-monorepo': Boolean,
+    '--package-manager': String,
+    '--extras': [String],
+    '--no-extras': Boolean,
+    '--react': Boolean,
+    '--no-react': Boolean,
+    '--public': Boolean,
+    '--private': Boolean,
+    '--registry': String,
+    '--help': Boolean,
+    '-h': '--help'
+  }, {
+    permissive: true
+  });
+  return argv;
+}
+
+async function getName(argv) {
+  let {
+    '--name': name
+  } = argv;
+
+  if (name == null) {
+    name = await index.prompt({
+      type: 'text',
+      message: 'What would you like to name your new package?',
+      initial: '@my-team/package'
+    });
+  }
+
+  return name;
+}
+
+async function getDirectory(argv, {
+  name,
+  inWorkspace
+}) {
+  let directory = argv['--directory'] ? path__namespace.resolve(argv['--directory']) : undefined;
+
+  if (directory == null) {
+    const basePackageName = packageManager.toValidPackageName(name.split('/').pop());
+    const defaultDirectory = inWorkspace ? `packages/${basePackageName}` : basePackageName;
+    directory = path__namespace.resolve(await index.prompt({
+      type: 'text',
+      message: 'Where would you like to create your new package?',
+      initial: defaultDirectory
+    }));
+  }
+
+  while (!argv['--yes']) {
+    if (fs__namespace.existsSync(directory) && !(await packageManager.isEmpty(directory))) {
+      const relativeDirectory = path__namespace.relative(process.cwd(), directory);
+      const empty = await index.prompt({
+        type: 'confirm',
+        message: `Directory ${index.bold_1(packageManager.relativeDirectoryForDisplay(relativeDirectory))} is not empty, is it safe to empty it?`,
+        initial: true
+      });
+      if (empty) break;
+      const promptDirectory = await index.prompt({
+        type: 'text',
+        message: 'What directory do you want to create your package in?'
+      });
+      directory = path__namespace.resolve(promptDirectory);
+    } else {
+      break;
+    }
+  }
+
+  return directory;
+}
+
+async function getPublic(argv) {
+  let isPublic;
+
+  if (argv['--public'] || argv['--yes']) {
+    isPublic = true;
+  } else if (argv['--private']) {
+    isPublic = false;
+  } else {
+    isPublic = await index.prompt({
+      type: 'confirm',
+      message: 'Will you publish this package to use in other projects?',
+      initial: true
+    });
+  }
+
+  return isPublic;
+}
+
+async function getReact(argv) {
+  let useReact;
+
+  if (argv['--react'] || argv['--yes']) {
+    useReact = true;
+  } else if (argv['--no-react']) {
+    useReact = false;
+  } else {
+    useReact = await index.prompt({
+      type: 'confirm',
+      message: 'Will this package depend on React?',
+      initial: true
+    });
+  }
+
+  return useReact;
+}
+
+function adjustPackageJson(packageJson, {
+  name,
+  react,
+  isPublic,
+  registry
+}) {
+  packageJson.name = name;
+  const packageParts = name.split('/');
+  const scope = packageParts[0].startsWith('@') ? packageParts[0] : undefined;
+  const finalRegistry = registry !== null && registry !== void 0 ? registry : 'https://registry.npmjs.org';
+
+  if (scope) {
+    packageJson.publishConfig[`${scope}/registry`] = finalRegistry;
+  } else if (registry) {
+    packageJson.publishConfig.registry = finalRegistry;
+  }
+
+  if (isPublic) {
+    delete packageJson.private;
+  } else {
+    delete packageJson.publishConfig;
+  }
+
+  if (!react) {
+    delete packageJson.dependencies['@types/react'];
+    delete packageJson.devDependencies['react'];
+    delete packageJson.peerDependencies['react'];
+    delete packageJson.peerDependenciesMeta['react'];
+    packageJson.eslintConfig.extends = packageJson.eslintConfig.extends.filter(extend => !extend.includes('react'));
+  }
+
+  return packageJson;
+}
+
+function sortKeys(object) {
+  const newObject = {};
+  const sortedEntries = Object.entries(object).sort(([keyOne], [keyTwo]) => keyOne.localeCompare(keyTwo));
+
+  for (const [key, value] of sortedEntries) {
+    newObject[key] = value;
+  }
+
+  return newObject;
+}
+
+exports.createProject = createProject;