@pcg/cli-tools 1.0.0-alpha.2

package/.turbo/turbo-build.log

@@ -0,0 +1,16 @@
+
+
+> @pcg/cli-tools@1.0.0-alpha.1 build /Users/vangolenko/node/pcg/packages/cli-tools
+> tsdown
+
+ℹ tsdown v0.15.12 powered by rolldown v1.0.0-beta.45
+ℹ Using tsdown config: /Users/vangolenko/node/pcg/packages/cli-tools/tsdown.config.ts
+ℹ entry: src/index.ts
+ℹ tsconfig: tsconfig.lib.json
+ℹ Build start
+ℹ Cleaning 3 files
+ℹ dist/index.js      4.84 kB │ gzip: 1.91 kB
+ℹ dist/index.js.map  9.84 kB │ gzip: 3.44 kB
+ℹ dist/index.d.ts    1.96 kB │ gzip: 0.76 kB
+ℹ 3 files, total: 16.64 kB
+✔ Build complete in 1200ms

package/.turbo/turbo-lint.log

@@ -0,0 +1,4 @@
+
+> @pcg/cli-tools@1.0.0-alpha.1 lint /Users/vangolenko/node/pcg/packages/cli-tools
+> eslint "src/**/*.ts"
+

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @pcg/cli-tools
+
+## 1.0.0-alpha.2
+
+### Patch Changes
+
+- 1e20e35: Creates `@pcg/cli-tools` package with reusable utilities for CLI applications:

package/dist/index.d.ts

