Feat/template based project creation

.github/workflows/publish.yml

@@ -0,0 +1,119 @@
+name: Publish Release
+
+on:
+  push:
+    branches:
+      - main # Trigger on pushes to the main branch
+
+# Keep workflow_call secrets definition for potential future use or reference
+# workflow_call:
+#   secrets:
+#     NPM_TOKEN:
+#       required: true
+#     SLACK_WEBHOOK_URL:
+#       required: true
+#     PUBLISH_DOCS_TOKEN:
+#       required: true
+
+jobs:
+  publish-release:
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout and setup environment
+        uses: MetaMask/action-checkout-and-setup@v1
+        with:
+          is-high-risk-environment: true
+          ref: ${{ github.sha }}
+      # This assumes your build command is 'yarn build' and output is 'dist'
+      - run: yarn build
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: publish-release-artifacts-${{ github.sha }}
+          retention-days: 4
+          include-hidden-files: true
+          path: |
+            ./dist
+            ./node_modules/.yarn-state.yml
+
+  publish-npm-dry-run:
+    needs: publish-release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout and setup environment
+        uses: MetaMask/action-checkout-and-setup@v1
+        with:
+          is-high-risk-environment: true
+          ref: ${{ github.sha }}
+      - name: Restore build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: publish-release-artifacts-${{ github.sha }}
+      - name: Dry Run Publish
+        # omit npm-token token to perform dry run publish
+        uses: MetaMask/action-npm-publish@v5
+        with:
+          slack-webhook-url: ${{ secrets.SLACK_WEBHOOK_URL }}
+          subteam: S042S7RE4AE # @metamask-npm-publishers
+        env:
+          SKIP_PREPACK: true
+
+  publish-npm:
+    needs: publish-npm-dry-run
+    runs-on: ubuntu-latest
+    environment: npm-publish
+    steps:
+      - name: Checkout and setup environment
+        uses: MetaMask/action-checkout-and-setup@v1
+        with:
+          is-high-risk-environment: true
+          ref: ${{ github.sha }}
+      - name: Restore build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: publish-release-artifacts-${{ github.sha }}
+      - name: Publish
+        uses: MetaMask/action-npm-publish@v5
+        with:
+          npm-token: ${{ secrets.NPM_TOKEN }}
+        env:
+          SKIP_PREPACK: true
+
+  get-release-version:
+    needs: publish-npm
+    runs-on: ubuntu-latest
+    outputs:
+      RELEASE_VERSION: ${{ steps.get-release-version.outputs.RELEASE_VERSION }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.sha }}
+      - id: get-release-version
+        # Use Node.js to extract version from package.json
+        run: echo "RELEASE_VERSION=$(node -p "require('./package.json').version")" >> $GITHUB_OUTPUT
+
+  # The following jobs depend on ./.github/workflows/publish-docs.yml
+  # Commenting them out for now. Uncomment and create publish-docs.yml if needed.
+  # publish-release-to-gh-pages:
+  #   name: Publish docs to ${{ needs.get-release-version.outputs.RELEASE_VERSION }} directory of gh-pages branch
+  #   needs: get-release-version
+  #   permissions:
+  #     contents: write
+  #   uses: ./.github/workflows/publish-docs.yml
+  #   with:
+  #     destination_dir: ${{ needs.get-release-version.outputs.RELEASE_VERSION }}
+  #   secrets:
+  #     PUBLISH_DOCS_TOKEN: ${{ secrets.PUBLISH_DOCS_TOKEN }} # Requires PUBLISH_DOCS_TOKEN secret
+
+  # publish-release-to-latest-gh-pages:
+  #   name: Publish docs to latest directory of gh-pages branch
+  #   needs: publish-npm
+  #   permissions:
+  #     contents: write
+  #   uses: ./.github/workflows/publish-docs.yml
+  #   with:
+  #     destination_dir: latest
+  #   secrets:
+  #     PUBLISH_DOCS_TOKEN: ${{ secrets.PUBLISH_DOCS_TOKEN }} # Requires PUBLISH_DOCS_TOKEN secret

