epiq 0.0.4 → 0.1.0

package/package.json

@@ -1,34 +1,48 @@
 {
 	"name": "epiq",
-	"version": "0.0.4",
+	"version": "0.1.0",
 	"license": "MIT",
-	"bin": "dist/cli.js",
 	"type": "module",
 	"description": "EPIQ - CLI based issue tracker",
+	"bin": {
+		"epiq": "dist/cli.js"
+	},
 	"engines": {
 		"node": ">=16"
 	},
 	"scripts": {
-		"build": "tsc",
-		"dev": "tsc --watch",
-		"test": "prettier --check . && xo && ava",
-		"start": "node dist/cli.js"
+		"clean": "node -e \"import('node:fs').then(fs => fs.rmSync('dist', { recursive: true, force: true }))\"",
+		"build": "tsc --noEmit",
+		"build:publish": "pnpm clean && esbuild source/cli.tsx --bundle --platform=node --format=esm --target=node16 --minify --outfile=dist/cli.js --banner:js='#!/usr/bin/env node' --external:react-devtools-core",
+		"dev": "tsc --watch --noEmit",
+		"dev:start": "IS_LOCAL=true tsx source/cli.tsx",
+		"start": "node dist/cli.js",
+		"start:debug": "IS_LOCAL=true node dist/cli.js",
+		"test": "prettier --check \"**/*.{ts,tsx}\" && vitest run",
+		"prepack": "pnpm build:publish",
+		"pack:check": "npm pack && tar -tf epiq-*.tgz",
+		"publish:dry": "npm publish --dry-run",
+		"release": "pnpm test && pnpm pack:check && npm publish"
 	},
 	"files": [
 		"dist"
 	],
 	"dependencies": {
-		"ink": "^4.1.0",
-		"meow": "^11.0.0",
-		"react": "^18.2.0"
+		"ink": "^6.8.0",
+		"json-stringify-pretty-compact": "^4.0.0",
+		"marked": "^17.0.3",
+		"marked-terminal": "^7.3.0",
+		"meow": "^14.1.0",
+		"react": "^19.2.4",
+		"ulid": "^3.0.2"
 	},
 	"devDependencies": {
 		"@sindresorhus/tsconfig": "^3.0.1",
+		"@types/marked-terminal": "^6.1.1",
 		"@types/react": "^18.0.32",
 		"@vdemedes/prettier-config": "^2.0.1",
-		"ava": "^5.2.0",
 		"chalk": "^5.2.0",
-		"eslint-config-xo-react": "^0.27.0",
+		"esbuild": "^0.25.0",
 		"eslint-plugin-react": "^7.32.2",
 		"eslint-plugin-react-hooks": "^4.6.0",
 		"ink-testing-library": "^3.0.0",
@@ -36,6 +50,7 @@
 		"ts-node": "^10.9.1",
 		"tsx": "^4.20.3",
 		"typescript": "^5.0.3",
+		"vitest": "^4.1.0",
 		"xo": "^0.53.1"
 	},
 	"ava": {

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.

package/dist/app.d.ts

@@ -1,5 +0,0 @@
-import React from 'react';
-import { Board } from './board/model/board.model.js';
-export default function App({ board }: {
-    board: Board;
-}): React.JSX.Element;

package/dist/app.js

@@ -1,18 +0,0 @@
-import { Box } from 'ink';
-import React from 'react';
-import { BoardUI } from './board/components/Board.js';
-import { ContextBar } from './board/components/ContextBar.js';
-import { HelpUI } from './board/components/Help.js';
-import { Mode } from './navigation/model/action-map.model.js';
-import { appState } from './navigation/state/state.js';
-export default function App({ board }) {
-    const width = process.stdout.columns || 120;
-    const swimlaneMaxWidth = Math.floor(process.stdout.columns / 3);
-    const swimlaneDynamicWidth = Math.floor(width / board.children.length);
-    const renderedWidth = swimlaneDynamicWidth * board.children.length;
-    const swimlaneWidth = Math.min(renderedWidth, swimlaneMaxWidth);
-    return (React.createElement(Box, { flexDirection: "column" },
-        !(appState.mode === Mode.HELP) && (React.createElement(BoardUI, { board: board, swimlaneWidth: swimlaneWidth })),
-        appState.mode === Mode.HELP && React.createElement(HelpUI, { width: renderedWidth }),
-        React.createElement(ContextBar, { width: width })));
-}

package/dist/board/components/Board.d.ts

@@ -1,6 +0,0 @@
-import React from 'react';
-import { Board } from '../model/board.model.js';
-export declare const BoardUI: React.FC<{
-    board: Board;
-    swimlaneWidth: number;
-}>;

package/dist/board/components/Board.js

@@ -1,11 +0,0 @@
-import { Box, Text } from 'ink';
-import React from 'react';
-import { appState } from '../../navigation/state/state.js';
-import { BoardContentUI } from './Swimlanes.js';
-export const BoardUI = ({ board, swimlaneWidth, }) => {
-    return (React.createElement(Box, { flexDirection: "column" },
-        React.createElement(Box, { paddingLeft: 1 },
-            React.createElement(Text, null, appState.breadCrumb.map(b => '  >  ' + b.name))),
-        React.createElement(Box, { flexDirection: "row" },
-            React.createElement(BoardContentUI, { items: board.children, width: swimlaneWidth }))));
-};

package/dist/board/components/CommandLine.d.ts

@@ -1,2 +0,0 @@
-import React from 'react';
-export declare const CommandLine: React.FC;

package/dist/board/components/CommandLine.js

@@ -1,26 +0,0 @@
-import React, { useEffect, useState } from 'react';
-import { Box, Text } from 'ink';
-import { getCommandLineInput, subscribeCommandLineState, } from '../../navigation/state/command-line.state.js';
-const roleColors = {
-    command: 'cyan',
-    argument: 'white',
-};
-export const CommandLine = () => {
-    const [input, setInput] = useState(getCommandLineInput());
-    useEffect(() => {
-        const unsubscribe = subscribeCommandLineState(() => {
-            setInput(getCommandLineInput());
-        });
-        return () => {
-            unsubscribe();
-        };
-    }, []);
-    const [command, ...rest] = input.split(' ');
-    const argument = rest.join(' ');
-    return (React.createElement(Box, null,
-        React.createElement(Text, { color: "gray" }, ":"),
-        command && React.createElement(Text, { color: roleColors.command }, command),
-        argument && (React.createElement(Text, null,
-            ' ',
-            React.createElement(Text, { color: roleColors.argument }, "'" + argument + "'")))));
-};

package/dist/board/components/ContextBar.d.ts

@@ -1,4 +0,0 @@
-import React from 'react';
-export declare const ContextBar: React.FC<{
-    width: number;
-}>;

package/dist/board/components/ContextBar.js

@@ -1,17 +0,0 @@
-import { Box, Text } from 'ink';
-import React from 'react';
-import { Mode } from '../../navigation/model/action-map.model.js';
-import { appState } from '../../navigation/state/state.js';
-import { CommandLine } from './CommandLine.js';
-export const ContextBar = ({ width }) => (React.createElement(Box, { flexDirection: "column", paddingLeft: 1, paddingRight: 1, borderColor: "gray", borderStyle: "round", width: width },
-    React.createElement(Box, null, appState.mode === Mode.COMMAND_LINE ? (React.createElement(CommandLine, null)) : (React.createElement(Box, { flexDirection: "row", gap: 2 },
-        React.createElement(Text, null, "\uD83D\uDCA1"),
-        appState.availableHints.map((x, index) => {
-            const [command, ...rest] = x.split(' ');
-            const argument = rest.join(' ');
-            return (React.createElement(Box, { key: index },
-                React.createElement(Text, { color: "cyan" }, command),
-                argument && (React.createElement(React.Fragment, null,
-                    React.createElement(Text, null, " "),
-                    React.createElement(Text, { color: "gray" }, argument)))));
-        }))))));

package/dist/board/components/Help.d.ts

@@ -1,4 +0,0 @@
-import React from 'react';
-export declare const HelpUI: React.FC<{
-    width: number;
-}>;

package/dist/board/components/Help.js

@@ -1,28 +0,0 @@
-import { Box, Text } from 'ink';
-import { appState } from '../../navigation/state/state.js';
-import React from 'react';
-import { Mode } from '../../navigation/model/action-map.model.js';
-export const HelpUI = ({ width }) => (React.createElement(Box, { flexDirection: "column", marginTop: 3, borderColor: "gray", borderStyle: "round", width: width, minHeight: 19 },
-    React.createElement(Box, { flexDirection: "column", width: width }, appState.mode === Mode.HELP
-        ? [
-            {
-                action: '',
-                description: '[COMMAND] DESCRIPTION',
-                mode: appState.mode,
-            },
-            ...appState.availableActions,
-        ]
-            .filter(action => Boolean(action.description))
-            // .filter(x => x.mode === navigationState.mode)
-            .map((action, index) => {
-            const [leftRaw, rightRaw] = action.description.split(']');
-            const left = leftRaw?.replace('[', '');
-            const right = rightRaw?.trim(); // no extra space
-            return (React.createElement(Box, { paddingLeft: 1, key: index, flexDirection: "row" },
-                React.createElement(Box, { key: index, flexDirection: "row", paddingBottom: index ? 0 : 1 },
-                    React.createElement(Box, { flexGrow: 1, width: 30 },
-                        React.createElement(Text, { color: index ? 'white' : 'gray' }, right)),
-                    React.createElement(Box, { width: 20 },
-                        React.createElement(Text, { color: index ? 'yellow' : 'gray' }, left)))));
-        })
-        : null)));

package/dist/board/components/Logo.d.ts

@@ -1,2 +0,0 @@
-import React from 'react';
-export default function Logo(): React.JSX.Element;

package/dist/board/components/Logo.js

@@ -1,21 +0,0 @@
-import { Box, Text } from 'ink';
-import { highlight } from '../render/color.js';
-import React from 'react';
-function replaceRange(str, start, end, replacement) {
-    return str.slice(0, start) + replacement + str.slice(end);
-}
-const logoLines = [
-    ` ______ _____   _____   _____`,
-    `|  ____|  __ \\ |_   _| / ____|`,
-    `| |__  |  |__)\\  | |  | |     `,
-    `|  __| |   ___/  | |  | |     `,
-    `| |____|  |     _| |_ | |____ `,
-    `|______|__|    |_____| \\____ |`,
-    `                           (_|`,
-];
-const coloredLogo = logoLines
-    .map(line => replaceRange(line, 0, 7, highlight(line.slice(0, 7), 'cyan')))
-    .map(line => replaceRange(line, 31, 39, highlight(line.slice(31, 39), 'yellow')));
-export default function Logo() {
-    return (React.createElement(Box, { flexDirection: "column", marginBottom: 1 }, coloredLogo.map((line, idx) => (React.createElement(Text, { key: idx }, line)))));
-}

package/dist/board/components/ScrollBox.d.ts

@@ -1,9 +0,0 @@
-import React from 'react';
-type Props = {
-    width: number;
-    children?: React.ReactNode[];
-    size: number;
-    selectedIndex: number;
-};
-export declare const ScrollBoxUI: React.FC<Props>;
-export {};

package/dist/board/components/ScrollBox.js

@@ -1,22 +0,0 @@
-import { Box, Text } from 'ink';
-import React from 'react';
-export const ScrollBoxUI = ({ children = [], size, selectedIndex, }) => {
-    if (children.length === 0) {
-        return null;
-    }
-    const scrollIndex = Math.floor(Math.max(selectedIndex, 0) / size);
-    const start = scrollIndex * size;
-    const end = start + size;
-    // Clamp values to avoid overflow
-    const visibleChildren = children.slice(start, end);
-    // Scrollbar calculations
-    const scrollBarHeight = size;
-    const scrollSteps = Math.floor(children.length / size) + 1;
-    const indexBarHeight = Math.ceil(scrollBarHeight / scrollSteps);
-    const barOffset = scrollIndex * indexBarHeight;
-    return (React.createElement(Box, { flexDirection: "row" },
-        children.length > size && (React.createElement(Box, { flexDirection: "column", width: 1, height: scrollBarHeight, marginRight: 1 }, Array.from({ length: scrollBarHeight }).map((_, i) => (React.createElement(Text, { key: i, color: i >= barOffset && i < barOffset + indexBarHeight
-                ? 'cyan'
-                : 'gray' }, "\u2502"))))),
-        React.createElement(Box, { flexDirection: "column" }, visibleChildren)));
-};

package/dist/board/components/Swimlane.d.ts

@@ -1,9 +0,0 @@
-import React from 'react';
-import { Swimlane } from '../model/board.model.js';
-type Props = {
-    item: Swimlane;
-    width: number;
-    isSelected: boolean;
-};
-export declare const SwimlaneUI: React.FC<Props>;
-export {};

package/dist/board/components/Swimlane.js

@@ -1,12 +0,0 @@
-import { Box, Text } from 'ink';
-import React from 'react';
-import { ScrollBoxUI } from './ScrollBox.js';
-import { TicketListItemUI } from './TicketListItem.js';
-export const SwimlaneUI = ({ item, isSelected, width }) => {
-    const color = isSelected ? 'cyan' : 'gray';
-    return (React.createElement(Box, { flexDirection: "column", width: width, borderStyle: "round", borderColor: 'gray', paddingRight: 1, paddingLeft: 1, minHeight: 15, height: 20 },
-        React.createElement(Box, { borderStyle: "round", borderColor: color, justifyContent: "center" },
-            React.createElement(Text, { bold: true }, item.name)),
-        React.createElement(Box, { padding: 1 },
-            React.createElement(ScrollBoxUI, { selectedIndex: item.children.findIndex(x => x.isSelected), width: width, size: 10, children: item.children.map((ticket, index) => (React.createElement(TicketListItemUI, { key: index, width: width, ticket: ticket }))) }))));
-};

package/dist/board/components/Swimlanes.d.ts

@@ -1,8 +0,0 @@
-import React from 'react';
-import { Swimlane } from '../model/board.model.js';
-type Props = {
-    items: Swimlane[];
-    width: number;
-};
-export declare const BoardContentUI: React.FC<Props>;
-export {};

package/dist/board/components/Swimlanes.js

@@ -1,17 +0,0 @@
-import React from 'react';
-import { Box } from 'ink';
-import { appState } from '../../navigation/state/state.js';
-import { BoardItemTypes } from '../model/board.model.js';
-import { SwimlaneUI } from './Swimlane.js';
-import { TicketUI } from './TicketUI.js';
-export const BoardContentUI = ({ items, width }) => {
-    const actionContext = appState.currentNode.actionContext;
-    const isTicketContext = actionContext === BoardItemTypes.TICKET_LIST_ITEM;
-    const isSwimlaneContext = actionContext === BoardItemTypes.BOARD ||
-        actionContext === BoardItemTypes.SWIMLANE;
-    return (React.createElement(Box, { flexDirection: "row" },
-        isSwimlaneContext &&
-            items.map((lane, index) => (React.createElement(SwimlaneUI, { key: index, width: width, isSelected: appState.currentNode.actionContext === 'BOARD' &&
-                    appState.selectedIndex === index, item: lane }))),
-        isTicketContext && appState.currentNode && (React.createElement(TicketUI, { width: width * items.length, item: appState.breadCrumb[appState.breadCrumb.length - 1] }))));
-};

package/dist/board/components/TextInput.d.ts

@@ -1,6 +0,0 @@
-import React from 'react';
-export declare const TextInput: React.FC<{
-    value: string;
-    onChange: (value: string) => void;
-    onSubmit: (value: string) => void;
-}>;

package/dist/board/components/TextInput.js

@@ -1,9 +0,0 @@
-import { Text } from 'ink';
-import React from 'react';
-// const onChange = (_value: string) => {
-// 	// No-op for now
-// };
-// const onSubmit = (_value: string) => {
-// 	// No-op for now
-// };
-export const TextInput = ({ value }) => React.createElement(Text, null, value);

package/dist/board/components/TicketListItem.d.ts

@@ -1,6 +0,0 @@
-import React from 'react';
-import { TicketListItem } from '../model/board.model.js';
-export declare const TicketListItemUI: React.FC<{
-    width: number;
-    ticket: TicketListItem;
-}>;

package/dist/board/components/TicketListItem.js

@@ -1,13 +0,0 @@
-import { Box, Text } from 'ink';
-import React from 'react';
-import { Mode } from '../../navigation/model/action-map.model.js';
-import { appState } from '../../navigation/state/state.js';
-const truncateWithEllipsis = (str, width) => str.length >= width ? str.slice(0, width - 3) + '...' : str;
-export const TicketListItemUI = ({ width, ticket }) => (React.createElement(Box, { borderBottom: true },
-    React.createElement(Text, { color: ticket.isSelected && appState.mode === Mode.MOVE
-            ? 'cyan'
-            : ticket.isSelected
-                ? 'cyan'
-                : appState.mode === Mode.MOVE
-                    ? 'gray'
-                    : 'white' }, truncateWithEllipsis(ticket.name, width - 6))));

package/dist/board/components/TicketUI.d.ts

@@ -1,8 +0,0 @@
-import React from 'react';
-import { Ticket } from '../model/board.model.js';
-type Props = {
-    item: Ticket;
-    width: number;
-};
-export declare const TicketUI: React.FC<Props>;
-export {};

package/dist/board/components/TicketUI.js

@@ -1,8 +0,0 @@
-import { Box, Text } from 'ink';
-import React from 'react';
-export const TicketUI = ({ item, width }) => (React.createElement(Box, { flexDirection: "column", padding: 1, paddingLeft: 2, borderStyle: "round", width: width, minHeight: 20, borderColor: "gray" }, item.children.map(child => (React.createElement(Box, { key: child.id, flexDirection: "row", borderStyle: 'round', borderColor: child.isSelected ? 'cyan' : 'gray', paddingLeft: 1 },
-    React.createElement(Box, { width: 30 },
-        React.createElement(Text, { color: "cyan" },
-            child.name,
-            ":")),
-    React.createElement(Text, null, child.description))))));

package/dist/board/hints/hints.d.ts

@@ -1,7 +0,0 @@
-export declare const Hints: {
-    readonly [x: string]: readonly [] | readonly [":h Help", "hjkl: navigate", "enter: confirm"] | readonly ["q: exit"] | readonly ["i: edit", "y: yank/move"] | readonly ["q: exit", "i: edit"] | readonly ["hjkl: move selection", "e/enter: confirm move/yank", "q: exit"] | readonly ["hjkl: move selection", "e/enter: confirm move/yank", "y: confirm move/yank", "q: exit"];
-    readonly BOARD: readonly [];
-    readonly SWIMLANE: readonly [":h Help", "hjkl: navigate", "enter: confirm"];
-    readonly TICKET_LIST_ITEM: readonly ["i: edit", "y: yank/move"];
-    readonly TICKET: readonly ["q: exit", "i: edit"];
-};

package/dist/board/hints/hints.js

@@ -1,21 +0,0 @@
-import { Mode } from '../../navigation/model/action-map.model.js';
-import { BoardItemTypes } from '../model/board.model.js';
-export const Hints = {
-    [BoardItemTypes.BOARD]: [],
-    [BoardItemTypes.SWIMLANE]: [':h Help', 'hjkl: navigate', 'enter: confirm'],
-    [BoardItemTypes.TICKET_LIST_ITEM + Mode.HELP]: ['q: exit'],
-    [BoardItemTypes.SWIMLANE + Mode.HELP]: ['q: exit'],
-    [BoardItemTypes.TICKET_LIST_ITEM]: ['i: edit', 'y: yank/move'],
-    [BoardItemTypes.TICKET]: ['q: exit', 'i: edit'],
-    [BoardItemTypes.SWIMLANE + Mode.MOVE]: [
-        'hjkl: move selection',
-        'e/enter: confirm move/yank',
-        'q: exit',
-    ],
-    [BoardItemTypes.TICKET_LIST_ITEM + Mode.MOVE]: [
-        'hjkl: move selection',
-        'e/enter: confirm move/yank',
-        'y: confirm move/yank',
-        'q: exit',
-    ],
-};

package/dist/board/mock/board.d.ts

@@ -1,2 +0,0 @@
-import { Board } from '../model/board.model.js';
-export declare const board: Board;