@devinpublic/cli 0.1.0

package/README.md

@@ -0,0 +1,110 @@
+# @devinpublic/cli
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Node.js](https://img.shields.io/badge/node-%3E%3D18-brightgreen)](https://nodejs.org/)
+
+The **`dip`** command is provided by **`@devinpublic/cli`**: a small, dependency-light CLI that captures what you are about to do and saves it as a dated Markdown note under `.devinpublic/`. It is built with TypeScript, [Commander](https://github.com/tj/commander.js), and ships as an npm package for use in any project.
+
+## Why use it?
+
+- **One prompt** — asks what you are about to do, then writes the file.
+- **Predictable filenames** — `YYYY-MM-DD--NNN-init.md` with per-day sequence numbering so runs do not overwrite each other.
+- **Portable** — install once per repo or run via `npx`; works on Node 18+.
+
+## Installation
+
+```bash
+npm install @devinpublic/cli
+```
+
+Or run without installing:
+
+```bash
+npx @devinpublic/cli
+```
+
+## Usage
+
+Add a script to your `package.json`:
+
+```json
+{
+  "scripts": {
+    "dip": "dip"
+  }
+}
+```
+
+Then:
+
+```bash
+npm run dip
+```
+
+You will be prompted:
+
+```text
+What are you about to do?
+```
+
+After you press Enter, a new file is created under `.devinpublic/` and a success line is printed, for example:
+
+```text
+File created successfully at .devinpublic/2026-03-28--001-init.md
+```
+
+### CLI options
+
+| Option | Description |
+|--------|-------------|
+| `-h`, `--help` | Show help |
+| `-V`, `--version` | Print version |
+
+## Requirements
+
+- **Node.js** 18 or newer
+
+## Development
+
+```bash
+git clone <your-repo-url>
+cd devinpublic
+npm install
+npm run build
+npm test
+npm run typecheck
+```
+
+| Script | Purpose |
+|--------|---------|
+| `npm run build` | Compile TypeScript to `dist/` and resolve path aliases |
+| `npm run dip` | Run the built CLI locally |
+| `npm test` | Run the test suite (Vitest) |
+| `npm run test:watch` | Tests in watch mode |
+| `npm run typecheck` | Typecheck `src/` and `tests/` |
+
+### Project layout
+
+- `src/cli.ts` — CLI entry (Commander)
+- `src/actions/` — Command actions (e.g. `note-create`)
+- `src/utils/` — Shared helpers
+- `tests/` — Test files
+
+Imports use the `@/` alias mapped to `src/` (see `tsconfig.json`).
+
+## Contributing
+
+Contributions are welcome. Please open an issue to discuss larger changes before submitting a pull request. Ensure tests pass:
+
+```bash
+npm test
+npm run typecheck
+```
+
+## License
+
+[MIT](https://opensource.org/licenses/MIT). SPDX: `MIT` (see `package.json`).
+
+## Acknowledgements
+
+Built with [Commander](https://github.com/tj/commander.js), [TypeScript](https://www.typescriptlang.org/), and [Vitest](https://vitest.dev/).

package/dist/actions/note-create.d.ts

@@ -0,0 +1,13 @@
+export declare const QUESTION = "What are you about to do?";
+export type NoteCreateOptions = {
+    cwd: string;
+    now?: Date;
+    stdin?: NodeJS.ReadableStream;
+    stdout?: NodeJS.WritableStream;
+    log?: (msg: string) => void;
+    prompt?: () => Promise<string>;
+};
+export declare function noteCreate(options: NoteCreateOptions): Promise<{
+    relativePath: string;
+}>;
+//# sourceMappingURL=note-create.d.ts.map

package/dist/actions/note-create.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"note-create.d.ts","sourceRoot":"","sources":["../../src/actions/note-create.ts"],"names":[],"mappings":"AAUA,eAAO,MAAM,QAAQ,8BAA8B,CAAC;AAEpD,MAAM,MAAM,iBAAiB,GAAG;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,CAAC,EAAE,IAAI,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC,cAAc,CAAC;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC,cAAc,CAAC;IAC/B,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAC5B,MAAM,CAAC,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;CAChC,CAAC;AAgBF,wBAAsB,UAAU,CAC9B,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC;IAAE,YAAY,EAAE,MAAM,CAAA;CAAE,CAAC,CA4BnC"}

package/dist/actions/note-create.js

@@ -0,0 +1,34 @@
+import { createInterface } from 'node:readline';
+import { mkdir, readdir, writeFile } from 'node:fs/promises';
+import { join } from 'node:path';
+import { formatYmd } from '../utils/date-format.js';
+import { buildNoteFilename, nextSequenceFromFilenames, } from '../utils/devinpublic-filename.js';
+import { buildMarkdown } from '../utils/note-markdown.js';
+export const QUESTION = 'What are you about to do?';
+async function promptWithReadline(question, stdin, stdout) {
+    const rl = createInterface({ input: stdin, output: stdout });
+    return new Promise((resolve) => {
+        rl.question(`${question}\n`, (line) => {
+            rl.close();
+            resolve(line);
+        });
+    });
+}
+export async function noteCreate(options) {
+    const { cwd, now = new Date(), stdin = process.stdin, stdout = process.stdout, log = console.log, prompt, } = options;
+    const answer = prompt
+        ? await prompt()
+        : await promptWithReadline(QUESTION, stdin, stdout);
+    const dir = join(cwd, '.devinpublic');
+    await mkdir(dir, { recursive: true });
+    const ymd = formatYmd(now);
+    const names = await readdir(dir);
+    const seq = nextSequenceFromFilenames(names, ymd);
+    const filename = buildNoteFilename(ymd, seq);
+    const filepath = join(dir, filename);
+    await writeFile(filepath, buildMarkdown(answer), 'utf8');
+    const relativePath = `.devinpublic/${filename}`;
+    log(`File created successfully at ${relativePath}`);
+    return { relativePath };
+}
+//# sourceMappingURL=note-create.js.map

package/dist/actions/note-create.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"note-create.js","sourceRoot":"","sources":["../../src/actions/note-create.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EACL,iBAAiB,EACjB,yBAAyB,GAC1B,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAEzD,MAAM,CAAC,MAAM,QAAQ,GAAG,2BAA2B,CAAC;AAWpD,KAAK,UAAU,kBAAkB,CAC/B,QAAgB,EAChB,KAA4B,EAC5B,MAA6B;IAE7B,MAAM,EAAE,GAAG,eAAe,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAC7D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,EAAE,CAAC,QAAQ,CAAC,GAAG,QAAQ,IAAI,EAAE,CAAC,IAAY,EAAE,EAAE;YAC5C,EAAE,CAAC,KAAK,EAAE,CAAC;YACX,OAAO,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,OAA0B;IAE1B,MAAM,EACJ,GAAG,EACH,GAAG,GAAG,IAAI,IAAI,EAAE,EAChB,KAAK,GAAG,OAAO,CAAC,KAAK,EACrB,MAAM,GAAG,OAAO,CAAC,MAAM,EACvB,GAAG,GAAG,OAAO,CAAC,GAAG,EACjB,MAAM,GACP,GAAG,OAAO,CAAC;IAEZ,MAAM,MAAM,GAAG,MAAM;QACnB,CAAC,CAAC,MAAM,MAAM,EAAE;QAChB,CAAC,CAAC,MAAM,kBAAkB,CAAC,QAAQ,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IAEtD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;IACtC,MAAM,KAAK,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAEtC,MAAM,GAAG,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;IAC3B,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,yBAAyB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAClD,MAAM,QAAQ,GAAG,iBAAiB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAC7C,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IAErC,MAAM,SAAS,CAAC,QAAQ,EAAE,aAAa,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;IAEzD,MAAM,YAAY,GAAG,gBAAgB,QAAQ,EAAE,CAAC;IAChD,GAAG,CAAC,gCAAgC,YAAY,EAAE,CAAC,CAAC;IACpD,OAAO,EAAE,YAAY,EAAE,CAAC;AAC1B,CAAC"}

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}

package/dist/cli.js

@@ -0,0 +1,27 @@
+#!/usr/bin/env node
+import { readFileSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { Command } from 'commander';
+import { noteCreate } from './actions/note-create.js';
+function readPackageVersion() {
+    const here = dirname(fileURLToPath(import.meta.url));
+    const pkgPath = join(here, '..', 'package.json');
+    const raw = readFileSync(pkgPath, 'utf8');
+    const pkg = JSON.parse(raw);
+    return pkg.version ?? '0.0.0';
+}
+const program = new Command();
+program
+    .name('dip')
+    .description('Create a markdown note under .devinpublic')
+    .version(readPackageVersion(), '-V, --version', 'output the version number')
+    .helpOption('-h, --help', 'display help for command')
+    .action(async () => {
+    await noteCreate({ cwd: process.cwd() });
+});
+program.parseAsync(process.argv).catch((err) => {
+    console.error(err);
+    process.exitCode = 1;
+});
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAEtD,SAAS,kBAAkB;IACzB,MAAM,IAAI,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACrD,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC;IACjD,MAAM,GAAG,GAAG,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC1C,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAyB,CAAC;IACpD,OAAO,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC;AAChC,CAAC;AAED,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,KAAK,CAAC;KACX,WAAW,CAAC,2CAA2C,CAAC;KACxD,OAAO,CAAC,kBAAkB,EAAE,EAAE,eAAe,EAAE,2BAA2B,CAAC;KAC3E,UAAU,CAAC,YAAY,EAAE,0BAA0B,CAAC;KACpD,MAAM,CAAC,KAAK,IAAI,EAAE;IACjB,MAAM,UAAU,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;AAC3C,CAAC,CAAC,CAAC;AAEL,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,GAAY,EAAE,EAAE;IACtD,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;AACvB,CAAC,CAAC,CAAC"}

package/dist/utils/date-format.d.ts

@@ -0,0 +1,2 @@
+export declare function formatYmd(date: Date): string;
+//# sourceMappingURL=date-format.d.ts.map

package/dist/utils/date-format.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"date-format.d.ts","sourceRoot":"","sources":["../../src/utils/date-format.ts"],"names":[],"mappings":"AAAA,wBAAgB,SAAS,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAK5C"}

package/dist/utils/date-format.js

@@ -0,0 +1,7 @@
+export function formatYmd(date) {
+    const y = date.getFullYear();
+    const m = String(date.getMonth() + 1).padStart(2, '0');
+    const day = String(date.getDate()).padStart(2, '0');
+    return `${y}-${m}-${day}`;
+}
+//# sourceMappingURL=date-format.js.map

package/dist/utils/date-format.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"date-format.js","sourceRoot":"","sources":["../../src/utils/date-format.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,SAAS,CAAC,IAAU;IAClC,MAAM,CAAC,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IAC7B,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IACvD,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IACpD,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;AAC5B,CAAC"}

package/dist/utils/devinpublic-filename.d.ts

@@ -0,0 +1,3 @@
+export declare function nextSequenceFromFilenames(filenames: string[], ymd: string): number;
+export declare function buildNoteFilename(ymd: string, seq: number): string;
+//# sourceMappingURL=devinpublic-filename.d.ts.map

package/dist/utils/devinpublic-filename.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"devinpublic-filename.d.ts","sourceRoot":"","sources":["../../src/utils/devinpublic-filename.ts"],"names":[],"mappings":"AAAA,wBAAgB,yBAAyB,CACvC,SAAS,EAAE,MAAM,EAAE,EACnB,GAAG,EAAE,MAAM,GACV,MAAM,CAcR;AAED,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAGlE"}

package/dist/utils/devinpublic-filename.js

@@ -0,0 +1,19 @@
+export function nextSequenceFromFilenames(filenames, ymd) {
+    const suffix = '-init.md';
+    const re = new RegExp(`^${ymd.replace(/-/g, '\\-')}--(\\d+)${suffix.replace(/\./g, '\\.')}$`);
+    let max = 0;
+    for (const name of filenames) {
+        const m = name.match(re);
+        if (m) {
+            const n = parseInt(m[1], 10);
+            if (n > max)
+                max = n;
+        }
+    }
+    return max + 1;
+}
+export function buildNoteFilename(ymd, seq) {
+    const seqStr = String(seq).padStart(3, '0');
+    return `${ymd}--${seqStr}-init.md`;
+}
+//# sourceMappingURL=devinpublic-filename.js.map

package/dist/utils/devinpublic-filename.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"devinpublic-filename.js","sourceRoot":"","sources":["../../src/utils/devinpublic-filename.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,yBAAyB,CACvC,SAAmB,EACnB,GAAW;IAEX,MAAM,MAAM,GAAG,UAAU,CAAC;IAC1B,MAAM,EAAE,GAAG,IAAI,MAAM,CACnB,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,WAAW,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CACvE,CAAC;IACF,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;QAC7B,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACzB,IAAI,CAAC,EAAE,CAAC;YACN,MAAM,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YAC7B,IAAI,CAAC,GAAG,GAAG;gBAAE,GAAG,GAAG,CAAC,CAAC;QACvB,CAAC;IACH,CAAC;IACD,OAAO,GAAG,GAAG,CAAC,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,GAAW,EAAE,GAAW;IACxD,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAC5C,OAAO,GAAG,GAAG,KAAK,MAAM,UAAU,CAAC;AACrC,CAAC"}

package/dist/utils/note-markdown.d.ts

@@ -0,0 +1,2 @@
+export declare function buildMarkdown(answer: string): string;
+//# sourceMappingURL=note-markdown.d.ts.map

package/dist/utils/note-markdown.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"note-markdown.d.ts","sourceRoot":"","sources":["../../src/utils/note-markdown.ts"],"names":[],"mappings":"AAAA,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAGpD"}

