@komaci/cli 244.1.4 → 244.1.7

package/build/cmds/analyze/index.d.ts

@@ -0,0 +1,5 @@
+import type { Command } from '../../types';
+import { AnalyzerOptions } from './types';
+declare const _default: Command<AnalyzerOptions>;
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/build/cmds/analyze/index.js

@@ -0,0 +1,29 @@
+import { run } from './lib/run.js';
+export default {
+    name: 'analyze',
+    alias: 'a',
+    options: [
+        {
+            name: 'paths',
+            alias: 'p',
+            multiple: true,
+            type: String,
+            required: true,
+            defaultOption: true,
+        },
+        {
+            name: 'bundleType',
+            alias: 't',
+            type: String,
+            defaultValue: 'internal',
+        },
+        {
+            name: 'raw',
+            alias: 'r',
+            type: Boolean,
+            defaultValue: false,
+        },
+    ],
+    run,
+};
+//# sourceMappingURL=index.js.map

package/build/cmds/analyze/lib/analyzeBundle.d.ts

@@ -0,0 +1,13 @@
+import { PrimingDiagnostic } from '@komaci/static-analyzer';
+export declare type AnalyzeOutput = {
+    files: Record<string, string>;
+    diagnostics: PrimingDiagnostic[];
+};
+export declare function collectGlobbedModulePaths(globPath: string): string[];
+/**
+ * Takes the directory path of an LWC module bundle. Returns the priming diagnostics for the given bundle.
+ * @param path
+ * @returns PrimingDiagnostics for the bundle
+ */
+export declare function analyzeBundle(path: string): AnalyzeOutput;
+//# sourceMappingURL=analyzeBundle.d.ts.map

package/build/cmds/analyze/lib/analyzeBundle.js

@@ -0,0 +1,38 @@
+import { basename, dirname } from 'path';
+import { generatePrimingDiagnosticsModule } from '@komaci/static-analyzer';
+import { readBundle } from '../../../lib/collectBundle.js';
+import glob from 'glob';
+import fs from 'fs';
+export function collectGlobbedModulePaths(globPath) {
+    return glob.sync(globPath).filter((path) => {
+        const info = fs.statSync(path);
+        return info.isDirectory();
+    });
+}
+/**
+ * Takes the directory path of an LWC module bundle. Returns the priming diagnostics for the given bundle.
+ * @param path
+ * @returns PrimingDiagnostics for the bundle
+ */
+export function analyzeBundle(path) {
+    const files = readBundle(path);
+    const name = basename(path);
+    const namespace = basename(dirname(path));
+    const filesMap = {};
+    files.forEach((value) => {
+        const fileName = value.fileName.substring(value.fileName.lastIndexOf('/') + 1);
+        filesMap[fileName] = value.source;
+    });
+    const analyzerInput = {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        type: 'bundle',
+        name,
+        namespace,
+        files: filesMap,
+    };
+    return {
+        diagnostics: generatePrimingDiagnosticsModule(analyzerInput),
+        files: filesMap,
+    };
+}
+//# sourceMappingURL=analyzeBundle.js.map

package/build/cmds/analyze/lib/run.d.ts

@@ -0,0 +1,7 @@
+import { AnalyzerOptions } from '../types.js';
+/**
+ * Runs the analyze command with the given Command Options.
+ * @param cmdOptions
+ */
+export declare function run(cmdOptions: AnalyzerOptions): void;
+//# sourceMappingURL=run.d.ts.map

package/build/cmds/analyze/lib/run.js