.gitignore

@@ -1,4 +1,11 @@
 node_modules
 demo
 *.yaml
-dist
+dist
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+.env.development
+.env.test

README.md

@@ -21,13 +21,13 @@ To create a new project using the Web3 Template CLI, run one of the following co
 Using **pnpm**:
 
 ```bash
-pnpm create @metamask/create-web3-app [project-name]
+pnpm create @consensys/create-web3-app [project-name]
 ```
 
 Using **npx**:
 
 ```bash
-npx @metamask/create-web3-app [project-name]
+npx @consensys/create-web3-app [project-name]
 ```
 
 ### Interactive Setup
@@ -42,7 +42,7 @@ After running the command, the CLI will guide you through the setup process with
 ### Example
 
 ```bash
-npx @metamask/create-web3-app my-web3-project
+npx @consensys/create-web3-app my-web3-project
 ```
 
 ## Project Structure

package.json

@@ -1,15 +1,16 @@
 {
-  "name": "@metamask/create-web3-app",
+  "name": "@consensys/create-web3-app",
   "type": "module",
   "module": "dist/index.js",
   "bin": {
     "create-web3-app": "dist/index.js"
   },
-  "version": "1.0.0",
+  "version": "1.1.5",
   "description": "CLI tool for generating Web3 starter projects, streamlining the setup of monorepo structures with a frontend (Next.js or React) and blockchain tooling (HardHat or Foundry). It leverages the commander library for command-line interactions and guides users through selecting a framework, package manager (npm, yarn, pnpm), and blockchain stack.",
   "main": "index.js",
   "scripts": {
     "dev": "tsc -w",
+    "build": "tsc",
     "link-cli": "yarn unlink --global create-web3-app && yarn link --global create-web3-app",
     "test": "vitest"
   },
@@ -26,10 +27,17 @@
   "author": "cxalem",
   "license": "MIT",
   "dependencies": {
+    "@segment/analytics-node": "^2.2.1",
+    "@types/degit": "^2.8.6",
+    "chalk": "^5.4.1",
     "commander": "12.0.0",
+    "degit": "^2.8.4",
+    "dotenv": "^16.5.0",
     "fs": "0.0.1-security",
     "inquirer": "9.2.15",
-    "memfs": "^4.9.3"
+    "memfs": "^4.9.3",
+    "ora": "^8.2.0",
+    "uuid": "^11.1.0"
   },
   "devDependencies": {
     "@types/inquirer": "9.0.7",
@@ -41,6 +49,10 @@
     "type": "git",
     "url": "git+https://github.com/MetaMask/create-web3-app.git"
   },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
   "bugs": {
     "url": "https://github.com/MetaMask/create-web3-app/issues"
   },

src/analytics/index.ts

@@ -0,0 +1,52 @@
+import os from "os";
+import { v4 as uuid } from "uuid";
+import { Analytics } from "@segment/analytics-node";
+
+const DEFAULT_WRITE_KEY = "AhYEnWamvR0lVj5JYLDsnxcySWdG6Q5J";
+const WRITE_KEY = process.env.SEGMENT_WRITE_KEY ?? DEFAULT_WRITE_KEY;
+const analyticsDisabled =
+  process.env.SEGMENT_OPT_OUT === "1" || process.env.CI === "true";
+
+const enabled = Boolean(WRITE_KEY) && !analyticsDisabled;
+
+type EVENTS =
+  | "project_created"
+  | "cli_started"
+  | "project_creation_failed"
+  | "foundry_not_installed"
+  | "git_not_installed"
+  | "cwd_not_writable";
+
+const analytics = enabled
+  ? new Analytics({ writeKey: WRITE_KEY })
+  : ({
+      track: () => {},
+      identify: () => {},
+      flush: () => Promise.resolve(),
+    } as unknown as Analytics);
+
+const anonymousId = uuid();
+
+export const identifyRun = () => {
+  if (!enabled) return;
+  analytics.identify({
+    anonymousId,
+    traits: {
+      os_platform: process.platform,
+      os_release: os.release(),
+      node_version: process.version,
+    },
+  });
+};
+
+export const track = (
+  event: EVENTS,
+  properties: Record<string, unknown> = {}
+) =>
+  analytics.track({
+    event,
+    anonymousId,
+    properties,
+  });
+
+export const flush = () => analytics.flush();

src/constants/index.ts

@@ -1,13 +1,15 @@
+import { execAsync } from "../utils/index.js";
+import { TEMPLATES } from "./templates.js";
+
+export { TEMPLATES } from "./templates.js";
+
 export const FRAMEWORK_CHOICES = [
-  {
-    name: "React (with Vite)",
-    value: "react",
-  },
   {
     name: "Next.js",
-    value: "nextjs",
+    value: "next-web3-starter",
   },
 ] as const;
+
 export const BLOCKCHAIN_TOOLING_CHOICES = [
   {
     name: "HardHat",
@@ -23,7 +25,7 @@ export const BLOCKCHAIN_TOOLING_CHOICES = [
   },
 ] as const;
 
-export const PACAKGE_MANAGER_CHOICES = [
+export const PACKAGE_MANAGER_CHOICES = [
   {
     name: "Yarn",
     value: "yarn",
@@ -38,17 +40,27 @@ export const PACAKGE_MANAGER_CHOICES = [
   },
 ] as const;
 
-export const NPM_COMMAND = (projectName: string, path: string) =>
-  path
-    ? `cd ${path} && npm init vite@latest . -- --template react-ts`
-    : `npm init vite@latest ${projectName} -- --template react-ts`;
+// Add a type helper to make working with templates easier
+type Template = (typeof TEMPLATES)[number];
+
+export type GitTemplate = Extract<Template, { repo_url: string }>;
+export type DegitTemplate = Extract<Template, { degitSource: string }>;
+
+export function isDegitTemplate(template: Template): template is DegitTemplate {
+  return "degitSource" in template;
+}
+
+export function isGitTemplate(template: Template): template is GitTemplate {
+  return "repo_url" in template;
+}
 
-export const YARN_COMMAND = (projectName: string, path: string) =>
-  path
-    ? `cd ${path} && yarn create vite . --template react-ts`
-    : `yarn create vite ${projectName} --template react-ts`;
+export const isGitAvailable = async (): Promise<boolean> => {
+  try {
+    await execAsync("git --version");
+    return true;
+  } catch {
+    return false;
+  }
+};
 
-export const PNPM_COMMAND = (projectName: string, path: string) =>
-  path
-    ? `cd ${path} && pnpm create vite . --template react-ts`
-    : `pnpm create vite ${projectName} --template react-ts`;
+export const CLI_VERSION = "1.1.5";

src/constants/templates.ts

@@ -1,14 +1,19 @@
 export const TEMPLATES = [
   {
-    name: "Next Web3 Starter",
-    id: "next-web3-starter",
-    repo_url: "https://github.com/Consensys/next-web3-starter.git",
-    packageName: "@consensys/web3-starter",
+    name: "MetaMask <-> Next.js Wagmi Quickstart",
+    id: "metamask-nextjs-wagmi",
+    degitSource: "MetaMask/metamask-sdk-examples/examples/quickstart",
   },
   {
-    name: "React Web3 Starter",
-    id: "react-web3-starter",
-    repo_url: "https://github.com/Consensys/react-web3-starter.git",
-    packageName: "@consensys/react-web3-starter",
+    name: "MetaMask <-> Web3Auth Quickstart",
+    id: "metamask-web3auth",
+    repo_url: "https://github.com/MetaMask/metamask-web3auth.git",
+    packageName: "metamask-web3auth",
+  },
+  {
+    name: "MetaMask <-> Dynamic Quickstart",
+    id: "metamask-dynamic",
+    repo_url: "https://github.com/MetaMask/metamask-dynamic.git",
+    packageName: "metamask-dynamic",
   },
 ] as const;

src/index.ts

@@ -1,5 +1,7 @@
 #!/usr/bin/env node
 
+import "dotenv/config";
+
 import { Command } from "commander";
 import { createProject } from "./utils/index.js";