@quilted/create 0.1.87 → 0.1.89

package/source/module.ts

@@ -33,9 +33,19 @@ export async function createModule() {
   const argv = getArgv();
 
   if (argv['--help']) {
+    const additionalOptions = stripIndent`
+      ${color.cyan(`--entry [entry]`)}
+      The entry file for your module. This should be a relative path from the root
+      of the project, and should include the file extension.
+
+      ${color.cyan(`--react`)}
+      Whether this package will use React. Defaults to false.
+    `;
+
     printHelp({
       kind: 'module',
       packageManager: argv['--package-manager']?.toLowerCase(),
+      options: additionalOptions,
     });
     return;
   }
@@ -76,147 +86,72 @@ export async function createModule() {
   const rootDirectory = inWorkspace ? process.cwd() : directory;
   const outputRoot = createOutputTarget(rootDirectory);
   const moduleTemplate = loadTemplate('module');
-  const workspaceTemplate = loadTemplate('workspace');
+  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 moduleRelativeToRoot = relativeDirectoryForDisplay(
-        path.relative(directory, moduleDirectory),
-      );
-
-      const workspacePackageJson = JSON.parse(
-        await workspaceTemplate.read('package.json'),
-      );
-
-      workspacePackageJson.name = toValidPackageName(name!);
-      workspacePackageJson.workspaces = [moduleRelativeToRoot, './packages/*'];
-
-      if (packageManager.type === 'pnpm') {
-        await outputRoot.write(
-          'pnpm-workspace.yaml',
-          await format(
-            `
-              packages:
-              - '${moduleRelativeToRoot}'
-              - './packages/*'
-            `,
-            {as: 'yaml'},
-          ),
-        );
-      }
-
-      await outputRoot.write(
-        'package.json',
-        await format(JSON.stringify(workspacePackageJson), {
-          as: 'json-stringify',
-        }),
-      );
-    } else {
-      const [projectPackageJson, projectTSConfig, workspacePackageJson] =
-        await Promise.all([
-          moduleTemplate
-            .read('package.json')
-            .then((content) => JSON.parse(content)),
-          moduleTemplate
-            .read('tsconfig.json')
-            .then((content) => JSON.parse(content)),
-          workspaceTemplate
-            .read('package.json')
-            .then((content) => JSON.parse(content)),
-        ]);
-
-      const combinedPackageJson = mergeWorkspaceAndProjectPackageJsons(
-        projectPackageJson,
-        workspacePackageJson,
-      );
+    const workspacePackageJson = JSON.parse(
+      await workspaceTemplate.read('package.json'),
+    );
 
-      adjustPackageJson(combinedPackageJson, {name, entry, react: useReact});
-      delete combinedPackageJson.workspaces;
+    workspacePackageJson.name = toValidPackageName(name!);
 
-      await outputRoot.write(
-        'package.json',
-        await format(JSON.stringify(combinedPackageJson), {
-          as: 'json-stringify',
-        }),
-      );
+    const moduleRelativeToRoot = relativeDirectoryForDisplay(
+      path.relative(directory, moduleDirectory),
+    );
 
+    if (packageManager.type === 'pnpm') {
       await outputRoot.write(
-        'tsconfig.json',
-        await format(JSON.stringify(projectTSConfig), {as: 'json'}),
+        'pnpm-workspace.yaml',
+        await format(
+          `
+            packages:
+            - './packages/*'
+            - '${moduleRelativeToRoot}'
+          `,
+          {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 moduleTemplate.copy(moduleDirectory, (file) => {
-    // If we are in a monorepo, we can use all the template files as they are
-    if (file === 'quilt.project.ts' || file === 'tsconfig.json') {
-      return partOfMonorepo;
-    }
-
-    // We will adjust the entry file
-    if (file === 'module.ts') return false;
-
-    // We need to make some adjustments the project’s package.json and quilt
-    // config
-    if (file === 'package.json' || file === 'quilt.project.ts') return false;
-
-    return true;
+    // We will adjust the package.json before writing them
+    return file !== 'package.json';
   });
 
-  let quiltProject = await moduleTemplate.read('quilt.project.ts');
-
-  if (!partOfMonorepo) {
-    quiltProject = quiltProject
-      .replace('quiltModule', 'quiltWorkspace, quiltModule')
-      .replace('quiltModule(', 'quiltWorkspace(), quiltModule(');
-  }
-
-  if (!useReact) {
-    quiltProject = quiltProject.replace(
-      'quiltPackage()',
-      'quiltPackage({react: false})',
-    );
-  }
-
-  await outputRoot.write(
-    path.join(moduleDirectory, 'quilt.project.ts'),
-    await format(quiltProject, {as: 'typescript'}),
-  );
-
-  await outputRoot.write(
-    path.join(moduleDirectory, entry),
-    await moduleTemplate.read('module.ts'),
-  );
-
   if (partOfMonorepo) {
-    // Write the app’s package.json (the root one was already created)
+    // Add the package to the workspace configuration files
+    await Promise.all([
+      addToTsConfig(moduleDirectory, outputRoot),
+      addToPackageManagerWorkspaces(
+        moduleDirectory,
+        outputRoot,
+        packageManager.type,
+      ),
+    ]);
+
+    // Write the package’s package.json (the root one was already created)
     const projectPackageJson = JSON.parse(
       await moduleTemplate.read('package.json'),
     );
 
-    adjustPackageJson(projectPackageJson, {name, entry, react: useReact});
+    adjustPackageJson(projectPackageJson, {
+      name: toValidPackageName(name),
+      react: useReact,
+      entry,
+    });
 
     await outputRoot.write(
       path.join(moduleDirectory, 'package.json'),
@@ -224,15 +159,45 @@ export async function createModule() {
         as: 'json-stringify',
       }),
     );
-
-    await Promise.all([
-      addToTsConfig(moduleDirectory, outputRoot),
-      addToPackageManagerWorkspaces(
-        moduleDirectory,
-        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([
+      moduleTemplate
+        .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!),
+      react: useReact,
+      entry,
+    });
+
+    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) {
@@ -310,7 +275,6 @@ function getArgv() {
       '--extras': [String],
       '--no-extras': Boolean,
       '--react': Boolean,
-      '--no-react': Boolean,
       '--help': Boolean,
       '-h': '--help',
     },
@@ -320,8 +284,10 @@ function getArgv() {
   return argv;
 }
 
-async function getName(argv: Arguments) {
-  let {'--name': name} = argv;
+async function getName(args: Arguments) {
+  const {_, '--name': nameArgument} = args;
+
+  let name = nameArgument ?? _[1];
 
   if (name == null) {
     name = await prompt({
@@ -388,21 +354,7 @@ async function getDirectory(argv: Arguments, {name}: {name: string}) {
 }
 
 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 module depend on React?',
-      initial: false,
-    });
-  }
-
-  return useReact;
+  return Boolean(args['--react']);
 }
 
 function adjustPackageJson(
@@ -418,7 +370,7 @@ function adjustPackageJson(
   },
 ) {
   packageJson.name = name;
-  packageJson.main = `./${entry}`;
+  packageJson.exports['.'] = `./${entry}`;
 
   if (!react) {
     delete packageJson.devDependencies['@types/react'];
@@ -426,10 +378,6 @@ function adjustPackageJson(
     delete packageJson.devDependencies['preact'];
     delete packageJson.devDependencies['react'];
     delete packageJson.devDependencies['react-dom'];
-
-    packageJson.eslintConfig.extends = packageJson.eslintConfig.extends.filter(
-      (extend: string) => !extend.includes('react'),
-    );
   }
 
   return packageJson;

package/source/package.ts

@@ -102,7 +102,7 @@ export async function createProject() {
 
   const rootDirectory = inWorkspace ? process.cwd() : directory;
   const outputRoot = createOutputTarget(rootDirectory);
-  const packageTemplate = loadTemplate('package-simple');
+  const packageTemplate = loadTemplate('package');
   const workspaceTemplate = loadTemplate('workspace-simple');
 
   if (createAsMonorepo) {

package/source/shared.ts

@@ -7,7 +7,6 @@ export {prompt} from '@quilted/cli-kit';
 export function loadTemplate(
   name:
     | 'package'
-    | 'package-simple'
     | 'app-basic'
     | 'app-empty'
     | 'app-graphql'
@@ -86,7 +85,6 @@ let packageRootPromise: Promise<string> | undefined;
 async function templateDirectory(
   name:
     | 'package'
-    | 'package-simple'
     | 'app-basic'
     | 'app-empty'
     | 'app-graphql'

package/templates/module/module.ts

@@ -1,3 +1,5 @@
 // Replace this module with whatever you want to run in a browser!
 
-export {};
+export function run() {
+  return 'Go build something fun!';
+}

package/templates/module/package.json

@@ -1,7 +1,9 @@
 {
   "name": "template-module",
   "type": "module",
-  "main": "./module.ts",
+  "exports": {
+    ".": "./module.ts"
+  },
   "version": "0.0.0",
   "private": true,
   "dependencies": {},
@@ -13,12 +15,7 @@
     "react-dom": "npm:@quilted/react-dom@^18.2.0"
   },
   "browserslist": [
-    "extends @quilted/browserslist-config/modules"
-  ],
-  "eslintConfig": {
-    "extends": [
-      "@quilted/eslint-config/project",
-      "@quilted/eslint-config/react"
-    ]
-  }
+    "defaults",
+    "not ie 11"
+  ]
 }

package/templates/module/rollup.config.js

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

package/templates/module/tsconfig.json

@@ -4,6 +4,6 @@
     "outDir": "build/typescript"
   },
   "include": ["**/*"],
-  "exclude": ["build", "quilt.project.ts", "**/*.test.ts", "**/*.test.tsx"],
+  "exclude": ["build"],
   "references": []
 }

package/templates/package/package.json

@@ -9,7 +9,7 @@
   },
   "version": "0.0.0",
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=18.0.0"
   },
   "repository": {
     "type": "git",
@@ -20,12 +20,14 @@
       "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"
+      "import": "./build/esm/index.mjs"
     }
   },
   "types": "./build/typescript/index.d.ts",
   "sideEffects": false,
+  "scripts": {
+    "build": "rollup --config rollup.config.js"
+  },
   "dependencies": {
     "@types/react": "^17.0.0 || ^18.0.0"
   },
@@ -38,16 +40,10 @@
     }
   },
   "devDependencies": {
-    "@quilted/testing": "^0.1.0",
     "react": "npm:@quilted/react@^18.2.0"
   },
-  "eslintConfig": {
-    "extends": [
-      "@quilted/eslint-config/project",
-      "@quilted/eslint-config/react"
-    ]
-  },
   "browserslist": [
-    "extends @quilted/browserslist-config/defaults"
+    "defaults and fully supports es6-module",
+    "maintained node versions"
   ]
 }

package/templates/package/tsconfig.json

@@ -5,6 +5,6 @@
     "outDir": "build/typescript"
   },
   "include": ["source"],
-  "exclude": ["quilt.project.ts", "**/*.test.ts", "**/*.test.tsx"],
+  "exclude": [],
   "references": []
 }

package/templates/module/quilt.project.ts

@@ -1,5 +0,0 @@
-import {createProject, quiltModule} from '@quilted/craft';
-
-export default createProject((project) => {
-  project.use(quiltModule());
-});

package/templates/package/quilt.project.ts

@@ -1,5 +0,0 @@
-import {createProject, quiltPackage} from '@quilted/craft';
-
-export default createProject((project) => {
-  project.use(quiltPackage());
-});

package/templates/package/source/tests/index.test.ts

@@ -1,8 +0,0 @@
-import {describe, it, expect} from '@quilted/testing';
-import {run} from '..';
-
-describe('package', () => {
-  it('returns something fun', () => {
-    expect(run()).toContain('fun');
-  });
-});

package/templates/package-simple/README.md

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

package/templates/package-simple/package.json

@@ -1,49 +0,0 @@
-{
-  "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"
-    }
-  },
-  "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": {
-    "react": "npm:@quilted/react@^18.2.0"
-  },
-  "browserslist": [
-    "defaults and fully supports es6-module",
-    "maintained node versions"
-  ]
-}

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

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

package/templates/package-simple/tsconfig.json

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