index.js

#!/usr/bin/env node
/*
MIT License

Copyright (c) 2019-present, Yuxi (Evan) You and Vite contributors

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.
 */

// @ts-check
const fs = require("fs")
const path = require("path")
const argv = require("minimist")(process.argv.slice(2))
// eslint-disable-next-line node/no-restricted-require
const { prompt } = require("enquirer")
const {
  yellow,
  green,
  cyan,
  blue,
  magenta,
  lightRed,
  lightBlue,
  red,
} = require("kolorist")

const cwd = process.cwd()

const FRAMEWORKS = [
  {
    name: "react",
    color: cyan,
    variants: [
      {
        name: "react",
        display: "JavaScript",
        color: yellow,
      },
      {
        name: "react-ts",
        display: "TypeScript",
        color: blue,
      },
    ],
  },
  {
    name: "vue",
    color: green,
    variants: [
      {
        name: "vue",
        display: "JavaScript",
        color: yellow,
      },
      {
        name: "vue-ts",
        display: "TypeScript",
        color: blue,
      },
    ],
  },
  {
    name: "svelte",
    color: red,
    variants: [
      {
        name: "svelte",
        display: "JavaScript",
        color: yellow,
      },
      {
        name: "svelte-ts",
        display: "TypeScript",
        color: blue,
      },
    ],
  },
  {
    name: "vanilla",
    color: yellow,
    variants: [
      {
        name: "vanilla",
        display: "JavaScript",
        color: yellow,
      },
      {
        name: "vanilla-ts",
        display: "TypeScript",
        color: blue,
      },
    ],
  },
  // {
  //   name: "community templates",
  //   color: magenta,
  //   variants: [
  //   ],
  // },
  // {
  //   name: 'preact',
  //   color: magenta,
  //   variants: [
  // {
  //   name: 'preact',
  //   display: 'JavaScript',
  //   color: yellow
  // },
  //     {
  //       name: 'preact-ts',
  //       display: 'TypeScript',
  //       color: blue
  //     }
  //   ]
  // },
  // {
  //   name: 'lit-element',
  //   color: lightRed,
  //   variants: [
  //     {
  //       name: 'lit-element',
  //       display: 'JavaScript',
  //       color: yellow
  //     },
  //     {
  //       name: 'lit-element-ts',
  //       display: 'TypeScript',
  //       color: blue
  //     }
  //   ]
  // },
]

const TEMPLATES = FRAMEWORKS.map(
  (f) => (f.variants && f.variants.map((v) => v.name)) || [f.name],
).reduce((a, b) => a.concat(b), [])

const renameFiles = {
  _gitignore: ".gitignore",
}

