oh-my-space 0.4.0 → 0.5.0

package/README.md

@@ -32,9 +32,10 @@ bun install -g oh-my-space
 
 ## Quick start
 
-Create an `oms.yaml` in your project root:
+Run `oms init` to scaffold a starter `oms.yaml` (also adds `oms/` to `.gitignore`), or create one by hand in your project root:
 
 ```yaml
+# yaml-language-server: $schema=https://raw.githubusercontent.com/divlook/oh-my-space/main/oms.schema.json
 repos:
   - alias: api
     url: git@github.com:example/api.git
@@ -46,6 +47,7 @@ repos:
 Sync and explore:
 
 ```bash
+oms init                           # scaffold a starter oms.yaml
 oms doctor                         # validate oms.yaml + bare/worktree state
 oms sync --list                    # list registered source repos
 oms sync <alias>...                # bare-clone + create the baseline worktree
@@ -81,6 +83,7 @@ Slash-containing branch names are kept nested as directories.
 
 | Command | Runs in | Does | Notes |
 | --- | --- | --- | --- |
+| `oms init` | current directory | Writes a starter `oms.yaml` and adds `oms/` to `.gitignore`. | Refuses if `oms.yaml` exists; use `--force` to overwrite. |
 | `oms doctor` | project root or child path | Checks `oms.yaml`, git availability, `.gitignore`, and each alias's bare clone + `remote.origin.fetch`. | Returns exit 2 if any warning is raised. |
 | `oms sync <alias>` / `--all` | workspace root | Bare-clones missing repos, fetches origin, creates the baseline worktree. | Adds `oms/` to `.gitignore` if absent. |
 | `oms unsync <alias>` / `--all` | workspace root | Removes every worktree, the bare clone, and the `.git` placeholder for the alias. | Keeps the `oms.yaml` entry. Use `--force` to discard uncommitted changes. |
@@ -94,6 +97,7 @@ Slash-containing branch names are kept nested as directories.
 ## `oms.yaml` format
 
 ```yaml
+# yaml-language-server: $schema=https://raw.githubusercontent.com/divlook/oh-my-space/main/oms.schema.json
 repos:
   - alias: service-a
     url: git@github.com:example/service-a.git

package/dist/oms.js

@@ -13,6 +13,7 @@ const FETCH_REFSPEC = "+refs/heads/*:refs/remotes/origin/*";
 const MANIFEST_FILENAME = "oms.yaml";
 const DATA_DIRNAME = "oms";
 const GITIGNORE_ENTRY = `${DATA_DIRNAME}/`;
+const GITIGNORE_COMMENT = "# managed by oms";
 const LEGACY_MANIFEST = "sources.yaml";
 const LEGACY_DATA_DIRNAME = "sources";
 const LEGACY_MIGRATION_DOC = "docs/migrations/0.3.x-to-0.4.0.md";
@@ -247,7 +248,8 @@ function ensureGitignore(repoRoot) {
             return;
     }
     const needsNewline = content.length > 0 && !content.endsWith("\n");
-    writeFileSync(path, `${content}${needsNewline ? "\n" : ""}${GITIGNORE_ENTRY}\n`);
+    const block = `${GITIGNORE_COMMENT}\n${GITIGNORE_ENTRY}\n`;
+    writeFileSync(path, `${content}${needsNewline ? "\n" : ""}${block}`);
     log.info(`added ${GITIGNORE_ENTRY} to .gitignore`);
 }
 function setupBareRepo(repo, repoRoot) {
@@ -800,6 +802,25 @@ async function runWorktreeRemove(alias, branch, options) {
     log.success(`${alias}: removed worktree for ${branch}`);
     return 0;
 }
+const INIT_TEMPLATE = `# yaml-language-server: $schema=https://raw.githubusercontent.com/divlook/oh-my-space/main/oms.schema.json
+repos:
+  - alias: example
+    url: git@github.com:example/repo.git
+    branch: main
+`;
+/** 현재 디렉터리에 기본 oms.yaml 템플릿을 생성합니다. */
+async function runInit(options) {
+    const target = join(process.cwd(), MANIFEST_FILENAME);
+    if (existsSync(target) && !options.force) {
+        log.error(`${MANIFEST_FILENAME} already exists at ${target}. Use --force to overwrite.`);
+        return 1;
+    }
+    writeFileSync(target, INIT_TEMPLATE);
+    log.success(`created ${MANIFEST_FILENAME} at ${target}`);
+    ensureGitignore(process.cwd());
+    log.info(`edit alias/url/branch, then run "oms sync".`);
+    return 0;
+}
 async function runDoctor() {
     const loaded = loadRepos();
     if (!loaded) {
@@ -884,6 +905,7 @@ async function exitWith(action) {
 }
 const exitHelp = "\nExit codes: 0 ok | 1 usage/config error | 2 one or more git operations failed.";
 const commandNames = new Set([
+    "init",
     "doctor",
     "sync",
     "fetch",
@@ -899,6 +921,14 @@ program
     .description(`Manage source repositories listed in ${MANIFEST_FILENAME} as bare clones + worktrees under ${DATA_DIRNAME}/<alias>/.`)
     .version(readPackageVersion())
     .addHelpText("after", exitHelp);
+program
+    .command("init")
+    .description(`Create a starter ${MANIFEST_FILENAME} in the current directory.`)
+    .option("--force", `overwrite an existing ${MANIFEST_FILENAME}`)
+    .addHelpText("after", exitHelp)
+    .action(async (options) => {
+    await exitWith(runInit(options));
+});
 program
     .command("doctor")
     .description(`Check ${MANIFEST_FILENAME}, git availability, bare-clone state, and .gitignore for each registered alias.`)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oh-my-space",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "CLI for managing external source repositories declared in oms.yaml.",
   "license": "MIT",
   "homepage": "https://github.com/divlook/oh-my-space",