@liangmi/mo 0.0.5 → 1.0.1

package/README.md

@@ -2,10 +2,9 @@
 
 **M**anage your **O**pensource projects!
 
-It just keeps your repos organized like this:
-
-```text
+`mo` keeps your GitHub repos organized under a single root directory:
 
+```
 ~/code
 ├── vitejs
 │   ├── vite
@@ -13,107 +12,64 @@ It just keeps your repos organized like this:
 └── vuejs
     ├── core
     └── vue
-
-```
-
-## Install
-
-```bash
-
-vp install -g @liangmi/mo
-
 ```
 
 ## Requirements
 
-- macOS or Linux (Windows is not supported)
-- global install (local install is not supported for runtime usage)
+- macOS or Linux
 - `git`
 - GitHub CLI `gh` authenticated (`gh auth status`)
 
-## Quick Start
-
-Run setup once:
+## Install
 
 ```bash
-mo setup
+npm install -g @liangmi/mo
 ```
 
-`mo setup` will:
-
-1. check `git`
-2. check `gh` authentication
-3. ask for your projects root directory
-4. ask which shell(s) you use (`zsh`, `bash`, `fish`)
-5. optionally collect aliases for `mo clone`, `mo list`, and `mo cd`
-6. write `~/.config/morc.json`
-7. sync managed shellrc blocks
+## Setup
 
-After setup:
+Run once to initialize config and shell integration:
 
 ```bash
-mo clone vitejs/vite
-mo list
-mo cd
+mo setup
 ```
 
 ## Commands
 
-### `mo setup`
-
-Initialize config and shell integration.
-
-### `mo clone <owner>/<repo>`
-
-Clone a GitHub repository into `<root>/<owner>/<repo>`.
-
-Alias: `mo c <owner>/<repo>`
-
-Example:
-
-```bash
-mo clone vuejs/core
-```
-
-### `mo list`
-
-List repositories under your configured root.
-
-Alias: `mo ls`
-
-### `mo cd [target]`
-
-Resolve and jump to a managed path in your shell integration function.
-
-Without `target`, it opens an interactive selector for:
-
-- root
-- owner directory
-- repository directory
-
-With `target`, supported forms are:
-
-- `root` or `.`
-- `<owner>`
-- `<owner>/<repo>`
-
-Alias: `mo d`
+| Command                   | Alias   | Description                               |
+| ------------------------- | ------- | ----------------------------------------- |
+| `mo setup`                |         | Initialize config and shell integration   |
+| `mo clone <owner>/<repo>` | `mo c`  | Clone a repo into `<root>/<owner>/<repo>` |
+| `mo list`                 | `mo ls` | List all managed repos                    |
+| `mo cd [owner[/repo]]`    | `mo d`  | Jump to root, owner, or repo directory    |
+| `mo edit [owner[/repo]]`  | `mo e`  | Open a repo in your editor                |
+| `mo open [owner[/repo]]`  | `mo o`  | Open a repo in Finder/Explorer            |
+
+`mo cd`, `mo edit`, and `mo open` open an interactive selector when called without arguments.
+
+> [!TIP]
+> If you are using `mo` with VS Code based editors, you can add this line to your editor config to prevent `mo edit` popping up a new separated window.
+>
+> ```json
+> "window.openFoldersInNewWindow": "off"
+> ```
+>
+> Setting `code -r` as your editor in `mo setup` have the same effect as well.
 
 ## Config
 
-Default config path:
+The config file should be generated by running `mo setup`. Modifying `~/.config/morc.json` manually is not recommended.
 
-```text
-~/.config/morc.json
-```
+Please follow the [config_schema.json](./config_schema.json) if you are developing `mo`.
 
-Example:
+`~/.config/morc.json`:
 
 ```json
 {
   "$schema": "https://raw.githubusercontent.com/liangmiQwQ/mo/main/config_schema.json",
   "root": "~/code",
   "shells": ["zsh"],
+  "editor": "code",
   "alias": {
     "clone": ["k"],
     "list": ["li"],
@@ -122,34 +78,9 @@ Example:
 }
 ```
 
-### Fields
-
-- `root` (required): absolute path or `~` path for your projects directory
-- `shells` (required): one or more of `zsh`, `bash`, `fish`
-- `alias` (optional): alias arrays for `clone`, `list`, `cd`
-
-Alias names must match:
-
-```text
-[A-Za-z_][A-Za-z0-9_-]*
-```
-
-## Shell Integration
-
-`mo` manages shell integration blocks in your shellrc files:
-
-- `~/.zshrc`
-- `~/.bashrc`
-- `~/.config/fish/config.fish`
-
-## Notes
-
-- If you run config-required commands without config, `mo` prompts you to run `mo setup`.
-- `mo list` only shows repositories that are Git repos with a GitHub remote.
-
 ## Contribution
 
-We're really excited to receive your contributions! Please see [ROADMAP.md](./ROADMAP.md) for details!
+See [ROADMAP.md](./ROADMAP.md) for what's planned.
 
 ## License
 

package/config_schema.json

@@ -53,6 +53,22 @@
             "pattern": "^[A-Za-z_][A-Za-z0-9_-]*$"
           },
           "uniqueItems": true
+        },
+        "edit": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "pattern": "^[A-Za-z_][A-Za-z0-9_-]*$"
+          },
+          "uniqueItems": true
+        },
+        "open": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "pattern": "^[A-Za-z_][A-Za-z0-9_-]*$"
+          },
+          "uniqueItems": true
         }
       },
       "additionalProperties": false

package/dist/chunk-CBBoxR_p.mjs

@@ -0,0 +1,26 @@
+import { createRequire } from "node:module";
+//#region \0rolldown/runtime.js
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __commonJSMin = (cb, mod) => () => (mod || cb((mod = { exports: {} }).exports, mod), mod.exports);
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+var __require = /* @__PURE__ */ createRequire(import.meta.url);
+//#endregion
+export { __require as n, __toESM as r, __commonJSMin as t };