@pcg/cli-tools 1.0.0-alpha.2 → 1.0.0-alpha.3

package/dist/index.js

@@ -25,7 +25,7 @@ const createCommandWithEnv = (name) => createCommand(name).option("--env <env>",
 let cliConfig;
 const getConfig = async () => {
 	if (cliConfig) return cliConfig;
-	const localConfigFile = join(process.cwd(), "/config.yml");
+	const localConfigFile = join(process.cwd(), "/cli.config.yml");
 	let configFile = "";
 	try {
 		await stat(localConfigFile);
@@ -64,9 +64,10 @@ const colorScheme = {
 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)}`;
+		const color = colorScheme[level] ?? ((text) => text);
+		let msg = typeof message === "string" ? message : "";
+		if (isObject(message)) msg = JSON.stringify(message, null, 2);
+		return `${typeof timestamp === "string" ? timestamp : ""} ${color(level.toUpperCase().padEnd(5))} ${clc.yellow(`[${name}]`)} ${color(msg)}`;
 	});
 	return createLogger({
 		level: "debug",

package/dist/index.js.map

@@ -1 +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"}
+{"version":3,"file":"index.js","names":["cliConfig: CliConfig | undefined","colorScheme: Record<string, ColorFn>","color: ColorFn","msg: string"],"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 | undefined;\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(), '/cli.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  ) as CliConfig;\n\n  return cliConfig as T;\n};\n","import { default as knex } from 'knex';\n\nimport { getConfig } from './config.js';\nimport { type 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","import { isObject } from '@pcg/predicates';\nimport clc from 'cli-color';\nimport {\n  createLogger, format,\n  type Logger, transports,\n} from 'winston';\n\ntype ColorFn = (text: string) => string;\n\nconst colorScheme: Record<string, ColorFn> = {\n  info: clc.greenBright as ColorFn,\n  error: clc.red as ColorFn,\n  warn: clc.yellow as ColorFn,\n  debug: clc.magentaBright as ColorFn,\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: ColorFn = colorScheme[level] ?? ((text: string): string => text);\n\n    let msg: string = typeof message === 'string' ? message : '';\n    if (isObject(message)) {\n      msg = JSON.stringify(message, null, 2);\n    }\n\n    const sTimestamp = typeof timestamp === 'string' ? timestamp : '';\n    const sLevel = color(level.toUpperCase().padEnd(5));\n    const sName = (clc.yellow as ColorFn)(`[${name}]`);\n    const sMessage = color(msg);\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,kBAAkB;CAE9D,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;;;;;ACpCT,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;;;;;ACbJ,MAAMC,cAAuC;CAC3C,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,MAAMC,QAAiB,YAAY,YAAY,SAAyB;EAExE,IAAIC,MAAc,OAAO,YAAY,WAAW,UAAU;AAC1D,MAAI,SAAS,QAAQ,CACnB,OAAM,KAAK,UAAU,SAAS,MAAM,EAAE;AAQxC,SAAO,GALY,OAAO,cAAc,WAAW,YAAY,GAK1C,GAJN,MAAM,MAAM,aAAa,CAAC,OAAO,EAAE,CAAC,CAIpB,GAHhB,IAAI,OAAmB,IAAI,KAAK,GAAG,CAGV,GAFvB,MAAM,IAAI;GAG3B;AAEF,QAAO,aAAa;EAClB,OAAO;EACP,YAAY,CACV,IAAI,WAAW,SAAS,CACzB;EACD,QAAQ,OAAO,QACb,OAAO,WAAW,EAClB,UACD;EACF,CAAC"}

package/package.json

@@ -1,15 +1,27 @@
 {
   "name": "@pcg/cli-tools",
-  "version": "1.0.0-alpha.2",
+  "version": "1.0.0-alpha.3",
   "description": "CLI utilities for database, logging and configuration",
+  "license": "MIT",
+  "author": {
+    "email": "code@deepvision.team",
+    "name": "DeepVision Code"
+  },
+  "contributors": [
+    "Vitaliy Angolenko <v.angolenko@deepvision.software>",
+    "Sergii Sadovyi <s.sadovyi@deepvision.software>"
+  ],
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
   "dependencies": {
     "cli-color": "^2.0.4",
     "winston": "^3.19.0",
     "yaml": "^2.8.0",
-    "@pcg/predicates": "1.0.0-alpha.1"
+    "@pcg/predicates": "1.0.0-alpha.2"
   },
   "devDependencies": {
     "@types/cli-color": "^2.0.6",

package/.turbo/turbo-build.log

@@ -1,16 +0,0 @@
-
-
-> @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

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

package/CHANGELOG.md

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

package/eslint.config.cjs

@@ -1,14 +0,0 @@
-//
-// @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

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

package/src/command.ts

@@ -1,10 +0,0 @@
-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

@@ -1,47 +0,0 @@
-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

@@ -1,24 +0,0 @@
-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

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

package/src/index.ts

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

package/src/logger.ts

@@ -1,54 +0,0 @@
-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

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

package/tsconfig.lib.json

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

package/tsdown.config.ts

@@ -1,11 +0,0 @@
-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',
-});