async function init() {
  let targetDir = argv._[0]
  if (!targetDir) {
    /**
     * @type {{ projectName: string }}
     */
    const { projectName } = await prompt({
      type: "input",
      name: "projectName",
      message: `Project name:`,
      initial: "vite-project",
    })
    targetDir = projectName
  }
  const packageName = await getValidPackageName(targetDir)
  const root = path.join(cwd, targetDir)

  if (!fs.existsSync(root)) {
    fs.mkdirSync(root, { recursive: true })
  } else {
    const existing = fs.readdirSync(root)
    if (existing.length) {
      /**
       * @type {{ yes: boolean }}
       */
      const { yes } = await prompt({
        type: "confirm",
        name: "yes",
        initial: "Y",
        message:
          (targetDir === "."
            ? "Current directory"
            : `Target directory ${targetDir}`) +
          " is not empty.\n" +
          "Remove existing files and continue?",
      })
      if (yes) {
        emptyDir(root)
      } else {
        return
      }
    }
  }

  // determine template
  let template = argv.t || argv.template
  let message = "Select a framework:"
  let isValidTemplate = false

  // --template expects a value
  if (typeof template === "string") {
    isValidTemplate = TEMPLATES.includes(template)
    message = `${template} isn't a valid template. Please choose from below:`
  }

  if (!template || !isValidTemplate) {
    /**
     * @type {{ framework: string }}
     */
    const { framework } = await prompt({
      type: "select",
      name: "framework",
      message,
      format(name) {
        const framework = FRAMEWORKS.find((v) => v.name === name)
        return framework
          ? framework.color(framework.display || framework.name)
          : name
      },
      choices: FRAMEWORKS.map((f) => ({
        name: f.name,
        value: f.name,
        message: f.color(f.display || f.name),
      })),
    })
    const frameworkInfo = FRAMEWORKS.find((f) => f.name === framework)

    if (frameworkInfo.variants) {
      /**
       * @type {{ name: string }}
       */
      const { name } = await prompt({
        type: "select",
        name: "name",
        format(name) {
          const variant = frameworkInfo.variants.find((v) => v.name === name)
          return variant ? variant.color(variant.display || variant.name) : name
        },
        message: "Select a variant:",
        choices: frameworkInfo.variants.map((v) => ({
          name: v.name,
          value: v.name,
          message: v.color(v.display || v.name),
        })),
      })
      template = name
    } else {
      template = frameworkInfo.name
    }
  }

  console.log(`\nScaffolding project in ${root}...`)

  const templateDir = path.join(__dirname, `template-${template}`)

  const write = (file, content) => {
    const targetPath = renameFiles[file]
      ? path.join(root, renameFiles[file])
      : path.join(root, file)
    if (content) {
      fs.writeFileSync(targetPath, content)
    } else {
      copy(path.join(templateDir, file), targetPath)
    }
  }

  const files = fs.readdirSync(templateDir)
  for (const file of files.filter((f) => f !== "package.json")) {
    write(file)
  }

  const pkg = require(path.join(templateDir, `package.json`))

  pkg.name = packageName

  write("package.json", JSON.stringify(pkg, null, 2))

  const pkgManager = /yarn/.test(process.env.npm_execpath) ? "yarn" : "npm"

  console.log(`\nDone. Now run:\n`)
  if (root !== cwd) {
    console.log(`  cd ${path.relative(cwd, root)}\n`)
  }
  console.log(`  ${pkgManager === "yarn" ? `yarn` : `npm install`}`)
  console.log(`  dfx start --background`)
  console.log(`  dfx deploy`)
  console.log(`  ${pkgManager === "yarn" ? `yarn dev` : `npm run dev`}`)
  console.log()
}

function copy(src, dest) {
  const stat = fs.statSync(src)
  if (stat.isDirectory()) {
    copyDir(src, dest)
  } else {
    fs.copyFileSync(src, dest)
  }
}

async function getValidPackageName(projectName) {
  const packageNameRegExp = /^(?:@[a-z0-9-*~][a-z0-9-*._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/
  if (packageNameRegExp.test(projectName)) {
    return projectName
  } else {
    const suggestedPackageName = projectName
      .trim()
      .toLowerCase()
      .replace(/\s+/g, "-")
      .replace(/^[._]/, "")
      .replace(/[^a-z0-9-~]+/g, "-")

    /**
     * @type {{ inputPackageName: string }}
     */
    const { inputPackageName } = await prompt({
      type: "input",
      name: "inputPackageName",
      message: `Package name:`,
      initial: suggestedPackageName,
      validate: (input) =>
        packageNameRegExp.test(input) ? true : "Invalid package.json name",
    })
    return inputPackageName
  }
}

function copyDir(srcDir, destDir) {
  fs.mkdirSync(destDir, { recursive: true })
  for (const file of fs.readdirSync(srcDir)) {
    const srcFile = path.resolve(srcDir, file)
    const destFile = path.resolve(destDir, file)
    copy(srcFile, destFile)
  }
}

function emptyDir(dir) {
  if (!fs.existsSync(dir)) {
    return
  }
  for (const file of fs.readdirSync(dir)) {
    const abs = path.resolve(dir, file)
    // baseline is Node 12 so can't use rmSync :(
    if (fs.lstatSync(abs).isDirectory()) {
      emptyDir(abs)
      fs.rmdirSync(abs)
    } else {
      fs.unlinkSync(abs)
    }
  }
}

init().catch((e) => {
  console.error(e)
})