@@ -0,0 +1,51 @@
+import * as commander0 from "commander";
+import knex from "knex";
+import { Logger } from "winston";
+
+//#region src/env.d.ts
+declare enum Env {
+  LOCAL = "local",
+  DEV = "dev",
+  STAGE = "stage",
+  PROD = "prod",
+}
+//#endregion
+//#region src/command.d.ts
+interface CommandArgsWithEnv {
+  env: Env;
+}
+declare const createCommandWithEnv: (name: string) => commander0.Command;
+//#endregion
+//#region src/config.d.ts
+interface DatabaseConfig {
+  host: string;
+  port: number;
+  user: string;
+  pass: string;
+  db: string;
+}
+interface WithEnv<T> {
+  local: T;
+  dev: T;
+  stage: T;
+  prod: T;
+}
+interface CliConfig {
+  database: WithEnv<DatabaseConfig>;
+}
+declare const getConfig: <T extends CliConfig>() => Promise<T>;
+//#endregion
+//#region src/database.d.ts
+interface KnexClientOptions {
+  env: Env;
+}
+declare const createKnexClient: (opts: KnexClientOptions) => Promise<knex.Knex<any, unknown[]>>;
+//#endregion
+//#region src/logger.d.ts
+interface UseCliLoggerOpts {
+  name: string;
+}
+declare const useLogger: (opts: UseCliLoggerOpts) => Logger;
+//#endregion
+export { CliConfig, CommandArgsWithEnv, DatabaseConfig, Env, UseCliLoggerOpts, WithEnv, createCommandWithEnv, createKnexClient, getConfig, useLogger };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,80 @@
+import { createCommand } from "commander";
+import { readFile, stat } from "fs/promises";
+import { join } from "path";
+import { parse } from "yaml";
+import knex from "knex";
+import { isObject } from "@pcg/predicates";
+import clc from "cli-color";
+import { createLogger, format, transports } from "winston";
+
+//#region src/env.ts
+let Env = /* @__PURE__ */ function(Env$1) {
+	Env$1["LOCAL"] = "local";
+	Env$1["DEV"] = "dev";
+	Env$1["STAGE"] = "stage";
+	Env$1["PROD"] = "prod";
+	return Env$1;
+}({});
+
+//#endregion
+//#region src/command.ts
+const createCommandWithEnv = (name) => createCommand(name).option("--env <env>", "Environment where commands will be executed", Env.LOCAL);
+
+//#endregion
+//#region src/config.ts
+let cliConfig;
+const getConfig = async () => {
+	if (cliConfig) return cliConfig;
+	const localConfigFile = join(process.cwd(), "/config.yml");
+	let configFile = "";
+	try {
+		await stat(localConfigFile);
+		configFile = localConfigFile;
+	} catch {
+		throw new Error("Can`t find config.yml file in project root directory");
+	}
+	cliConfig = parse(await readFile(configFile, { encoding: "utf-8" }));
+	return cliConfig;
+};
+
+//#endregion
+//#region src/database.ts
+const createKnexClient = async (opts) => {
+	const dbConfig = (await getConfig()).database[opts.env];
+	return knex({
+		client: "pg",
+		connection: {
+			host: dbConfig.host,
+			port: dbConfig.port,
+			user: dbConfig.user,
+			password: dbConfig.pass,
+			database: dbConfig.db
+		}
+	});
+};
+
+//#endregion
+//#region src/logger.ts
+const colorScheme = {
+	info: clc.greenBright,
+	error: clc.red,
+	warn: clc.yellow,
+	debug: clc.magentaBright
+};
+const useLogger = (opts) => {
+	const { name } = opts;
+	const plainText = format.printf(({ level, message, timestamp }) => {
+		const color = colorScheme[level] || ((text) => text);
+		if (isObject(message)) message = JSON.stringify(message, null, 2);
+		return `${timestamp} ${color(level.toUpperCase().padEnd(5))} ${clc.yellow(`[${name}]`)} ${color(message)}`;
+	});
+	return createLogger({
+		level: "debug",
+		transports: [new transports.Console()],
+		format: format.combine(format.timestamp(), plainText)
+	});
+};
+
+//#endregion
+export { Env, createCommandWithEnv, createKnexClient, getConfig, useLogger };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["cliConfig: CliConfig","colorScheme: Record<string, bare.Format>"],"sources":["../src/env.ts","../src/command.ts","../src/config.ts","../src/database.ts","../src/logger.ts"],"sourcesContent":["export enum Env {\n  LOCAL = 'local',\n  DEV = 'dev',\n  STAGE = 'stage',\n  PROD = 'prod',\n}\n","import { createCommand } from 'commander';\n\nimport { Env } from './env.js';\n\nexport interface CommandArgsWithEnv {\n  env: Env;\n}\n\nexport const createCommandWithEnv = (name: string) => createCommand(name)\n  .option('--env <env>', 'Environment where commands will be executed', Env.LOCAL);\n","import { readFile, stat } from 'fs/promises';\nimport { join } from 'path';\nimport { parse } from 'yaml';\n\nexport interface DatabaseConfig {\n  host: string;\n  port: number;\n  user: string;\n  pass: string;\n  db: string;\n}\n\nexport interface WithEnv<T> {\n  local: T;\n  dev: T;\n  stage: T;\n  prod: T;\n}\n\nexport interface CliConfig {\n  database: WithEnv<DatabaseConfig>;\n}\n\nlet cliConfig: CliConfig;\nexport const getConfig = async <T extends CliConfig>(): Promise<T> => {\n  if (cliConfig) {\n    return cliConfig as T;\n  }\n\n  const localConfigFile = join(process.cwd(), '/config.yml');\n\n  let configFile = '';\n  try {\n    await stat(localConfigFile);\n    configFile = localConfigFile;\n  } catch {\n    throw new Error('Can`t find config.yml file in project root directory');\n  }\n\n  cliConfig = parse(\n    await readFile(configFile, {\n      encoding: 'utf-8',\n    }),\n  );\n\n  return cliConfig as T;\n};\n","/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { default as knex } from 'knex';\n\nimport { getConfig } from './config.js';\nimport { Env } from './env.js';\n\ninterface KnexClientOptions {\n  env: Env;\n}\n\nexport const createKnexClient = async (opts: KnexClientOptions) => {\n  const appConfig = await getConfig();\n  const dbConfig = appConfig.database[opts.env];\n\n  return knex({\n    client: 'pg',\n    connection: {\n      host: dbConfig.host,\n      port: dbConfig.port,\n      user: dbConfig.user,\n      password: dbConfig.pass,\n      database: dbConfig.db,\n    },\n  });\n};\n\n","import { isObject } from '@pcg/predicates';\nimport clc from 'cli-color';\nimport bare from 'cli-color/bare';\nimport {\n  createLogger, format,\n  Logger, transports,\n} from 'winston';\n\nconst colorScheme: Record<string, bare.Format> = {\n  info: clc.greenBright,\n  error: clc.red,\n  warn: clc.yellow,\n  debug: clc.magentaBright,\n};\n\nexport interface UseCliLoggerOpts {\n  name: string;\n}\n\nexport const useLogger = (opts: UseCliLoggerOpts): Logger => {\n  const { name } = opts;\n\n  const plainText = format.printf(({\n    level,\n    message,\n    timestamp,\n  }) => {\n    const color = colorScheme[level] || ((text: string): string => text);\n\n    if (isObject(message)) {\n      message = JSON.stringify(message, null, 2);\n    }\n\n    const sTimestamp = timestamp;\n    const sLevel = color(level.toUpperCase().padEnd(5));\n    const sName = clc.yellow(`[${name}]`);\n    const sMessage = color(message);\n\n    return `${sTimestamp} ${sLevel} ${sName} ${sMessage}`;\n  });\n\n  return createLogger({\n    level: 'debug',\n    transports: [\n      new transports.Console(),\n    ],\n    format: format.combine(\n      format.timestamp(),\n      plainText,\n    ),\n  });\n};\n"],"mappings":";;;;;;;;;;AAAA,IAAY,sCAAL;AACL;AACA;AACA;AACA;;;;;;ACIF,MAAa,wBAAwB,SAAiB,cAAc,KAAK,CACtE,OAAO,eAAe,+CAA+C,IAAI,MAAM;;;;ACclF,IAAIA;AACJ,MAAa,YAAY,YAA6C;AACpE,KAAI,UACF,QAAO;CAGT,MAAM,kBAAkB,KAAK,QAAQ,KAAK,EAAE,cAAc;CAE1D,IAAI,aAAa;AACjB,KAAI;AACF,QAAM,KAAK,gBAAgB;AAC3B,eAAa;SACP;AACN,QAAM,IAAI,MAAM,uDAAuD;;AAGzE,aAAY,MACV,MAAM,SAAS,YAAY,EACzB,UAAU,SACX,CAAC,CACH;AAED,QAAO;;;;;ACnCT,MAAa,mBAAmB,OAAO,SAA4B;CAEjE,MAAM,YADY,MAAM,WAAW,EACR,SAAS,KAAK;AAEzC,QAAO,KAAK;EACV,QAAQ;EACR,YAAY;GACV,MAAM,SAAS;GACf,MAAM,SAAS;GACf,MAAM,SAAS;GACf,UAAU,SAAS;GACnB,UAAU,SAAS;GACpB;EACF,CAAC;;;;;ACfJ,MAAMC,cAA2C;CAC/C,MAAM,IAAI;CACV,OAAO,IAAI;CACX,MAAM,IAAI;CACV,OAAO,IAAI;CACZ;AAMD,MAAa,aAAa,SAAmC;CAC3D,MAAM,EAAE,SAAS;CAEjB,MAAM,YAAY,OAAO,QAAQ,EAC/B,OACA,SACA,gBACI;EACJ,MAAM,QAAQ,YAAY,YAAY,SAAyB;AAE/D,MAAI,SAAS,QAAQ,CACnB,WAAU,KAAK,UAAU,SAAS,MAAM,EAAE;AAQ5C,SAAO,GALY,UAKE,GAJN,MAAM,MAAM,aAAa,CAAC,OAAO,EAAE,CAAC,CAIpB,GAHjB,IAAI,OAAO,IAAI,KAAK,GAAG,CAGG,GAFvB,MAAM,QAAQ;GAG/B;AAEF,QAAO,aAAa;EAClB,OAAO;EACP,YAAY,CACV,IAAI,WAAW,SAAS,CACzB;EACD,QAAQ,OAAO,QACb,OAAO,WAAW,EAClB,UACD;EACF,CAAC"}