package/dist/utils/note-markdown.js

@@ -0,0 +1,5 @@
+export function buildMarkdown(answer) {
+    const body = answer.trim() === '' ? '_(empty)_' : answer.trim();
+    return ['# Note', '', body, ''].join('\n');
+}
+//# sourceMappingURL=note-markdown.js.map

package/dist/utils/note-markdown.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"note-markdown.js","sourceRoot":"","sources":["../../src/utils/note-markdown.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,aAAa,CAAC,MAAc;IAC1C,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IAChE,OAAO,CAAC,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC7C,CAAC"}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@devinpublic/cli",
+  "version": "0.1.0",
+  "description": "CLI to create notes in .devinpublic",
+  "type": "module",
+  "main": "./dist/cli.js",
+  "types": "./dist/cli.d.ts",
+  "bin": {
+    "dip": "./dist/cli.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc && tsc-alias -p tsconfig.json",
+    "dip": "node dist/cli.js",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit -p tsconfig.vitest.json",
+    "prepublishOnly": "npm run build && npm run test"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "keywords": [
+    "cli",
+    "devinpublic"
+  ],
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^25.5.0",
+    "tsc-alias": "^1.8.16",
+    "typescript": "^6.0.2",
+    "vitest": "^4.1.2"
+  },
+  "dependencies": {
+    "commander": "^14.0.3"
+  }
+}