vovk-cli 0.2.0 → 0.3.0-beta.0

package/dist/utils/remove-unlisted-directories.mjs

@@ -1,28 +1,62 @@
 import fs from 'node:fs/promises';
 import path from 'node:path';
-import { getFileSystemEntryType, FileSystemEntryType } from './get-file-system-entry-type.mjs';
-/**
- * Removes all directories in a folder that aren't in the provided allowlist
- * Supports nested directory paths like 'foo/bar/baz'
- *
- * @param folderPath - The path to the folder to process
- * @param allowedDirs - Array of relative directory paths to keep
- * @returns Promise that resolves when all operations are complete
- */
-export async function removeUnlistedDirectories(folderPath, allowedDirs) {
+import { GENERATED_BANNER_PREFIX } from './generated-banner.mjs';
+import { FileSystemEntryType, getFileSystemEntryType } from './get-file-system-entry-type.mjs';
+// removes all dirs in folderPath that aren't in allowedDirs, supports nested paths like 'foo/bar/baz'
+// generatedRelPaths guards user files: a dir holding anything the generator wouldn't write is kept,
+// returns the dirs that were kept for that reason
+export async function removeUnlistedDirectories(folderPath, allowedDirs, generatedRelPaths) {
     // Normalize all allowed paths to use the system-specific separator
     const normalizedAllowedDirs = allowedDirs.map((dir) => dir.split('/').join(path.sep));
+    const skipped = [];
     // Process the directory tree recursively
-    await processDirectory(folderPath, '', normalizedAllowedDirs);
+    await processDirectory(folderPath, '', normalizedAllowedDirs, generatedRelPaths, skipped);
+    return skipped;
 }
-/**
- * Recursively processes directories to determine which should be kept or removed
- *
- * @param basePath - The absolute base path being processed
- * @param relativePath - The current relative path from the base
- * @param allowedDirs - Normalized list of allowed directory paths
- */
-async function processDirectory(basePath, relativePath, allowedDirs) {
+// "[package_name]" is substituted at write time, so treat it as a wildcard segment
+function matchesGeneratedPath(relPath, generatedRelPaths) {
+    const segments = relPath.split(path.sep);
+    return generatedRelPaths.some((generated) => {
+        const generatedSegments = generated.split(path.sep);
+        if (generatedSegments.length > segments.length)
+            return false;
+        // a nested segment such as bar/baz adds leading directories, so match the tail
+        const offset = segments.length - generatedSegments.length;
+        return generatedSegments.every((segment, i) => segment === '[package_name]' || segment === segments[offset + i]);
+    });
+}
+// a matching name is not enough, a user file may be named like ours, so require our banner too.
+// json holds no comment and therefore no banner, so there the name stays the only signal
+async function isGeneratedFile(absolutePath, relPath, generatedRelPaths) {
+    if (!matchesGeneratedPath(relPath, generatedRelPaths))
+        return false;
+    if (path.extname(absolutePath) === '.json')
+        return true;
+    try {
+        const content = await fs.readFile(absolutePath, 'utf-8');
+        return content.slice(0, content.indexOf('\n') + 1 || undefined).includes(GENERATED_BANNER_PREFIX);
+    }
+    catch {
+        return false;
+    }
+}
+// true when every file below dirPath is something the generator wrote
+async function containsOnlyGenerated(dirPath, generatedRelPaths, relativePath = '') {
+    const entries = await fs.readdir(path.join(dirPath, relativePath), { withFileTypes: true });
+    for (const entry of entries) {
+        const entryRelPath = relativePath ? path.join(relativePath, entry.name) : entry.name;
+        if (entry.isDirectory()) {
+            if (!(await containsOnlyGenerated(dirPath, generatedRelPaths, entryRelPath)))
+                return false;
+        }
+        else if (!(await isGeneratedFile(path.join(dirPath, entryRelPath), entryRelPath, generatedRelPaths))) {
+            return false;
+        }
+    }
+    return true;
+}
+// recursively decides which dirs to keep or remove
+async function processDirectory(basePath, relativePath, allowedDirs, generatedRelPaths, skipped) {
     const currentDirPath = path.join(basePath, relativePath);
     // check if the current path is a directory
     const type = await getFileSystemEntryType(currentDirPath);
@@ -49,11 +83,16 @@ async function processDirectory(basePath, relativePath, allowedDirs) {
         });
         if (shouldKeep) {
             // Recursively process this directory's contents
-            await processDirectory(basePath, newRelativePath, allowedDirs);
+            await processDirectory(basePath, newRelativePath, allowedDirs, generatedRelPaths, skipped);
         }
         else {
-            // Remove this directory since it's not in the allowed list
             const fullPath = path.join(basePath, newRelativePath);
+            // never delete a directory that holds files we did not generate
+            if (generatedRelPaths && !(await containsOnlyGenerated(fullPath, generatedRelPaths))) {
+                skipped.push(fullPath);
+                continue;
+            }
+            // Remove this directory since it's not in the allowed list
             await fs.rm(fullPath, { recursive: true, force: true });
         }
     }

package/dist/utils/resolve-absolute-module-path.mjs

@@ -1,5 +1,5 @@
-import path from 'node:path';
 import { createRequire } from 'node:module';
+import path from 'node:path';
 import { getPublicModuleNameFromPath } from './get-public-module-name-from-path.mjs';
 // Returns the path up to and including the last occurrence of the given module name
 export function getPathUpToModule(moduleName, fullPath) {
@@ -24,7 +24,6 @@ export function resolveAbsoluteModulePath(modulePath, cwd) {
         return path.resolve(getPathUpToModule(moduleName, path.dirname(resolved)), restPath);
     }
     catch (e) {
-        // eslint-disable-next-line no-console
         console.error(`Error resolving module path: ${modulePath}`, e);
         // If resolution fails, fall back to the original behavior
         return path.resolve(cwd, './node_modules', modulePath);

package/dist/utils/update-config-property.mjs

@@ -1,4 +1,4 @@
-import { Project, QuoteKind, IndentationText, NewLineKind, SyntaxKind, Node, } from 'ts-morph';
+import { IndentationText, NewLineKind, Node, Project, QuoteKind, SyntaxKind, } from 'ts-morph';
 export function updateConfigProperty(sourceCode, pathToProperty, newValue) {
     const project = createProject();
     const sourceFile = project.createSourceFile('config-temp.mts', sourceCode, { overwrite: true });

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "vovk-cli",
-  "version": "0.2.0",
+  "version": "0.3.0-beta.0",
   "description": "CLI tool for managing Vovk.ts projects",
   "files": [
     "dist",
     "client-templates",
-    "module-templates"
+    "module-templates",
+    "CHANGELOG.md"
   ],
   "bin": {
     "vovk": "./dist/index.mjs"
@@ -18,10 +19,10 @@
     "build": "rm -rf dist tsconfig.build.tsbuildinfo && tsc -P tsconfig.build.json",
     "postbuild": "chmod +x ./dist/index.mjs",
     "pre-test": "npm run build && npm run clear-test-cache",
-    "test-only": "npm run pre-test && NODE_ENV=test node --experimental-transform-types --experimental-strip-types --experimental-vm-modules --test --test-only test/spec/**/*.mts",
-    "test": "npm run pre-test && NODE_ENV=test node --experimental-transform-types --experimental-strip-types --experimental-vm-modules --test --test-concurrency=1 test/spec/**/*.mts",
+    "test-only": "npm run pre-test && NODE_ENV=test node --experimental-strip-types --experimental-vm-modules --test --test-only test/spec/**/*.mts",
+    "test": "npm run pre-test && NODE_ENV=test node --experimental-strip-types --experimental-vm-modules --test --test-concurrency=1 test/spec/**/*.mts",
     "tsc": "tsc --noEmit",
-    "ncu": "npm-check-updates -u -x commander,node-pty",
+    "ncu": "npm-check-updates -u -x commander,tsdown",
     "npm-publish": "npm publish",
     "clear-test-cache": "rm -rf ./tmp_*"
   },
@@ -44,36 +45,29 @@
   "peerDependencies": {
     "vovk": ">=3.0.0"
   },
-  "optionalDependencies": {
-    "@rolldown/binding-linux-x64-gnu": "1.0.0-rc.13"
-  },
   "dependencies": {
     "@iarna/toml": "^2.2.5",
-    "@inquirer/prompts": "^8.3.2",
-    "@npmcli/package-json": "^7.0.5",
+    "@inquirer/prompts": "^8.5.2",
+    "@npmcli/package-json": "^8.0.0",
     "@types/json-schema": "^7.0.15",
-    "@types/lodash": "^4.17.24",
-    "chalk": "^5.6.2",
+    "@types/lodash": "^4.17.25",
+    "chalk": "^6.0.0",
     "chokidar": "^5.0.0",
-    "clone-deep": "^4.0.1",
     "commander": "^13.1.0",
-    "concurrently": "^9.2.1",
-    "dotenv": "^17.4.1",
-    "ejs": "^5.0.1",
-    "get-tsconfig": "^4.13.7",
+    "concurrently": "^10.0.4",
+    "dotenv": "^17.4.2",
+    "ejs": "^6.0.1",
+    "get-tsconfig": "^4.14.1",
     "glob": "^13.0.6",
     "gray-matter": "^4.0.3",
-    "inflection": "^3.0.2",
     "jsonc-parser": "^3.3.1",
     "lodash": "^4.18.1",
     "loglevel": "^1.9.2",
     "pluralize": "^8.0.0",
-    "prettier": "^3.8.1",
-    "tar-stream": "^3.1.8",
-    "ts-morph": "^27.0.2",
-    "type-fest": "^5.5.0",
-    "undici": "^8.0.2",
-    "yaml": "^2.8.3"
+    "ts-morph": "^28.0.0",
+    "type-fest": "^5.8.0",
+    "undici": "^8.9.0",
+    "yaml": "^2.9.0"
   },
   "devDependencies": {
     "@types/concat-stream": "^2.0.3",
@@ -81,13 +75,12 @@
     "@types/js-yaml": "^4.0.9",
     "@types/npmcli__package-json": "^4.0.4",
     "@types/pluralize": "^0.0.33",
-    "@types/tar-stream": "^3.1.4",
     "concat-stream": "^2.0.0",
-    "create-next-app": "^16.2.2",
+    "create-next-app": "^16.2.12",
     "http-server": "^14.1.1",
-    "node-pty": "0.10.1",
-    "openapi3-ts": "^4.5.0",
-    "tsdown": "^0.21.7",
-    "zod": "^4.3.6"
+    "node-pty": "1.1.0",
+    "openapi3-ts": "^4.6.1",
+    "tsdown": "0.22.14",
+    "zod": "^4.4.3"
   }
 }

package/client-templates/js-base/index.d.ts.ejs

@@ -1,21 +0,0 @@
-<%- t.getFirstLineBanner() %>
-import type { VovkFetcher } from 'vovk/fetcher';
-import type { createRPC } from '<%= t.commonImports.createRPC %>';
-<% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment, i) => { if(segment.segmentType !== 'mixin') { %>
-import type { Controllers as Controllers<%= i %> } from "<%= t.segmentMeta[segment.segmentName].segmentImportPath %>";
-<% }}) %>
-<% if (t.hasMixins) { %>
-import type { Controllers as MixinControllers, Mixins } from "./mixins";
-<% } %>
-<% Object.entries(t.reExports).forEach(([reExportWhat, reExportFrom]) => { %>
-export { <%= reExportWhat %> } from '<%= reExportFrom %>';
-<% }) %>
-<% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment, i) => { %>
-  <% Object.keys(segment.controllers).forEach((rpcModuleName) => { %>
-export const <%= rpcModuleName %>: ReturnType<typeof createRPC<<%= segment.segmentType === 'mixin' ? `MixinControllers` : `Controllers${i}` %>["<%= rpcModuleName %>"], typeof import('<%- t.segmentImports[segment.segmentName].fetcher %>').fetcher extends VovkFetcher<infer U> ? U : never>>;
-  <% }) 
-}) %>
-export { schema } from './schema.js';
-<% if (t.hasMixins) { %>
-export { Mixins };
-<% } %>