package/eslint.config.cjs

@@ -0,0 +1,14 @@
+//
+// @pkg 📦 DeepVision ESLint Config [NestJS]
+// @version 📍 1.0.0
+// @author 🐳 DeepVision Team <code@deepvision.team>
+//
+// Documentation reference: https://eslint.org/docs/user-guide/configuring/
+// ESLint versions: https://eslint.org/blog/
+//
+// eslint-disable-next-line @typescript-eslint/no-require-imports, node/no-unpublished-require
+const deep = require('@deepvision/eslint-plugin');
+
+module.exports = [
+  ...deep.default.configs.node,
+];

package/eslint.config.js

@@ -0,0 +1,5 @@
+import deepEslint, { defineConfig } from '@deepvision/eslint-plugin';
+
+export default defineConfig([
+  deepEslint.configs.vue,
+]);

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@pcg/cli-tools",
+  "version": "1.0.0-alpha.2",
+  "description": "CLI utilities for database, logging and configuration",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "dependencies": {
+    "cli-color": "^2.0.4",
+    "winston": "^3.19.0",
+    "yaml": "^2.8.0",
+    "@pcg/predicates": "1.0.0-alpha.1"
+  },
+  "devDependencies": {
+    "@types/cli-color": "^2.0.6",
+    "@types/pg": "^8.16.0",
+    "knex": "^3.1.0"
+  },
+  "peerDependencies": {
+    "commander": "^13.0.0",
+    "knex": "^3.1.0",
+    "pg": "^8.16.3"
+  },
+  "scripts": {
+    "dev": "tsdown --watch",
+    "build": "tsdown",
+    "lint": "eslint \"src/**/*.ts\" --fix"
+  }
+}

package/src/command.ts

