@player-tools/cli 0.0.2-next.0

package/dist/utils/diag-renderer.js

@@ -0,0 +1,168 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validationRenderer = exports.getTaskSymbol = exports.formatDiagnosticResults = exports.getSummary = void 0;
+const vscode_languageserver_types_1 = require("vscode-languageserver-types");
+const chalk_1 = __importDefault(require("chalk"));
+const log_symbols_1 = __importDefault(require("log-symbols"));
+const elegant_spinner_1 = __importDefault(require("elegant-spinner"));
+const fs_1 = require("./fs");
+/** Compare the ranges and return the one that starts of finishes first */
+function rangeComparator(first, second) {
+    if (first.start.line < second.start.line) {
+        return -1;
+    }
+    if (first.start.line > second.start.line) {
+        return 1;
+    }
+    if (first.start.character < second.start.character) {
+        return -1;
+    }
+    if (first.start.character > second.start.character) {
+        return 1;
+    }
+    return 0;
+}
+/** Sort a list of digs by position */
+const sortDiagnostics = (validations) => {
+    // Sort the validations by line/char number
+    return validations.sort((a, b) => {
+        return rangeComparator(a.range, b.range);
+    });
+};
+/** Get the text representing the line range */
+function getLineRange(range) {
+    return `${range.start.line + 1}:${range.start.character + 1}`;
+}
+/** Fix the plurality of a word */
+function maybePlural(word, count) {
+    return count > 1 ? `${word}s` : word;
+}
+/** Get the lines representing the summary of the results */
+function getSummary({ errors, warnings, skipped, fileCount, duration, }) {
+    return [
+        '\n',
+        (errors > 0 || warnings === 0) &&
+            chalk_1.default.red(`${errors} ${maybePlural('error', errors)}`),
+        warnings > 0 &&
+            chalk_1.default.yellow(`${warnings} ${maybePlural('warning', warnings)}`),
+        skipped !== undefined &&
+            skipped > 0 &&
+            chalk_1.default.gray(`${skipped} ${maybePlural('skipped', skipped)}`),
+        chalk_1.default.gray(`in ${fileCount} ${maybePlural('file', fileCount)}`),
+        chalk_1.default.gray(`took ${duration}ms`),
+    ]
+        .filter(Boolean)
+        .join(' ');
+}
+exports.getSummary = getSummary;
+/** Format a diag for printing on the console */
+function formatDiagnostic(diag, longestLine, fName) {
+    const type = diag.severity === vscode_languageserver_types_1.DiagnosticSeverity.Error
+        ? chalk_1.default.red(`${log_symbols_1.default.error}  `)
+        : chalk_1.default.yellow(`${log_symbols_1.default.warning}  `);
+    const msg = chalk_1.default.bold(diag.message);
+    const range = getLineRange(diag.range);
+    return [
+        `${type}`,
+        range.padEnd(longestLine),
+        msg,
+        `${fName}:${range.padEnd(longestLine)}`,
+    ].join(' ');
+}
+/** Format the results for printing on the console */
+function formatDiagnosticResults(filePath, results, verbose = false) {
+    const count = {
+        errors: 0,
+        warnings: 0,
+    };
+    const linePrefix = '  ';
+    const longestLine = Math.max(...results.map((r) => getLineRange(r.range).length));
+    let lines = results
+        .map((diag) => {
+        if (diag.severity === vscode_languageserver_types_1.DiagnosticSeverity.Error) {
+            count.errors += 1;
+        }
+        else if (diag.severity === vscode_languageserver_types_1.DiagnosticSeverity.Warning) {
+            count.warnings += 1;
+        }
+        if (diag.severity === vscode_languageserver_types_1.DiagnosticSeverity.Error || verbose) {
+            return linePrefix + formatDiagnostic(diag, longestLine + 1, filePath);
+        }
+        return '';
+    })
+        .filter((line) => line !== '');
+    if (count.errors > 0) {
+        lines = ['', `${chalk_1.default.red(log_symbols_1.default.error)} ${filePath}`, ...lines, ''];
+    }
+    else if (verbose) {
+        if (count.warnings > 0) {
+            lines = [
+                '',
+                `${chalk_1.default.yellow(log_symbols_1.default.warning)} ${filePath}`,
+                ...lines,
+                '',
+            ];
+        }
+        else {
+            lines = [`${chalk_1.default.green(log_symbols_1.default.success)} ${filePath}`, ...lines];
+        }
+    }
+    return Object.assign(Object.assign({}, count), { lines });
+}
+exports.formatDiagnosticResults = formatDiagnosticResults;
+const spinnerState = new WeakMap();
+/** Get the symbol for a given task */
+const getTaskSymbol = (task) => {
+    var _a;
+    if (task.state === 'pending' || task.state === 'idle') {
+        const spinner = (_a = spinnerState.get(task)) !== null && _a !== void 0 ? _a : (0, elegant_spinner_1.default)();
+        spinnerState.set(task, spinner);
+        return chalk_1.default.yellow(spinner());
+    }
+    if (task.state === 'completed' && task.error) {
+        return log_symbols_1.default.error;
+    }
+    if (task.state === 'completed') {
+        return chalk_1.default.yellow(log_symbols_1.default.success);
+    }
+    return ' ';
+};
+exports.getTaskSymbol = getTaskSymbol;
+exports.validationRenderer = {
+    onUpdate(ctx) {
+        const { tasks } = ctx;
+        const output = ['Validating content'];
+        tasks.forEach((task) => {
+            var _a, _b;
+            if (task.state === 'completed' && task.output) {
+                const formattedDiags = formatDiagnosticResults(((_a = task.data) === null || _a === void 0 ? void 0 : _a.file) ? (0, fs_1.normalizePath)(task.data.file) : '', sortDiagnostics(task.output), true);
+                output.push(...formattedDiags.lines);
+            }
+            else {
+                output.push(`${(0, exports.getTaskSymbol)(task)} ${((_b = task.data) === null || _b === void 0 ? void 0 : _b.file) ? (0, fs_1.normalizePath)(task.data.file) : ''}`);
+            }
+        });
+        return output.join('\n');
+    },
+    onEnd(ctx) {
+        const count = {
+            errors: 0,
+            warnings: 0,
+            skipped: 0,
+            fileCount: ctx.tasks.length,
+            duration: ctx.duration,
+        };
+        ctx.tasks.forEach((t) => {
+            var _a, _b;
+            if (t.state === 'completed' && t.output) {
+                const formattedDiags = formatDiagnosticResults((_b = (_a = t.data) === null || _a === void 0 ? void 0 : _a.file) !== null && _b !== void 0 ? _b : '', t.output, true);
+                count.errors += formattedDiags.errors;
+                count.warnings += formattedDiags.warnings;
+            }
+        });
+        return [exports.validationRenderer.onUpdate(ctx), getSummary(count)].join('\n');
+    },
+};