package/client-templates/js-base/index.js.ejs

@@ -1,18 +0,0 @@
-<%- t.getFirstLineBanner() %>
-import { createRPC } from '<%= t.commonImports.createRPC %>';
-import { schema } from './schema.js';
-<% Object.entries(t.reExports).forEach(([reExportWhat, reExportFrom]) => { %>
-export { <%= reExportWhat %> } from '<%= reExportFrom %>';
-<% }) %>
-<% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment, i) => { %>
-  <% Object.keys(segment.controllers).forEach((rpcModuleName) => { 
-    const apiRoot = t.segmentMeta[segment.segmentName].forceApiRoot ?? t.apiRoot; %>
-export const <%= rpcModuleName %> = createRPC(
-  schema, '<%= segment.segmentName %>', '<%= rpcModuleName %>', import('<%- t.segmentImports[segment.segmentName].fetcher %>'),
-  { validateOnClient: <%- t.segmentImports[segment.segmentName].validateOnClient ? `import('${t.segmentImports[segment.segmentName].validateOnClient}')` : 'undefined' %>, <%- typeof t.segmentMeta[segment.segmentName].segmentNameOverride === 'string' ? `segmentNameOverride: '${t.segmentMeta[segment.segmentName].segmentNameOverride}', ` : '' %><%- segment.segmentType === 'mixin' ? '' : apiRoot ? `apiRoot: '${apiRoot}'` : '' %> }
-);
-<% 
-  }); 
-});
-%>
-export { schema };

