dappbooster 0.3.4 → 2.0.0

package/.nvmrc

@@ -0,0 +1 @@
+20

package/README.md

@@ -1,9 +1,36 @@
 # dAppBooster starter
 
-A script to clone dAppBooster and cleanup the history to freshly start your new project
+A script to clone dAppBooster and cleanup the history to freshly start your new project.
 
-# Usage
+Clones the latest tag from https://github.com/BootNodeDev/dAppBooster (so you might not see the last changes in `main`).
+
+## Usage
+
+```shell
+$ pnpm dlx dappbooster <projectName>
+```
+
+## Development
+
+Move into the script's folder and then
 
 ```shell
-$ pnpx dappbooster <projectDirectory>
+# Clone the repo
+git clone git@github.com:BootNodeDev/dAppBooster-starter.git
+
+# Install dependencies
+pnpm i
+
+# Move into the script's folder
+cd dAppBooster-starter
 ```
+
+The common loop for testing the script looks something like
+
+```shell
+# Test the script, creates a folder called test
+$ node index.js test
+
+# Remove the test directory (ignored in .gitignore)
+$ rm -rf test
+```

package/import/config.js

@@ -0,0 +1,17 @@
+export const repoUrl = 'https://github.com/BootNodeDev/dAppBooster.git'
+export const homeFolder = '/src/components/pageComponents/home'
+
+export const defaultExecOptions = {
+  stdio: 'pipe',
+  shell: true,
+}
+
+export const fileExecOptions = {
+  recursive: true,
+  force: true,
+}
+
+export const installPackageExecOptions = {
+  stdio: 'inherit',
+  shell: true,
+}

package/import/git.js

@@ -0,0 +1,56 @@
+import { execSync } from 'node:child_process'
+import { rmSync } from 'node:fs'
+import os from 'node:os'
+import { join } from 'node:path'
+import chalk from 'chalk'
+import { defaultExecOptions, fileExecOptions, repoUrl } from './config.js'
+
+/**
+ * @description Get the latest tag from the repository
+ * @returns {string} The latest tag
+ */
+function getLatestTag() {
+  const commandSilencer = os.platform() === 'win32' ? '> nul 2>&1' : '> /dev/null 2>&1'
+
+  execSync(`git fetch --tags ${commandSilencer}`, defaultExecOptions)
+
+  const tags = execSync('git tag -l --sort=-v:refname').toString().trim().split('\n')
+
+  return tags[0]
+}
+
+/**
+ * @description Clone the repository
+ */
+export function cloneRepo(projectName) {
+  const projectDir = join(process.cwd(), projectName)
+
+  try {
+    console.log(`Cloning dAppBooster in ${chalk.bold(`${projectName}`)}`)
+    execSync(`git clone --depth 1 --no-checkout "${repoUrl}" "${projectDir}"`, defaultExecOptions)
+
+    process.chdir(projectDir)
+
+    const latestTag = getLatestTag(defaultExecOptions)
+
+    if (latestTag) {
+      console.log(`Checking out latest tag`)
+      execSync(`git checkout "${latestTag}"`, defaultExecOptions)
+    } else {
+      console.log(`No tags found, checking out ${chalk.bold('main')} branch...`)
+      execSync('git checkout main', defaultExecOptions)
+    }
+
+    // Remove .git, and initialize the repo
+    rmSync(join(projectDir, '.git'), fileExecOptions)
+    execSync('git init', defaultExecOptions)
+
+    console.log(`Repository cloned in ${chalk.bold(projectDir)}`)
+    console.log(`Version: ${latestTag ? chalk.bold(latestTag) : chalk.bold('main')}`)
+  } catch (error) {
+    console.error(`${chalk.bold.red('An error occurred:')}`, error.message)
+    process.exit(1)
+  }
+
+  console.log('\n---\n')
+}

package/import/install.js