package/dist/utils/fs.d.ts

@@ -0,0 +1,5 @@
+/** Check if an input is a directory, if it is, then swap it to a globbed path */
+export declare const convertToFileGlob: (input: string[], glob: string) => string[];
+/** Normalize a path for display */
+export declare const normalizePath: (p: string) => string;
+//# sourceMappingURL=fs.d.ts.map

package/dist/utils/fs.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizePath = exports.convertToFileGlob = void 0;
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+/** Check if an input is a directory, if it is, then swap it to a globbed path */
+const convertToFileGlob = (input, glob) => {
+    return input.map((i) => {
+        try {
+            if (fs_1.default.statSync(i).isDirectory()) {
+                return path_1.default.join(i, glob);
+            }
+        }
+        catch (e) { }
+        return i;
+    });
+};
+exports.convertToFileGlob = convertToFileGlob;
+/** Normalize a path for display */
+const normalizePath = (p) => {
+    return path_1.default.relative(process.cwd(), p);
+};
+exports.normalizePath = normalizePath;

package/dist/utils/task-runner.d.ts

@@ -0,0 +1,52 @@
+interface BaseTask<Results, Data> {
+    /** The state of the task */
+    state: 'idle' | 'pending';
+    /** A function to run */
+    run: () => Promise<Results>;
+    /** other metadata about the task */
+    data?: Data;
+}
+export declare type CompletedTask<Results, Data> = Omit<BaseTask<Results, Data>, 'state'> & {
+    /** The state of the task */
+    state: 'completed';
+} & ({
+    /** The results */
+    output: Results;
+    /** An error if any */
+    error?: never;
+} | {
+    /** The error if any */
+    error: Error;
+    /** No output on error */
+    output?: never;
+});
+export declare type Task<ResultsType, Data> = BaseTask<ResultsType, Data> | CompletedTask<ResultsType, Data>;
+export interface TaskProgressRenderer<ResultType, Data = unknown> {
+    /** Call back to paint update on the page */
+    onUpdate: (ctx: {
+        /** The tasks that are running */
+        tasks: Array<Task<ResultType, Data>>;
+    }) => string;
+    /** Called for a summary */
+    onEnd: (ctx: {
+        /** The completed tasks */
+        tasks: Array<CompletedTask<ResultType, Data>>;
+        /** Number of ms it took to run */
+        duration: number;
+    }) => string;
+}
+interface TaskRunner<R, Data> {
+    /** The list of tasks */
+    tasks: Array<Task<R, Data>>;
+    /** A trigger to start it */
+    run: () => Promise<Array<CompletedTask<R, Data>>>;
+}
+/** Create a runner to kick off tasks in parallel */
+export declare const createTaskRunner: <R, D>({ tasks, renderer, }: {
+    /** A list of tasks to run */
+    tasks: Pick<BaseTask<R, D>, "run" | "data">[];
+    /** How to report progress */
+    renderer: TaskProgressRenderer<R, D>;
+}) => TaskRunner<R, D>;
+export {};
+//# sourceMappingURL=task-runner.d.ts.map