package/client-templates/openapi-js/openapi.d.ts.ejs

@@ -1,4 +0,0 @@
-<%- t.getFirstLineBanner() %>
-import type { OpenAPIObject } from 'openapi3-ts/oas31';
-
-export const openapi: OpenAPIObject;

package/client-templates/openapi-js/openapi.js.ejs

@@ -1,4 +0,0 @@
-<%- t.getFirstLineBanner() %>
-import openapi from './openapi.json' with { type: 'json' };
-
-export { openapi };

package/client-templates/schema-js/schema.d.ts.ejs

@@ -1,10 +0,0 @@
-<%- t.getFirstLineBanner() %>
-import type { VovkMetaSchema, VovkSegmentSchema } from 'vovk';
-
-export const schema: {
-    $schema: '<%- t.VovkSchemaIdEnum.SCHEMA %>';
-    meta: VovkMetaSchema;
-    segments: {<% Object.values(t.schema.segments).filter((segment) => segment.emitSchema).forEach((segment) => { %>
-      '<%= segment.segmentName %>': VovkSegmentSchema;<% }) %>
-    };
-};

package/client-templates/schema-js/schema.js.ejs

@@ -1,29 +0,0 @@
-<%- t.getFirstLineBanner() %>
-<% if(t.isVovkProject) { %>
-import meta from './<%= t.schemaOutDir %>/_meta.json' with { type: 'json' };
-<% } else { %>
-const meta = <%- JSON.stringify(t.schema.meta, null, 2) %>;
-<% } %>
-
-<% if(t.hasMixins) { %>
-import mixins from './mixins.json' with { type: 'json' };
-<% } %>
-<% Object.values(t.schema.segments).filter((segment) => segment.emitSchema && segment.segmentType !== 'mixin').forEach((segment, i) => { %>
-import schema<%= i %> from './<%= t.schemaOutDir %>/<%= segment.segmentName || t.ROOT_SEGMENT_FILE_NAME %>.json' with { type: 'json' };
-<% }) %>
-
-const segments = {<% Object.values(t.schema.segments).filter((segment) => segment.emitSchema && segment.segmentType !== 'mixin').forEach((segment, i) => { %>
-    '<%= segment.segmentName %>': schema<%= i %>,
-<% }) %>
-  <% if(t.hasMixins) { %>
-  ...mixins,
-  <% } %>
-};
-
-const schema = {
-  $schema: '<%- t.VovkSchemaIdEnum.SCHEMA %>',
-  segments,
-  meta,
-};
-
-export { schema };