Merge branch 'develop' into feature/fix-app-props-type

Author: akd-io

src/helpers/capitalize-first-letter.ts

@@ -0,0 +1,3 @@
+export const capitalizeFirstLetter = (string: string) => {
+  return string.charAt(0).toUpperCase() + string.slice(1)
+}

src/setup/setup.ts

@@ -1,4 +1,7 @@
 import { ValidCNSInputs } from "../create-next-stack-types"
+import { capitalizeFirstLetter } from "../helpers/capitalize-first-letter"
+import { exitWithError } from "../helpers/exit-with-error"
+import { commandInstance } from "../instance"
 import { Step } from "./step"
 import { addBaseBabelConfigStep } from "./steps/add-base-babel-config"
 import { addContentStep } from "./steps/add-content/add-content"
@@ -11,8 +14,7 @@ import { gitCommitStep } from "./steps/git-commit"
 import { installFormikStep } from "./steps/install-formik"
 import { installFramerMotionStep } from "./steps/install-framer-motion"
 import { installReactHookFormStep } from "./steps/install-react-hook-form"
-import { printGitInitializationWarningStep } from "./steps/print-git-initialization-warning"
-import { printSuccessMessageStep } from "./steps/print-success-message"
+import { printFinalMessagesStep } from "./steps/print-final-messages"
 import { removeOfficialCNAContentStep } from "./steps/remove-official-cna-content"
 import { setUpEmotionStep } from "./steps/set-up-emotion"
 import { setUpLintStagedStep } from "./steps/set-up-lint-staged"