@@ -0,0 +1,200 @@
+import { execSync } from 'node:child_process'
+import { existsSync, readFileSync, rmSync, writeFileSync } from 'node:fs'
+import { join } from 'node:path'
+import chalk from 'chalk'
+import { defaultExecOptions, fileExecOptions, homeFolder, installPackageExecOptions } from './config.js'
+
+/**
+ * @description Create the .env.local file
+ */
+export function createEnvFile() {
+  const envFilePath = join(process.cwd(), '.env.local')
+  const exampleFilePath = join(process.cwd(), '.env.example')
+
+  execSync(`cp ${exampleFilePath} ${envFilePath}`, defaultExecOptions)
+}
+
+/**
+ * @description Install project packages, remove unwanted ones.
+ */
+export function installPackages(
+  demoSupport,
+  subgraphSupport,
+  typedocSupport,
+  vocsSupport,
+  huskySupport,
+) {
+  const subgraphPackages = !subgraphSupport
+    ? [
+        '@bootnodedev/db-subgraph',
+        'graphql graphql-request',
+        '@graphql-codegen/cli',
+        '@graphql-typed-document-node/core',
+      ]
+    : []
+  const typedocPackages = !typedocSupport
+    ? [
+        'typedoc',
+        'typedoc-github-theme',
+        'typedoc-plugin-inline-sources',
+        'typedoc-plugin-missing-exports',
+        'typedoc-plugin-rename-defaults',
+      ]
+    : []
+  const vocsPackages = !vocsSupport ? ['vocs'] : []
+  const huskyPackages = !huskySupport
+    ? ['husky', 'lint-staged', '@commitlint/cli', '@commitlint/config-conventional']
+    : []
+
+  const packagesToRemove = [
+    ...subgraphPackages,
+    ...typedocPackages,
+    ...vocsPackages,
+    ...huskyPackages,
+  ]
+
+  console.log('\n---\n')
+  console.log(`Installing packages...`)
+
+  // Remove demo files
+  if (!demoSupport) {
+    demoFilesCleanup()
+  }
+
+  console.log('\n---\n')
+
+  if (!packagesToRemove.length) {
+    execSync('pnpm install --loglevel warn', installPackageExecOptions)
+    console.log('\n---\n')
+  } else {
+    // pnpm remove will install the necessary packages while uninstalling the unwanted ones...
+    execSync(`pnpm remove ${packagesToRemove.join(' ')} --loglevel warn`, installPackageExecOptions)
+    // ... but it won't run the post-install script, so we run it manually
+    execSync(`pnpm run postinstall`, installPackageExecOptions)
+    console.log('\n---\n')
+
+    // Remove package-related files and scripts
+    packageFilesCleanup(subgraphSupport, typedocSupport, vocsSupport, huskySupport)
+  }
+
+  // Remove installer files
+  installFilesCleanup()
+  console.log('\n---\n')
+}
+
+/**
+ * @description Removes demo-related folders and files
+ */
+function demoFilesCleanup() {
+  const absoluteHomeFolder = join(process.cwd(), homeFolder)
+
+  console.log(`${chalk.bold.red('Removing')} demo list`)
+
+  rmSync(absoluteHomeFolder, fileExecOptions)
+
+  execSync(`mkdir -p ${absoluteHomeFolder}`, defaultExecOptions)
+  execSync(
+    `cp ${join(process.cwd(), '.install-files/home/index.tsx')} ${absoluteHomeFolder}`,
+    defaultExecOptions,
+  )
+}
+
+/**
+ * @description Removes:
+ * - Subgraphs folder
+ * - Subgraph demos and references to them in the demos list
+ */
+function subgraphCleanup() {
+  const demoListFile = join(process.cwd(), `${homeFolder}/Examples/index.tsx`)
+
+  // Remove the root subgraphs folder
+  rmSync(join(process.cwd(), '/src/subgraphs'), fileExecOptions)
+
+  // Only remove the subgraph demos if the user kept the demo list
+  if (existsSync(demoListFile)) {
+    // Remove the subgraph demos
+    rmSync(join(process.cwd(), `${homeFolder}/Examples/demos/subgraphs`), fileExecOptions)
+
+    // Remove the list...
+    rmSync(demoListFile, { force: true })
+
+    // ... and replace it by the list with no subgraph demos
+    execSync(
+      `cp ${join(process.cwd(), `.install-files/home/Examples/index.tsx`)} ${demoListFile}`,
+      defaultExecOptions,
+    )
+  }
+}
+
+/**
+ * @description Removes typedoc files
+ */
+function typedocCleanup() {
+  rmSync(join(process.cwd(), 'typedoc.json'), fileExecOptions)
+  rmSync(join(process.cwd(), '.github/workflows/typedoc.yml'), fileExecOptions)
+}
+
+/**
+ * @description Removes Vocs files
+ */
+function vocsCleanup() {
+  rmSync(join(process.cwd(), 'vocs.config.ts'), fileExecOptions)
+  rmSync(join(process.cwd(), 'docs'), fileExecOptions)
+}
+
+/**
+ * @description Removes Husky files
+ */
+function huskyCleanup() {
+  rmSync(join(process.cwd(), '.lintstagedrc.mjs'), fileExecOptions)
+  rmSync(join(process.cwd(), 'commitlint.config.js'), fileExecOptions)
+  rmSync(join(process.cwd(), '.husky'), fileExecOptions)
+}
+
+/**
+ * @description Removes the .install-files folder
+ */
+function installFilesCleanup() {
+  console.log(`${chalk.bold.red('Removing')} installer files`)
+  rmSync(join(process.cwd(), '.install-files'), fileExecOptions)
+}
+
+/**
+ * @description Cleans up the files associated with removed packages
+ */
+function packageFilesCleanup(subgraphSupport, typedocSupport, vocsSupport, huskySupport) {
+  const pkgPath = join(process.cwd(), 'package.json')
+  const pkgJson = JSON.parse(readFileSync(pkgPath, 'utf8'))
+
+  console.log(
+    `${chalk.bold.red('Removing')} files and scripts associated with uninstalled packages`,
+  )
+
+  // Remove everything subgraph-related
+  if (!subgraphSupport) {
+    subgraphCleanup()
+    pkgJson.scripts['subgraph-codegen'] = undefined
+  }
+
+  // Remove everything typedoc-related
+  if (!typedocSupport) {
+    typedocCleanup()
+    pkgJson.scripts['typedoc:build'] = undefined
+  }
+
+  // Remove everything vocs-related
+  if (!vocsSupport) {
+    vocsCleanup()
+    pkgJson.scripts['docs:build'] = undefined
+    pkgJson.scripts['docs:dev'] = undefined
+    pkgJson.scripts['docs:preview'] = undefined
+  }
+
+  // Remove everything husky-related
+  if (!huskySupport) {
+    huskyCleanup()
+    pkgJson.scripts['prepare'] = undefined
+  }
+
+  writeFileSync(pkgPath, `${JSON.stringify(pkgJson, null, 2)}\n`)
+}

