preguito 0.1.0

package/dist/index.cjs

@@ -0,0 +1,276 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+let node_fs_promises = require("node:fs/promises");
+let node_fs = require("node:fs");
+let node_path = require("node:path");
+let node_os = require("node:os");
+
+//#region src/utils/errors.ts
+var PrequitoError = class extends Error {
+	constructor(message) {
+		super(message);
+		this.name = "PrequitoError";
+	}
+};
+var TemplateMissingVariableError = class extends PrequitoError {
+	missingVariables;
+	constructor(missing) {
+		super(`Missing template variable(s): ${missing.join(", ")}. Provide shortcodes or check your config.`);
+		this.name = "TemplateMissingVariableError";
+		this.missingVariables = missing;
+	}
+};
+var TemplateMissingMessageError = class extends PrequitoError {
+	constructor(placeholderName) {
+		super(`Template requires a message (the <${placeholderName}> placeholder). Provide it as the last argument(s).`);
+		this.name = "TemplateMissingMessageError";
+	}
+};
+
+//#endregion
+//#region src/template/engine.ts
+const VARIABLE_PATTERN = /\{\{(\w+)\}\}/g;
+const MESSAGE_PLACEHOLDER_PATTERN = /<(\w+)>/;
+function parseTemplate(template) {
+	const variables = [];
+	let match;
+	const pattern = new RegExp(VARIABLE_PATTERN.source, "g");
+	while ((match = pattern.exec(template)) !== null) if (!variables.includes(match[1])) variables.push(match[1]);
+	const messageMatch = MESSAGE_PLACEHOLDER_PATTERN.exec(template);
+	return {
+		variables,
+		messagePlaceholder: messageMatch ? messageMatch[1] : null
+	};
+}
+function renderTemplate(template, context, message) {
+	const parsed = parseTemplate(template);
+	const missing = parsed.variables.filter((v) => !(v in context));
+	if (missing.length > 0) throw new TemplateMissingVariableError(missing);
+	let result = template.replace(/\{\{(\w+)\}\}/g, (_, varName) => {
+		return context[varName];
+	});
+	if (parsed.messagePlaceholder) {
+		if (!message) throw new TemplateMissingMessageError(parsed.messagePlaceholder);
+		result = result.replace(/<\w+>/, message);
+	}
+	return result;
+}
+function mergeContext(defaults, overrides) {
+	return {
+		...defaults,
+		...overrides
+	};
+}
+
+//#endregion
+//#region src/config/types.ts
+const PREDEFINED_TYPES = [
+	{
+		key: "f",
+		label: "feat"
+	},
+	{
+		key: "x",
+		label: "fix"
+	},
+	{
+		key: "c",
+		label: "chore"
+	},
+	{
+		key: "t",
+		label: "test"
+	},
+	{
+		key: "l",
+		label: "lint"
+	},
+	{
+		key: "r",
+		label: "refactor"
+	},
+	{
+		key: "o",
+		label: "docs"
+	},
+	{
+		key: "y",
+		label: "style"
+	},
+	{
+		key: "e",
+		label: "perf"
+	},
+	{
+		key: "b",
+		label: "build"
+	}
+];
+const PREDEFINED_ENVIRONMENTS = [
+	{
+		key: "p",
+		label: "prd"
+	},
+	{
+		key: "u",
+		label: "uat"
+	},
+	{
+		key: "h",
+		label: "homolog"
+	},
+	{
+		key: "d",
+		label: "dev"
+	},
+	{
+		key: "s",
+		label: "staging"
+	}
+];
+function generateTemplate(features, hasPrefix) {
+	const { cardId, type, environment } = features;
+	return [
+		cardId ? hasPrefix ? "[{{prefix}}-{{card_id}}]" : "[{{card_id}}]" : "",
+		type && environment ? "{{type}}({{environment}}):" : type ? "{{type}}:" : environment ? "({{environment}}):" : "",
+		"<message>"
+	].filter((p) => p !== "").join(" ");
+}
+const DEFAULT_CONFIG = {
+	template: "{{type}}: <message>",
+	features: {
+		cardId: false,
+		type: true,
+		environment: false
+	},
+	types: [
+		{
+			key: "f",
+			label: "feat"
+		},
+		{
+			key: "x",
+			label: "fix"
+		},
+		{
+			key: "c",
+			label: "chore"
+		},
+		{
+			key: "t",
+			label: "test"
+		},
+		{
+			key: "r",
+			label: "refactor"
+		},
+		{
+			key: "o",
+			label: "docs"
+		}
+	],
+	environments: [],
+	defaults: {}
+};
+const CONFIG_PATHS = [
+	".preguitorc",
+	".preguitorc.json",
+	".config/preguito/config.json"
+];
+
+//#endregion
+//#region src/config/loader.ts
+async function findConfigPath() {
+	const cwd = process.cwd();
+	const home = (0, node_os.homedir)();
+	for (const relPath of [".preguitorc", ".preguitorc.json"]) {
+		const fullPath = (0, node_path.join)(cwd, relPath);
+		if ((0, node_fs.existsSync)(fullPath)) return fullPath;
+	}
+	for (const relPath of CONFIG_PATHS) {
+		const fullPath = (0, node_path.join)(home, relPath);
+		if ((0, node_fs.existsSync)(fullPath)) return fullPath;
+	}
+	return null;
+}
+async function loadConfig() {
+	const configPath = await findConfigPath();
+	if (!configPath) return null;
+	const raw = await (0, node_fs_promises.readFile)(configPath, "utf-8");
+	return validateConfig(JSON.parse(raw));
+}
+async function loadConfigOrDefault() {
+	return await loadConfig() ?? DEFAULT_CONFIG;
+}
+function validateConfig(obj) {
+	if (typeof obj !== "object" || obj === null) throw new Error("Config must be a JSON object");
+	const config = obj;
+	if (typeof config.template !== "string" || config.template.trim() === "") throw new Error("Config must have a non-empty \"template\" string field");
+	const defaults = {};
+	if (config.defaults !== void 0) {
+		if (typeof config.defaults !== "object" || config.defaults === null) throw new Error("\"defaults\" must be an object");
+		for (const [key, value] of Object.entries(config.defaults)) {
+			if (typeof value !== "string") throw new Error(`Default value for "${key}" must be a string`);
+			defaults[key] = value;
+		}
+	}
+	let features;
+	if (config.features && typeof config.features === "object") {
+		const f = config.features;
+		features = {
+			cardId: Boolean(f.cardId),
+			type: Boolean(f.type),
+			environment: Boolean(f.environment)
+		};
+	} else features = inferFeaturesFromTemplate(config.template);
+	let types = [];
+	if (Array.isArray(config.types)) types = validateShortcodeArray(config.types, "types");
+	else if (features.type) types = [...PREDEFINED_TYPES];
+	let environments = [];
+	if (Array.isArray(config.environments)) environments = validateShortcodeArray(config.environments, "environments");
+	else if (features.environment) environments = [...PREDEFINED_ENVIRONMENTS];
+	return {
+		template: config.template,
+		features,
+		types,
+		environments,
+		defaults
+	};
+}
+function inferFeaturesFromTemplate(template) {
+	const parsed = parseTemplate(template);
+	return {
+		cardId: parsed.variables.includes("card_id"),
+		type: parsed.variables.includes("type"),
+		environment: parsed.variables.includes("environment")
+	};
+}
+function validateShortcodeArray(arr, fieldName) {
+	const result = [];
+	for (let i = 0; i < arr.length; i++) {
+		const item = arr[i];
+		if (typeof item !== "object" || item === null || typeof item.key !== "string" || typeof item.label !== "string") throw new Error(`${fieldName}[${i}] must be an object with "key" and "label" string fields`);
+		const entry = item;
+		if (entry.key.length !== 1) throw new Error(`${fieldName}[${i}].key must be a single character, got "${entry.key}"`);
+		result.push({
+			key: entry.key,
+			label: entry.label
+		});
+	}
+	return result;
+}
+async function writeConfig(config) {
+	const configDir = (0, node_path.join)((0, node_os.homedir)(), ".config", "preguito");
+	const configPath = (0, node_path.join)(configDir, "config.json");
+	if (!(0, node_fs.existsSync)(configDir)) await (0, node_fs_promises.mkdir)(configDir, { recursive: true });
+	await (0, node_fs_promises.writeFile)(configPath, JSON.stringify(config, null, 2) + "\n", "utf-8");
+	return configPath;
+}
+
+//#endregion
+exports.generateTemplate = generateTemplate;
+exports.loadConfig = loadConfig;
+exports.loadConfigOrDefault = loadConfigOrDefault;
+exports.mergeContext = mergeContext;
+exports.parseTemplate = parseTemplate;
+exports.renderTemplate = renderTemplate;
+exports.writeConfig = writeConfig;