@@ -0,0 +1,128 @@
+import logger from '../../../lib/log.js';
+import { analyzeBundle, collectGlobbedModulePaths } from './analyzeBundle.js';
+import chalk from 'chalk';
+import glob from 'glob';
+const { log, warn } = logger;
+/**
+ * Runs the analyze command with the given Command Options.
+ * @param cmdOptions
+ */
+export function run(cmdOptions) {
+    const { paths = [] } = cmdOptions;
+    if (paths.length) {
+        let hasDiagnostics = false;
+        const inflatedPaths = [];
+        paths.forEach((path) => {
+            if (glob.hasMagic(path)) {
+                collectGlobbedModulePaths(path).forEach((inflatedPath) => inflatedPaths.push(inflatedPath));
+            }
+            else {
+                inflatedPaths.push(path);
+            }
+        });
+        const parsedBundles = inflatedPaths.map((path) => analyzeBundle(path));
+        for (let i = 0; i < parsedBundles.length; i++) {
+            printOutput(cmdOptions, parsedBundles[i], inflatedPaths[i]);
+            hasDiagnostics = hasDiagnostics || parsedBundles[i].diagnostics.length > 0;
+        }
+        if (hasDiagnostics) {
+            process.exit(1);
+        }
+    }
+    else {
+        warn('Please provide 1 or more paths to a LWC bundle directory.');
+    }
+}
+/**
+ * do a bunch of fancy parsing on the file to output in a format that matches eslint or produces the raw json files
+ * @param cmdOptions
+ * @param toPrint
+ */
+function printOutput(cmdOptions, parsedBundle, basePath) {
+    const { raw } = cmdOptions;
+    if (raw) {
+        log(JSON.stringify(parsedBundle, null, 2));
+    }
+    else {
+        log(chalk.bold(`Diagnostics for ${basePath}:`));
+        if (parsedBundle.diagnostics.length === 0) {
+            log('No failures found 🎉');
+        }
+        else {
+            let currentFilename = '';
+            let currentFileLines = [];
+            for (const diagnostic of parsedBundle.diagnostics) {
+                let message = '';
+                if (diagnostic.code?.target &&
+                    diagnostic.code?.target.path !== currentFilename) {
+                    currentFilename = diagnostic.code?.target.path;
+                    if (parsedBundle.files[currentFilename]) {
+                        currentFileLines = parsedBundle.files[currentFilename].split('\n');
+                    }
+                }
+                message += chalk.cyan(`${currentFilename}:`);
+                message += `${message === '' ? ':' : ''}${chalk.gray(diagnostic.range.start.line)}:${chalk.gray(diagnostic.range.start.character)} `;
+                let underlineHighlight = chalk.whiteBright;
+                if (diagnostic.severity === 'error') {
+                    message += `- ${chalk.red('error')} `;
+                    underlineHighlight = chalk.redBright;
+                }
+                else if (diagnostic.severity === 'warning') {
+                    message += `- ${chalk.yellow('warning')} `;
+                    underlineHighlight = chalk.yellowBright;
+                }
+                else if (diagnostic.severity === 'info') {
+                    message += `- ${chalk.white('info')} `;
+                }
+                if (diagnostic.code && diagnostic.code.value) {
+                    message += `${diagnostic.code.value}: `;
+                }
+                else if (diagnostic.code) {
+                    message += `${diagnostic.code}: `;
+                }
+                message += diagnostic.message;
+                if (currentFileLines.length > 0) {
+                    message += '\n';
+                    for (let i = diagnostic.range.start.line; i <= diagnostic.range.end.line && i < currentFileLines.length; i++) {
+                        message += `${chalk.bgBlack(chalk.white(i))} `;
+                        let start = 0;
+                        let end = currentFileLines[i].length;
+                        message += currentFileLines[i] + '\n';
+                        if (i === diagnostic.range.start.line) {
+                            start = diagnostic.range.start.character;
+                        }
+                        if (i === diagnostic.range.end.line) {
+                            end = diagnostic.range.end.character;
+                        }
+                        let squiggle = ' ';
+                        const frontFiller = String(i).length;
+                        for (let j = 0; j < frontFiller; j++) {
+                            message += chalk.bgBlack(' ');
+                        }
+                        for (let j = 0; j < start; j++) {
+                            squiggle += ' ';
+                        }
+                        let lastCharNotSpace = false;
+                        for (let j = start; j < end; j++) {
+                            if (currentFileLines[i].charAt(j) !== ' ' ||
+                                (lastCharNotSpace &&
+                                    j + 1 !== end &&
+                                    currentFileLines[i].charAt(j + 1) !== ' ')) {
+                                squiggle += '~';
+                                lastCharNotSpace = true;
+                            }
+                            else {
+                                squiggle += ' ';
+                                lastCharNotSpace = false;
+                            }
+                        }
+                        message += underlineHighlight(squiggle);
+                        message += '\n';
+                    }
+                }
+                log(message);
+            }
+        }
+    }
+}
+//# sourceMappingURL=run.js.map

package/build/cmds/analyze/types.d.ts

