@valbuild/cli 0.60.9 → 0.60.11

package/cli/dist/valbuild-cli-cli.cjs.dev.js

@@ -8,6 +8,7 @@ var fastGlob = require('fast-glob');
 var picocolors = require('picocolors');
 var eslint = require('eslint');
 var fs = require('fs/promises');
+var core = require('@valbuild/core');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
 
@@ -143,23 +144,112 @@ function logEslintMessage(fileContent, filePath, eslintMessage) {
   lineAfter && console.log(picocolors__default["default"].gray("  " + (eslintMessage.line + 1) + " |"), lineAfter);
 }
 
+async function files({
+  root,
+  cfg,
+  managedDir
+}) {
+  const printFilesUsedByVal = !managedDir;
+  const projectRoot = root ? path__default["default"].resolve(root) : process.cwd();
+  const service = await server.createService(projectRoot, {
+    valConfigPath: cfg ?? "./val.config"
+  });
+  const valFiles = await fastGlob.glob("**/*.val.{js,ts}", {
+    ignore: ["node_modules/**"],
+    cwd: projectRoot
+  });
+  const absoluteFilesPathUsedByVal = [];
+  async function printOrGetFileRefs(file) {
+    const moduleId = `/${file}`.replace(/(\.val\.(ts|js))$/, ""); // TODO: check if this always works? (Windows?)
+    const valModule = await service.get(moduleId, "");
+    // TODO: not sure using validation is the best way to do this, but it works currently.
+    if (valModule.errors) {
+      if (valModule.errors.validation) {
+        for (const sourcePathS in valModule.errors.validation) {
+          const sourcePath = sourcePathS;
+          const validationError = valModule.errors.validation[sourcePath];
+          for (const error of validationError) {
+            const value = error.value;
+            if (isFileRef(value)) {
+              const absoluteFilePathUsedByVal = path__default["default"].join(projectRoot, ...value[core.FILE_REF_PROP].split("/"));
+              if (printFilesUsedByVal) {
+                console.log(absoluteFilePathUsedByVal);
+              } else {
+                absoluteFilesPathUsedByVal.push(absoluteFilePathUsedByVal);
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+  for (const file of valFiles) {
+    await printOrGetFileRefs(file);
+  }
+  if (managedDir) {
+    const managedRoot = path__default["default"].isAbsolute(managedDir) ? managedDir : path__default["default"].join(projectRoot, managedDir);
+    const allFilesInManagedDir = await fastGlob.glob("**/*", {
+      ignore: ["node_modules/**"],
+      cwd: managedRoot
+    });
+    for (const file of allFilesInManagedDir) {
+      const absoluteFilePath = path__default["default"].join(managedRoot, file);
+      if (!absoluteFilesPathUsedByVal.includes(absoluteFilePath)) {
+        console.log(path__default["default"].join(managedRoot, file));
+      }
+    }
+  }
+  service.dispose();
+  return;
+}
+function isFileRef(value) {
+  if (!value) return false;
+  if (typeof value !== "object") return false;
+  if (core.FILE_REF_PROP in value && core.VAL_EXTENSION in value) {
+    if (value[core.VAL_EXTENSION] === "file" && typeof value[core.FILE_REF_PROP] === "string") {
+      return true;
+    }
+  }
+  return false;
+}
+
 async function main() {
   const {
     input,
     flags,
     showHelp
   } = meow__default["default"](`
-      Usage
+      Usage:
         $ val [command]
-      Commands
-        validate val-idate val modules
-
-      Options
+      
+      Options:
         --help                   Show this message
+      
+      Commands:
+        validate
+        list-files
+      
+      Command: validate
+      Description: val-idate val modules
+      Options:
         --root [root], -r [root] Set project root directory (default process.cwd())
         --cfg  [cfg],  -c [cfg]  Set path to config relative to root (default ./val.config)
         --fix  [fix]             Attempt to fix validation errors
-        --noEslint [noEslint]    Disable eslint validation
+        --noEslint [noEslint]    Disable eslint validation during validate
+
+
+      Command: files
+      Description: EXPERIMENTAL.
+        Perform file operations in Val.
+        By default it lists files (images, ...) currently in use by Val. 
+
+        If a managed directory is specified, 
+        it will list all files in the managed directory that ARE NOT currently used by Val.
+        This is useful for cleaning up unused files.
+      Options:
+        --managedDir [dir]      If set, list files found in directory that are not managed by Val
+        --root [root], -r [root] Set project root directory (default process.cwd())
+        --cfg  [cfg],  -c [cfg]  Set path to config relative to root (default ./val.config)
     `, {
     flags: {
       port: {
@@ -180,6 +270,9 @@ async function main() {
       },
       noEslint: {
         type: "boolean"
+      },
+      managedDir: {
+        type: "string"
       }
     },
     hardRejection: false
@@ -192,8 +285,20 @@ async function main() {
   }
   const [command] = input;
   switch (command) {
+    case "files":
+      if (flags.fix || flags.noEslint) {
+        return error(`Command "files" does not support --fix or --noEslint flags`);
+      }
+      return files({
+        root: flags.root,
+        cfg: flags.cfg,
+        managedDir: flags.managedDir
+      });
     case "validate":
     case "idate":
+      if (flags.managedDir) {
+        return error(`Command "validate" does not support --managedDir flag`);
+      }
       return validate({
         root: flags.root,
         cfg: flags.cfg,

package/cli/dist/valbuild-cli-cli.cjs.prod.js

@@ -8,6 +8,7 @@ var fastGlob = require('fast-glob');
 var picocolors = require('picocolors');
 var eslint = require('eslint');
 var fs = require('fs/promises');
+var core = require('@valbuild/core');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
 
@@ -143,23 +144,112 @@ function logEslintMessage(fileContent, filePath, eslintMessage) {
   lineAfter && console.log(picocolors__default["default"].gray("  " + (eslintMessage.line + 1) + " |"), lineAfter);
 }
 
+async function files({
+  root,
+  cfg,
+  managedDir
+}) {
+  const printFilesUsedByVal = !managedDir;
+  const projectRoot = root ? path__default["default"].resolve(root) : process.cwd();
+  const service = await server.createService(projectRoot, {
+    valConfigPath: cfg ?? "./val.config"
+  });
+  const valFiles = await fastGlob.glob("**/*.val.{js,ts}", {
+    ignore: ["node_modules/**"],
+    cwd: projectRoot
+  });
+  const absoluteFilesPathUsedByVal = [];
+  async function printOrGetFileRefs(file) {
+    const moduleId = `/${file}`.replace(/(\.val\.(ts|js))$/, ""); // TODO: check if this always works? (Windows?)
+    const valModule = await service.get(moduleId, "");
+    // TODO: not sure using validation is the best way to do this, but it works currently.
+    if (valModule.errors) {
+      if (valModule.errors.validation) {
+        for (const sourcePathS in valModule.errors.validation) {
+          const sourcePath = sourcePathS;
+          const validationError = valModule.errors.validation[sourcePath];
+          for (const error of validationError) {
+            const value = error.value;
+            if (isFileRef(value)) {
+              const absoluteFilePathUsedByVal = path__default["default"].join(projectRoot, ...value[core.FILE_REF_PROP].split("/"));
+              if (printFilesUsedByVal) {
+                console.log(absoluteFilePathUsedByVal);
+              } else {
+                absoluteFilesPathUsedByVal.push(absoluteFilePathUsedByVal);
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+  for (const file of valFiles) {
+    await printOrGetFileRefs(file);
+  }
+  if (managedDir) {
+    const managedRoot = path__default["default"].isAbsolute(managedDir) ? managedDir : path__default["default"].join(projectRoot, managedDir);
+    const allFilesInManagedDir = await fastGlob.glob("**/*", {
+      ignore: ["node_modules/**"],
+      cwd: managedRoot
+    });
+    for (const file of allFilesInManagedDir) {
+      const absoluteFilePath = path__default["default"].join(managedRoot, file);
+      if (!absoluteFilesPathUsedByVal.includes(absoluteFilePath)) {
+        console.log(path__default["default"].join(managedRoot, file));
+      }
+    }
+  }
+  service.dispose();
+  return;
+}
+function isFileRef(value) {
+  if (!value) return false;
+  if (typeof value !== "object") return false;
+  if (core.FILE_REF_PROP in value && core.VAL_EXTENSION in value) {
+    if (value[core.VAL_EXTENSION] === "file" && typeof value[core.FILE_REF_PROP] === "string") {
+      return true;
+    }
+  }
+  return false;
+}
+
 async function main() {
   const {
     input,
     flags,
     showHelp
   } = meow__default["default"](`
-      Usage
+      Usage:
         $ val [command]
-      Commands
-        validate val-idate val modules
-
-      Options
+      
+      Options:
         --help                   Show this message
+      
+      Commands:
+        validate
+        list-files
+      
+      Command: validate
+      Description: val-idate val modules
+      Options:
         --root [root], -r [root] Set project root directory (default process.cwd())
         --cfg  [cfg],  -c [cfg]  Set path to config relative to root (default ./val.config)
         --fix  [fix]             Attempt to fix validation errors
-        --noEslint [noEslint]    Disable eslint validation
+        --noEslint [noEslint]    Disable eslint validation during validate
+
+
+      Command: files
+      Description: EXPERIMENTAL.
+        Perform file operations in Val.
+        By default it lists files (images, ...) currently in use by Val. 
+
+        If a managed directory is specified, 
+        it will list all files in the managed directory that ARE NOT currently used by Val.
+        This is useful for cleaning up unused files.
+      Options:
+        --managedDir [dir]      If set, list files found in directory that are not managed by Val
+        --root [root], -r [root] Set project root directory (default process.cwd())
+        --cfg  [cfg],  -c [cfg]  Set path to config relative to root (default ./val.config)
     `, {
     flags: {
       port: {
@@ -180,6 +270,9 @@ async function main() {
       },
       noEslint: {
         type: "boolean"
+      },
+      managedDir: {
+        type: "string"
       }
     },
     hardRejection: false
@@ -192,8 +285,20 @@ async function main() {
   }
   const [command] = input;
   switch (command) {
+    case "files":
+      if (flags.fix || flags.noEslint) {
+        return error(`Command "files" does not support --fix or --noEslint flags`);
+      }
+      return files({
+        root: flags.root,
+        cfg: flags.cfg,
+        managedDir: flags.managedDir
+      });
     case "validate":
     case "idate":
+      if (flags.managedDir) {
+        return error(`Command "validate" does not support --managedDir flag`);
+      }
       return validate({
         root: flags.root,
         cfg: flags.cfg,

package/cli/dist/valbuild-cli-cli.esm.js

@@ -6,6 +6,7 @@ import { glob } from 'fast-glob';
 import picocolors from 'picocolors';
 import { ESLint } from 'eslint';
 import fs from 'fs/promises';
+import { FILE_REF_PROP, VAL_EXTENSION } from '@valbuild/core';
 
 function error(message) {
   console.error(chalk.red("❌Error: ") + message);
@@ -133,23 +134,112 @@ function logEslintMessage(fileContent, filePath, eslintMessage) {
   lineAfter && console.log(picocolors.gray("  " + (eslintMessage.line + 1) + " |"), lineAfter);
 }
 
+async function files({
+  root,
+  cfg,
+  managedDir
+}) {
+  const printFilesUsedByVal = !managedDir;
+  const projectRoot = root ? path.resolve(root) : process.cwd();
+  const service = await createService(projectRoot, {
+    valConfigPath: cfg ?? "./val.config"
+  });
+  const valFiles = await glob("**/*.val.{js,ts}", {
+    ignore: ["node_modules/**"],
+    cwd: projectRoot
+  });
+  const absoluteFilesPathUsedByVal = [];
+  async function printOrGetFileRefs(file) {
+    const moduleId = `/${file}`.replace(/(\.val\.(ts|js))$/, ""); // TODO: check if this always works? (Windows?)
+    const valModule = await service.get(moduleId, "");
+    // TODO: not sure using validation is the best way to do this, but it works currently.
+    if (valModule.errors) {
+      if (valModule.errors.validation) {
+        for (const sourcePathS in valModule.errors.validation) {
+          const sourcePath = sourcePathS;
+          const validationError = valModule.errors.validation[sourcePath];
+          for (const error of validationError) {
+            const value = error.value;
+            if (isFileRef(value)) {
+              const absoluteFilePathUsedByVal = path.join(projectRoot, ...value[FILE_REF_PROP].split("/"));
+              if (printFilesUsedByVal) {
+                console.log(absoluteFilePathUsedByVal);
+              } else {
+                absoluteFilesPathUsedByVal.push(absoluteFilePathUsedByVal);
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+  for (const file of valFiles) {
+    await printOrGetFileRefs(file);
+  }
+  if (managedDir) {
+    const managedRoot = path.isAbsolute(managedDir) ? managedDir : path.join(projectRoot, managedDir);
+    const allFilesInManagedDir = await glob("**/*", {
+      ignore: ["node_modules/**"],
+      cwd: managedRoot
+    });
+    for (const file of allFilesInManagedDir) {
+      const absoluteFilePath = path.join(managedRoot, file);
+      if (!absoluteFilesPathUsedByVal.includes(absoluteFilePath)) {
+        console.log(path.join(managedRoot, file));
+      }
+    }
+  }
+  service.dispose();
+  return;
+}
+function isFileRef(value) {
+  if (!value) return false;
+  if (typeof value !== "object") return false;
+  if (FILE_REF_PROP in value && VAL_EXTENSION in value) {
+    if (value[VAL_EXTENSION] === "file" && typeof value[FILE_REF_PROP] === "string") {
+      return true;
+    }
+  }
+  return false;
+}
+
 async function main() {
   const {
     input,
     flags,
     showHelp
   } = meow(`
-      Usage
+      Usage:
         $ val [command]
-      Commands
-        validate val-idate val modules
-
-      Options
+      
+      Options:
         --help                   Show this message
+      
+      Commands:
+        validate
+        list-files
+      
+      Command: validate
+      Description: val-idate val modules
+      Options:
         --root [root], -r [root] Set project root directory (default process.cwd())
         --cfg  [cfg],  -c [cfg]  Set path to config relative to root (default ./val.config)
         --fix  [fix]             Attempt to fix validation errors
-        --noEslint [noEslint]    Disable eslint validation
+        --noEslint [noEslint]    Disable eslint validation during validate
+
+
+      Command: files
+      Description: EXPERIMENTAL.
+        Perform file operations in Val.
+        By default it lists files (images, ...) currently in use by Val. 
+
+        If a managed directory is specified, 
+        it will list all files in the managed directory that ARE NOT currently used by Val.
+        This is useful for cleaning up unused files.
+      Options:
+        --managedDir [dir]      If set, list files found in directory that are not managed by Val
+        --root [root], -r [root] Set project root directory (default process.cwd())
+        --cfg  [cfg],  -c [cfg]  Set path to config relative to root (default ./val.config)
     `, {
     flags: {
       port: {
@@ -170,6 +260,9 @@ async function main() {
       },
       noEslint: {
         type: "boolean"
+      },
+      managedDir: {
+        type: "string"
       }
     },
     hardRejection: false
@@ -182,8 +275,20 @@ async function main() {
   }
   const [command] = input;
   switch (command) {
+    case "files":
+      if (flags.fix || flags.noEslint) {
+        return error(`Command "files" does not support --fix or --noEslint flags`);
+      }
+      return files({
+        root: flags.root,
+        cfg: flags.cfg,
+        managedDir: flags.managedDir
+      });
     case "validate":
     case "idate":
+      if (flags.managedDir) {
+        return error(`Command "validate" does not support --managedDir flag`);
+      }
       return validate({
         root: flags.root,
         cfg: flags.cfg,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@valbuild/cli",
   "private": false,
-  "version": "0.60.9",
+  "version": "0.60.11",
   "description": "Val CLI tools",
   "bin": {
     "val": "./bin.js"
@@ -18,8 +18,9 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@valbuild/server": "~0.60.9",
-    "@valbuild/eslint-plugin": "~0.60.9",
+    "@valbuild/core": "~0.60.11",
+    "@valbuild/server": "~0.60.11",
+    "@valbuild/eslint-plugin": "~0.60.11",
     "eslint": "^8.31.0",
     "@inquirer/confirm": "^2.0.15",
     "@inquirer/prompts": "^3.0.2",

package/src/cli.ts

@@ -1,21 +1,42 @@
 import meow from "meow";
 import { error } from "./logger";
 import { validate } from "./validate";
+import { files as files } from "./files";
 
 async function main(): Promise<void> {
   const { input, flags, showHelp } = meow(
     `
-      Usage
+      Usage:
         $ val [command]
-      Commands
-        validate val-idate val modules
-
-      Options
+      
+      Options:
         --help                   Show this message
+      
+      Commands:
+        validate
+        list-files
+      
+      Command: validate
+      Description: val-idate val modules
+      Options:
         --root [root], -r [root] Set project root directory (default process.cwd())
         --cfg  [cfg],  -c [cfg]  Set path to config relative to root (default ./val.config)
         --fix  [fix]             Attempt to fix validation errors
-        --noEslint [noEslint]    Disable eslint validation
+        --noEslint [noEslint]    Disable eslint validation during validate
+
+
+      Command: files
+      Description: EXPERIMENTAL.
+        Perform file operations in Val.
+        By default it lists files (images, ...) currently in use by Val. 
+
+        If a managed directory is specified, 
+        it will list all files in the managed directory that ARE NOT currently used by Val.
+        This is useful for cleaning up unused files.
+      Options:
+        --managedDir [dir]      If set, list files found in directory that are not managed by Val
+        --root [root], -r [root] Set project root directory (default process.cwd())
+        --cfg  [cfg],  -c [cfg]  Set path to config relative to root (default ./val.config)
     `,
     {
       flags: {
@@ -38,6 +59,9 @@ async function main(): Promise<void> {
         noEslint: {
           type: "boolean",
         },
+        managedDir: {
+          type: "string",
+        },
       },
       hardRejection: false,
     }
@@ -53,8 +77,22 @@ async function main(): Promise<void> {
 
   const [command] = input;
   switch (command) {
+    case "files":
+      if (flags.fix || flags.noEslint) {
+        return error(
+          `Command "files" does not support --fix or --noEslint flags`
+        );
+      }
+      return files({
+        root: flags.root,
+        cfg: flags.cfg,
+        managedDir: flags.managedDir,
+      });
     case "validate":
     case "idate":
+      if (flags.managedDir) {
+        return error(`Command "validate" does not support --managedDir flag`);
+      }
       return validate({
         root: flags.root,
         cfg: flags.cfg,

package/src/files.ts

@@ -0,0 +1,99 @@
+import {
+  FILE_REF_PROP,
+  ModuleId,
+  ModulePath,
+  SourcePath,
+  VAL_EXTENSION,
+} from "@valbuild/core";
+import { createService } from "@valbuild/server";
+import { glob } from "fast-glob";
+import path from "path";
+
+export async function files({
+  root,
+  cfg,
+  managedDir,
+}: {
+  root?: string;
+  cfg?: string;
+  managedDir?: string;
+}) {
+  const printFilesUsedByVal = !managedDir;
+  const projectRoot = root ? path.resolve(root) : process.cwd();
+
+  const service = await createService(projectRoot, {
+    valConfigPath: cfg ?? "./val.config",
+  });
+
+  const valFiles: string[] = await glob("**/*.val.{js,ts}", {
+    ignore: ["node_modules/**"],
+    cwd: projectRoot,
+  });
+
+  const absoluteFilesPathUsedByVal: string[] = [];
+  async function printOrGetFileRefs(file: string) {
+    const moduleId = `/${file}`.replace(/(\.val\.(ts|js))$/, "") as ModuleId; // TODO: check if this always works? (Windows?)
+    const valModule = await service.get(moduleId, "" as ModulePath);
+    // TODO: not sure using validation is the best way to do this, but it works currently.
+    if (valModule.errors) {
+      if (valModule.errors.validation) {
+        for (const sourcePathS in valModule.errors.validation) {
+          const sourcePath = sourcePathS as SourcePath;
+          const validationError = valModule.errors.validation[sourcePath];
+          for (const error of validationError) {
+            const value = error.value;
+            if (isFileRef(value)) {
+              const absoluteFilePathUsedByVal = path.join(
+                projectRoot,
+                ...value[FILE_REF_PROP].split("/")
+              );
+              if (printFilesUsedByVal) {
+                console.log(absoluteFilePathUsedByVal);
+              } else {
+                absoluteFilesPathUsedByVal.push(absoluteFilePathUsedByVal);
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+  for (const file of valFiles) {
+    await printOrGetFileRefs(file);
+  }
+
+  if (managedDir) {
+    const managedRoot = path.isAbsolute(managedDir)
+      ? managedDir
+      : path.join(projectRoot, managedDir);
+    const allFilesInManagedDir = await glob("**/*", {
+      ignore: ["node_modules/**"],
+      cwd: managedRoot,
+    });
+    for (const file of allFilesInManagedDir) {
+      const absoluteFilePath = path.join(managedRoot, file);
+      if (!absoluteFilesPathUsedByVal.includes(absoluteFilePath)) {
+        console.log(path.join(managedRoot, file));
+      }
+    }
+  }
+
+  service.dispose();
+  return;
+}
+
+function isFileRef(
+  value: unknown
+): value is { [FILE_REF_PROP]: string; [VAL_EXTENSION]: "file" } {
+  if (!value) return false;
+  if (typeof value !== "object") return false;
+  if (FILE_REF_PROP in value && VAL_EXTENSION in value) {
+    if (
+      value[VAL_EXTENSION] === "file" &&
+      typeof value[FILE_REF_PROP] === "string"
+    ) {
+      return true;
+    }
+  }
+  return false;
+}