create-stylus 0.0.5

package/.github/issue_template.md

@@ -0,0 +1,7 @@
+## Issue Overview
+
+Provide a brief summary of the issue, including the motivation for addressing it, the problems it presents, and any features required to resolve it.
+
+## Proposed Solutions or Ideas
+
+Outline your proposed solution or share any ideas you have for discussing or resolving the issue.

package/.github/pull_request_template.md

@@ -0,0 +1,11 @@
+# Task name here
+
+Fixes #relevant-issue-here
+
+## Types of change
+
+- [ ] Feature
+- [ ] Bug
+- [ ] Enhancement
+
+## Comments (optional)

package/.github/workflows/release-alpha.yml

@@ -0,0 +1,32 @@
+name: Publish Alpha
+
+on:
+ workflow_dispatch:
+
+jobs:
+ publish-alpha:
+   runs-on: ubuntu-22.04
+   
+   steps:
+     - name: Checkout
+       uses: actions/checkout@v4
+       with:
+         ref: main
+
+     - name: Set up Node.js
+       uses: actions/setup-node@v3
+       with:
+         node-version: "22"
+         registry-url: "https://registry.npmjs.org/"
+
+     - name: Bump alpha version
+       run: |
+         git config --global user.name 'github-actions[bot]'
+         git config --global user.email 'github-actions[bot]@users.noreply.github.com'
+         npm version prerelease --preid=alpha
+
+     - name: Publish alpha
+       run: |
+         npm install && npm run build && npm publish --tag alpha
+       env:
+         NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/release-manual.yml

@@ -0,0 +1,26 @@
+name: Publish Latest Manual
+
+on:
+  workflow_dispatch:
+
+jobs:
+  publish-alpha:
+    runs-on: ubuntu-22.04
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          ref: main
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "22"
+          registry-url: "https://registry.npmjs.org/"
+
+      - name: Publish alpha
+        run: |
+          npm install && npm run build && npm publish --tag latest
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

package/CONTRIBUTING.md