@@ -23,6 +25,8 @@ import { updateYarnStep } from "./steps/update-yarn"
 export const performSetupSteps = async (
   inputs: ValidCNSInputs
 ): Promise<void> => {
+  const instance = commandInstance.get()
+
   const steps: Step[] = [
     updateYarnStep,
     createNextAppStep,
@@ -49,13 +53,19 @@ export const performSetupSteps = async (
     addGitAttributesStep,
     gitCommitStep,
 
-    printGitInitializationWarningStep,
-    printSuccessMessageStep,
+    printFinalMessagesStep,
   ]
 
   for (const step of steps) {
     if (await step.shouldRun(inputs)) {
-      await step.run(inputs)
+      instance.log(`${capitalizeFirstLetter(step.description)}...`)
+
+      try {
+        await step.run(inputs)
+      } catch (error) {
+        exitWithError(`An error occurred while ${step.description}.`, error)
+      }
+
       step.didRun = true
     }
   }

src/setup/step.ts

@@ -1,6 +1,10 @@
 import { ValidCNSInputs } from "../create-next-stack-types"
 
 export type Step = {
+  /**
+   * `description` should be written in present continuous tense, without punctuation, and with a lowercase first letter unless the description starts with a name or similar.
+   */
+  description: string
   shouldRun: (inputs: ValidCNSInputs) => Promise<boolean>
   run: (inputs: ValidCNSInputs) => Promise<void>
   didRun: boolean

src/setup/steps/add-base-babel-config.ts

@@ -1,30 +1,20 @@
-import { exitWithError } from "../../helpers/exit-with-error"
 import { writeJsonFile } from "../../helpers/write-json-file"
-import { commandInstance } from "../../instance"
 import { Step } from "../step"
 
 export const addBaseBabelConfigStep: Step = {
+  description: "adding custom Babel configuration",
+
   shouldRun: async () => true,
 
   didRun: false,
 
   run: async () => {
-    const instance = commandInstance.get()
-    instance.log("Adding custom Babel configuration...")
-
     // The base Babel config is ready for custom preset configurations to be added onto the `next/babel` preset as per the Next.js docs: https://nextjs.org/docs/advanced-features/customizing-babel-config
     const baseBabelConfig = {
       presets: [["next/babel", {}]],
       plugins: [],
     }
 
-    try {
-      await writeJsonFile(".babelrc", baseBabelConfig)
-    } catch (error) {
-      exitWithError(
-        "An error occurred while adding custom Babel configuration.",
-        error
-      )
-    }
+    await writeJsonFile(".babelrc", baseBabelConfig)
   },
 }

src/setup/steps/add-content/add-content.ts

@@ -1,6 +1,4 @@
 import { promises as fs } from "fs"
-import { exitWithError } from "../../../helpers/exit-with-error"
-import { commandInstance } from "../../../instance"
 import { Step } from "../../step"
 import { generatePage } from "./components/generate-page"
 import { generateWithDefaultGlobalStyles } from "./components/generate-with-default-global-styles"
@@ -9,45 +7,40 @@ import { globalStyles } from "./global-styles"
 import { generateIndexPage } from "./index-page/generate-index"
 
 export const addContentStep: Step = {
+  description: "adding content",
+
   shouldRun: async () => true,
 
   didRun: false,
 
   run: async (inputs) => {
-    const instance = commandInstance.get()
-    instance.log("Adding content...")
-
-    try {
-      await fs.mkdir("components")
+    await fs.mkdir("components")
 
-      const promises = [
-        fs.writeFile("components/Page.tsx", generatePage(inputs)),
-        fs.writeFile("pages/index.tsx", generateIndexPage(inputs)),
-        fs.writeFile("pages/_app.tsx", generateApp(inputs)),
-      ]
+    const promises = [
+      fs.writeFile("components/Page.tsx", generatePage(inputs)),
+      fs.writeFile("pages/index.tsx", generateIndexPage(inputs)),
+      fs.writeFile("pages/_app.tsx", generateApp(inputs)),
+    ]
 
-      if (
-        inputs.flags.styling === "emotion" ||
-        inputs.flags.styling === "styled-components"
-      ) {
-        promises.push(
-          fs.writeFile(
-            "components/WithDefaultGlobalStyles.tsx",
-            generateWithDefaultGlobalStyles(inputs)
-          )
-        )
-      } else if (inputs.flags.styling === "css-modules") {
-        await fs.mkdir("styles")
-        promises.push(fs.writeFile("styles/global-styles.css", globalStyles))
-      } else {
-        throw new Error(
-          "Unsupported styling technology found in addContentStep, or no styling technology was chosen."
+    if (
+      inputs.flags.styling === "emotion" ||
+      inputs.flags.styling === "styled-components"
+    ) {
+      promises.push(
+        fs.writeFile(
+          "components/WithDefaultGlobalStyles.tsx",
+          generateWithDefaultGlobalStyles(inputs)
         )
-      }
-
-      await Promise.all(promises)
-    } catch (error) {
-      exitWithError("An error occurred while adding content.", error)
+      )
+    } else if (inputs.flags.styling === "css-modules") {
+      await fs.mkdir("styles")
+      promises.push(fs.writeFile("styles/global-styles.css", globalStyles))
+    } else {
+      throw new Error(
+        "Unsupported styling technology found in addContentStep, or no styling technology was chosen."
+      )
     }
+
+    await Promise.all(promises)
   },
 }

src/setup/steps/add-git-attributes.ts

@@ -1,13 +1,14 @@
 import endent from "endent"
 import { promises as fs } from "fs"
-import { exitWithError } from "../../helpers/exit-with-error"
 import { isGitInitialized } from "../../helpers/is-git-initialized"
 import { commandInstance } from "../../instance"
 import { Step } from "../step"
 
 const filename = ".gitattributes"
 
 export const addGitAttributesStep: Step = {
+  description: `adding ${filename}`,
+
   shouldRun: async () => {
     if (!(await isGitInitialized())) {
       const instance = commandInstance.get()
@@ -22,14 +23,7 @@ export const addGitAttributesStep: Step = {
   didRun: false,
 
   run: async () => {
-    try {
-      const instance = commandInstance.get()
-      instance.log(`Adding ${filename}...`)
-
-      await fs.writeFile(filename, generateGitAttributes())
-    } catch (error) {
-      exitWithError(`An error occurred while adding ${filename}.`, error)
-    }
+    await fs.writeFile(filename, generateGitAttributes())
   },
 }
 

src/setup/steps/add-readme/add-readme.ts

@@ -1,23 +1,16 @@
 import { promises as fs } from "fs"
-import { exitWithError } from "../../../helpers/exit-with-error"
-import { commandInstance } from "../../../instance"
 import { Step } from "../../step"
 import { generateReadme } from "./generate-readme"
 
 export const addReadmeStep: Step = {
+  description: "adding Readme",
+
   shouldRun: async () => true,
 
   didRun: false,
 
   run: async (inputs) => {
-    const instance = commandInstance.get()
-    instance.log("Adding Readme...")
-
-    try {
-      const readmeString = await generateReadme(inputs)
-      await fs.writeFile("README.md", readmeString)
-    } catch (error) {
-      exitWithError("An error occurred while adding Readme.", error)
-    }
+    const readmeString = await generateReadme(inputs)
+    await fs.writeFile("README.md", readmeString)
   },
 }

src/setup/steps/copy-assets.ts

@@ -4,6 +4,8 @@ import { getCreateNextStackDir } from "../../helpers/get-create-next-stack-dir"
 import { Step } from "../step"
 
 export const copyAssetsStep: Step = {
+  description: "copying static assets",
+
   shouldRun: async () => true,
 
   didRun: false,

src/setup/steps/create-next-app.ts

@@ -1,36 +1,29 @@
 import execa from "execa"
 import { promises as fs } from "fs"
-import { exitWithError } from "../../helpers/exit-with-error"
-import { commandInstance } from "../../instance"
 import { getNameVersionCombo, packages } from "../packages"
 import { Step } from "../step"
 
 export const createNextAppStep: Step = {
+  description: "creating Next.js app",
+
   shouldRun: async () => true,
 
   didRun: false,
 
   run: async ({ args, flags }) => {
-    const instance = commandInstance.get()
-    instance.log("Creating Next.js app...")
-
-    try {
-      // Make sure directory exists to avoid error from create-next-app
-      await fs.mkdir(args.appName, { recursive: true })
+    // Make sure directory exists to avoid error from create-next-app
+    await fs.mkdir(args.appName, { recursive: true })
 
-      const createNextAppArgs = [args.appName, "--typescript"]
-      if (flags["package-manager"] === "npm") {
-        createNextAppArgs.push("--use-npm")
-      }
-
-      await execa("npx", [
-        getNameVersionCombo(packages["create-next-app"]),
-        ...createNextAppArgs,
-      ])
-    } catch (error) {
-      exitWithError("An error occurred while creating Next.js app.", error)
+    const createNextAppArgs = [args.appName, "--typescript"]
+    if (flags["package-manager"] === "npm") {
+      createNextAppArgs.push("--use-npm")
     }
 
+    await execa("npx", [
+      getNameVersionCombo(packages["create-next-app"]),
+      ...createNextAppArgs,
+    ])
+
     process.chdir(args.appName)
   },
 }

src/setup/steps/format-project.ts

@@ -1,26 +1,15 @@
 import execa from "execa"
-import { exitWithError } from "../../helpers/exit-with-error"
-import { commandInstance } from "../../instance"
 import { getNameVersionCombo, packages } from "../packages"
 import { Step } from "../step"
 
 export const formatProjectStep: Step = {
+  description: "formatting project",
+
   shouldRun: async () => true,
 
   didRun: false,
 
   run: async () => {
-    const instance = commandInstance.get()
-    instance.log("Formatting project...")
-
-    try {
-      await execa("npx", [
-        getNameVersionCombo(packages.prettier),
-        "--write",
-        ".",
-      ])
-    } catch (error) {
-      exitWithError("An error occurred while formatting project.", error)
-    }
+    await execa("npx", [getNameVersionCombo(packages.prettier), "--write", "."])
   },
 }