@@ -0,0 +1,8 @@
+import { CommandLineOptions } from 'command-line-args';
+import type { BundleType } from '@lwc/metadata/dist/shared/config';
+export interface AnalyzerOptions extends CommandLineOptions {
+    paths: string[];
+    bundleType: BundleType;
+    raw: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/cmds/analyze/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/build/cmds/index.d.ts

@@ -1,3 +1,4 @@
 import modgen from './modgen/index.js';
-export { modgen };
+import analyze from './analyze/index.js';
+export { modgen, analyze };
 //# sourceMappingURL=index.d.ts.map

package/build/cmds/index.js

@@ -1,3 +1,4 @@
 import modgen from './modgen/index.js';
-export { modgen };
+import analyze from './analyze/index.js';
+export { modgen, analyze };
 //# sourceMappingURL=index.js.map

package/build/cmds/modgen/lib/readAndParseBundle.d.ts

@@ -1,26 +1,5 @@
 import { BundleConfig } from '@lwc/metadata';
 import { ParsedBundle } from '../types';
-/**
- * typeof BundleConfig.file
- */
-declare type BundleFile = {
-    fileName: string;
-    source: string;
-};
-/**
- * Finds all .js, .mjs, .css, and .html files within the given directory, reads their contents, and combines them into a bundle,
- * and returning the array of BundleFile containing the file's fileName and source
- * @param path
- * @returns An array of BundleFile
- */
-export declare function readBundle(path: string): BundleFile[];
-/**
- * Finds all .js, .mjs, .css, and .html files within the given directory, reads their contents, and combines them into a bundle,
- * and returning the array of BundleFile containing the file's fileName and source
- * @param path
- * @returns An array of BundleFile
- */
-export declare function traverseDir(path: string, filesArr: BundleFile[]): BundleFile[];
 /**
  * Takes the directory path of an LWC module bundle and an optional set of config overrides. Returns the ParsedBundle, inlcuding
  * the bundle's 1) LWC Metadata and 2) Komaci / Resolvable module.
@@ -38,5 +17,4 @@ export declare function readAndParseBundle(path: string, configOverrides: Partia
  * @returns ParsedBundle that includes the BundleConfig & GeneratorInput inputs, and BundleMetadata and generated module output
  */
 export declare function readAndParseBundleWithExceptions(path: string, configOverrides: Partial<BundleConfig>): string;
-export {};
 //# sourceMappingURL=readAndParseBundle.d.ts.map

package/build/cmds/modgen/lib/readAndParseBundle.js

@@ -1,47 +1,7 @@
-import { readdirSync, existsSync, readFileSync } from 'fs';
-import { basename, dirname, extname, resolve } from 'path';
+import { basename, dirname } from 'path';
 import { collectBundleMetadata } from '@lwc/metadata';
 import { generateKomaciModule, processGeneratorInputAndState } from '@komaci/esm-generator';
-/**
- * Finds all .js, .mjs, .css, and .html files within the given directory, reads their contents, and combines them into a bundle,
- * and returning the array of BundleFile containing the file's fileName and source
- * @param path
- * @returns An array of BundleFile
- */
-export function readBundle(path) {
-    path = resolve(path);
-    return traverseDir(path, []);
-}
-/**
- * Finds all .js, .mjs, .css, and .html files within the given directory, reads their contents, and combines them into a bundle,
- * and returning the array of BundleFile containing the file's fileName and source
- * @param path
- * @returns An array of BundleFile
- */
-export function traverseDir(path, filesArr) {
-    if (existsSync(path)) {
-        const contents = readdirSync(path, { withFileTypes: true });
-        const LWC_EXT = ['.js', '.mjs', '.css', '.html'];
-        contents.forEach((file) => {
-            if (file.isDirectory()) {
-                filesArr.concat(traverseDir(path + '/' + file.name, filesArr));
-            }
-            else {
-                //check the file extension here and then add it to the files arr
-                if (LWC_EXT.includes(extname(file.name))) {
-                    filesArr.push({
-                        fileName: path + '/' + file.name,
-                        source: readFileSync(resolve(path, file.name), 'utf-8').toString(),
-                    });
-                }
-            }
-        });
-        return filesArr;
-    }
-    else {
-        throw new Error(`path doesn't exist: ${path}`);
-    }
-}
+import { readBundle } from '../../../lib/collectBundle.js';
 /**
  * Takes the directory path of an LWC module bundle and an optional set of config overrides. Returns the ParsedBundle, inlcuding
  * the bundle's 1) LWC Metadata and 2) Komaci / Resolvable module.

package/build/index.js

@@ -1,12 +1,12 @@
 import commandLineArgs from 'command-line-args';
-import { modgen } from './cmds/index.js';
+import { modgen, analyze } from './cmds/index.js';
 import { commander } from './lib/commander.js';
 import logger from './lib/log.js';
 const { error } = logger;
 const optionDefinitions = [{ name: 'command', defaultOption: true }];
 const mainCommand = commandLineArgs(optionDefinitions, { stopAtFirstUnknown: true });
 const { command, _unknown: argv = [] } = mainCommand;
-if (!commander(command, argv, [modgen])) {
+if (!commander(command, argv, [modgen, analyze])) {
     error(`No command "${command}" found`);
     process.exit(1);
 }

package/build/lib/collectBundle.d.ts

@@ -0,0 +1,23 @@
+/**
+ * typeof BundleConfig.file
+ */
+declare type BundleFile = {
+    fileName: string;
+    source: string;
+};
+/**
+ * Finds all .js, .mjs, .css, and .html files within the given directory, reads their contents, and combines them into a bundle,
+ * and returning the array of BundleFile containing the file's fileName and source
+ * @param path
+ * @returns An array of BundleFile
+ */
+export declare function readBundle(path: string): BundleFile[];
+/**
+ * Finds all .js, .mjs, .css, and .html files within the given directory, reads their contents, and combines them into a bundle,
+ * and returning the array of BundleFile containing the file's fileName and source
+ * @param path
+ * @returns An array of BundleFile
+ */
+export declare function traverseDir(path: string, filesArr: BundleFile[]): BundleFile[];
+export {};
+//# sourceMappingURL=collectBundle.d.ts.map

package/build/lib/collectBundle.js

@@ -0,0 +1,43 @@
+import { readdirSync, existsSync, readFileSync } from 'fs';
+import { extname, resolve } from 'path';
+/**
+ * Finds all .js, .mjs, .css, and .html files within the given directory, reads their contents, and combines them into a bundle,
+ * and returning the array of BundleFile containing the file's fileName and source
+ * @param path
+ * @returns An array of BundleFile
+ */
+export function readBundle(path) {
+    path = resolve(path);
+    return traverseDir(path, []);
+}
+/**
+ * Finds all .js, .mjs, .css, and .html files within the given directory, reads their contents, and combines them into a bundle,
+ * and returning the array of BundleFile containing the file's fileName and source
+ * @param path
+ * @returns An array of BundleFile
+ */
+export function traverseDir(path, filesArr) {
+    if (existsSync(path)) {
+        const contents = readdirSync(path, { withFileTypes: true });
+        const LWC_EXT = ['.js', '.mjs', '.css', '.html'];
+        contents.forEach((file) => {
+            if (file.isDirectory()) {
+                filesArr.concat(traverseDir(path + '/' + file.name, filesArr));
+            }
+            else {
+                //check the file extension here and then add it to the files arr
+                if (LWC_EXT.includes(extname(file.name))) {
+                    filesArr.push({
+                        fileName: path + '/' + file.name,
+                        source: readFileSync(resolve(path, file.name), 'utf-8').toString(),
+                    });
+                }
+            }
+        });
+        return filesArr;
+    }
+    else {
+        throw new Error(`path doesn't exist: ${path}`);
+    }
+}
+//# sourceMappingURL=collectBundle.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@komaci/cli",
-    "version": "244.1.4",
+    "version": "244.1.7",
     "description": "CLI utility that enables developers to use komaci from the command line.",
     "license": "MIT",
     "type": "module",
@@ -24,11 +24,13 @@
         "url": "https://github.com/AndrewHuffman/komaci/issues"
     },
     "dependencies": {
-        "@komaci/esm-generator": "244.1.4",
+        "@komaci/esm-generator": "244.1.7",
+        "@komaci/static-analyzer": "244.1.7",
         "@lwc/metadata": "2.32.0-0",
         "@lwc/sfdc-compiler-utils": "2.22.0-0",
         "chalk": "^5.0.1",
-        "command-line-args": "^5.2.1"
+        "command-line-args": "^5.2.1",
+        "glob": "^7.1.7"
     },
     "devDependencies": {
         "@types/command-line-args": "^5.2.0",