finish cleanup of basic template

Effect-TS · Sep 10, 2024 · 06ebce5 · 06ebce5
1 parent d7ff698
commit 06ebce5
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 42 deletions.
diff --git a/packages/create-effect-app/package.json b/packages/create-effect-app/package.json
@@ -35,6 +35,7 @@
     "@effect/printer-ansi": "^0.35.2",
     "effect": "^3.7.2",
     "tar": "^7.4.3",
-    "tsup": "^8.2.4"
+    "tsup": "^8.2.4",
+    "yaml": "^2.5.1"
   }
 }
diff --git a/packages/create-effect-app/src/Cli.ts b/packages/create-effect-app/src/Cli.ts
@@ -10,6 +10,7 @@ import * as Array from "effect/Array"
 import * as Effect from "effect/Effect"
 import * as Match from "effect/Match"
 import * as Option from "effect/Option"
+import * as Yaml from "yaml"
 import { ProjectType } from "./Domain.js"
 import { GitHub } from "./GitHub.js"
 import type { Example } from "./internal/examples.js"
@@ -51,10 +52,6 @@ const withNixFlake = Options.boolean("flake").pipe(
   Options.withDescription("Initialize project with a Nix flake")
 )
 
-const withMadge = Options.boolean("madge").pipe(
-  Options.withDescription("Initialize project with Madge")
-)
-
 const withPrettier = Options.boolean("prettier").pipe(
   Options.withDescription("Initialize project with Prettier")
 )
@@ -76,7 +73,6 @@ const projectType: Options.Options<Option.Option<ProjectType>> = Options.all({
       template: templateType,
       withChangesets,
       withNixFlake,
-      withMadge,
       withPrettier,
       withESLint,
       withWorkflows
@@ -215,7 +211,7 @@ function createTemplate(config: TemplateConfig) {
     // Handle user preferences for changesets
     if (!config.projectType.withChangesets) {
       // Remove the .changesets directory
-      yield* fs.remove(path.join(config.projectName, ".changesets"), {
+      yield* fs.remove(path.join(config.projectName, ".changeset"), {
         recursive: true
       })
       // Remove patches for changesets
@@ -228,7 +224,7 @@ function createTemplate(config: TemplateConfig) {
         Object.keys(packageJson["pnpm"]["patchedDependencies"]),
         (key) => key.includes("changeset")
       )
-      for (const patch in depsToRemove) {
+      for (const patch of depsToRemove) {
         delete packageJson["pnpm"]["patchedDependencies"][patch]
       }
       // Remove scripts for changesets
@@ -249,6 +245,7 @@ function createTemplate(config: TemplateConfig) {
       }
       // If git workflows are enabled, remove changesets related workflows
       if (config.projectType.withWorkflows) {
+        yield* fs.remove(path.join(config.projectName, ".github", "workflows", "release.yml"))
       }
     }
 
@@ -260,26 +257,11 @@ function createTemplate(config: TemplateConfig) {
       )
     }
 
-    // Handle user preferences for Madge
-    if (!config.projectType.withMadge) {
-      // Remove the madge configuration file
-      yield* fs.remove(path.join(config.projectName, ".madgerc"))
-      // Remove the madge dependency
-      delete packageJson["devDependencies"]["madge"]
-      // Remove circular script if monorepo
-      if (config.projectType.template === "monorepo") {
-        yield* fs.remove(path.join(config.projectName, "scripts", "circular.js"))
-      }
-      if (config.projectType.withWorkflows) {
-        // If git workflows are enabled, remove madge check workflows
-      }
-    }
-
     // Handle user preferences for Prettier
     if (!config.projectType.withPrettier) {
       // Remove prettier configuration files
       yield* Effect.forEach(
-        [".prettierignore", ".prettierc.json"],
+        [".prettierignore", ".prettierrc.json"],
         (file) => fs.remove(path.join(config.projectName, file))
       )
       // Remove prettier from dependencies
@@ -306,6 +288,11 @@ function createTemplate(config: TemplateConfig) {
       }
       // If git workflows are enabled, remove lint workflows
       if (config.projectType.withWorkflows) {
+        const checkWorkflowPath = path.join(config.projectName, ".github", "workflows", "check.yml")
+        const checkWorkflow = yield* fs.readFileString(checkWorkflowPath)
+        const checkYaml = Yaml.parse(checkWorkflow)
+        delete checkYaml["jobs"]["lint"]
+        yield* fs.writeFileString(checkWorkflowPath, Yaml.stringify(checkYaml, undefined, 2))
       }
     }
 
@@ -315,10 +302,27 @@ function createTemplate(config: TemplateConfig) {
       yield* fs.remove(path.join(config.projectName, ".github"))
     }
 
+    // Write out the updated package.json
+    yield* fs.writeFileString(
+      path.join(config.projectName, "package.json"),
+      JSON.stringify(packageJson, undefined, 2)
+    )
+
     yield* Effect.logInfo(AnsiDoc.hsep([
       AnsiDoc.text("Success!").pipe(AnsiDoc.annotate(Ansi.green)),
       AnsiDoc.text(`Effect template project was initialized in ${config.projectName}`)
     ]))
+
+    if (config.projectType.withChangesets) {
+      yield* Effect.logInfo(AnsiDoc.hsep([
+        AnsiDoc.text("Make sure to update the Changesets configuration file"),
+        AnsiDoc.text("with your target GitHub repository for Changesets changelogs"),
+        AnsiDoc.hardLine,
+        AnsiDoc.text(path.join(config.projectName, ".changeset", "config.json")).pipe(
+          AnsiDoc.annotate(Ansi.magenta)
+        )
+      ]))
+    }
   })
 }
 
@@ -382,11 +386,6 @@ const getUserInput = Prompt.select<"example" | "template">({
           message: "Initialize project with a Nix flake?",
           initial: true
         }),
-        withMadge: Prompt.toggle({
-          message: "Initialize project with Madge?",
-          initial: true
-        }),
-
         withPrettier: Prompt.toggle({
           message: "Initialize project with Prettier?",
           initial: true

diff --git a/packages/create-effect-app/src/Domain.ts b/packages/create-effect-app/src/Domain.ts
@@ -10,7 +10,6 @@ export type ProjectType = Data.TaggedEnum<{
     readonly template: Template
     readonly withChangesets: boolean
     readonly withNixFlake: boolean
-    readonly withMadge: boolean
     readonly withPrettier: boolean
     readonly withESLint: boolean
     readonly withWorkflows: boolean

diff --git a/packages/create-effect-app/src/GitHub.ts b/packages/create-effect-app/src/GitHub.ts
@@ -44,10 +44,7 @@ export const make = Effect.gen(function*() {
         Tar.extract({
           cwd: config.projectName,
           strip: 2 + config.projectType.template.split("/").length,
-          filter: (path) => {
-            console.log(path)
-            return path.includes(`examples-chore-enhance-templates/templates/${config.projectType.template}`)
-          }
+          filter: (path) => path.includes(`examples-chore-enhance-templates/templates/${config.projectType.template}`)
         }), (cause) => new TarExtractionError({ cause, directory: config.projectName })))
     )
 

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/templates/basic/.madgerc b/templates/basic/.madgerc
diff --git a/templates/basic/package.json b/templates/basic/package.json
@@ -61,7 +61,6 @@
     "eslint-plugin-sort-destructure-keys": "^2.0.0",
     "fast-check": "^3.21.0",
     "glob": "^11.0.0",
-    "madge": "^8.0.0",
     "playwright": "^1.46.0",
     "prettier": "^3.3.3",
     "rimraf": "^6.0.1",