chore: remove outdated wiki commands from CLI

jfet97 · jfet97 · commit e31d54fa6817 · 2025-09-11T12:27:49.000+02:00
diff --git a/.changeset/rude-candies-move.md b/.changeset/rude-candies-move.md
@@ -0,0 +1,5 @@
+---
+"@effect-app/cli": patch
+---
+
+remove out of date wiki commands
diff --git a/packages/cli/src/index.ts b/packages/cli/src/index.ts
@@ -698,221 +698,6 @@ Effect
         Command.withDescription("Generate and update package.json exports mappings for all packages in monorepo")
       )
 
-    const wiki = Command
-      .make(
-        "wiki",
-        {},
-        Effect.fn("effa-cli.wiki")(function*() {
-          const action = yield* Prompt.select({
-            choices: [{
-              title: "sync",
-              description: "Initialize and update the documentation submodule",
-              value: "sync"
-            }, {
-              title: "update",
-              description: "Pull latest changes from remote, commit and push changes within the submodule",
-              value: "update"
-            }],
-            message: "Select wiki action"
-          })
-
-          const syncCommand = runNodeCommandEC("git submodule update --init --recursive --remote doc")
-
-          switch (action) {
-            case "sync": {
-              yield* Effect.logInfo("Initializing/updating git submodule for documentation...")
-
-              if ((yield* syncCommand) !== 0) {
-                return yield* Effect.fail(`Failed to sync submodule`)
-              }
-
-              break
-            }
-            case "update": {
-              yield* Effect.logInfo("Pulling latest changes from remote submodule...")
-
-              if ((yield* syncCommand) !== 0) {
-                return yield* Effect.fail(`Failed to sync submodule`)
-              }
-
-              const commitMessage = yield* Prompt.text({
-                message: "Enter commit message:",
-                default: "update doc",
-                validate: (input) =>
-                  input.trim().length > 0
-                    ? Effect.succeed(input.trim())
-                    : Effect.fail("Commit message cannot be empty")
-              })
-
-              yield* Effect.logInfo("Committing and pushing changes in submodule...")
-
-              if (
-                (yield* runNodeCommandEC(
-                  `git -C doc add . && git -C doc commit -m '${commitMessage}' && git -C doc push`
-                )) === 0
-              ) {
-                yield* Effect.logInfo("Submodule updated and pushed successfully")
-              }
-
-              break
-            }
-            default: {
-              action satisfies never
-              return yield* Effect.fail(`Unknown wiki action: ${action}. Available actions: sync, update`)
-            }
-          }
-
-          // check if references to submodule have changed in main repo
-          // and offer to commit these changes
-          const statusOutput = yield* runNodeCommand("git status --porcelain")
-
-          const hasSubmoduleChanges = statusOutput
-            .split("\n")
-            .some((line) => line.trim().endsWith("doc") && line.trim().startsWith("M "))
-
-          if (hasSubmoduleChanges) {
-            const shouldCommitSubmodule = yield* Prompt.confirm({
-              message: "Changes to the submodule detected in main repository. Commit these changes?",
-              initial: false
-            })
-
-            if (
-              shouldCommitSubmodule
-            ) {
-              const mainCommitMessage = yield* Prompt.text({
-                message: "Enter commit message for main repository:",
-                default: "update doc submodule reference",
-                validate: (input) =>
-                  input.trim().length > 0
-                    ? Effect.succeed(input.trim())
-                    : Effect.fail("Commit message cannot be empty")
-              })
-
-              if (
-                (yield* runNodeCommandEC(
-                  `git commit -m '${mainCommitMessage}' doc`
-                )) === 0
-              ) {
-                yield* Effect.logInfo("Main repository updated with submodule changes successfully")
-              } else {
-                yield* Effect.logError("Failed to commit submodule changes in main repository")
-              }
-            } else {
-              yield* Effect.logInfo("Remember to commit the submodule changes in the main repository later.")
-            }
-          } else {
-            yield* Effect.logInfo("No changes to the submodule detected in main repository.")
-          }
-        })
-      )
-      .pipe(Command.withDescription(
-        `Manage the documentation wiki git submodule with interactive action selection.
-
-Available actions:
-- sync: Initialize and update the documentation submodule from remote
-- update: Pull latest changes, commit and push changes within the submodule
-
-After any action, automatically detects and offers to commit submodule reference changes in the main repository.`
-      ))
-
-    const initWiki = Command
-      .make(
-        "init-wiki",
-        {},
-        Effect.fn("effa-cli.initWiki")(function*({}) {
-          yield* Effect.logInfo("⚠️  IMPORTANT: This is a one-time project setup command!")
-
-          // check if doc directory already exists in git index
-          const docInIndex = yield* runNodeCommand("git ls-files")
-            .pipe(
-              Effect.map((output) => output.split("\n").some((line) => line.startsWith("doc/") || line === "doc")),
-              Effect.catchAll(() => Effect.succeed(false))
-            )
-
-          if (docInIndex) {
-            return yield* Effect.logError(`❌ ERROR: A 'doc' directory already exists in the git index!
-
-This suggests the wiki submodule may have been initialized before, or there are conflicting files.
-
-Required actions before proceeding:
-1. Move existing doc files to GitHub wiki or another location
-2. Remove the doc directory from filesystem: rm -rf doc
-3. Remove the doc directory from git index: git rm --cached -r doc
-4. Commit the removal: git commit -m "Remove doc directory"
-5. Re-run this command
-
-Operation cancelled for safety.`)
-          }
-
-          const confirmation = yield* Prompt.confirm({
-            message: `This command will initialize the wiki submodule for this project.
-
-⚠️  WARNING: This is NOT the command to use for local submodule initialization!
-
-This command should only be run ONCE in the entire project history by a project maintainer to:
-- Set up the initial .gitmodules configuration
-- Add the wiki submodule to the repository
-- Commit the submodule configuration
-
-For normal local development, use 'effa wiki sync' instead.
-
-Are you sure you want to proceed with the one-time project setup?`,
-            initial: false
-          })
-
-          if (!confirmation) {
-            return yield* Effect.logInfo("Operation cancelled. Use 'effa wiki sync' for normal wiki operations.")
-          }
-
-          yield* Effect.logInfo("Extracting project name from git remote...")
-          const remoteUrl = yield* runNodeCommand("git config --get remote.origin.url")
-
-          // extract project name from URL (supports both SSH and HTTPS)
-          //
-          // - git@github.com:user/project-name.git -> project-name
-          // - https://github.com/user/project-name.git -> project-name
-          let detectedProjectName = remoteUrl
-            .split("/")
-            .pop()
-            ?.replace(/\.git$/, "")
-            ?.trim()
-
-          yield* detectedProjectName
-            ? Effect.logInfo(`Detected project name from git remote: ${detectedProjectName}`)
-            : Effect.logWarning("Could not determine project name from git remote")
-
-          detectedProjectName = yield* Prompt.text({
-            message: detectedProjectName
-              ? "Please confirm or modify the project name:"
-              : "Please enter the project name:",
-            ...detectedProjectName && { default: detectedProjectName },
-            validate: (input) =>
-              input.trim().length > 0
-                ? Effect.succeed(input.trim())
-                : Effect.fail("Project name cannot be empty")
-          })
-
-          yield* Effect.logInfo(`Using project name: ${detectedProjectName}`)
-
-          yield* Effect.logInfo("Creating .gitmodules file...")
-          yield* runNodeCommandEC(`echo '' >> .gitmodules`)
-          yield* runNodeCommandEC(`echo '[submodule "doc"]' >> .gitmodules`)
-          yield* runNodeCommandEC(`echo '  path = doc' >> .gitmodules`)
-          yield* runNodeCommandEC(`echo '  url = ../${detectedProjectName}.wiki.git' >> .gitmodules`)
-          yield* runNodeCommandEC(`echo '  branch = master' >> .gitmodules`)
-          yield* runNodeCommandEC(`echo '  update = merge' >> .gitmodules`)
-
-          yield* Effect.logInfo("Adding git submodule for documentation wiki...")
-          yield* runNodeCommandEC(`git submodule add -b master ../${detectedProjectName}.wiki.git doc`)
-
-          yield* Effect.logInfo("Committing wiki submodule addition...")
-          yield* runNodeCommandEC("git add . && git commit -am 'Add doc submodule'")
-
-          return yield* Effect.logInfo("Wiki submodule initialized successfully")
-        })
-      )
-      .pipe(Command.withDescription("Set up the wiki submodule for the project (one-time setup)"))
-
     const nuke = Command
       .make(
         "nuke",
@@ -960,8 +745,6 @@ Are you sure you want to proceed with the one-time project setup?`,
           indexMulti,
           packagejson,
           packagejsonPackages,
-          wiki,
-          initWiki,
           nuke
         ])),
       {
diff --git a/wiki/effect‐app‐cli.md b/wiki/effect‐app‐cli.md
@@ -27,8 +27,6 @@ node packages/cli/dist/index.js effa <command>
 | `effa index-multi` | Monitor controller and index files for auto-eslint fixes |
 | `effa packagejson` | Generate and monitor export mappings for root package.json |
 | `effa packagejson-packages` | Generate and monitor export mappings for all packages |
-| `effa wiki` | Interactive wiki submodule management (sync/update) |
-| `effa init-wiki` | **[Maintainer Only]** One-time wiki submodule setup |
 | `effa nuke` | Nuclear cleanup - remove all generated files and directories |
 
 ## Available Commands
@@ -146,94 +144,6 @@ pnpm effa packagejson-packages
 4. Generates exports for all found packages
 5. Monitors each package for changes
 
-### `effa wiki` - Documentation Wiki Management
-
-Manages the documentation wiki git submodule with interactive action selection for updating and synchronizing documentation.
-
-```bash
-pnpm effa wiki
-```
-
-**⚠️ ACHTUNG - Important Git Submodule Behavior:**
-> **Submodule operations will change the commit reference in the main project repository!**
-> When you run `effa wiki`, the git submodule reference in your main project may be updated to point to the latest commit in the submodule.
-> **The CLI will automatically detect these changes and offer to commit the new submodule reference** in the main project repository.
-
-**Interactive Selection:**
-When you run the command, you'll get a menu to choose the action:
-- **sync**: Initialize and update the documentation submodule from remote  
-- **update**: Pull latest changes, commit and push changes within the submodule
-
-**Available Actions:**
-
-#### `sync`
-Updates or initializes the documentation submodule from remote:
-
-💡 **Run this periodically to keep your local documentation up-to-date**
-
-**What it does:**
-- Runs `git submodule update --init --recursive --remote doc`
-- Pulls the latest changes from the remote submodule repository
-- Automatically detects if submodule reference changed in main repo
-- Offers to commit the submodule reference changes
-
-#### `update`
-Interactive workflow to update and commit changes within the submodule:
-
-**What it does:**
-1. Pulls latest changes from remote submodule (same as sync)
-2. Prompts for a commit message (default: "update doc")  
-3. Stages all changes in the submodule
-4. Commits and pushes changes to the remote submodule repository
-5. Automatically detects if submodule reference changed in main repo
-6. Offers to commit the submodule reference changes
-
-### `effa init-wiki` - Wiki Submodule Setup
-
-**⚠️ PROJECT MAINTAINER ONLY - ONE-TIME SETUP COMMAND**
-
-Sets up the wiki submodule for the project. This is a standalone command that should only be run once in the project's entire history by a project maintainer.
-
-```bash
-pnpm effa init-wiki
-```
-
-**What it does:**
-1. **Safety checks**: Verifies no existing `doc` directory exists in git index
-2. **Confirmation prompt**: Requires explicit confirmation with detailed warnings
-3. **Project detection**: Extracts project name from git remote URL (supports SSH and HTTPS)
-4. **Manual override**: Allows manual project name input or modification
-5. **Submodule setup**: Creates `.gitmodules` configuration file
-6. **Repository integration**: Adds the wiki submodule (`../{project-name}.wiki.git`) 
-7. **Automatic commit**: Commits the submodule configuration to the main repository
-
-**⚠️ CRITICAL WARNINGS:**
-- **NOT for local development**: This is NOT the command for local submodule initialization!
-- **ONE-TIME ONLY**: Should only be run ONCE by a project maintainer during initial project setup
-- **Repository modification**: Modifies the main repository by adding submodule configuration  
-- **Use `effa wiki sync` instead** for normal local development submodule initialization
-
-**Safety Features:**
-- Checks for existing `doc` directory conflicts before proceeding
-- Requires explicit user confirmation with detailed warnings
-- Provides clear guidance for different scenarios
-- Auto-detects project name but allows manual override
-
-**Example workflow:**
-```bash
-# Project maintainer runs this ONCE during project setup:
-pnpm effa init-wiki
-# ⚠️  IMPORTANT: This is a one-time project setup command!
-# This command will initialize the wiki submodule for this project...
-# Detected project name from git remote: my-awesome-project
-# Please confirm or modify the project name: my-awesome-project
-# ✅ Wiki submodule initialized successfully
-
-# Later, other developers use:
-pnpm effa wiki
-# Choose: sync
-```
-
 ### `effa nuke` - Nuclear Cleanup
 
 Performs deep cleanup by removing all generated files and directories from the workspace.

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@effect-app/cli": patch
 +---
++
 +remove out of date wiki commands