Merge pull request #5352 from NomicFoundation/example-project

Example project

Author: alcuadrado

.github/workflows/v-next-ci.yml

@@ -47,7 +47,7 @@ jobs:
       - uses: actions/checkout@v4
       - id: list
         run: |
-          echo "packages=$(ls -d v-next/* | xargs -n 1 basename| jq -R -s -c 'split("\n")[:-1]')" >> $GITHUB_OUTPUT
+          echo "packages=$(ls -d v-next/* | xargs -n 1 basename | grep -v example-project | jq -R -s -c 'split("\n")[:-1]')" >> $GITHUB_OUTPUT
 
   lint:
     needs: list-packages

pnpm-lock.yaml

@@ -20,6 +20,11 @@ for (const dir of dirs) {
     continue;
   }
 
+  // Same with the example project, we don't use the same scripts
+  if (dir.name === "example-project") {
+    continue;
+  }
+
   const packageJsonPath = path.resolve(vNextDir, dir.name, "package.json");
   const packageJson = require(packageJsonPath);
 

scripts/check-v-next-npm-scripts.js

@@ -0,0 +1,5 @@
+# Node modules
+/node_modules
+
+# Compilation output
+/dist

v-next/example-project/.gitignore

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024 Nomic Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

v-next/example-project/LICENSE

@@ -0,0 +1,11 @@
+# Hardhat example project
+
+This is an example hardhat v3 project, which you can use to experiment with the developnment version.
+
+To use it you have to `cd` into this folder and run:
+
+```sh
+pnpm install
+pnpm build
+pnpm hardhat
+```

v-next/example-project/README.md

@@ -0,0 +1,16 @@
+import { task, HardhatUserConfig } from "@nomicfoundation/hardhat/config";
+
+export default {
+  tasks: [
+    task("hello", "Prints a greeting")
+      .addNamedParameter({
+        name: "greeting",
+        description: "The greeting to print",
+        defaultValue: "Hello, World!",
+      })
+      .setAction(async ({ greeting }, _) => {
+        console.log(greeting);
+      })
+      .build(),
+  ],
+} satisfies HardhatUserConfig;

v-next/example-project/hardhat.config.ts

@@ -0,0 +1,25 @@
+{
+  "name": "@nomicfoundation/example-project",
+  "private": true,
+  "version": "3.0.0",
+  "description": "Example project using Hardhat v3",
+  "homepage": "https://github.com/nomicfoundation/hardhat/tree/v-next/v-next/example-project",
+  "repository": "github:nomicfoundation/hardhat",
+  "author": "Nomic Foundation",
+  "license": "MIT",
+  "type": "module",
+  "scripts": {
+    "lint": "pnpm prettier --check",
+    "lint:fix": "pnpm prettier --write",
+    "prettier": "prettier \"**/*.{ts,js,md,json}\"",
+    "build": "tsc --build .",
+    "prepublishOnly": "pnpm build",
+    "clean": "rimraf dist"
+  },
+  "devDependencies": {
+    "@nomicfoundation/hardhat": "workspace:^3.0.0",
+    "@types/node": "^20.0.0",
+    "prettier": "3.2.5",
+    "typescript": "~5.4.0"
+  }
+}

v-next/example-project/package.json

@@ -0,0 +1,18 @@
+{
+  "extends": "../../config-v-next/tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "composite": true,
+    "incremental": true
+  },
+  "exclude": [
+    "./dist",
+    "./node_modules",
+    "./test/fixture-projects/hardhat.config.ts"
+  ],
+  "references": [
+    {
+      "path": "../hardhat"
+    }
+  ]
+}