epiq 0.0.3 → 0.0.5

package/dist/navigation/state/command-line.state.js

@@ -1,11 +1,23 @@
+export const commandDelimiter = ' ';
 export let commandLineState = {
     commandHistory: [],
     value: '',
     commandHistoryIndex: -1,
 };
+const listeners = new Set();
+const notify = () => {
+    for (const l of listeners)
+        l();
+};
+export const subscribeCommandLineState = (listener) => {
+    listeners.add(listener);
+    return () => listeners.delete(listener);
+};
+// ===== Updates =====
 export const updateCommandLineState = (cb) => {
-    bug(commandLineState);
-    commandLineState = cb(structuredClone(commandLineState));
+    const next = cb(structuredClone(commandLineState));
+    commandLineState = next;
+    notify();
 };
 export const updateCommandLineInput = (cb) => {
     updateCommandLineState(state => ({
@@ -31,13 +43,18 @@ export const getPrevCommand = () => {
 };
 export const getNextCommand = () => {
     updateCommandLineState(s => {
-        const nextIndex = Math.min(s.commandHistoryIndex - 1, s.commandHistory.length - 1);
+        // typically you want to clamp down to -1 (meaning "no selection")
+        const nextIndex = Math.max(s.commandHistoryIndex - 1, -1);
         return {
             ...s,
             commandHistoryIndex: nextIndex,
-            value: s.commandHistory[nextIndex] ?? '',
+            value: nextIndex === -1 ? '' : s.commandHistory[nextIndex] ?? '',
         };
     });
 };
 export const clearCommandLine = () => updateCommandLineInput(() => '');
 export const getCommandLineInput = () => commandLineState.value;
+export const getCommandLineArgumentValue = () => {
+    const [_, ...rest] = commandLineState.value.split(commandDelimiter);
+    return rest.join(commandDelimiter);
+};

package/dist/navigation/state/state.d.ts

@@ -1,12 +1,20 @@
+import { Board } from '../../board/model/board.model.js';
 import { ActionEntry, ModeUnion } from '../model/action-map.model.js';
 import { NavigationTree } from '../model/navigation-tree.model.js';
-export declare let navigationState: {
-    mode: ModeUnion;
-    availableActions: ActionEntry[];
-    availableHints: readonly string[];
-    currentNode: NavigationTree<NavigationTree> | null;
-    breadCrumb: NavigationTree<NavigationTree>[];
+export type AppState = {
+    readonly selectedIndex: number;
+    readonly mode: ModeUnion;
+    readonly availableActions: ActionEntry[];
+    readonly availableHints: readonly string[];
+    readonly currentNode: NavigationTree<NavigationTree>;
+    readonly breadCrumb: NavigationTree<NavigationTree>[];
+    readonly rootNode: Board;
 };
-export declare const updateState: (cb: (oldState: typeof navigationState) => typeof navigationState) => void;
-export declare const patchState: (patch: Partial<typeof navigationState>) => void;
-export declare const flashHint: (hints: string[]) => Promise<void>;
+export declare let appState: AppState;
+export declare const initAppState: (board: Board) => void;
+export declare const updateState: (cb: (oldState: typeof appState) => typeof appState, opts?: {
+    render?: boolean;
+}) => void;
+export declare const patchState: (patch: Partial<typeof appState>, opts?: {
+    render?: boolean;
+}) => void;

package/dist/navigation/state/state.js

@@ -1,39 +1,38 @@
 import { Hints } from '../../board/hints/hints.js';
-import { triggerRender } from '../../cli.js';
-export let navigationState = {
-    mode: 'default',
-    availableActions: [],
-    availableHints: [],
-    currentNode: null,
-    breadCrumb: [],
+import { renderBoard } from '../../cli.js';
+import { ContextualActionMap } from '../actions/board-action-map.js';
+import { DefaultActions } from '../actions/default/default-actions.js';
+import { inputActions } from '../actions/input/input-actions.js';
+export let appState;
+const derived = (state) => {
+    const { currentNode, mode } = state;
+    const availableHints = Hints[currentNode.actionContext + mode] ?? Hints[currentNode.actionContext];
+    const actionContext = currentNode?.actionContext;
+    const availableActions = [
+        ...DefaultActions,
+        ...ContextualActionMap[actionContext],
+        ...inputActions,
+    ];
+    return {
+        ...state,
+        availableHints,
+        availableActions,
+    };
 };
-export const updateState = (cb) => {
-    navigationState = cb(navigationState);
-};
-export const patchState = (patch) => updateState(oldState => ({
-    ...oldState,
-    ...patch,
-}));
-// Utilities for updating specific parts of the state
-export const flashHint = async (hints) => {
-    await new Promise(resolve => {
-        setTimeout(() => {
-            updateState(state => {
-                const { currentNode, mode } = state;
-                const contextualHints = (currentNode &&
-                    Hints[currentNode.actionContext + mode]) ??
-                    (currentNode && Hints[currentNode.actionContext]) ?? [''];
-                return {
-                    ...state,
-                    availableHints: contextualHints,
-                };
-            });
-            triggerRender();
-            resolve();
-        }, 3000);
-        patchState({
-            availableHints: hints,
-        });
-        triggerRender();
+export const initAppState = (board) => {
+    appState = derived({
+        ...appState,
+        rootNode: board,
+        breadCrumb: [board],
+        selectedIndex: 0,
+        mode: 'default',
+        currentNode: board,
     });
+    renderBoard();
+};
+export const updateState = (cb, opts = { render: true }) => {
+    appState = derived(cb(appState));
+    if (opts.render)
+        renderBoard();
 };
+export const patchState = (patch, opts = { render: true }) => updateState(old => ({ ...old, ...patch }), opts);

package/dist/navigation/utils/get-command-line-intent.d.ts

@@ -1,3 +1,3 @@
-import { KeyIntent } from './key-intent.js';
+import { Intent } from './key-intent.js';
 import readline from 'readline';
-export declare const getCommandLineIntent: (key: readline.Key) => KeyIntent.Confirm | KeyIntent.ToggleCommandLine | KeyIntent.CaptureInput | KeyIntent.EraseInput | KeyIntent.GetLastCommandFromHistory | KeyIntent.GetNextCommandFromHistory;
+export declare const getCommandLineIntent: (key: readline.Key) => Intent.Confirm | Intent.ToggleCommandLine | Intent.CaptureInput | Intent.EraseInput | Intent.GetLastCommandFromHistory | Intent.GetNextCommandFromHistory;

package/dist/navigation/utils/get-command-line-intent.js

@@ -1,17 +1,17 @@
-import { KeyIntent } from './key-intent.js';
+import { Intent } from './key-intent.js';
 export const getCommandLineIntent = (key) => {
     switch (key.name) {
         case 'up':
-            return KeyIntent.GetLastCommandFromHistory;
+            return Intent.GetLastCommandFromHistory;
         case 'down':
-            return KeyIntent.GetNextCommandFromHistory;
+            return Intent.GetNextCommandFromHistory;
         case 'return':
-            return KeyIntent.Confirm;
+            return Intent.Confirm;
         case 'backspace':
-            return KeyIntent.EraseInput;
+            return Intent.EraseInput;
         case 'escape':
-            return KeyIntent.ToggleCommandLine;
+            return Intent.ToggleCommandLine;
         default:
-            return KeyIntent.CaptureInput;
+            return Intent.CaptureInput;
     }
 };

package/dist/navigation/utils/key-intent.d.ts

@@ -1,7 +1,6 @@
 import readline from 'readline';
 import { ModeUnion } from '../model/action-map.model.js';
-import { NavigateCtx } from '../model/navigation-ctx.model.js';
-export declare enum KeyIntent {
+export declare enum Intent {
     NavPreviousItem = "navPreviousItem",
     NavNextItem = "navNextItem",
     NavToPreviousContainer = "navToPreviousContainer",
@@ -13,8 +12,9 @@ export declare enum KeyIntent {
     Confirm = "confirm",
     Edit = "edit",
     Exit = "exit",
-    ToggleHelp = "toggleHelp",
-    ToggleMove = "toggleMove",
+    ViewHelp = "viewHelp",
+    HideHelp = "hideHelp",
+    InitMove = "initMove",
     ToggleCommandLine = "toggleCommandLine",
     CaptureInput = "captureInput",
     EraseInput = "eraseInput",
@@ -22,4 +22,4 @@ export declare enum KeyIntent {
     GetLastCommandFromHistory = "getLastCommandFromHistory",
     GetNextCommandFromHistory = "getNextCommandFromHistory"
 }
-export declare function getKeyIntent(key: readline.Key, ctx: NavigateCtx, mode: ModeUnion): KeyIntent | null;
+export declare function getKeyIntent(key: readline.Key, mode: ModeUnion): Intent | null;

package/dist/navigation/utils/key-intent.js

@@ -1,27 +1,30 @@
 import { Mode } from '../model/action-map.model.js';
+import { appState } from '../state/state.js';
 import { getCommandLineIntent } from './get-command-line-intent.js';
-export var KeyIntent;
-(function (KeyIntent) {
-    KeyIntent["NavPreviousItem"] = "navPreviousItem";
-    KeyIntent["NavNextItem"] = "navNextItem";
-    KeyIntent["NavToPreviousContainer"] = "navToPreviousContainer";
-    KeyIntent["NavToNextContainer"] = "navToNextContainer";
-    KeyIntent["MovePreviousItem"] = "movePreviousItem";
-    KeyIntent["MoveNextItem"] = "moveNextItem";
-    KeyIntent["MoveToPreviousContainer"] = "moveToPreviousContainer";
-    KeyIntent["MoveToNextContainer"] = "moveToNextContainer";
-    KeyIntent["Confirm"] = "confirm";
-    KeyIntent["Edit"] = "edit";
-    KeyIntent["Exit"] = "exit";
-    KeyIntent["ToggleHelp"] = "toggleHelp";
-    KeyIntent["ToggleMove"] = "toggleMove";
-    KeyIntent["ToggleCommandLine"] = "toggleCommandLine";
-    KeyIntent["CaptureInput"] = "captureInput";
-    KeyIntent["EraseInput"] = "eraseInput";
-    KeyIntent["AddItem"] = "addItem";
-    KeyIntent["GetLastCommandFromHistory"] = "getLastCommandFromHistory";
-    KeyIntent["GetNextCommandFromHistory"] = "getNextCommandFromHistory";
-})(KeyIntent || (KeyIntent = {}));
+export var Intent;
+(function (Intent) {
+    Intent["NavPreviousItem"] = "navPreviousItem";
+    Intent["NavNextItem"] = "navNextItem";
+    Intent["NavToPreviousContainer"] = "navToPreviousContainer";
+    Intent["NavToNextContainer"] = "navToNextContainer";
+    Intent["MovePreviousItem"] = "movePreviousItem";
+    Intent["MoveNextItem"] = "moveNextItem";
+    Intent["MoveToPreviousContainer"] = "moveToPreviousContainer";
+    Intent["MoveToNextContainer"] = "moveToNextContainer";
+    Intent["Confirm"] = "confirm";
+    Intent["Edit"] = "edit";
+    Intent["Exit"] = "exit";
+    Intent["ViewHelp"] = "viewHelp";
+    Intent["HideHelp"] = "hideHelp";
+    Intent["InitMove"] = "initMove";
+    // Command line
+    Intent["ToggleCommandLine"] = "toggleCommandLine";
+    Intent["CaptureInput"] = "captureInput";
+    Intent["EraseInput"] = "eraseInput";
+    Intent["AddItem"] = "addItem";
+    Intent["GetLastCommandFromHistory"] = "getLastCommandFromHistory";
+    Intent["GetNextCommandFromHistory"] = "getNextCommandFromHistory";
+})(Intent || (Intent = {}));
 function getDir(key) {
     switch (key.name) {
         // arrows
@@ -43,12 +46,21 @@ function getDir(key) {
             return null;
     }
 }
-function mapDirectionalIntent(dir, axis, enableAcrossContainers, intents) {
+function mapDirectionalIntent(axis, dir, intents) {
+    const enableAcrossContainers = appState.currentNode.enableChildNavigationAcrossContainers;
     switch (dir) {
         case 'up':
-            return axis === 'vertical' ? intents.prevItem : null;
+            return axis === 'vertical'
+                ? intents.prevItem
+                : enableAcrossContainers
+                    ? intents.prevContainer
+                    : null;
         case 'down':
-            return axis === 'vertical' ? intents.nextItem : null;
+            return axis === 'vertical'
+                ? intents.nextItem
+                : enableAcrossContainers
+                    ? intents.nextContainer
+                    : null;
         case 'left':
             return axis === 'horizontal'
                 ? intents.prevItem
@@ -63,62 +75,44 @@ function mapDirectionalIntent(dir, axis, enableAcrossContainers, intents) {
                     : null;
     }
 }
-export function getKeyIntent(key, ctx, mode) {
-    if (key.sequence === ':') {
-        return KeyIntent.ToggleCommandLine;
-    }
-    if (mode === Mode.COMMAND_LINE) {
+export function getKeyIntent(key, mode) {
+    if (key.sequence === ':')
+        return Intent.ToggleCommandLine;
+    if (mode === Mode.COMMAND_LINE)
         return getCommandLineIntent(key);
-    }
-    const axis = ctx.navigationNode.childrenRenderAxis;
-    const enableAcrossContainers = ctx.navigationNode.enableChildNavigationAcrossContainers;
-    if (key.name === 'escape' && mode === Mode.HELP) {
-        return KeyIntent.ToggleHelp;
-    }
-    // Hard exits
-    if (key.ctrl && key.name === 'c')
-        return KeyIntent.Exit;
-    if (key.name === 'escape')
-        return KeyIntent.Exit;
-    // Move mode
-    if (mode === Mode.MOVE) {
-        if (key.name === 'y')
-            return KeyIntent.ToggleMove;
-        const dir = getDir(key);
-        if (!dir)
-            return null;
-        return mapDirectionalIntent(dir, axis, Boolean(enableAcrossContainers), {
-            prevItem: KeyIntent.MovePreviousItem,
-            nextItem: KeyIntent.MoveNextItem,
-            prevContainer: KeyIntent.MoveToPreviousContainer,
-            nextContainer: KeyIntent.MoveToNextContainer,
-        });
-    }
-    // Normal mode
-    if (key.name === 'y')
-        return KeyIntent.ToggleMove;
-    // Edit (vim-ish)
-    if (key.name === 'i')
-        return KeyIntent.Edit;
-    // Navigation (arrows + vim hjkl)
+    // Navigation keys
     const dir = getDir(key);
     if (dir) {
-        return mapDirectionalIntent(dir, axis, Boolean(enableAcrossContainers), {
-            prevItem: KeyIntent.NavPreviousItem,
-            nextItem: KeyIntent.NavNextItem,
-            prevContainer: KeyIntent.NavToPreviousContainer,
-            nextContainer: KeyIntent.NavToNextContainer,
-        });
+        let dirMap = mode === Mode.MOVE
+            ? {
+                prevItem: Intent.MovePreviousItem,
+                nextItem: Intent.MoveNextItem,
+                prevContainer: Intent.MoveToPreviousContainer,
+                nextContainer: Intent.MoveToNextContainer,
+            }
+            : {
+                prevItem: Intent.NavPreviousItem,
+                nextItem: Intent.NavNextItem,
+                prevContainer: Intent.NavToPreviousContainer,
+                nextContainer: Intent.NavToNextContainer,
+            };
+        return mapDirectionalIntent(appState.currentNode.childrenRenderAxis, dir, dirMap);
     }
-    // Actions
+    // Hard exit
+    if (key.ctrl && key.name === 'c')
+        return Intent.Exit;
+    // Default actions
     switch (key.name) {
-        case 'a':
-            return KeyIntent.AddItem;
-        case 'return':
+        case 'i':
+            return Intent.Edit;
+        case 'y':
+            return Intent.InitMove;
         case 'e':
-            return KeyIntent.Confirm;
+        case 'return':
+            return Intent.Confirm;
         case 'q':
-            return KeyIntent.Exit;
+        case 'escape':
+            return Intent.Exit;
         default:
             return null;
     }

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "epiq",
-	"version": "0.0.3",
+	"version": "0.0.5",
 	"license": "MIT",
 	"bin": "dist/cli.js",
 	"type": "module",
-	"description": "CLI based issue tracking manager",
+	"description": "EPIQ - CLI based issue tracker",
 	"engines": {
 		"node": ">=16"
 	},

package/readme.md

@@ -1,37 +1,74 @@
 # epiq
 
-## Local dev
+> **The ultimate productivity tool** — a CLI-based issue tracking client powered by Git as its backend, living directly inside the repository you work in.
+> No external services. No context switching. Just tickets, versioned and colocated with your code.
 
-Start dev server in background terminal session:
+---
+
+## Why epiq?
+
+- **Simplicity** — Skip the additional tooling complexity
+- **Repo-native** — Lives inside your project directory
+- **Offline-ready** — Works wherever Git works
+- **Team-friendly** — Collaborate through normal Git workflows
+- **Shareable** — ASCII board exported to `.md`, viewable in the CLI, on GitHub/GitLab, or as your project README.
+- **CLI-first** — Fast, scriptable, and developer/agent-friendly
+
+---
+
+## 📦 Installation
+
+Install globally using npm:
 
 ```bash
-$ npm run dev
+npm install --global epiq
 ```
 
-Run app with:
+Verify installation:
 
 ```bash
-$ npm run execute
+epiq --version
 ```
 
-## Install (WIP!)
+---
+
+## 🚀 Getting Started
+
+### Initialize a project
+
+Create a new epiq workspace inside your current directory:
 
 ```bash
-$ npm install --global epiq
+epiq --init "Project Name"
 ```
 
-## CLI (WIP!)
+This sets up epiq in your repository and prepares it for issue tracking.
 
-```
-$ epiq --help
+---
 
-  Usage
-    $ epiq
+### Open the workspace
 
-  Options
-    --name  Your name
+Run epiq inside any initialized repository:
 
-  Examples
-    $ epiq --name=Jane
-    Hello, Jane
+```bash
+epiq
 ```
+
+This opens the interactive CLI workspace.
+
+---
+
+## 🛠 Philosophy
+
+epiq keeps issue tracking:
+
+- Close to your code
+- Versioned with your commits
+- Simple and transparent
+- Independent from external platforms
+
+If you use Git, you already have everything you need.
+
+---
+
+Built for developers who live in the terminal.