Merge branch 'v-next' into change-the-type-of-package-name

Author: ChristopherDedominici

.changeset/purple-pans-happen.md

@@ -0,0 +1,5 @@
+---
+"hardhat": patch
+---
+
+Added Hardhat v2 template support to `hardhat --init` ([#7035](https://github.com/NomicFoundation/hardhat/issues/7035))

pnpm-lock.yaml

@@ -1,3 +1,3 @@
 packages:
   - "v-next/*"
-  - "v-next/hardhat/templates/*"
+  - "v-next/hardhat/templates/hardhat-3/*"

pnpm-workspace.yaml

@@ -2,7 +2,7 @@
 /dist
 /CHANGELOG.md
 /src/internal/cli/telemetry/sentry/vendor
-/templates/*/artifacts
-/templates/*/cache
+/templates/*/*/artifacts
+/templates/*/*/cache
 /test/fixture-projects/**/artifacts
 /test/fixture-projects/**/cache

v-next/hardhat/.prettierignore

@@ -37,11 +37,13 @@ import {
   promptForTemplate,
   promptForUpdate,
   promptForWorkspace,
+  promptForHardhatVersion,
 } from "./prompt.js";
 import { spawn } from "./subprocess.js";
 import { getTemplates } from "./template.js";
 
 export interface InitHardhatOptions {
+  hardhatVersion?: "hardhat-2" | "hardhat-3";
   workspace?: string;
   migrateToEsm?: boolean;
   template?: string;
@@ -85,17 +87,24 @@ export async function initHardhat(options?: InitHardhatOptions): Promise<void> {
 
     await printWelcomeMessage();
 
+    const hardhatVersion =
+      options?.hardhatVersion ?? (await promptForHardhatVersion());
+
     // Ask the user for the workspace to initialize the project in
     // if it was not provided, and validate that it is not already initialized
     const workspace = await getWorkspace(options?.workspace);
 
-    // Create the package.json file if it does not exist
-    // and validate that it is an esm package
-    await validatePackageJson(workspace, options?.migrateToEsm);
-
     // Ask the user for the template to use for the project initialization
     // if it was not provided, and validate that it exists
-    const template = await getTemplate(options?.template);
+    const template = await getTemplate(hardhatVersion, options?.template);
+
+    // Create the package.json file if it does not exist
+    // and validate that it is an esm package
+    await validatePackageJson(
+      workspace,
+      template.packageJson,
+      options?.migrateToEsm,
+    );
 
     // Copy the template files to the workspace
     // Overwrite existing files only if the user opts-in to it
@@ -234,8 +243,11 @@ export async function getWorkspace(workspace?: string): Promise<string> {
  * @param template The name of the template to use for the project initialization.
  * @returns
  */
-export async function getTemplate(template?: string): Promise<Template> {
-  const templates = await getTemplates();
+export async function getTemplate(
+  hardhatVersion: "hardhat-2" | "hardhat-3",
+  template?: string,
+): Promise<Template> {
+  const templates = await getTemplates(hardhatVersion);
 
   // Ask the user for the template to use for the project initialization if it was not provided
   if (template === undefined) {
@@ -266,21 +278,57 @@ export async function getTemplate(template?: string): Promise<Template> {
  */
 export async function validatePackageJson(
   workspace: string,
+  templatePkg: PackageJson,
   migrateToEsm?: boolean,
 ): Promise<void> {
   const absolutePathToPackageJson = path.join(workspace, "package.json");
+  const shouldUseEsm = templatePkg.type === "module";
 
   // Create the package.json file if it does not exist
   if (!(await exists(absolutePathToPackageJson))) {
     const packageJson: PackageJson = {
       name: path.basename(workspace),
-      type: "module",
       version: "1.0.0",
     };
 
+    if (shouldUseEsm) {
+      packageJson.type = "module";
+    }
+
     await writeJsonFile(absolutePathToPackageJson, packageJson);
   }
 
+  const packageManager = await getPackageManager(workspace);
+
+  // We know this works with npm, pnpm, but not with yarn. If, so we use
+  // pnpm or npm exclusively.
+  // If you read this comment and wonder if this is outdated, you can
+  // answer it by checking if the most popular versions of yarn and other
+  // package managers support `<package manager> pkg set type=module`.
+  const packageManagerToUse = packageManager === "pnpm" ? "pnpm" : "npm";
+
+  // We need to set the hardhat version in the package.json file
+  // to ensure that the template is compatible with the current Hardhat version.
+  // This is needed because we have hardhat-2 and hardhat-3 templates,
+  // and the user may install hardhat 3 first and then initialize a project
+  // with a hardhat-2 template.
+  const templateHardhatVersion = templatePkg.devDependencies?.hardhat ?? "";
+  if (templateHardhatVersion.startsWith("^2")) {
+    await spawn(
+      [packageManagerToUse, "pkg", "delete", "dependencies.hardhat"].join(" "),
+      [],
+      {
+        cwd: workspace,
+        shell: true,
+        stdio: "inherit",
+      },
+    );
+  }
+
+  if (!shouldUseEsm) {
+    return;
+  }
+
   const pkg: PackageJson = await readJsonFile(absolutePathToPackageJson);
 
   // Validate that the package.json file is an esm package
@@ -296,15 +344,6 @@ export async function validatePackageJson(
     throw new HardhatError(HardhatError.ERRORS.CORE.GENERAL.ONLY_ESM_SUPPORTED);
   }
 
-  const packageManager = await getPackageManager(workspace);
-
-  // We know this works with npm, pnpm, but not with yarn. If, so we use
-  // pnpm or npm exclusively.
-  // If you read this comment and wonder if this is outdated, you can
-  // answer it by checking if the most popular versions of yarn and other
-  // package managers support `<package manager> pkg set type=module`.
-  const packageManagerToUse = packageManager === "pnpm" ? "pnpm" : "npm";
-
   await spawn(
     [packageManagerToUse, "pkg", "set", "type=module"].join(" "),
     [],

v-next/hardhat/src/internal/cli/init/init.ts

@@ -4,6 +4,39 @@ import { HardhatError } from "@nomicfoundation/hardhat-errors";
 import { shortenPath } from "@nomicfoundation/hardhat-utils/path";
 import chalk from "chalk";
 
+export async function promptForHardhatVersion(): Promise<
+  "hardhat-2" | "hardhat-3"
+> {
+  ensureTTY();
+
+  const { default: enquirer } = await import("enquirer");
+
+  const hardhatVersionResponse = await enquirer.prompt<{
+    hardhatVersion: "hardhat-2" | "hardhat-3";
+  }>([
+    {
+      name: "hardhatVersion",
+      type: "select",
+      message: "Which version of Hardhat would you like to use?",
+      initial: 0,
+      choices: [
+        {
+          name: "hardhat-3",
+          message: "Hardhat 3 (recommended for new projects)",
+          value: "hardhat-3",
+        },
+        {
+          name: "hardhat-2",
+          message: "Hardhat 2 (older version)",
+          value: "hardhat-2",
+        },
+      ],
+    },
+  ]);
+
+  return hardhatVersionResponse.hardhatVersion;
+}
+
 export async function promptForWorkspace(): Promise<string> {
   ensureTTY();
 

v-next/hardhat/src/internal/cli/init/prompt.ts

@@ -34,9 +34,11 @@ export interface Template {
  *
  * @returns The list of available templates.
  */
-export async function getTemplates(): Promise<Template[]> {
+export async function getTemplates(
+  templatesDir: "hardhat-2" | "hardhat-3",
+): Promise<Template[]> {
   const packageRoot = await findClosestPackageRoot(import.meta.url);
-  const pathToTemplates = path.join(packageRoot, "templates");
+  const pathToTemplates = path.join(packageRoot, "templates", templatesDir);
 
   if (!(await exists(pathToTemplates))) {
     return [];

v-next/hardhat/src/internal/cli/init/template.ts

@@ -55,6 +55,7 @@ export class Anonymizer {
     const result: Event = {
       event_id: event.event_id,
       platform: event.platform,
+      release: event.release,
       timestamp: event.timestamp,
       extra: event.extra,
     };

v-next/hardhat/src/internal/cli/telemetry/sentry/anonymizer.ts

@@ -30,6 +30,7 @@ import { createGetModuleFromFilename } from "./vendor/utils/module.js";
 interface InitOptions {
   dsn: string;
   transport: (transportOptions: BaseTransportOptions) => Transport;
+  release?: string;
   serverName?: string;
   integrations?: (integrations: Integration[]) => Integration[];
 }

v-next/hardhat/src/internal/cli/telemetry/sentry/init.ts

@@ -68,6 +68,7 @@ class Reporter {
       "./vendor/integrations/contextlines.js"
     );
 
+    const hardhatVersion = await getHardhatVersion();
     const { init } = await import("./init.js");
 
     const linkedErrorsIntegrationInstance = linkedErrorsIntegration({
@@ -79,14 +80,15 @@ class Reporter {
     await init({
       dsn: SENTRY_DSN,
       transport: makeSubprocessTransport,
+      release: `hardhat@${hardhatVersion}`,
       integrations: () => [
         linkedErrorsIntegrationInstance,
         contextLinesIntegrationInstance,
       ],
     });
 
     setExtra("nodeVersion", process.version);
-    setExtra("hardhatVersion", await getHardhatVersion());
+    setExtra("hardhatVersion", hardhatVersion);
 
     return this.#instance;
   }