package/dist/index.d.cts

@@ -0,0 +1,37 @@
+//#region src/template/engine.d.ts
+interface TemplateContext {
+  [key: string]: string;
+}
+interface ParsedTemplate {
+  variables: string[];
+  messagePlaceholder: string | null;
+}
+declare function parseTemplate(template: string): ParsedTemplate;
+declare function renderTemplate(template: string, context: TemplateContext, message?: string): string;
+declare function mergeContext(defaults: TemplateContext, overrides: TemplateContext): TemplateContext;
+//#endregion
+//#region src/config/types.d.ts
+interface ShortcodeEntry {
+  key: string;
+  label: string;
+}
+interface PrequitoFeatures {
+  cardId: boolean;
+  type: boolean;
+  environment: boolean;
+}
+interface PrequitoConfig {
+  template: string;
+  features: PrequitoFeatures;
+  types: ShortcodeEntry[];
+  environments: ShortcodeEntry[];
+  defaults: Record<string, string>;
+}
+declare function generateTemplate(features: PrequitoFeatures, hasPrefix: boolean): string;
+//#endregion
+//#region src/config/loader.d.ts
+declare function loadConfig(): Promise<PrequitoConfig | null>;
+declare function loadConfigOrDefault(): Promise<PrequitoConfig>;
+declare function writeConfig(config: PrequitoConfig): Promise<string>;
+//#endregion
+export { type ParsedTemplate, type PrequitoConfig, type PrequitoFeatures, type ShortcodeEntry, type TemplateContext, generateTemplate, loadConfig, loadConfigOrDefault, mergeContext, parseTemplate, renderTemplate, writeConfig };

