@quilted/create 0.1.84 → 0.1.86

package/source/package.ts

@@ -31,17 +31,15 @@ export async function createProject() {
 
   if (args['--help']) {
     const additionalOptions = stripIndent`
-      ${color.cyan(`--description`)}, ${color.cyan(`--no-description`)}
+      ${color.cyan(`--description [description]`)}, ${color.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.
       ${color.dim(
         `@see https://docs.npmjs.com/cli/v9/configuring-npm/package-json#description`,
       )}
 
-      ${color.cyan(`--react`)}, ${color.cyan(`--no-react`)}
-      Whether this package will use React. If you don’t provide this option, the command
-      will ask you about it later.
-
       ${color.cyan(`--public`)}, ${color.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.
@@ -53,9 +51,12 @@ export async function createProject() {
         `@see https://docs.npmjs.com/cli/v9/configuring-npm/package-json#repository`,
       )}
 
-      ${color.cyan(`--registry`)}
+      ${color.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.
+
+      ${color.cyan(`--react`)}
+      Whether this package will use React. Defaults to false.
     `;
 
     printHelp({
@@ -101,143 +102,47 @@ export async function createProject() {
 
   const rootDirectory = inWorkspace ? process.cwd() : directory;
   const outputRoot = createOutputTarget(rootDirectory);
-  const packageTemplate = loadTemplate('package');
-  const workspaceTemplate = loadTemplate('workspace');
+  const packageTemplate = loadTemplate('package-simple');
+  const workspaceTemplate = loadTemplate('workspace-simple');
 
-  // 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) {
+  if (createAsMonorepo) {
     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
-      if (file === 'package.json') return false;
-
-      return true;
+      // We will adjust the package.json before writing it
+      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 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:
-              - '${packageGlobRelativeToRoot}'
-            `,
-            {as: 'yaml'},
-          ),
-        );
-      }
-
-      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)),
-        ]);
-
-      const mergedPackageJson = mergeWorkspaceAndProjectPackageJsons(
-        projectPackageJson,
-        workspacePackageJson,
-      );
-
-      delete mergedPackageJson.workspaces;
-
-      adjustPackageJson(mergedPackageJson, {
-        name: toValidPackageName(name!),
-        description,
-        react: useReact,
-        isPublic,
-        registry: args['--registry'],
-      });
+    const workspacePackageJson = JSON.parse(
+      await workspaceTemplate.read('package.json'),
+    );
 
-      await outputRoot.write(
-        'package.json',
-        await format(JSON.stringify(mergedPackageJson), {
-          as: 'json-stringify',
-        }),
-      );
+    workspacePackageJson.name = toValidPackageName(name!);
 
+    if (packageManager.type === 'pnpm') {
       await outputRoot.write(
-        'tsconfig.json',
-        await format(JSON.stringify(projectTSConfig), {as: 'json'}),
+        'pnpm-workspace.yaml',
+        await format(
+          `
+            packages:
+            - './packages/*'
+          `,
+          {as: 'yaml'},
+        ),
       );
     }
 
-    if (setupExtras.has('github')) {
-      await loadTemplate('github').copy(directory);
-    }
-
-    if (setupExtras.has('vscode')) {
-      await loadTemplate('vscode').copy(directory);
-    }
+    await outputRoot.write(
+      'package.json',
+      await format(JSON.stringify(workspacePackageJson), {
+        as: 'json-stringify',
+      }),
+    );
   }
 
   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, README, and Quilt config
-    return (
-      file !== 'package.json' &&
-      file !== 'quilt.project.ts' &&
-      file !== 'README.md'
-    );
+    // We will adjust the package.json and README.md before writing them
+    return file !== 'package.json' && file !== 'README.md';
   });
 
-  let quiltProject = await packageTemplate.read('quilt.project.ts');
-
-  if (!partOfMonorepo) {
-    quiltProject = quiltProject
-      .replace('quiltPackage', 'quiltWorkspace, quiltPackage')
-      .replace('quiltPackage(', 'quiltWorkspace(), quiltPackage(');
-  }
-
-  if (!useReact) {
-    quiltProject = quiltProject.replace(
-      'quiltPackage()',
-      'quiltPackage({react: false})',
-    );
-  }
-
-  await outputRoot.write(
-    path.join(packageDirectory, 'quilt.project.ts'),
-    await format(quiltProject, {as: 'typescript'}),
-  );
-
   await outputRoot.write(
     path.join(packageDirectory, 'README.md'),
     (await packageTemplate.read('README.md')).replaceAll(
@@ -247,6 +152,16 @@ export async function createProject() {
   );
 
   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'),
@@ -264,7 +179,11 @@ export async function createProject() {
           directory,
         };
       } else if (repository != null) {
-        projectPackageJson.repository = {type: 'git', ...repository, directory};
+        projectPackageJson.repository = {
+          type: 'git',
+          ...repository,
+          directory,
+        };
       } else {
         projectPackageJson.repository.directory = directory;
       }
@@ -284,15 +203,47 @@ export async function createProject() {
         as: 'json-stringify',
       }),
     );