package/dist/utils/task-runner.js

@@ -0,0 +1,65 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTaskRunner = void 0;
+const log_update_1 = __importDefault(require("log-update"));
+/** Create a runner to kick off tasks in parallel */
+const createTaskRunner = ({ tasks, renderer, }) => {
+    const statefulTasks = tasks.map((t) => {
+        return Object.assign(Object.assign({}, t), { state: 'idle' });
+    });
+    /** Kick off the task list */
+    const run = () => __awaiter(void 0, void 0, void 0, function* () {
+        const startTime = Date.now();
+        let ended = false;
+        const paintInterval = setInterval(() => {
+            if (ended) {
+                return;
+            }
+            const output = renderer.onUpdate({ tasks: statefulTasks });
+            if (process.stdout.isTTY) {
+                (0, log_update_1.default)(output);
+            }
+        }, 10);
+        yield Promise.all(statefulTasks.map((t) => __awaiter(void 0, void 0, void 0, function* () {
+            t.state = 'pending';
+            try {
+                const r = yield t.run();
+                t.state = 'completed';
+                t.output = r;
+            }
+            catch (e) {
+                if (e instanceof Error) {
+                    t.state = 'completed';
+                    t.error = e;
+                }
+            }
+        })));
+        ended = true;
+        clearInterval(paintInterval);
+        const duration = Date.now() - startTime;
+        const output = renderer.onEnd({
+            duration,
+            tasks: statefulTasks,
+        });
+        console.log(output);
+        log_update_1.default.done();
+        return statefulTasks;
+    });
+    return {
+        tasks: statefulTasks,
+        run,
+    };
+};
+exports.createTaskRunner = createTaskRunner;

package/oclif.manifest.json