package/dist/index.d.mts

@@ -0,0 +1,37 @@
+//#region src/template/engine.d.ts
+interface TemplateContext {
+  [key: string]: string;
+}
+interface ParsedTemplate {
+  variables: string[];
+  messagePlaceholder: string | null;
+}
+declare function parseTemplate(template: string): ParsedTemplate;
+declare function renderTemplate(template: string, context: TemplateContext, message?: string): string;
+declare function mergeContext(defaults: TemplateContext, overrides: TemplateContext): TemplateContext;
+//#endregion
+//#region src/config/types.d.ts
+interface ShortcodeEntry {
+  key: string;
+  label: string;
+}
+interface PrequitoFeatures {
+  cardId: boolean;
+  type: boolean;
+  environment: boolean;
+}
+interface PrequitoConfig {
+  template: string;
+  features: PrequitoFeatures;
+  types: ShortcodeEntry[];
+  environments: ShortcodeEntry[];
+  defaults: Record<string, string>;
+}
+declare function generateTemplate(features: PrequitoFeatures, hasPrefix: boolean): string;
+//#endregion
+//#region src/config/loader.d.ts
+declare function loadConfig(): Promise<PrequitoConfig | null>;
+declare function loadConfigOrDefault(): Promise<PrequitoConfig>;
+declare function writeConfig(config: PrequitoConfig): Promise<string>;
+//#endregion
+export { type ParsedTemplate, type PrequitoConfig, type PrequitoFeatures, type ShortcodeEntry, type TemplateContext, generateTemplate, loadConfig, loadConfigOrDefault, mergeContext, parseTemplate, renderTemplate, writeConfig };

package/dist/index.mjs

