@quilted/create 0.1.15 → 0.1.18

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @quilted/create
 
+## 0.1.18
+
+### Patch Changes
+
+- [`a98c7c2b`](https://github.com/lemonmade/quilt/commit/a98c7c2bc40fa29b95e1ca3005d5c0fe995c9a5f) Thanks [@lemonmade](https://github.com/lemonmade)! - Add versioning instructions to package create
+
+* [`ae2475f7`](https://github.com/lemonmade/quilt/commit/ae2475f735a5e83969cbb596efe7b31cfd9f893b) Thanks [@lemonmade](https://github.com/lemonmade)! - Add tests to created packages
+
+## 0.1.17
+
+### Patch Changes
+
+- [`78d28015`](https://github.com/lemonmade/quilt/commit/78d280157c239175a431e12dbb9fda08f2c84a09) Thanks [@lemonmade](https://github.com/lemonmade)! - Fix create package flow in monorepos
+
+* [`ae3bbaa8`](https://github.com/lemonmade/quilt/commit/ae3bbaa8e2cc50bb8f57e332fa0aa12100153fc6) Thanks [@lemonmade](https://github.com/lemonmade)! - Add `directory` to package.json in monorepo packages
+
+## 0.1.16
+
+### Patch Changes
+
+- [`910c7dbe`](https://github.com/lemonmade/quilt/commit/910c7dbe0ba5ad9b348c77e045faf13ba4b94219) Thanks [@lemonmade](https://github.com/lemonmade)! - Fix prettier standalone usage
+
 ## 0.1.15
 
 ### Patch Changes

package/README.md

@@ -0,0 +1,30 @@
+# `@quilted/create`
+
+This package provides a command line tool for generating new Quilt projects.
+
+When run inside an existing [Quilt workspace](../../documentation/projects.md), this command will add additional [apps](../../documentation/projects.md#apps) or [packages](../../documentation/projects.md#packages) to the same workspace.
+
+You can also run it outside an existing repository, and it will create a new repository with a Quilt app or package. This new repo can be configured either as a “monorepo”, with room for additional projects, or as a repo just focused on a single project.
+
+The best way to use this command is to run the `create` command in your favorite package manager. Quilt supports [npm](https://docs.npmjs.com/about-npm), [yarn](https://yarnpkg.com), and [pnpm](https://pnpm.io).
+
+```bash
+pnpm create @quilted # for pnpm
+npm create @quilted # for npm
+yarn create @quilted # for yarn
+```
+
+> **Note:** If you don’t already have a favorite package manager, we recommend [pnpm](https://pnpm.io). pnpm is fast, takes up less space on disk, and produces a strict package installation that enforces dependency management best practices.
+
+This command will ask you what type of project you want to create. If you want to jump right to creating a particular kind of project, you can pass it as an additional argument to this command:
+
+```bash
+pnpm create @quilted app # create an app with pnpm
+npm create @quilted package # create a package with npm
+```
+
+This command also accepts many command-line flags to pre-answer the questions you will be asked when creating your project. To learn more about these flags, run the command with the `--help` flag:
+
+```bash
+pnpm create @quilted --help
+```

package/build/cjs/_commonjsHelpers.cjs

@@ -0,0 +1,10 @@
+'use strict';
+
+var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
+
+function getDefaultExportFromCjs (x) {
+	return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
+}
+
+exports.commonjsGlobal = commonjsGlobal;
+exports.getDefaultExportFromCjs = getDefaultExportFromCjs;

package/build/cjs/app.cjs

@@ -120,8 +120,6 @@ async function createApp() {
       workspacePackageJson.name = packageManager.toValidPackageName(name);
       workspacePackageJson.eslintConfig = projectPackageJson.eslintConfig;
       workspacePackageJson.browserslist = projectPackageJson.browserslist;
-      const addBackToTSConfigInclude = new Set(['quilt.project.ts', '*.test.ts', '*.test.tsx']);
-      projectTSConfig.exclude = projectTSConfig.exclude.filter(excluded => !addBackToTSConfigInclude.has(excluded));
       let quiltProject = await appTemplate.read('quilt.project.ts');
       quiltProject = quiltProject.replace('quiltApp', 'quiltWorkspace, quiltApp').replace('quiltApp(', 'quiltWorkspace(), quiltApp(');
       await outputRoot.write('quilt.project.ts', await packageManager.format(quiltProject, {

package/build/cjs/package-manager.cjs

@@ -146,13 +146,18 @@ async function format(content, {
 }) {
   const [{
     format
-  }] = await Promise.all([Promise.resolve().then(function () { return require('./standalone.cjs'); }).then(function (n) { return n.standalone; })]);
+  }, {
+    default: babel
+  }, {
+    default: yaml
+  }] = await Promise.all([Promise.resolve().then(function () { return require('./standalone.cjs'); }).then(function (n) { return n.standalone; }), Promise.resolve().then(function () { return require('./parser-babel.cjs'); }).then(function (n) { return n.parserBabel; }), Promise.resolve().then(function () { return require('./parser-yaml.cjs'); }).then(function (n) { return n.parserYaml; })]);
   return format(content, {
     arrowParens: 'always',
     bracketSpacing: false,
     singleQuote: true,
     trailingComma: 'all',
-    parser
+    parser,
+    plugins: [babel, yaml]
   });
 }
 

package/build/cjs/package.cjs

@@ -153,8 +153,6 @@ async function createPackage() {
         isPublic,
         registry: argv['--registry']
       });
-      const addBackToTSConfigInclude = new Set(['quilt.project.ts', '*.test.ts', '*.test.tsx']);
-      projectTSConfig.exclude = projectTSConfig.exclude.filter(excluded => !addBackToTSConfigInclude.has(excluded));
       quiltProject = quiltProject.replace('quiltPackage', 'quiltWorkspace, quiltPackage').replace('quiltPackage(', 'quiltWorkspace(), quiltPackage(');
       await outputRoot.write('quilt.project.ts', await packageManager.format(quiltProject, {
         as: 'typescript'
@@ -189,6 +187,7 @@ async function createPackage() {
   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,
@@ -198,6 +197,7 @@ async function createPackage() {
     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)]);
   }
 
@@ -212,6 +212,18 @@ async function createPackage() {
     console.log('Installed dependencies.');
   }
 
+  const packageJsonInstructions = index.stripIndent`
+    Your new package is ready to go! However, before you go too much further,
+    you should update the following fields in ${index.cyan_1(packageManager.relativeDirectoryForDisplay(path__namespace.relative(process.cwd(), path__namespace.join(packageDirectory, 'package.json'))))}:
+
+     - ${index.bold_1(`"description"`)}, where you provide a description of what your package does
+     - ${index.bold_1(`"repository"`)}, where you should include the ${index.bold_1(`"url"`)} of your project’s repo
+
+    Before you publish your package, you will also want to update the ${index.bold_1(`"version"`)}
+    field in the package.json file.
+  `;
+  console.log();
+  console.log(packageJsonInstructions);
   const commands = [];
 
   if (!inWorkspace && directory !== process.cwd()) {
@@ -227,17 +239,20 @@ async function createPackage() {
     commands.push(`git init && git add -A && git commit -m "Initial commit" ${index.dim_1('# Start your git history (optional)')}`);
   }
 
-  const whatsNext = index.stripIndent`
-    Your new package 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 building:
-  `;
-  console.log();
-  console.log(whatsNext);
-  console.log();
-  console.log(commands.map(command => `  ${command}`).join('\n'));
+  if (commands.length > 0) {
+    const whatsNext = index.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();
+    console.log(commands.map(command => `  ${command}`).join('\n'));
+  }
+
   const followUp = index.stripIndent`
-    Quilt can also help you build, test, lint, and type-check your new package.
-    You can learn more about building packages with Quilt by reading the documentation:
+    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:
     ${index.underline_1(index.magenta_1('https://github.com/lemonmade/quilt/tree/main/documentation'))}
 
     Have fun! 🎉