package/import/user-prompts.js

@@ -0,0 +1,145 @@
+import { join } from 'node:path'
+import readline from 'node:readline'
+import chalk from 'chalk'
+import { homeFolder } from './config.js'
+
+/**
+ * @description Check if the project name is valid
+ */
+export function checkProjectName(name) {
+  const error = !name
+    ? `
+#################################################
+# A directory name is mandatory.                #
+#                                               #
+# Letters (a–z, A–Z), numbers (0–9),            #
+# hyphens (-), and underscores (_) are allowed. #
+#################################################`
+    : !/^[a-zA-Z0-9-_]+$/.test(name)
+      ? `
+#################################################
+# Invalid project name.                         #
+#                                               #
+# Letters (a–z, A–Z), numbers (0–9),            #
+# hyphens (-), and underscores (_) are allowed. #
+#################################################`
+      : ''
+
+  if (error) {
+    console.error(`${chalk.red.bold(error.trim())}`)
+    process.exit(1)
+  } else {
+    return name.replace(/[^a-zA-Z0-9-_]/g, '-')
+  }
+}
+
+/**
+ * @description Asks a question to the user
+ */
+function askQuestion(query) {
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout,
+  })
+
+  return new Promise((resolve) => {
+    rl.question(query, (answer) => {
+      rl.close()
+      resolve(answer)
+    })
+  })
+}
+
+/**
+ * @description Asks the user for setup options
+ * @returns {Promise<{demoSupport: boolean, subgraphSupport: boolean, typedocSupport: boolean, vocsSupport: boolean, commitHookPackagesSupport: boolean}>}
+ */
+export async function installationSetup() {
+  const demoSupport =
+    (await askQuestion(`Keep the ${chalk.bold('home page demos')}? (Y/n) `)).toLowerCase() !== 'n'
+
+  const subgraphSupport =
+    (await askQuestion(`Keep ${chalk.bold('subgraph')} support? (Y/n) `)).toLowerCase() !== 'n'
+
+  const typedocSupport =
+    (
+      await askQuestion(
+        `Keep ${chalk.bold('Typedoc')} (converts TypeScript comments to HTML documentation) support? (Y/n) `,
+      )
+    ).toLowerCase() !== 'n'
+
+  const vocsSupport =
+    (
+      await askQuestion(
+        `Keep ${chalk.bold('Vocs')} (static markdown documentation generation) support? (Y/n) `,
+      )
+    ).toLowerCase() !== 'n'
+
+  const huskySupport =
+    (
+      await askQuestion(
+        `Keep ${chalk.bold('Husky')} (Git hooks) support? Note: removing this will also remove ${chalk.bold('lint-staged')} and ${chalk.bold('commitlint')} (Y/n) `,
+      )
+    ).toLowerCase() !== 'n'
+
+  return {
+    demoSupport,
+    subgraphSupport,
+    typedocSupport,
+    vocsSupport,
+    huskySupport,
+  }
+}
+
+/**
+ * @description Prints instructions for subgraph support
+ */
+function subgraphInstructions() {
+  console.log(
+    `${chalk.yellow.bold('##################################################################################')}`,
+  )
+  console.log(
+    `${chalk.yellow.bold('# WARNING: Your project support subgraphs, before you continue you MUST:         #')}`,
+  )
+  console.log(
+    `${chalk.yellow.bold('##################################################################################')}`,
+  )
+  console.log('')
+  console.log(
+    `1- Provide your own API key for the var ${chalk.bold('PUBLIC_SUBGRAPHS_API_KEY')} in ${chalk.italic('.env.local')}`,
+  )
+  console.log(
+    `   You can get one at ${chalk.bold.underline('https://thegraph.com/studio/apikeys/')}`,
+  )
+  console.log(
+    `2- Run ${chalk.bold('pnpm subgraph-codegen')} in your console from the project's folder`,
+  )
+  console.log('')
+  console.log('Only after you followed these steps you may proceed.')
+  console.log('\n---\n')
+}
+
+/**
+ * @description Prints post-install instructions
+ */
+export function postInstallInstructions(subgraphSupport, projectName) {
+  console.log('To start development on your project:')
+  console.log('')
+  console.log('1- Move into the project directory')
+  console.log(chalk.cyan(`$ cd ${projectName}`))
+  console.log('')
+  console.log('2- Start the development server')
+  console.log(chalk.cyan('$ pnpm dev'))
+  console.log('')
+  console.log(
+    `You can edit the home page in ${chalk.bold(`${join(process.cwd(), homeFolder)}/index.tsx`)}`,
+  )
+  console.log('\n---\n')
+  console.log(`Check out ${chalk.bold('.env.local')} for more project configurations.`)
+  console.log(`Check out the docs at ${chalk.bold.underline('https://docs.dappbooster.dev/')}`)
+  console.log('\n---\n')
+
+  if (subgraphSupport) {
+    subgraphInstructions()
+  }
+}