@@ -0,0 +1,42 @@
+# Contributing to Scaffold-Stylus (`create-stylus`)
+
+> `create-stylus` is part of the Scaffold-Stylus toolkit
+
+Thank you for your interest in contributing to Scaffold-Stylus! Your support enhances this Arbitrum-focused framework that bridges smart contract integration with web applications.
+
+## About the Project
+
+**Scaffold-Stylus** provides a full DApp development template, offering seamless integration of Stylus smart contracts with web applications. **SpeedrunStylus.com** offers interactive challenges that serve to practice your Rust with Stylus and Arbitrum skills, learn how to use the provided hooks, and launch your applications swiftly with potential rewards.
+
+## Project Vision
+
+Our goal is to simplify the DApp development and learning process, enabling developers to launch applications efficiently while understanding the intricacies of Arbitrum.
+
+## How to Get Involved
+
+1. **Understand the Code**: Begin by familiarizing yourself with the architecture and flow by reading through the documentation provided in the README.md.
+2. **Check Issues and Discussions**: Look through existing issues and discussions to understand ongoing problems or feature requests.
+3. **Start Contributing**:
+   - **Fix Issues**: Choose an existing issue and work towards a solution.
+   - **Enhance Documentation**: Improve instructions, examples, or explanations.
+   - **Develop New Features**: Contribute new features that align with our project's goals.
+
+## Making Changes
+
+- **Branch Out**: Always work in a separate branch to avoid conflicts.
+- **Coding Standards**: Follow the coding conventions and maintain the code quality as described in our documentation.
+- **Commit Messages**: Write clear, concise commit messages that describe your changes and their impact.
+
+## Submitting Contributions
+
+1. **Pull Requests**: Submit a PR to the main repository with a detailed description of your changes.
+2. **Review Process**: Engage with any feedback from maintainers to refine your PR.
+3. **Tests**: Ensure all tests pass and, if necessary, add new tests relevant to your changes.
+
+## Documentation
+
+If your changes involve updates to how users interact with Scaffold-Stylus or SpeedrunStylus, update the relevant sections of the documentation to reflect these changes.
+
+## Need Help?
+
+Reach out via our community channels if you encounter issues or need clarification on contributing [here](https://t.me/+wO3PtlRAreo4MDI9).

package/README.md

@@ -0,0 +1,66 @@
+> ⚠️ Under active development.
+
+# 🏗 create-stylus
+
+CLI to create decentralized applications (dapps) using Scaffold-Stylus.
+
+This is an alternative method of installing Scaffold-Stylus. Instead of directly [cloning SS](https://github.com/Arb-Stylus/scaffold-stylus?tab=readme-ov-file#quickstart), you can use create-stylus to create your own custom instance, where you can choose among several configurations and extensions.
+
+<h4 align="center">
+  <a href="https://github.com/Arb-Stylus/scaffold-stylus">SS Repo</a> |
+  <a href="https://arb-stylus.github.io/scaffold-stylus-docs/">SS Docs</a> |
+  <a href="https://www.scaffoldstylus.com/">SS Website</a>
+</h4>
+
+## Requirements
+
+Before you begin, you need to install the following tools:
+
+- [Node (>= v18.17)](https://nodejs.org/en/download/)
+- Yarn ([v1](https://classic.yarnpkg.com/en/docs/install/) or [v2+](https://yarnpkg.com/getting-started/install))
+- [Git](https://git-scm.com/downloads)
+
+## Quickstart
+
+To get started building Create-Stylus, follow the steps below:
+
+1. Install dependencies.
+
+```
+yarn install
+```
+
+2. Build Create-Stylus:
+
+```
+yarn build
+```
+
+3. Test Create-Stylus:
+
+```
+yarn cli [...options]
+```
+
+## Extensions
+
+Now you can choose from some preset extensions to ship your dApp faster! You can embed the Erc 20 indexer during the Scaffold-Stylus creation by running the following commands:
+
+```bash
+npx create-stylus@latest --extension erc-20
+```
+
+## Documentation
+
+Visit our [docs](https://arb-stylus.github.io/scaffold-stylus-docs/) to learn how to start building with Scaffold-Stylus.
+
+To know more about its features, check out our [website](https://www.scaffoldstylus.com/).
+
+## Contributing to create-stylus
+
+We welcome contributions to create-stylus and Scaffold-Stylus!
+
+For more information and guidelines for contributing, please see:
+
+- [create-stylus CONTRIBUTING.MD](https://github.com/Arb-Stylus/create-stylus/blob/main/CONTRIBUTING.md) if you want to contribute to the CLI.
+- [Scaffold-Stylus CONTRIBUTING.MD](https://github.com/Arb-Stylus/scaffold-stylus/blob/main/CONTRIBUTING.md) if you want to contribute to SS base code.

package/bin/create-dapp-ss.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { cli } from "../dist/cli.js";
+
+cli(process.argv);

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "create-stylus",
+  "version": "0.0.5",
+  "author": "Q3 Labs",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Arb-Stylus/create-stylus.git"
+  },
+  "type": "module",
+  "main": "dist/cli.js",
+  "bin": "bin/create-dapp-ss.js",
+  "scripts": {
+    "build": "rollup -c rollup.config.js",
+    "dev": "rollup -c rollup.config.js --watch",
+    "cli": "node bin/create-dapp-ss.js",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "changeset:release": "yarn build && changeset publish"
+  },
+  "devDependencies": {
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "16.0.1",
+    "@rollup/plugin-typescript": "12.1.2",
+    "@types/inquirer": "9.0.7",
+    "@types/listr": "0.14.9",
+    "@types/ncp": "2.0.8",
+    "@types/node": "22.14.0",
+    "rollup": "4.39.0",
+    "rollup-plugin-auto-external": "2.0.0",
+    "tslib": "2.8.1",
+    "typescript": "5.8.3"
+  },
+  "dependencies": {
+    "@changesets/cli": "^2.28.1",
+    "arg": "5.0.2",
+    "chalk": "5.4.1",
+    "execa": "9.5.2",
+    "handlebars": "^4.7.8",
+    "inquirer": "9.2.0",
+    "listr": "0.14.3",
+    "merge-packages": "^0.1.6",
+    "ncp": "2.0.0",
+    "pkg-install": "1.0.0"
+  },
+  "packageManager": "yarn@3.5.0"
+}

package/rollup.config.js

@@ -0,0 +1,22 @@
+import typescript from "@rollup/plugin-typescript";
+import autoExternal from "rollup-plugin-auto-external";
+import nodeResolve from "@rollup/plugin-node-resolve";
+import json from "@rollup/plugin-json";
+
+export default {
+  input: "src/cli.ts",
+  output: {
+    dir: "dist",
+    format: "es",
+    sourcemap: true,
+  },
+  plugins: [
+    json(),
+    nodeResolve(), 
+    autoExternal(), 
+    typescript({ 
+      include: ["src/**/*.ts"],
+      exclude: ["templates/**"] 
+    })
+  ],
+};

package/src/cli.ts

@@ -0,0 +1,14 @@
+import { createProject } from "./main";
+import { parseArgumentsIntoOptions } from "./utils/parse-arguments-into-options";
+import { promptForMissingOptions } from "./utils/prompt-for-missing-options";
+import { renderIntroMessage } from "./utils/render-intro-message";
+import type { Args } from "./types";
+
+export async function cli(args: Args) {
+  renderIntroMessage();
+
+  const rawOptions = parseArgumentsIntoOptions(args);
+  const options = await promptForMissingOptions(rawOptions);
+
+  await createProject(options);
+}

package/src/extensions.json

@@ -0,0 +1,14 @@
+[
+  {
+    "extensionFlagValue": "erc-20",
+    "description": "Adds support for ERC-20 token contracts, including balance checks and token transfers.",
+    "repository": "https://github.com/Arb-Stylus/create-stylus-extensions",
+    "branch": "erc-20"
+  },
+  {
+    "extensionFlagValue": "erc-721",
+    "description": "Adds support for ERC-721 NFT contracts, including supply, balance, listing, and transfer features.",
+    "repository": "https://github.com/Arb-Stylus/create-stylus-extensions",
+    "branch": "erc-721"
+  }
+]

package/src/main.ts

@@ -0,0 +1,72 @@
+import {
+  copyTemplateFiles,
+  createProjectDirectory,
+  installPackages,
+  createFirstGitCommit,
+  prettierFormat,
+} from "./tasks";
+import type { Options } from "./types";
+import { renderOutroMessage } from "./utils/render-outro-message";
+import chalk from "chalk";
+import Listr from "listr";
+import path from "path";
+import { fileURLToPath } from "url";
+
+export async function createProject(options: Options) {
+  console.log(`\n`);
+
+  const currentFileUrl = import.meta.url;
+
+  const templateDirectory = path.resolve(
+    decodeURI(fileURLToPath(currentFileUrl)),
+    "../../templates",
+  );
+
+  const targetDirectory = path.resolve(process.cwd(), options.directory);
+
+  const tasks = new Listr([
+    {
+      title: `📁 Create project directory ${targetDirectory}`,
+      task: () => createProjectDirectory(options.directory),
+    },
+    {
+      title: `🚀 Creating a new Scaffold-Stylus 2 app${
+        options.extension
+          ? ` with ${chalk.green.bold(options.extension)} extension`
+          : ""
+      } in ${chalk.green.bold(options.directory)}`,
+      task: () =>
+        copyTemplateFiles(options, templateDirectory, targetDirectory),
+    },
+    {
+      title: `📦 Installing dependencies with yarn, this could take a while`,
+      task: () => installPackages(targetDirectory, options),
+      skip: () => {
+        if (!options.install) {
+          return "Manually skipped";
+        }
+      },
+    },
+    {
+      title: "🪄 Formatting Next.js files with prettier",
+      task: () => prettierFormat(targetDirectory),
+      skip: () => {
+        if (!options.install) {
+          return "Skipping because prettier install was skipped";
+        }
+      },
+    },
+    {
+      title: `📡 Initializing Git repository`,
+      task: () => createFirstGitCommit(targetDirectory),
+    },
+  ]);
+
+  try {
+    await tasks.run();
+    renderOutroMessage(options);
+  } catch (error) {
+    console.log("%s Error occurred", chalk.red.bold("ERROR"), error);
+    console.log("%s Exiting...", chalk.red.bold("Uh oh! 😕 Sorry about that!"));
+  }
+}

package/src/tasks/copy-extension-file.ts

@@ -0,0 +1,227 @@
+import path from "path";
+import fs from "fs";
+import { execa } from "execa";
+import { findExtensionByFlag } from "../utils/load-extensions";
+import type { Extension } from "../types";
+
+export async function copyExtensionFile(extensionName: string, targetDirectory: string) {
+
+  if (!extensionName || extensionName.trim() === "") {
+    return;
+  }
+
+  const extensionConfig = findExtensionByFlag(extensionName);
+
+  if (!extensionConfig) {
+    return;
+  }
+
+  const targetPackagesDir = path.join(targetDirectory, "packages");
+  
+  if (!fs.existsSync(targetPackagesDir)) {
+    return;
+  }
+
+  try {
+    const tempDir = path.join(targetDirectory, ".temp-extension");
+    fs.mkdirSync(tempDir, { recursive: true });
+
+    await cloneExtensionRepository(extensionConfig, tempDir);
+
+    await copyExtensionFiles(tempDir, targetPackagesDir, extensionConfig.extensionFlagValue);
+
+    await mergePackageJsonFiles(tempDir, targetPackagesDir, extensionConfig.extensionFlagValue);
+
+    await mergeRootPackageJson(tempDir, targetDirectory, extensionConfig.extensionFlagValue);
+
+    fs.rmSync(tempDir, { recursive: true, force: true });
+
+  } catch (error) {
+    throw error;
+  }
+}
+
+async function cloneExtensionRepository(extension: Extension, tempDir: string) {
+  try {
+    const { stdout, stderr } = await execa("git", [
+      "clone",
+      "--branch", extension.branch,
+      "--single-branch",
+      "--depth", "1",
+      extension.repository,
+      tempDir
+    ]);
+
+  } catch (error) {
+    throw error;
+  }
+}
+
+async function copyExtensionFiles(tempDir: string, targetPackagesDir: string, extensionName: string) {
+  let extensionPackageDir = path.join(tempDir, "packages", extensionName);
+  
+  if (!fs.existsSync(extensionPackageDir)) {
+    extensionPackageDir = path.join(tempDir, "extensions", "packages", extensionName);
+  }
+  
+  if (fs.existsSync(extensionPackageDir)) {
+    const targetExtensionDir = path.join(targetPackagesDir, extensionName);
+    copyDirectoryRecursive(extensionPackageDir, targetExtensionDir);
+  }
+  
+  let extensionPackagesDir = path.join(tempDir, "packages");
+  
+  if (!fs.existsSync(extensionPackagesDir)) {
+    extensionPackagesDir = path.join(tempDir, "extensions", "packages");
+  }
+  
+  if (fs.existsSync(extensionPackagesDir)) {
+    const packages = fs.readdirSync(extensionPackagesDir);
+    
+    for (const packageName of packages) {
+      if (packageName === extensionName) {
+        continue;
+      }
+      
+      const sourcePackageDir = path.join(extensionPackagesDir, packageName);
+      const targetPackageDir = path.join(targetPackagesDir, packageName);
+      
+      if (fs.existsSync(targetPackageDir)) {
+        mergeDirectoryRecursive(sourcePackageDir, targetPackageDir);
+      } else {
+        copyDirectoryRecursive(sourcePackageDir, targetPackageDir);
+      }
+    }
+  }
+}
+
+async function mergePackageJsonFiles(tempDir: string, targetPackagesDir: string, extensionName: string) {
+  let extensionPackagesDir = path.join(tempDir, "packages");
+  
+  if (!fs.existsSync(extensionPackagesDir)) {
+    extensionPackagesDir = path.join(tempDir, "extensions", "packages");
+  }
+  
+  if (!fs.existsSync(extensionPackagesDir)) {
+    return;
+  }
+  
+  const packages = fs.readdirSync(extensionPackagesDir);
+  
+  for (const packageName of packages) {
+    const sourcePackageDir = path.join(extensionPackagesDir, packageName);
+    const targetPackageDir = path.join(targetPackagesDir, packageName);
+    
+    if (fs.existsSync(targetPackageDir)) {
+      const sourcePackageJsonPath = path.join(sourcePackageDir, "package.json");
+      const targetPackageJsonPath = path.join(targetPackageDir, "package.json");
+      
+      if (fs.existsSync(sourcePackageJsonPath) && fs.existsSync(targetPackageJsonPath)) {
+        mergePackageJson(sourcePackageJsonPath, targetPackageJsonPath);
+      }
+    }
+  }
+}
+
+async function mergeRootPackageJson(tempDir: string, targetDirectory: string, extensionName: string) {
+  let extensionRootPackageJsonPath = path.join(tempDir, "package.json");
+  
+  if (!fs.existsSync(extensionRootPackageJsonPath)) {
+    extensionRootPackageJsonPath = path.join(tempDir, "extensions", "package.json");
+  }
+  
+  if (!fs.existsSync(extensionRootPackageJsonPath)) {
+    return;
+  }
+  
+  const targetRootPackageJsonPath = path.join(targetDirectory, "package.json");
+  
+  if (fs.existsSync(targetRootPackageJsonPath)) {
+    mergePackageJson(extensionRootPackageJsonPath, targetRootPackageJsonPath);
+    addPackageToWorkspaces(targetRootPackageJsonPath, extensionName);
+  }
+}
+
+function mergePackageJson(sourcePath: string, targetPath: string) {
+  try {
+    const sourcePackageJson = JSON.parse(fs.readFileSync(sourcePath, 'utf8'));
+    const targetPackageJson = JSON.parse(fs.readFileSync(targetPath, 'utf8'));
+    
+    if (sourcePackageJson.scripts && targetPackageJson.scripts) {
+      targetPackageJson.scripts = { ...targetPackageJson.scripts, ...sourcePackageJson.scripts };
+    }
+    
+    if (sourcePackageJson.dependencies && targetPackageJson.dependencies) {
+      targetPackageJson.dependencies = { ...targetPackageJson.dependencies, ...sourcePackageJson.dependencies };
+    }
+    
+    if (sourcePackageJson.devDependencies && targetPackageJson.devDependencies) {
+      targetPackageJson.devDependencies = { ...targetPackageJson.devDependencies, ...sourcePackageJson.devDependencies };
+    }
+    
+    if (sourcePackageJson.peerDependencies && targetPackageJson.peerDependencies) {
+      targetPackageJson.peerDependencies = { ...targetPackageJson.peerDependencies, ...sourcePackageJson.peerDependencies };
+    }
+    
+    fs.writeFileSync(targetPath, JSON.stringify(targetPackageJson, null, 2));
+    
+  } catch (error) {
+    // Error handling without logging
+  }
+}
+
+function addPackageToWorkspaces(packageJsonPath: string, packageName: string) {
+  try {
+    const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+    
+    if (packageJson.workspaces && packageJson.workspaces.packages) {
+      const workspacePath = `packages/${packageName}`;
+      if (!packageJson.workspaces.packages.includes(workspacePath)) {
+        packageJson.workspaces.packages.push(workspacePath);
+        fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));
+      }
+    }
+  } catch (error) {
+    // Error handling without logging
+  }
+}
+
+function copyDirectoryRecursive(source: string, destination: string) {
+  fs.mkdirSync(destination, { recursive: true });
+  
+  const files = fs.readdirSync(source);
+  
+  for (const file of files) {
+    const sourcePath = path.join(source, file);
+    const destPath = path.join(destination, file);
+    
+    const stat = fs.statSync(sourcePath);
+    
+    if (stat.isDirectory()) {
+      copyDirectoryRecursive(sourcePath, destPath);
+    } else {
+      fs.copyFileSync(sourcePath, destPath);
+    }
+  }
+}
+
+function mergeDirectoryRecursive(source: string, destination: string) {
+  if (!fs.existsSync(destination)) {
+    fs.mkdirSync(destination, { recursive: true });
+  }
+  
+  const files = fs.readdirSync(source);
+  
+  for (const file of files) {
+    const sourcePath = path.join(source, file);
+    const destPath = path.join(destination, file);
+    
+    const stat = fs.statSync(sourcePath);
+    
+    if (stat.isDirectory()) {
+      mergeDirectoryRecursive(sourcePath, destPath);
+    } else {
+      fs.copyFileSync(sourcePath, destPath);
+    }
+  }
+}