@@ -0,0 +1,269 @@
+import { mkdir, readFile, writeFile } from "node:fs/promises";
+import { existsSync } from "node:fs";
+import { join } from "node:path";
+import { homedir } from "node:os";
+
+//#region src/utils/errors.ts
+var PrequitoError = class extends Error {
+	constructor(message) {
+		super(message);
+		this.name = "PrequitoError";
+	}
+};
+var TemplateMissingVariableError = class extends PrequitoError {
+	missingVariables;
+	constructor(missing) {
+		super(`Missing template variable(s): ${missing.join(", ")}. Provide shortcodes or check your config.`);
+		this.name = "TemplateMissingVariableError";
+		this.missingVariables = missing;
+	}
+};
+var TemplateMissingMessageError = class extends PrequitoError {
+	constructor(placeholderName) {
+		super(`Template requires a message (the <${placeholderName}> placeholder). Provide it as the last argument(s).`);
+		this.name = "TemplateMissingMessageError";
+	}
+};
+
+//#endregion
+//#region src/template/engine.ts
+const VARIABLE_PATTERN = /\{\{(\w+)\}\}/g;
+const MESSAGE_PLACEHOLDER_PATTERN = /<(\w+)>/;
+function parseTemplate(template) {
+	const variables = [];
+	let match;
+	const pattern = new RegExp(VARIABLE_PATTERN.source, "g");
+	while ((match = pattern.exec(template)) !== null) if (!variables.includes(match[1])) variables.push(match[1]);
+	const messageMatch = MESSAGE_PLACEHOLDER_PATTERN.exec(template);
+	return {
+		variables,
+		messagePlaceholder: messageMatch ? messageMatch[1] : null
+	};
+}
+function renderTemplate(template, context, message) {
+	const parsed = parseTemplate(template);
+	const missing = parsed.variables.filter((v) => !(v in context));
+	if (missing.length > 0) throw new TemplateMissingVariableError(missing);
+	let result = template.replace(/\{\{(\w+)\}\}/g, (_, varName) => {
+		return context[varName];
+	});
+	if (parsed.messagePlaceholder) {
+		if (!message) throw new TemplateMissingMessageError(parsed.messagePlaceholder);
+		result = result.replace(/<\w+>/, message);
+	}
+	return result;
+}
+function mergeContext(defaults, overrides) {
+	return {
+		...defaults,
+		...overrides
+	};
+}
+
+//#endregion
+//#region src/config/types.ts
+const PREDEFINED_TYPES = [
+	{
+		key: "f",
+		label: "feat"
+	},
+	{
+		key: "x",
+		label: "fix"
+	},
+	{
+		key: "c",
+		label: "chore"
+	},
+	{
+		key: "t",
+		label: "test"
+	},
+	{
+		key: "l",
+		label: "lint"
+	},
+	{
+		key: "r",
+		label: "refactor"
+	},
+	{
+		key: "o",
+		label: "docs"
+	},
+	{
+		key: "y",
+		label: "style"
+	},
+	{
+		key: "e",
+		label: "perf"
+	},
+	{
+		key: "b",
+		label: "build"
+	}
+];
+const PREDEFINED_ENVIRONMENTS = [
+	{
+		key: "p",
+		label: "prd"
+	},
+	{
+		key: "u",
+		label: "uat"
+	},
+	{
+		key: "h",
+		label: "homolog"
+	},
+	{
+		key: "d",
+		label: "dev"
+	},
+	{
+		key: "s",
+		label: "staging"
+	}
+];
+function generateTemplate(features, hasPrefix) {
+	const { cardId, type, environment } = features;
+	return [
+		cardId ? hasPrefix ? "[{{prefix}}-{{card_id}}]" : "[{{card_id}}]" : "",
+		type && environment ? "{{type}}({{environment}}):" : type ? "{{type}}:" : environment ? "({{environment}}):" : "",
+		"<message>"
+	].filter((p) => p !== "").join(" ");
+}
+const DEFAULT_CONFIG = {
+	template: "{{type}}: <message>",
+	features: {
+		cardId: false,
+		type: true,
+		environment: false
+	},
+	types: [
+		{
+			key: "f",
+			label: "feat"
+		},
+		{
+			key: "x",
+			label: "fix"
+		},
+		{
+			key: "c",
+			label: "chore"
+		},
+		{
+			key: "t",
+			label: "test"
+		},
+		{
+			key: "r",
+			label: "refactor"
+		},
+		{
+			key: "o",
+			label: "docs"
+		}
+	],
+	environments: [],
+	defaults: {}
+};
+const CONFIG_PATHS = [
+	".preguitorc",
+	".preguitorc.json",
+	".config/preguito/config.json"
+];
+
+//#endregion
+//#region src/config/loader.ts
+async function findConfigPath() {
+	const cwd = process.cwd();
+	const home = homedir();
+	for (const relPath of [".preguitorc", ".preguitorc.json"]) {
+		const fullPath = join(cwd, relPath);
+		if (existsSync(fullPath)) return fullPath;
+	}
+	for (const relPath of CONFIG_PATHS) {
+		const fullPath = join(home, relPath);
+		if (existsSync(fullPath)) return fullPath;
+	}
+	return null;
+}
+async function loadConfig() {
+	const configPath = await findConfigPath();
+	if (!configPath) return null;
+	const raw = await readFile(configPath, "utf-8");
+	return validateConfig(JSON.parse(raw));
+}
+async function loadConfigOrDefault() {
+	return await loadConfig() ?? DEFAULT_CONFIG;
+}
+function validateConfig(obj) {
+	if (typeof obj !== "object" || obj === null) throw new Error("Config must be a JSON object");
+	const config = obj;
+	if (typeof config.template !== "string" || config.template.trim() === "") throw new Error("Config must have a non-empty \"template\" string field");
+	const defaults = {};
+	if (config.defaults !== void 0) {
+		if (typeof config.defaults !== "object" || config.defaults === null) throw new Error("\"defaults\" must be an object");
+		for (const [key, value] of Object.entries(config.defaults)) {
+			if (typeof value !== "string") throw new Error(`Default value for "${key}" must be a string`);
+			defaults[key] = value;
+		}
+	}
+	let features;
+	if (config.features && typeof config.features === "object") {
+		const f = config.features;
+		features = {
+			cardId: Boolean(f.cardId),
+			type: Boolean(f.type),
+			environment: Boolean(f.environment)
+		};
+	} else features = inferFeaturesFromTemplate(config.template);
+	let types = [];
+	if (Array.isArray(config.types)) types = validateShortcodeArray(config.types, "types");
+	else if (features.type) types = [...PREDEFINED_TYPES];
+	let environments = [];
+	if (Array.isArray(config.environments)) environments = validateShortcodeArray(config.environments, "environments");
+	else if (features.environment) environments = [...PREDEFINED_ENVIRONMENTS];
+	return {
+		template: config.template,
+		features,
+		types,
+		environments,
+		defaults
+	};
+}
+function inferFeaturesFromTemplate(template) {
+	const parsed = parseTemplate(template);
+	return {
+		cardId: parsed.variables.includes("card_id"),
+		type: parsed.variables.includes("type"),
+		environment: parsed.variables.includes("environment")
+	};
+}
+function validateShortcodeArray(arr, fieldName) {
+	const result = [];
+	for (let i = 0; i < arr.length; i++) {
+		const item = arr[i];
+		if (typeof item !== "object" || item === null || typeof item.key !== "string" || typeof item.label !== "string") throw new Error(`${fieldName}[${i}] must be an object with "key" and "label" string fields`);
+		const entry = item;
+		if (entry.key.length !== 1) throw new Error(`${fieldName}[${i}].key must be a single character, got "${entry.key}"`);
+		result.push({
+			key: entry.key,
+			label: entry.label
+		});
+	}
+	return result;
+}
+async function writeConfig(config) {
+	const configDir = join(homedir(), ".config", "preguito");
+	const configPath = join(configDir, "config.json");
+	if (!existsSync(configDir)) await mkdir(configDir, { recursive: true });
+	await writeFile(configPath, JSON.stringify(config, null, 2) + "\n", "utf-8");
+	return configPath;
+}
+
+//#endregion
+export { generateTemplate, loadConfig, loadConfigOrDefault, mergeContext, parseTemplate, renderTemplate, writeConfig };

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "preguito",
+  "version": "0.1.0",
+  "description": "A lazy git CLI tool with commit templates and shortcuts",
+  "type": "module",
+  "bin": {
+    "guito": "./dist/cli.mjs"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "tsc --noEmit",
+    "prepublishOnly": "npm run build",
+    "build:sea": "npm run build && node scripts/build-sea.js",
+    "build:deb": "npm run build:sea && bash scripts/build-deb.sh"
+  },
+  "keywords": [
+    "git",
+    "cli",
+    "commit",
+    "template",
+    "lazy"
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "commander": "^13.0.0"
+  },
+  "devDependencies": {
+    "tsdown": "^0.20.0",
+    "typescript": "^5.7.0",
+    "vitest": "^3.0.0",
+    "@types/node": "^22.0.0"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  }
+}