package/index.js

@@ -1,158 +1,33 @@
 #!/usr/bin/env node
 
-import { execSync } from "child_process";
-import { join } from "path";
-import { rmSync } from "fs";
-import readline from "readline";
-import chalk from "chalk";
-import os from "os";
+import { createEnvFile, installPackages } from './import/install.js'
+import { cloneRepo } from './import/git.js'
+import {
+  checkProjectName,
+  installationSetup,
+  postInstallInstructions,
+} from './import/user-prompts.js'
 
-const commandSilencer = os.platform() === "win32" ? '> nul 2>&1' : '> /dev/null 2>&1'
-
-const repoUrls = {
-  barebones: "https://github.com/BootNodeDev/dAppBooster.git",
-  example: "https://github.com/BootNodeDev/dAppBoosterLandingPage.git",
-};
-
-const projectName = process.argv[2];
-
-// Check if the project name is valid
-if (!projectName || !/^[a-zA-Z0-9-_]+$/.test(projectName)) {
-  console.error(`${chalk.red.bold("Invalid directory name. Please enter a valid project name.")}`);
-  process.exit(1);
-}
-
-// Prompt the user to select the repository type
-promptUserForRepoType()
-  .then((repoType) => {
-    const repoUrl = repoUrls[repoType];
-    cloneRepo(projectName, repoUrl);
-  })
-  .catch((error) => {
-    console.error(chalk.red.bold("Error:"), error.message);
-    process.exit(1);
-  });
-
-/**
- * @description Prompt the user to select the repository type
- * @returns {Promise<string>} The selected repository type
- */
-function promptUserForRepoType() {
-  return new Promise((resolve, reject) => {
-    const rl = readline.createInterface({
-      input: process.stdin,
-      output: process.stdout,
-    });
-
-    rl.question(
-      `You can choose to start with a ${chalk.green.bold('Barebones')} project or a project with ${chalk.green.bold('Examples')} and demo code (B/e):`,
-      (answer) => {
-        rl.close();
-        const selection = answer.trim().toUpperCase();
-        if (selection === "B" || selection === "") {
-          resolve("barebones");
-        } else if (selection === "E") {
-          resolve("example");
-        } else {
-          reject(new Error("Invalid selection. Please choose B or E."));
-        }
-      }
-    );
-  });
-}
-
-/**
- * @description Get the latest tag in the repository
- * @param {Object} execOptions The options to pass to the exec
- * @returns {string} The latest tag in the repository
- */
-function getLatestTag(execOptions) {
-  // Fetch all tags
-  execSync(`git fetch --tags ${commandSilencer}`, execOptions);
-
-  // Get all tags, sorted by version
-  const tags = execSync("git tag -l --sort=-v:refname")
-    .toString()
-    .trim()
-    .split("\n");
-
-  // Return the first (latest) tag
-  return tags[0];
-}
+main().then(() => console.log('\n👻\n'))
 
 /**
- * @description Clone the specified repository
- * @param {string} projectName The name of the project
- * @param {string} repoUrl The URL of the repository
- * @returns {void}
+ * @description Main entry point
  */
