Function createDefaultTemplate

packages/cli/template.ts:16–67

(
  dependencies: Record<string, string>,
  isCommentWithDev: boolean,
  selectedPackageManager: ("npm" | "yarn" | "pnpm" | "bun")[],
)

}

export const createDefaultTemplate = (
  dependencies: Record<string, string>,
  isCommentWithDev: boolean,
  selectedPackageManager: ("npm" | "yarn" | "pnpm" | "bun")[],
) => ({
  "index.js": "",
  "README.md": `
# Default Template

This is a template that leverages the experimental templates feature in the \`pkg.pr.new\` tool.

## Overview

Templates are particularly useful for creating live, interactive examples of your packages, which can be very beneficial for both development and documentation purposes.

As a user, you can check the package.json file and see the new generated packages! You can just copy those and put them in your package.json or install them with your favorite package manager.

${Object.values(dependencies)
  .map((url) =>
    generateShellCommand(url, isCommentWithDev, selectedPackageManager),
  )
  .join("")}

## Usage

To use this feature as a maintainer, you can run the following command:

\`\`\`sh
pnpm exec pkg-pr-new publish './packages/A' --template './examples/*'${isCommentWithDev ? " --commentWithDev" : ""}
\`\`\`

## Benefits

- Interactive Demos: Automatically create live demos that users can interact with directly in their browser.
- Enhanced Testing: Quickly spin up environments to test your package in different scenarios.
- Improved Sharing: Easily share working examples of your package with collaborators or users without needing them to set up their environment.
`,
  "package.json": JSON.stringify(
    {
      name: "default",
      version: "1.0.0",
      description: "generated by pkg.pr.new",
      main: "index.js",
      [isCommentWithDev ? "devDependencies" : "dependencies"]: dependencies,
      keywords: [],
      author: "pkg.pr.new",
      license: "ISC",
    },
    null,
    2,
  ),
});