Merge pull request #61 from akd-io/release/0.0.9

Release 0.0.9

Author: akd-io

.eslintrc

@@ -12,6 +12,7 @@
     "no-process-exit": "off",
     "unicorn/no-process-exit": "off",
     "no-warning-comments": "off",
-    "@typescript-eslint/no-use-before-define": "off"
+    "@typescript-eslint/no-use-before-define": "off",
+    "@typescript-eslint/no-unused-vars": "warn"
   }
 }

bin/run-prod

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require(`../lib`).run().catch(require("@oclif/errors/handle"))

package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-next-stack",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "author": "Anders Kjær Damgaard @akd-io",
   "bin": {
     "create-next-stack": "./bin/run"
@@ -13,13 +13,16 @@
     "@oclif/plugin-help": "^3.2.2",
     "execa": "^5.1.1",
     "inquirer": "^8.1.1",
+    "rimraf": "^3.0.2",
     "tslib": "^2.3.0",
     "validate-npm-package-name": "^3.0.0"
   },
   "devDependencies": {
     "@oclif/dev-cli": "^1.26.0",
     "@types/inquirer": "^7.3.2",
     "@types/node": "^15.12.4",
+    "@types/rimraf": "^3.0.1",
+    "@types/uuid": "^8.3.1",
     "@types/validate-npm-package-name": "^3.0.2",
     "eslint": "^5.16.0",
     "eslint-config-oclif": "^3.1.0",
@@ -28,9 +31,9 @@
     "husky": "^6.0.0",
     "lint-staged": "^11.0.0",
     "prettier": "^2.3.2",
-    "rimraf": "^3.0.2",
     "ts-node": "^10.0.0",
-    "typescript": "^4.3.4"
+    "typescript": "^4.3.4",
+    "uuid": "^8.3.2"
   },
   "engines": {
     "node": ">=12.0.0"
@@ -53,7 +56,7 @@
     "prepare": "husky install",
     "prepack": "yarn build && oclif-dev readme",
     "build": "rimraf lib && tsc -b",
-    "test": "echo NO TESTS",
+    "test": "ts-node src/e2e/test.ts",
     "version": "oclif-dev readme && git add README.md",
     "format": "prettier --write --ignore-path=.gitignore .",
     "format:check": "prettier --check --ignore-path=.gitignore .",

src/e2e/helpers/exit-with-error.ts

@@ -0,0 +1,12 @@
+import console from "console"
+
+export const exitWithError = async (error: unknown) => {
+  if (error instanceof Error) {
+    console.error(error.message)
+  } else if (typeof error === "string") {
+    console.error(error)
+  } else {
+    console.error("Error: An error object of unknown type was thrown.")
+  }
+  process.exit(1)
+}

src/e2e/helpers/set-git-name-and-email.ts

@@ -0,0 +1,33 @@
+import console from "console"
+import execa from "execa"
+import { exitWithError } from "./exit-with-error"
+
+export const setGitNameAndEmail = async () => {
+  try {
+    await execa("git", ["config", "--global", "user.name"])
+      .then((result) => {
+        console.log(`user.name found: ${result.stdout}`)
+      })
+      .catch(async () => {
+        console.log(`user.name didn't exist. Setting user.name="Test user"`)
+        await execa("git", ["config", "--global", "user.name", "Test user"])
+      })
+    await execa("git", ["config", "--global", "user.email"])
+      .then((result) => {
+        console.log(`user.email found: ${result.stdout}`)
+      })
+      .catch(async () => {
+        console.log(
+          `user.email didn't exist. Setting user.email="test-user@create-next-stack.com"`
+        )
+        await execa("git", [
+          "config",
+          "--global",
+          "user.email",
+          "test-user@create-next-stack.com",
+        ])
+      })
+  } catch (error) {
+    exitWithError(error)
+  }
+}

src/e2e/test.ts

@@ -0,0 +1,13 @@
+import { exitWithError } from "./helpers/exit-with-error"
+import { setGitNameAndEmail } from "./helpers/set-git-name-and-email"
+import { testDefaultOptions } from "./tests/default-options"
+;(async () => {
+  try {
+    // If not done already, Set Git name and email so `git commit` doesn't fail during create-next-app
+    await setGitNameAndEmail()
+
+    await testDefaultOptions()
+  } catch (error) {
+    exitWithError(error)
+  }
+})()

src/e2e/tests/default-options.ts

@@ -0,0 +1,47 @@
+import console from "console"
+import execa from "execa"
+import { promises as fs } from "fs"
+import path from "path"
+import { v4 as uuidv4 } from "uuid"
+
+export const testDefaultOptions = async () => {
+  const createNextStackDir = process.cwd()
+
+  // Create unique id for this run
+  const testRunId = uuidv4()
+
+  // Switch to unique test directory
+  const runDirectory = path.resolve(
+    `../create-next-stack-tests/run-${testRunId}`
+  )
+  await fs.mkdir(runDirectory, { recursive: true })
+  process.chdir(runDirectory)
+  console.log(`Created test run directory at ${runDirectory}`)
+
+  // Run /bin/run-prod to test against compiled js files in /lib instead of ts-files in /src using ts-node.
+  const pathToProdCLI = path.resolve(`${createNextStackDir}/bin/run-prod`)
+
+  console.log(`Making /bin/run readable and executable by all.`)
+  await fs.chmod(pathToProdCLI, 0o555)
+
+  console.log(`Running command: ${pathToProdCLI} --debug .`)
+  const execaProcess = execa(pathToProdCLI, ["--debug", "."], {
+    timeout: 10 * 60 * 1000,
+  }) // 10 minutes
+  execaProcess.stdout?.pipe(process.stdout)
+  execaProcess.stderr?.pipe(process.stderr)
+
+  console.log("Sending \\n to accept default options.")
+  execaProcess.stdin?.write("\n") // Press
+
+  await execaProcess
+
+  console.log("Checking formatting")
+  await execa("npx", ["prettier", "--check", "--ignore-path=.gitignore", "."])
+
+  console.log("Checking linting")
+  await execa("yarn", ["lint"])
+
+  console.log("Running yarn build")
+  await execa("yarn", ["build"])
+}

src/helpers/is-git-initialized.ts

@@ -1,4 +1,4 @@
-import fs from "fs/promises"
+import { promises as fs } from "fs"
 
 /**
  * `isGitInitialized` checks if Git has been initialized or not.

src/helpers/is-package-globally-installed.ts

@@ -0,0 +1,39 @@
+import execa from "execa"
+
+/**
+ * This function finds out if a package is installed globally.
+ *
+ * IMPORTANT: This function is not perfect. It uses `npm list -g --depth=0 <package-name>` which checks both top-level packages and their dependencies.
+ * In other words, the --depth param only limits the depth of the rendered tree, not the actual search algorithm itself.
+ * This means that a search for the package `which`, for example, will not throw an error even though the package isn't installed globally.
+ * As such, false positives can arise.
+ *
+ * In order to combat this, `isPackageGloballyInstalled` checks whether the output tree of depth 0 includes the specified package name.
+ *
+ * This limits the false positives to cases where some top-level package has:
+ * 1. the specified package somewhere in its dependency tree, AND
+ * 2. the specified package name included in its own name
+ *
+ * @param packageName The name of the npm package
+ * @returns Whether the specified npm package is globally installed or not.
+ */
+export const isPackageGloballyInstalled = async (
+  packageName: string
+): Promise<boolean> => {
+  try {
+    const execaResult = await execa("npm", [
+      "list",
+      "-g",
+      "--depth=0",
+      packageName,
+    ])
+
+    if (!execaResult.stdout.includes(packageName)) {
+      return false
+    }
+  } catch {
+    return false
+  }
+
+  return true
+}

src/helpers/remove.ts

@@ -1,8 +1,8 @@
-import fs from "fs/promises"
+import rimraf from "rimraf"
+import { promisify } from "util"
+
+const rm = promisify(rimraf)
 
 export const remove = (path: string): Promise<void> => {
-  return fs.rm(path, {
-    recursive: true,
-    force: true,
-  })
+  return rm(path)
 }