-function cloneRepo(projectName, repoUrl) {
-  const sanitizedProjectName = projectName.replace(/[^a-zA-Z0-9-_]/g, "-");
-  const projectDir = join(process.cwd(), sanitizedProjectName);
-  const execOptions = {
-    stdio: "pipe",
-    shell: true,
-  };
-
-  try {
-    console.log(`\nCloning dAppBooster...`);
-
-    // Clone the repository
-    execSync(
-      `git clone --depth 1 --no-checkout "${repoUrl}" "${projectDir}"`,
-      execOptions
-    );
-
-    // Change to the project directory
-    process.chdir(projectDir);
-
-    // Get the latest tag
-    const latestTag = getLatestTag();
-
-    if (latestTag) {
-      console.log(`Checking out latest tag: ${latestTag}`);
-      execSync(`git checkout "${latestTag}"`, execOptions);
-    } else {
-      console.log(`No tags found, checking out ${chalk.bold('main')} branch...`);
-      execSync("git checkout main", execOptions);
-    }
-
-    // Remove the .git directory
-    rmSync(join(projectDir, ".git"), { recursive: true, force: true });
-
-    // Initialize a new git repository
-    execSync("git init", execOptions);
-
-    // Success
-    console.log(`\ndAppBooster repository cloned in ${chalk.bold(projectDir)}`);
-    if (latestTag) {
-      console.log(`Latest version: ${chalk.bold(latestTag)}`);
-    }
-
-    console.log(`\n---\n`);
-    // Some extra instructions for the user
-    console.log(`
-${chalk.blue.bold("You can now start your project with the following commands:")}
-
-${chalk.gray.italic("# Change to the project directory")}
-$ ${chalk.cyan(`cd ${sanitizedProjectName}`)}
-
-${chalk.gray.italic("# Install dependencies")}
-$ ${chalk.cyan("pnpm install")}
-
-${chalk.gray.italic("# Copy the example environment file")}
-$ ${chalk.cyan("cp .env.example .env.local")}
+async function main() {
+  // Check if the project name is valid
+  const projectName = checkProjectName(process.argv[2])
 
-${chalk.gray.italic("# Start the development server")}
-$ ${chalk.cyan("pnpm dev")}
+  // Clone, create .env.local file
+  cloneRepo(projectName)
+  createEnvFile(projectName)
 
----
+  // Ask setup questions
+  const { demoSupport, subgraphSupport, typedocSupport, vocsSupport, huskySupport } =
+    await installationSetup()
 
-Remember to also check out the docs in ${chalk.green.bold("https://docs.dappbooster.dev/")}
+  // Install the required packages
+  installPackages(demoSupport, subgraphSupport, typedocSupport, vocsSupport, huskySupport)
 
-`);
-  } catch (error) {
-    console.error(`${chalk.bold.red("An error occurred:")}`, error.message);
-    process.exit(1);
-  }
+  // Tell the user what to do after installation is finished
+  postInstallInstructions(subgraphSupport, projectName)
 }

package/package.json

@@ -1,15 +1,17 @@
 {
   "name": "dappbooster",
-  "version": "0.3.4",
+  "author": "bootnodedev",
+  "version": "2.0.0",
   "description": "Script to easily start your project with dAppBooster",
   "main": "index.js",
+  "license": "MIT",
+  "engines": {
+    "node": ">=20.0.0"
+  },
   "bin": {
     "dappbooster": "index.js"
   },
   "type": "module",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
   "dependencies": {
     "chalk": "^5.3.0"
   },
@@ -20,9 +22,7 @@
     "installer",
     "dapp"
   ],
-  "author": "bootnodedev",
-  "license": "MIT",
-  "engines": {
-    "node": ">=20.0.0"
+  "devDependencies": {
+    "prettier": "^3.5.3"
   }
 }