@yuiseki/gyazocli 0.0.2 → 0.2.0

package/docs/ADR/005-module-layout.md

@@ -0,0 +1,72 @@
+# 005. Module layout
+
+## Status
+
+Accepted.
+
+## Context
+
+`src/index.ts` had grown to about 2950 lines. It held the commander
+definitions for sixteen commands, and underneath them the text formatting, the
+date handling, the cache walks, the rankings and the printers. Finding the code
+behind a command meant scrolling, and two unrelated concerns often sat a few
+lines apart.
+
+The tests made the move safe: all of them spawn the built CLI and assert on its
+output, so nothing here depends on the internal shape, and a behaviour change
+during the move would fail them.
+
+## Decision
+
+```
+src/
+  index.ts              the program, the register calls, the entry dispatch
+  commands/             one module per command, each exporting
+                        register<Name>Command(program)
+  api.ts                HTTP against Gyazo
+  storage.ts            reading and writing the cache files
+  config.ts             environment
+  credentials.ts        the access token
+  ids.ts                image and collection IDs out of what was typed
+  options.ts            numeric option validation
+  format.ts             reading and presenting the fields of an image
+  dates.ts              local days, ranges, hourly bucket keys
+  mcp.ts                the MCP server
+  services/
+    memory.ts           the cache, and the API walks that fill it
+    analytics.ts        rankings, summaries, the stats markdown
+    images.ts           showing captures, and the upload helpers
+    collections.ts      collections
+```
+
+Dependencies run one way. A command module may use anything below it;
+`services/` may use the modules above it; nothing below reaches back up into
+`commands/`. Within `services/`, `analytics` and `images` may use `memory`, and
+`collections` may use `images`.
+
+The register calls in `index.ts` run in the order the commands were defined
+before, because that order is what `--help` prints.
+
+Two placements are worth recording, because they were both the second attempt.
+`mergeImageForDisplay` and `shouldEnrichForLocationDisplay` sound like display
+code but live in `format.ts`: the cache walks need them too, and leaving them
+with the printers made `memory` and `images` depend on each other in both
+directions. `parsePositiveIntegerOption` is its own module rather than part of
+either `dates` or `index`, because the date handling and the commands both use
+it and it reports failure by exiting.
+
+## Consequences
+
+- `index.ts` is about 100 lines: the program metadata, the register calls, and
+  the two things that happen before parsing, which are the bare-argument
+  dispatch and the MCP branch.
+- The largest command module is `list.ts` at about 220 lines. The rest are
+  under 120.
+- `noUnusedLocals` and `noUnusedParameters` are on. The move left dozens of
+  imports behind for functions that were no longer there, and that class of
+  leftover should fail the build.
+- The MCP server no longer reaches into the command file for ID handling; it
+  imports `ids.ts` like everything else.
+- A command's implementation is now spread over more files than before. The
+  commander definition stays the place to start reading, and it names what it
+  calls.

package/package.json

@@ -1,7 +1,15 @@
 {
   "name": "@yuiseki/gyazocli",
-  "version": "0.0.2",
+  "version": "0.2.0",
   "description": "Gyazo Memory CLI for AI Secretary",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/yuiseki/gyazocli.git"
+  },
+  "bugs": {
+    "url": "https://github.com/yuiseki/gyazocli/issues"
+  },
+  "homepage": "https://github.com/yuiseki/gyazocli#readme",
   "main": "dist/index.js",
   "bin": {
     "gyazo": "dist/index.js"
@@ -28,9 +36,11 @@
   "license": "ISC",
   "type": "commonjs",
   "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.30.0",
     "axios": "^1.13.5",
     "commander": "^14.0.3",
     "dotenv": "^17.3.1",
+    "form-data": "^4.0.0",
     "zod": "^4.3.6"
   },
   "devDependencies": {