-
-    await Promise.all([
-      addToTsConfig(packageDirectory, outputRoot),
-      addToPackageManagerWorkspaces(
-        packageDirectory,
-        outputRoot,
-        packageManager.type,
-      ),
+  } 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,
+    );
+
+    adjustPackageJson(mergedPackageJson, {
+      name: toValidPackageName(name!),
+      description,
+      react: useReact,
+      isPublic,
+      registry: args['--registry'],
+    });
+
+    await outputRoot.write(
+      'package.json',
+      await format(JSON.stringify(mergedPackageJson), {
+        as: 'json-stringify',
+      }),
+    );
+  }
+
+  if (!inWorkspace) {
+    if (setupExtras.has('github')) {
+      await loadTemplate('github').copy(directory);
+    }
+
+    if (setupExtras.has('vscode')) {
+      await loadTemplate('vscode').copy(directory);
+    }
   }
 
   if (shouldInstall) {
@@ -441,7 +392,6 @@ function getArguments() {
       '--extras': [String],
       '--no-extras': Boolean,
       '--react': Boolean,
-      '--no-react': Boolean,
       '--public': Boolean,
       '--private': Boolean,
       '--registry': String,
@@ -455,7 +405,9 @@ function getArguments() {
 }
 
 async function getName(args: Arguments) {
-  let {'--name': name} = args;
+  const {_, '--name': nameArgument} = args;
+
+  let name = nameArgument ?? _[0];
 
   if (name == null) {
     name = await prompt({
@@ -570,21 +522,7 @@ async function getPublic(args: Arguments) {
 }
 
 async function getReact(args: Arguments) {
-  let useReact: boolean;
-
-  if (args['--react'] || args['--yes']) {
-    useReact = true;
-  } else if (args['--no-react']) {
-    useReact = false;
-  } else {
-    useReact = await prompt({
-      type: 'confirm',
-      message: 'Will this package depend on React?',
-      initial: true,
-    });
-  }
-
-  return useReact;
+  return Boolean(args['--react']);
 }
 
 function adjustPackageJson(
@@ -651,10 +589,6 @@ function adjustPackageJson(
     delete packageJson.devDependencies['react'];
     delete packageJson.peerDependencies['react'];
     delete packageJson.peerDependenciesMeta['react'];
-
-    packageJson.eslintConfig.extends = packageJson.eslintConfig.extends.filter(
-      (extend: string) => !extend.includes('react'),
-    );
   }
 
   return packageJson;

package/source/shared/prompts.ts

@@ -27,7 +27,7 @@ export async function getInWorkspace(argv: BaseArguments) {
   if (argv['--in-workspace']) return true;
   if (argv['--not-in-workspace']) return false;
 
-  return fs.existsSync('quilt.workspace.ts');
+  return fs.existsSync('pnpm-workspace.yaml');
 }
 
 export async function getCreateAsMonorepo(
@@ -63,7 +63,7 @@ export async function getPackageManager(
   options?: Parameters<typeof createPackageManagerRunner>[1],
 ) {
   const packageManager = await baseGetPackageManager(argv['--package-manager']);
-  return createPackageManagerRunner(packageManager ?? 'npm', options);
+  return createPackageManagerRunner(packageManager ?? 'pnpm', options);
 }
 
 type Extra = 'github' | 'vscode';

package/source/shared.ts

@@ -7,6 +7,7 @@ export {prompt} from '@quilted/cli-kit';
 export function loadTemplate(
   name:
     | 'package'
+    | 'package-simple'
     | 'app-basic'
     | 'app-empty'
     | 'app-graphql'
@@ -14,6 +15,7 @@ export function loadTemplate(
     | 'module'
     | 'service-basic'
     | 'workspace'
+    | 'workspace-simple'
     | 'github'
     | 'vscode',
 ) {
@@ -84,6 +86,7 @@ let packageRootPromise: Promise<string> | undefined;
 async function templateDirectory(
   name:
     | 'package'
+    | 'package-simple'
     | 'app-basic'
     | 'app-empty'
     | 'app-graphql'
@@ -91,6 +94,7 @@ async function templateDirectory(
     | 'module'
     | 'service-basic'
     | 'workspace'
+    | 'workspace-simple'
     | 'github'
     | 'vscode',
 ) {

package/templates/github/_github/workflows/ci.yml

@@ -19,7 +19,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - uses: ./.github/workflows/actions/prepare
-      - uses: quilt-framework/action-lint@v2
+      - run: pnpm run lint
 
   type-check:
     name: Type check 🧮
@@ -27,7 +27,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - uses: ./.github/workflows/actions/prepare
-      - uses: quilt-framework/action-type-check@v2
+      - run: pnpm run type-check
 
   unit-tests:
     name: Unit tests 🧪
@@ -35,7 +35,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - uses: ./.github/workflows/actions/prepare
-      - uses: quilt-framework/action-test@v2
+      - run: pnpm run test
 
   build:
     name: Build 🏗
@@ -44,4 +44,4 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - uses: ./.github/workflows/actions/prepare
-      - uses: quilt-framework/action-build@v2
+      - run: pnpm run build

package/templates/package-simple/README.md

@@ -0,0 +1 @@
+# `{{name}}`

package/templates/package-simple/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "template-package-simple",
+  "description": "<YOUR DESCRIPTION HERE>",
+  "type": "module",
+  "license": "MIT",
+  "private": true,
+  "publishConfig": {
+    "access": "public"
+  },
+  "version": "0.0.0",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/<USER>/<REPOSITORY>"
+  },
+  "exports": {
+    ".": {
+      "types": "./build/typescript/index.d.ts",
+      "quilt:source": "./source/index.ts",
+      "quilt:esnext": "./build/esnext/index.esnext",
+      "import": "./build/esm/index.mjs",
+      "require": "./build/cjs/index.cjs"
+    }
+  },
+  "types": "./build/typescript/index.d.ts",
+  "sideEffects": false,
+  "scripts": {
+    "build": "rollup --config rollup.config.js"
+  },
+  "dependencies": {
+    "@types/react": "^17.0.0 || ^18.0.0"
+  },
+  "peerDependencies": {
+    "react": "^17.0.0 || ^18.0.0"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@quilted/testing": "^0.1.0",
+    "react": "npm:@quilted/react@^18.2.0"
+  },
+  "browserslist": [
+    "defaults and fully supports es6-module",
+    "maintained node versions"
+  ]
+}

package/templates/package-simple/rollup.config.js

@@ -0,0 +1,3 @@
+import {quiltPackageESModules} from '@quilted/rollup';
+
+export default quiltPackageESModules();

package/templates/package-simple/source/index.test.ts

@@ -0,0 +1,9 @@
+import {describe, it, expect} from 'vitest';
+
+import {run} from './index.ts';
+
+describe('package', () => {
+  it('returns something fun', () => {
+    expect(run()).toContain('fun');
+  });
+});

package/templates/package-simple/source/index.ts

@@ -0,0 +1,3 @@
+export function run() {
+  return 'Have fun building!';
+}

package/templates/package-simple/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "@quilted/typescript/project.json",
+  "compilerOptions": {
+    "rootDir": "source",
+    "outDir": "build/typescript"
+  },
+  "include": ["source"],
+  "exclude": [],
+  "references": []
+}

package/templates/workspace-simple/_gitignore

@@ -0,0 +1,13 @@
+# Dependencies
+node_modules/
+
+# Build outputs
+.quilt/
+build/
+bin/
+
+# Special operating system files
+.DS_STORE
+
+# Temporary files
+*.log

package/templates/workspace-simple/_nvmrc

@@ -0,0 +1 @@
+18.17.0

package/templates/workspace-simple/_prettierignore

@@ -0,0 +1,8 @@
+# Dependencies
+node_modules/
+pnpm-lock.yaml
+
+# Build outputs
+.quilt/
+build/
+bin/

package/templates/workspace-simple/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "template-workspace-simple",
+  "type": "module",
+  "version": "0.0.0",
+  "private": true,
+  "scripts": {
+    "build": "pnpm -r run build",
+    "lint": "prettier --write --cache .",
+    "test": "vitest",
+    "type-check": "tsc --build --pretty"
+  },
+  "devDependencies": {
+    "@quilted/rollup": "^0.1.11",
+    "@quilted/typescript": "^0.2.0",
+    "rollup": "^4.1.0",
+    "prettier": "^3.0.0",
+    "typescript": "^5.2.0",
+    "vitest": "^0.34.0"
+  },
+  "prettier": {
+    "arrowParens": "always",
+    "bracketSpacing": false,
+    "singleQuote": true,
+    "trailingComma": "all"
+  }
+}

package/templates/workspace-simple/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "@quilted/typescript/workspace.json",
+  "compilerOptions": {
+    "outDir": "build/typescript"
+  },
+  "include": [],
+  "references": []
+}