dappbooster 2.0.1 → 3.0.1

package/import/install.js

@@ -1,199 +0,0 @@
-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)
-}
-
-/**
- * @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

@@ -1,145 +0,0 @@
-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,33 +0,0 @@
-#!/usr/bin/env node
-
-import { createEnvFile, installPackages } from './import/install.js'
-import { cloneRepo } from './import/git.js'
-import {
-  checkProjectName,
-  installationSetup,
-  postInstallInstructions,
-} from './import/user-prompts.js'
-
-main().then(() => console.log('\n👻\n'))
-
-/**
- * @description Main entry point
- */
-async function main() {
-  // Check if the project name is valid
-  const projectName = checkProjectName(process.argv[2])
-
-  // Clone, create .env.local file
-  cloneRepo(projectName)
-  createEnvFile(projectName)
-
-  // Ask setup questions
-  const { demoSupport, subgraphSupport, typedocSupport, vocsSupport, huskySupport } =
-    await installationSetup()
-
-  // Install the required packages
-  installPackages(demoSupport, subgraphSupport, typedocSupport, vocsSupport, huskySupport)
-
-  // Tell the user what to do after installation is finished
-  postInstallInstructions(subgraphSupport, projectName)
-}