@@ -0,0 +1 @@
+{"version":"0.0.2-next.0","commands":{"dsl:compile":{"id":"dsl:compile","description":"Compile Player DSL files into JSON","strict":true,"pluginName":"@player-tools/cli","pluginAlias":"@player-tools/cli","pluginType":"core","aliases":[],"flags":{"config":{"name":"config","type":"option","char":"c","description":"Path to a specific config file to load.\nBy default, will automatically search for an rc or config file to load","multiple":false},"input":{"name":"input","type":"option","char":"i","description":"An input directory to compile.\nAny jsx/ts/tsx files will be loaded via babel-require automatically.","multiple":false},"output":{"name":"output","type":"option","char":"o","description":"Output directory to write results to.","multiple":false},"skip-validation":{"name":"skip-validation","type":"boolean","description":"Option to skip validating the generated JSON","allowNo":false},"exp":{"name":"exp","type":"boolean","description":"Use experimental language features","allowNo":false}},"args":[],"_globalFlags":{}},"json:validate":{"id":"json:validate","description":"Validate Player JSON content","strict":true,"pluginName":"@player-tools/cli","pluginAlias":"@player-tools/cli","pluginType":"core","aliases":[],"flags":{"config":{"name":"config","type":"option","char":"c","description":"Path to a specific config file to load.\nBy default, will automatically search for an rc or config file to load","multiple":false},"files":{"name":"files","type":"option","char":"f","description":"A list of files or globs to validate","multiple":true},"exp":{"name":"exp","type":"boolean","description":"Use experimental language features","allowNo":false}},"args":[],"_globalFlags":{}},"xlr:compile":{"id":"xlr:compile","description":"Compiles typescript files to XLRs format","strict":true,"pluginName":"@player-tools/cli","pluginAlias":"@player-tools/cli","pluginType":"core","aliases":[],"flags":{"config":{"name":"config","type":"option","char":"c","description":"Path to a specific config file to load.\nBy default, will automatically search for an rc or config file to load","multiple":false},"input":{"name":"input","type":"option","char":"i","description":"An input directory to search for types to export","multiple":false,"default":"./src"},"output":{"name":"output","type":"option","char":"o","description":"Output directory to write results to.","multiple":false,"default":"./dist"},"mode":{"name":"mode","type":"option","char":"m","description":"Search strategy for types to export: plugin (default, looks for exported EnchancedPlayerPlugin classes) or type (all exported types)","helpValue":"(plugin|types)","multiple":false,"options":["plugin","types"],"default":"plugin"}},"args":[],"_globalFlags":{}},"xlr:convert":{"id":"xlr:convert","description":"Exports XLRs files to a specific language","strict":true,"pluginName":"@player-tools/cli","pluginAlias":"@player-tools/cli","pluginType":"core","aliases":[],"flags":{"config":{"name":"config","type":"option","char":"c","description":"Path to a specific config file to load.\nBy default, will automatically search for an rc or config file to load","multiple":false},"input":{"name":"input","type":"option","char":"i","description":"An input directory to search for types to export","multiple":false,"default":"./dist"},"output":{"name":"output","type":"option","char":"o","description":"Output directory to write results to.","multiple":false},"lang":{"name":"lang","type":"option","char":"l","description":"Search strategy for types to export: plugin (default, looks for exported EnchancedPlayerPlugin classes) or type (all exported types)","helpValue":"(TypeScript)","multiple":false,"options":["TypeScript"]}},"args":[],"_globalFlags":{}}}}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@player-tools/cli",
+  "version": "0.0.2-next.0",
+  "private": false,
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "peerDependencies": {},
+  "dependencies": {
+    "@babel/core": "^7.15.5",
+    "@babel/preset-env": "^7.15.6",
+    "@babel/preset-react": "^7.14.5",
+    "@babel/preset-typescript": "^7.15.0",
+    "@babel/plugin-transform-react-jsx-source": "^7.18.6",
+    "@babel/register": "^7.17.7",
+    "@types/babel__register": "^7.17.0",
+    "@oclif/core": "1.9.0",
+    "@oclif/plugin-legacy": "^1.2.7",
+    "chalk": "^4.0.1",
+    "cosmiconfig": "^7.0.1",
+    "cross-fetch": "^3.0.5",
+    "elegant-spinner": "^2.0.0",
+    "figures": "^3.0.0",
+    "globby": "^11.0.1",
+    "log-symbols": "^4.0.0",
+    "log-update": "^4.0.0",
+    "mkdirp": "^1.0.4",
+    "vscode-languageserver-textdocument": "^1.0.1",
+    "vscode-languageserver-types": "^3.15.1",
+    "@player-tools/dsl": "0.0.2-next.0",
+    "@player-tools/language-service": "0.0.2-next.0",
+    "@player-tools/xlr-sdk": "0.0.2-next.0",
+    "@player-tools/xlr-utils": "0.0.2-next.0",
+    "@player-tools/xlr-converters": "0.0.2-next.0"
+  },
+  "main": "./dist/index.js",
+  "module": "dist/index.esm.js",
+  "typings": "dist/index.d.ts",
+  "files": [
+    "bin",
+    "dist",
+    "oclif.manifest.json"
+  ],
+  "oclif": {
+    "bin": "player",
+    "dirname": "player",
+    "topicSeparator": " ",
+    "commands": "./dist/commands"
+  },
+  "bin": {
+    "player": "bin/run"
+  }
+}