@@ -0,0 +1,10 @@
+import { createCommand } from 'commander';
+
+import { Env } from './env.js';
+
+export interface CommandArgsWithEnv {
+  env: Env;
+}
+
+export const createCommandWithEnv = (name: string) => createCommand(name)
+  .option('--env <env>', 'Environment where commands will be executed', Env.LOCAL);

package/src/config.ts

@@ -0,0 +1,47 @@
+import { readFile, stat } from 'fs/promises';
+import { join } from 'path';
+import { parse } from 'yaml';
+
+export interface DatabaseConfig {
+  host: string;
+  port: number;
+  user: string;
+  pass: string;
+  db: string;
+}
+
+export interface WithEnv<T> {
+  local: T;
+  dev: T;
+  stage: T;
+  prod: T;
+}
+
+export interface CliConfig {
+  database: WithEnv<DatabaseConfig>;
+}
+
+let cliConfig: CliConfig | undefined;
+export const getConfig = async <T extends CliConfig>(): Promise<T> => {
+  if (cliConfig) {
+    return cliConfig as T;
+  }
+
+  const localConfigFile = join(process.cwd(), '/config.yml');
+
+  let configFile = '';
+  try {
+    await stat(localConfigFile);
+    configFile = localConfigFile;
+  } catch {
+    throw new Error('Can`t find config.yml file in project root directory');
+  }
+
+  cliConfig = parse(
+    await readFile(configFile, {
+      encoding: 'utf-8',
+    }),
+  ) as CliConfig;
+
+  return cliConfig as T;
+};

package/src/database.ts

@@ -0,0 +1,24 @@
+import { default as knex } from 'knex';
+
+import { getConfig } from './config.js';
+import { type Env } from './env.js';
+
+interface KnexClientOptions {
+  env: Env;
+}
+
+export const createKnexClient = async (opts: KnexClientOptions) => {
+  const appConfig = await getConfig();
+  const dbConfig = appConfig.database[opts.env];
+
+  return knex({
+    client: 'pg',
+    connection: {
+      host: dbConfig.host,
+      port: dbConfig.port,
+      user: dbConfig.user,
+      password: dbConfig.pass,
+      database: dbConfig.db,
+    },
+  });
+};

package/src/env.ts

@@ -0,0 +1,6 @@
+export enum Env {
+  LOCAL = 'local',
+  DEV = 'dev',
+  STAGE = 'stage',
+  PROD = 'prod',
+}

package/src/index.ts

@@ -0,0 +1,5 @@
+export * from './command.js';
+export * from './config.js';
+export * from './database.js';
+export * from './env.js';
+export * from './logger.js';

package/src/logger.ts

@@ -0,0 +1,54 @@
+import { isObject } from '@pcg/predicates';
+import clc from 'cli-color';
+import {
+  createLogger, format,
+  type Logger, transports,
+} from 'winston';
+
+type ColorFn = (text: string) => string;
+
+const colorScheme: Record<string, ColorFn> = {
+  info: clc.greenBright as ColorFn,
+  error: clc.red as ColorFn,
+  warn: clc.yellow as ColorFn,
+  debug: clc.magentaBright as ColorFn,
+};
+
+export interface UseCliLoggerOpts {
+  name: string;
+}
+
+export const useLogger = (opts: UseCliLoggerOpts): Logger => {
+  const { name } = opts;
+
+  const plainText = format.printf(({
+    level,
+    message,
+    timestamp,
+  }) => {
+    const color: ColorFn = colorScheme[level] ?? ((text: string): string => text);
+
+    let msg: string = typeof message === 'string' ? message : '';
+    if (isObject(message)) {
+      msg = JSON.stringify(message, null, 2);
+    }
+
+    const sTimestamp = typeof timestamp === 'string' ? timestamp : '';
+    const sLevel = color(level.toUpperCase().padEnd(5));
+    const sName = (clc.yellow as ColorFn)(`[${name}]`);
+    const sMessage = color(msg);
+
+    return `${sTimestamp} ${sLevel} ${sName} ${sMessage}`;
+  });
+
+  return createLogger({
+    level: 'debug',
+    transports: [
+      new transports.Console(),
+    ],
+    format: format.combine(
+      format.timestamp(),
+      plainText,
+    ),
+  });
+};

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "moduleResolution": "bundler",
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["node_modules", "dist"],
+}

package/tsconfig.lib.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "moduleResolution": "bundler",
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["node_modules", "dist"],
+}

package/tsdown.config.ts

@@ -0,0 +1,11 @@
+import { defineConfig } from 'tsdown';
+
+export default defineConfig({
+  entry: ['src/index.ts'],
+  tsconfig: './tsconfig.lib.json',
+  outDir: 'dist',
+  dts: true,
+  clean: true,
+  sourcemap: true,
+  format: 'esm',
+});