Merge pull request #151 from akd-io/feature/142-refactor-architecture-to-use-declara

Refactor to declarative plugin architecture

Author: akd-io

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "files.exclude": {}
+}

package.json

@@ -43,12 +43,14 @@
   "scripts": {
     "prepare": "husky install",
     "prepack": "yarn build && oclif-dev readme",
+    "check-types": "tsc --noEmit",
     "build": "rimraf lib && tsc --build",
     "test": "yarn build && yarn run test-only",
     "test-only": "node lib/tests/e2e/test.js",
     "test:manual": "yarn build && node lib/tests/e2e/manual-test.js --debug",
     "test:small": "yarn build && node lib/tests/e2e/manual-test.js --debug --package-manager=npm --styling=css-modules",
     "test:large": "yarn build && node lib/tests/e2e/manual-test.js --debug --package-manager=yarn --styling=emotion --react-hook-form --formik --prettier --formatting-pre-commit-hook --chakra --framer-motion --github-actions",
+    "test:cna": "yarn build && node lib/tests/e2e/test-cna.js",
     "version": "oclif-dev readme && git add README.md",
     "format": "prettier --write --ignore-path=.prettierignore .",
     "format:check": "prettier --check --ignore-path=.prettierignore .",
@@ -83,9 +85,10 @@
     "eslint-config-prettier": "^8.3.0",
     "husky": "^7.0.1",
     "lint-staged": "^11.0.0",
+    "next": "^13.2.4",
     "prettier": "^2.3.2",
     "ts-node": "^10.0.0",
-    "typescript": "^4.3.5",
+    "typescript": "^4.9.0",
     "uuid": "^8.3.2"
   }
 }

prod-assets/templates/LandingPage/LandingPageTemplate.tsx

@@ -56,6 +56,23 @@ const LandingPageTemplate = () => {
         strategy="afterInteractive"
         onLoad={onConfettiLoad}
       />
+      <style>
+        {`
+          * {
+            box-sizing: border-box;
+          }
+
+          html,
+          body {
+            padding: 0;
+            margin: 0;
+            font-family: -apple-system, BlinkMacSystemFont, Segoe UI, Roboto,
+              Oxygen, Ubuntu, Cantarell, Fira Sans, Droid Sans, Helvetica Neue,
+              sans-serif;
+            line-height: 1.5;
+          }
+        `}
+      </style>
       <main>
         <Section>
           <Container center className={styles.headerSection}>

prod-assets/templates/LandingPage/components/InlineCode.module.css

@@ -2,6 +2,8 @@
   border-radius: 0.5em;
   padding: 0.5em;
 
+  font-family: Menlo, Monaco, Lucida Console, Liberation Mono, DejaVu Sans Mono,
+    Bitstream Vera Sans Mono, Courier New, monospace;
   font-size: 0.8em;
   background-color: hsl(0, 0%, 95%);
 }

prod-assets/templates/LandingPage/components/Link.module.css

@@ -1,3 +1,5 @@
 .link {
   color: #319bff;
+  text-decoration: none;
+  font-weight: bold;
 }

src/main/instance.ts src/main/command-instance.tssrc/main/instance.ts renamed to src/main/command-instance.ts

@@ -15,7 +15,7 @@ export const commandInstance: CommandInstance = {
     if (commandInstance._instance != null) {
       return commandInstance._instance
     } else {
-      throw new Error("commandInstance.get() called before it was set.")
+      throw new Error("commandInstance accessed before it was set.")
     }
   },
 }

src/main/helpers/constrain.ts

@@ -0,0 +1,15 @@
+/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
+
+/**
+ * Generic constrained identity function (CIF) by Kent C. Dodds
+ *
+ * For a lesson on constrained identity functions and this generic version, see the blog post linked below.
+ *
+ * When TypeScript 4.9.0 is supported, we'll be able to use `satisfies` instead of this generic CIF.
+ *
+ * @see https://kentcdodds.com/blog/how-to-write-a-constrained-identity-function-in-typescript#a-generic-cif
+ */
+export const constrain =
+  <Given extends unknown>() =>
+  <Inferred extends Given>(item: Inferred) =>
+    item

src/main/helpers/copy-directory.ts

@@ -1,13 +1,14 @@
-import { promises as fs } from "fs"
+import fs from "fs/promises"
 import path from "path"
+import { makeDirectory } from "./io"
 
 export const copyDirectory = async (
   src: string,
   dest: string
 ): Promise<void> => {
   const [entries] = await Promise.all([
     fs.readdir(src, { withFileTypes: true }),
-    fs.mkdir(dest, { recursive: true }),
+    makeDirectory(dest),
   ])
 
   await Promise.all(

src/main/helpers/deeply-readonly.ts

@@ -0,0 +1,11 @@
+export type DeeplyReadonly<T> = T extends unknown[]
+  ? DeeplyReadonlyArray<T[number]>
+  : T extends Record<string, unknown>
+  ? DeeplyReadonlyObject<T>
+  : T
+
+export type DeeplyReadonlyArray<T> = ReadonlyArray<DeeplyReadonly<T>>
+
+export type DeeplyReadonlyObject<T> = {
+  readonly [P in keyof T]: DeeplyReadonly<T[P]>
+}

src/main/helpers/diff-string.ts

@@ -0,0 +1,3 @@
+export const getDiffString = (diffInMillis: number): string => {
+  return new Date(diffInMillis).toISOString().slice(11, 19)
+}