vovk-cli 0.0.1-draft.14 → 0.0.1-draft.16

package/dist/{watcher → dev}/index.d.mts

@@ -1,4 +1,4 @@
-export declare class VovkCLIWatcher {
+export declare class VovkDev {
     #private;
     start({ clientOutDir }?: {
         clientOutDir?: string;

package/dist/{watcher → dev}/index.mjs

@@ -15,7 +15,7 @@ import generateClient from '../generateClient.mjs';
 import locateSegments from '../locateSegments.mjs';
 import debounceWithArgs from '../utils/debounceWithArgs.mjs';
 import formatLoggedSegmentName from '../utils/formatLoggedSegmentName.mjs';
-export class VovkCLIWatcher {
+export class VovkDev {
     #projectInfo;
     #segments = [];
     #schemas = {};
@@ -289,5 +289,5 @@ export class VovkCLIWatcher {
 }
 const env = process.env;
 if (env.__VOVK_START_WATCHER_IN_STANDALONE_MODE__ === 'true') {
-    void new VovkCLIWatcher().start();
+    void new VovkDev().start();
 }

package/dist/generateClient.mjs

@@ -48,11 +48,11 @@ type Options = typeof fetcher extends VovkClientFetcher<infer U> ? U : never;
     ts += `
 ${validateOnClientImportPath ? `import validateOnClient from '${validateOnClientImportPath}';\n` : '\nconst validateOnClient = undefined;'}
 type Options = typeof fetcher extends VovkClientFetcher<infer U> ? U : never;
-const prefix = '${apiEntryPoint}';
+const apiRoot = '${apiEntryPoint}';
 `;
     js += `
 const { default: validateOnClient = null } = ${validateOnClientImportPath ? `require('${validateOnClientImportPath}')` : '{}'};
-const prefix = '${apiEntryPoint}';
+const apiRoot = '${apiEntryPoint}';
 `;
     for (let i = 0; i < segments.length; i++) {
         const { segmentName } = segments[i];
@@ -64,8 +64,8 @@ const prefix = '${apiEntryPoint}';
             continue;
         for (const key of Object.keys(schema.controllers)) {
             dts += `export const ${key}: ReturnType<typeof clientizeController<Controllers${i}["${key}"], Options>>;\n`;
-            js += `exports.${key} = clientizeController(schema['${segmentName}'].controllers.${key}, '${segmentName}', { fetcher, validateOnClient, defaultOptions: { prefix } });\n`;
-            ts += `export const ${key} = clientizeController<Controllers${i}["${key}"], Options>(schema['${segmentName}'].controllers.${key}, '${segmentName}', { fetcher, validateOnClient, defaultOptions: { prefix } });\n`;
+            js += `exports.${key} = clientizeController(schema['${segmentName}'].controllers.${key}, '${segmentName}', { fetcher, validateOnClient, defaultOptions: { apiRoot } });\n`;
+            ts += `export const ${key} = clientizeController<Controllers${i}["${key}"], Options>(schema['${segmentName}'].controllers.${key}, '${segmentName}', { fetcher, validateOnClient, defaultOptions: { apiRoot } });\n`;
         }
         for (const key of Object.keys(schema.workers)) {
             dts += `export const ${key}: ReturnType<typeof promisifyWorker<Workers${i}["${key}"]>>;\n`;

package/dist/index.d.mts

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import { Command } from 'commander';
-import type { VovkConfig, VovkEnv } from './types.mjs';
+import type { VovkConfig, VovkDevEnv } from './types.mjs';
 import 'dotenv/config';
-export type { VovkConfig, VovkEnv };
+export type { VovkConfig, VovkDevEnv };
 declare const program: Command;
 export declare function initProgram(p: typeof program, command: string): Command;

package/dist/index.mjs

@@ -7,7 +7,7 @@ import getAvailablePort from './utils/getAvailablePort.mjs';
 import getProjectInfo from './getProjectInfo/index.mjs';
 import generateClient from './generateClient.mjs';
 import locateSegments from './locateSegments.mjs';
-import { VovkCLIWatcher } from './watcher/index.mjs';
+import { VovkDev } from './dev/index.mjs';
 import { Init } from './init/index.mjs';
 import newComponents from './new/index.mjs';
 import 'dotenv/config';
@@ -33,12 +33,11 @@ program
     if (!PORT) {
         throw new Error('🐺 ❌ PORT env variable is required');
     }
-    console.log(`TODO:`, command.args);
     if (options.nextDev) {
         const { result } = concurrently([
             {
-                command: `node ${import.meta.dirname}/watcher/index.mjs`,
-                name: 'Vovk.ts Schema Watcher',
+                command: `node ${import.meta.dirname}/dev/index.mjs`,
+                name: 'Vovk Dev Command',
                 env: Object.assign({ PORT, __VOVK_START_WATCHER_IN_STANDALONE_MODE__: 'true' }, options.clientOut ? { VOVK_CLIENT_OUT_DIR: options.clientOut } : {}),
             },
             {
@@ -58,7 +57,7 @@ program
         }
     }
     else {
-        void new VovkCLIWatcher().start({ clientOutDir: options.clientOut });
+        void new VovkDev().start({ clientOutDir: options.clientOut });
     }
 });
 program
@@ -108,15 +107,6 @@ program
     .command('help')
     .description('Show help message')
     .action(() => program.help());
-/*
-TODO
-vovk new segment [segmentName]
-vovk new controller service [segmentName/]moduleName
-vovk new c s w [segmentName/]moduleName
-
-vovk c s w userApi/user
-vovk new c s w user
-*/
 program.parse(process.argv);
 if (!process.argv.slice(2).length) {
     program.outputHelp();

package/dist/init/createConfig.d.mts

@@ -1,10 +1,9 @@
 import type getLogger from '../utils/getLogger.mjs';
 import type { InitOptions } from '../types.mjs';
-export default function createConfig({ root, log, dryRun, options: { validationLibrary, validateOnClient }, }: {
+export default function createConfig({ root, log, options: { validationLibrary, validateOnClient, channel, dryRun }, }: {
     root: string;
     log: ReturnType<typeof getLogger>;
-    dryRun?: boolean;
-    options: Pick<InitOptions, 'validationLibrary' | 'validateOnClient'>;
+    options: Pick<InitOptions, 'validationLibrary' | 'validateOnClient' | 'channel' | 'dryRun'>;
 }): Promise<{
     configAbsolutePath: string;
 }>;

package/dist/init/createConfig.mjs

@@ -3,7 +3,7 @@ import fs from 'node:fs/promises';
 import getTemplateFilesFromPackage from './getTemplateFilesFromPackage.mjs';
 import prettify from '../utils/prettify.mjs';
 import getFileSystemEntryType, { FileSystemEntryType } from '../utils/getFileSystemEntryType.mjs';
-export default async function createConfig({ root, log, dryRun, options: { validationLibrary, validateOnClient }, }) {
+export default async function createConfig({ root, log, options: { validationLibrary, validateOnClient, channel, dryRun }, }) {
     const config = {};
     const dotConfigPath = path.join(root, '.config');
     const dir = (await getFileSystemEntryType(dotConfigPath)) === FileSystemEntryType.DIRECTORY ? dotConfigPath : root;
@@ -22,7 +22,7 @@ export default async function createConfig({ root, log, dryRun, options: { valid
             config.validateOnClient = `${validationLibrary}/validateOnClient`;
         }
         try {
-            const validationTemplates = await getTemplateFilesFromPackage(validationLibrary);
+            const validationTemplates = await getTemplateFilesFromPackage(validationLibrary, channel);
             Object.assign(templates, validationTemplates);
         }
         catch (error) {

package/dist/init/getTemplateFilesFromPackage.d.mts

@@ -1,6 +1,7 @@
+import { InitOptions } from '../types.mjs';
 /**
  * Retrieves a list of files in the 'templates' folder of an NPM package.
  * @param packageName - The name of the NPM package.
  * @returns A promise that resolves to an array of file paths.
  */
-export default function getTemplatesFiles(packageName: string, channel?: string): Promise<Record<string, string>>;
+export default function getTemplateFilesFromPackage(packageName: string, channel?: InitOptions['channel']): Promise<Record<string, string>>;

package/dist/init/getTemplateFilesFromPackage.mjs

@@ -7,8 +7,7 @@ import getNPMPackageMetadata from '../utils/getNPMPackageMetadata.mjs';
  * @param packageName - The name of the NPM package.
  * @returns A promise that resolves to an array of file paths.
  */
-export default async function getTemplatesFiles(packageName, channel = 'beta' // TODO change to latest
-) {
+export default async function getTemplateFilesFromPackage(packageName, channel = 'latest') {
     const metadata = await getNPMPackageMetadata(packageName);
     const latestVersion = metadata['dist-tags'][channel];
     const tarballUrl = metadata.versions[latestVersion].dist.tarball;

package/dist/init/index.mjs

@@ -101,8 +101,7 @@ export class Init {
             const { configAbsolutePath } = await createConfig({
                 root,
                 log,
-                options: { validationLibrary, validateOnClient },
-                dryRun,
+                options: { validationLibrary, validateOnClient, channel, dryRun },
             });
             log.info('Config created successfully at ' + configAbsolutePath);
         }
@@ -180,23 +179,23 @@ export class Init {
         updateScripts =
             updateScripts ??
                 (await select({
-                    message: 'Do you want to update package.json by adding "generate" and "dev" scripts?',
+                    message: 'Do you want to update package.json by adding "generate" and "dev" NPM scripts?',
                     default: 'implicit',
                     choices: [
                         {
                             name: 'Yes, use "concurrently" implicitly',
-                            description: `The "dev" script will use "concurrently" API internally in order to run "next dev" and "vovk dev" together and automatically look for an available port ${chalk.whiteBright.bold(`"vovk dev --next-dev"`)}`,
                             value: 'implicit',
+                            description: `The "dev" script will use "concurrently" API to run "next dev" and "vovk dev" commands together and automatically find an available port ${chalk.whiteBright.bold(`"vovk dev --next-dev"`)}`,
                         },
                         {
                             name: 'Yes, use "concurrently" explicitly',
                             value: 'explicit',
-                            description: `The "dev" script will use pre-defined PORT variable and run "next dev" and "vovk dev" as "concurrently" CLI arguments ${chalk.whiteBright.bold(`"PORT=3000 concurrently 'vovk dev' 'next dev' --kill-others"`)}`,
+                            description: `The "dev" script will use pre-defined PORT variable and run "next dev" and "vovk dev" as "concurrently" CLI arguments ${chalk.whiteBright.bold(`"PORT=3000 concurrently 'next dev' 'vovk dev' --kill-others"`)}`,
                         },
                         {
                             name: 'No',
                             value: undefined,
-                            description: 'Add the scripts manually',
+                            description: 'Add the NPM scripts manually',
                         },
                     ],
                 }));

package/dist/init/updateNPMScripts.mjs

@@ -5,7 +5,7 @@ export default async function updateNPMScripts(root, updateScriptsMode) {
         scripts: {
             generate: 'vovk generate',
             dev: updateScriptsMode === 'explicit'
-                ? "PORT=3000 concurrently 'vovk dev' 'next dev' --kill-others"
+                ? "PORT=3000 concurrently 'next dev' 'vovk dev' --kill-others"
                 : 'vovk dev --next-dev',
         },
     });

package/dist/new/newModule.mjs

@@ -60,7 +60,7 @@ export default async function newModule({ what, moduleNameWithOptionalSegment, d
             ? path.resolve(cwd, templatePath)
             : path.resolve(cwd, './node_modules', templatePath);
         const templateCode = await fs.readFile(templateAbsolutePath, 'utf-8');
-        const { dirName: renderedDirName, fileName, sourceName, compiledName, code, } = await render(templateCode, {
+        const { dir: renderedDirName, fileName, sourceName, compiledName, code, } = await render(templateCode, {
             cwd,
             config,
             withService: what.includes('service'),

package/dist/new/render.mjs

@@ -20,14 +20,11 @@ export default async function render(codeTemplate, { config, withService, segmen
         _, // lodash
         pluralize,
     };
-    // first, render the front matter because it can use ejs variables
     const parsed = matter((await ejs.render(codeTemplate, templateVars, { async: true })).trim());
-    const { dirName, fileName, sourceName, compiledName } = parsed.data;
+    const { dir, fileName, sourceName, compiledName } = parsed.data;
     const code = parsed.content;
-    // const templateContent = parsed.content; TODO
-    // const code = await ejs.render(templateContent, templateVars, { async: true });
     return {
-        dirName,
+        dir,
         fileName,
         sourceName,
         compiledName,

package/dist/types.d.mts

@@ -1,6 +1,6 @@
 import type { LogLevelNames } from 'loglevel';
 export type KnownAny = any;
-export type VovkEnv = {
+export type VovkDevEnv = {
     PORT?: string;
     VOVK_CLIENT_OUT_DIR?: string;
     VOVK_SCHEMA_OUT_DIR?: string;
@@ -39,7 +39,7 @@ export type VovkConfig = {
 };
 export type VovkModuleRenderResult = {
     fileName: string;
-    dirName: string;
+    dir: string;
     sourceName?: string;
     compiledName?: string;
     code: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vovk-cli",
-  "version": "0.0.1-draft.14",
+  "version": "0.0.1-draft.16",
   "bin": {
     "vovk": "./dist/index.mjs"
   },
@@ -35,7 +35,7 @@
   },
   "homepage": "https://vovk.dev",
   "peerDependencies": {
-    "vovk": "^3.0.0-draft.14"
+    "vovk": "^3.0.0-draft.19"
   },
   "dependencies": {
     "@inquirer/prompts": "^7.0.1",

package/templates/controller.ejs

@@ -4,7 +4,7 @@
 <% var compiledName = modulePascalName + 'RPC'; %>
 <% var serviceName = modulePascalName + 'Service'; %>
 ---
-dirName: <%= getModuleDirName(segmentName, moduleName) %>
+dir: <%= getModuleDirName(segmentName, moduleName) %>
 fileName: <%= controllerName + '.ts' %>
 sourceName: <%= controllerName %>
 compiledName: <%= compiledName %>

package/templates/service.ejs

@@ -3,7 +3,7 @@
 <% var serviceName = modulePascalName + 'Service'; %>
 <% var controllerName = modulePascalName + 'Controller'; %>
 ---
-dirName: <%= getModuleDirName(segmentName, moduleName) %>
+dir: <%= getModuleDirName(segmentName, moduleName) %>
 fileName: <%= serviceName + '.ts' %>
 ---
 

package/templates/worker.ejs

@@ -3,7 +3,7 @@
 <% var workerName = modulePascalName + 'Worker'; %>
 <% var compiledName = modulePascalName + 'WPC'; %>
 ---
-dirName: <%= getModuleDirName(segmentName, moduleName) %>
+dir: <%= getModuleDirName(segmentName, moduleName) %>
 fileName: <%= workerName + '.ts' %>
 sourceName: <%= workerName %>
 compiledName: <%= compiledName %>