@player-tools/cli 0.4.0-next.4 → 0.4.0-next.5

package/dist/commands/dsl/compile.js

@@ -24,6 +24,7 @@ const mkdirp_1 = __importDefault(require("mkdirp"));
 const log_symbols_1 = __importDefault(require("log-symbols"));
 const figures_1 = __importDefault(require("figures"));
 const chalk_1 = __importDefault(require("chalk"));
+const dsl_1 = require("@player-tools/dsl");
 const base_command_1 = require("../../utils/base-command");
 const fs_2 = require("../../utils/fs");
 const babel_register_1 = require("../../utils/babel-register");
@@ -59,7 +60,7 @@ class DSLCompile extends base_command_1.BaseCommand {
             const results = {
                 exitCode: 0,
             };
-            const compiler = yield this.createDSLCompiler();
+            const context = yield this.createCompilerContext();
             /** Compile a file from the DSL format into JSON */
             const compileFile = (file) => __awaiter(this, void 0, void 0, function* () {
                 const requiredModule = require(path_1.default.resolve(file));
@@ -67,21 +68,37 @@ class DSLCompile extends base_command_1.BaseCommand {
                 if (!defaultExport) {
                     return;
                 }
+                const preProcessedValue = yield context.dslCompiler.hooks.preProcessFlow.call(defaultExport);
+                const contentType = (yield context.hooks.identifyContentType.call(file, preProcessedValue)) ||
+                    (0, dsl_1.fingerprintContent)(preProcessedValue, file) ||
+                    'unknown';
                 let relativePath = path_1.default.relative(input, file);
                 if (!relativePath) {
                     relativePath = path_1.default.basename(file);
                 }
                 const outputFile = path_1.default.join(output, path_1.default.format(Object.assign(Object.assign({}, path_1.default.parse(relativePath)), { base: undefined, ext: '.json' })));
-                this.log(`${log_symbols_1.default.info} Compiling %s ${figures_1.default.arrowRight} %s`, (0, fs_2.normalizePath)(file), (0, fs_2.normalizePath)(outputFile));
-                const { value, contentType } = yield compiler.serialize(defaultExport);
-                const contentStr = JSON.stringify(value, null, 2);
-                yield (0, mkdirp_1.default)(path_1.default.dirname(outputFile));
-                yield fs_1.promises.writeFile(outputFile, contentStr);
-                return {
-                    contentType,
-                    outputFile,
-                    inputFile: file,
-                };
+                this.log(`${log_symbols_1.default.info} Compiling %s ${figures_1.default.arrowRight} %s as type %s`, (0, fs_2.normalizePath)(file), (0, fs_2.normalizePath)(outputFile), contentType);
+                const compileResult = yield context.hooks.compileContent.call({ type: contentType }, defaultExport, file);
+                if (compileResult) {
+                    const contentStr = JSON.stringify(compileResult.value, null, 2);
+                    yield (0, mkdirp_1.default)(path_1.default.dirname(outputFile));
+                    yield fs_1.promises.writeFile(outputFile, contentStr);
+                    if (compileResult.sourceMap) {
+                        yield fs_1.promises.writeFile(`${outputFile}.map`, compileResult.sourceMap);
+                    }
+                    if (contentType) {
+                        return {
+                            contentType,
+                            outputFile,
+                            inputFile: file,
+                        };
+                    }
+                    return {
+                        contentType,
+                        outputFile,
+                        inputFile: file,
+                    };
+                }
             });
             const compilerResults = [];
             // This has to be done serially b/c of the way React logs messages to console.error
@@ -97,8 +114,8 @@ class DSLCompile extends base_command_1.BaseCommand {
                 }
                 catch (e) {
                     results.exitCode = 100;
-                    console.log('');
-                    console.log(chalk_1.default.red(`${log_symbols_1.default.error} Error compiling ${file}: ${e.message}`));
+                    this.log('');
+                    this.log(chalk_1.default.red(`${log_symbols_1.default.error} Error compiling ${file}: ${e.message}`));
                     this.debug(e);
                     compilerResults.push({
                         state: 'completed',
@@ -106,7 +123,7 @@ class DSLCompile extends base_command_1.BaseCommand {
                     });
                 }
             }
-            yield compiler.hooks.onEnd.call({ output });
+            yield context.dslCompiler.hooks.onEnd.call({ output });
             if (!skipValidation) {
                 console.log('');
                 const hasOutput = compilerResults.some((r) => { var _a; return ((_a = r.output) === null || _a === void 0 ? void 0 : _a.contentType) === 'flow'; });

package/dist/index.d.ts

@@ -2,4 +2,5 @@ export { run } from '@oclif/core';
 export * from './config';
 export * from './plugins';
 export * from './utils/base-command';
+export * from './utils/compilation-context';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -20,3 +20,4 @@ Object.defineProperty(exports, "run", { enumerable: true, get: function () { ret
 __exportStar(require("./config"), exports);
 __exportStar(require("./plugins"), exports);
 __exportStar(require("./utils/base-command"), exports);
+__exportStar(require("./utils/compilation-context"), exports);

package/dist/plugins/index.d.ts

@@ -2,6 +2,7 @@ import type { PlayerLanguageService } from '@player-tools/json-language-service'
 import type { DSLCompiler } from '@player-tools/dsl';
 import type { ExportTypes } from '@player-tools/xlr-sdk';
 import type { TransformFunction } from '@player-tools/xlr';
+import type { CompilationContext } from '../utils/compilation-context';
 export * from './LSPAssetsPlugin';
 export interface PlayerCLIPlugin {
     /**
@@ -19,6 +20,10 @@ export interface PlayerCLIPlugin {
      * Append the transforms to apply to the passed in array based on the provided format
      */
     onConvertXLR?: (format: ExportTypes, transforms: Array<TransformFunction>) => void | Promise<void>;
+    /**
+     * Handler to expose hooks that influence how content is compiled
+     */
+    createCompilerContext?: (context: CompilationContext) => void | Promise<void>;
 }
 export declare type PlayerCLIClass = {
     new (): PlayerCLIPlugin;

package/dist/utils/base-command.d.ts

@@ -4,6 +4,7 @@ import { DSLCompiler } from '@player-tools/dsl';
 import type { ExportTypes } from '@player-tools/xlr-sdk';
 import type { TransformFunction } from '@player-tools/xlr';
 import type { PlayerConfigResolvedShape } from '../config';
+import { CompilationContext } from './compilation-context';
 /** The common configs for all  */
 export declare abstract class BaseCommand extends Command {
     static flags: {
@@ -18,6 +19,7 @@ export declare abstract class BaseCommand extends Command {
     createLanguageService(exp: boolean): Promise<PlayerLanguageService>;
     createDSLCompiler(): Promise<DSLCompiler>;
     getXLRTransforms(format: ExportTypes): Promise<Array<TransformFunction>>;
+    createCompilerContext(): Promise<CompilationContext>;
     exit(code?: number): void;
 }
 //# sourceMappingURL=base-command.d.ts.map

package/dist/utils/base-command.js

@@ -21,6 +21,7 @@ const path_1 = __importDefault(require("path"));
 const cosmiconfig_1 = require("cosmiconfig");
 const json_language_service_1 = require("@player-tools/json-language-service");
 const dsl_1 = require("@player-tools/dsl");
+const compilation_context_1 = require("./compilation-context");
 const configLoader = (0, cosmiconfig_1.cosmiconfig)('player');
 /** The common configs for all  */
 class BaseCommand extends core_1.Command {
@@ -151,6 +152,18 @@ class BaseCommand extends core_1.Command {
             return transforms;
         });
     }
+    createCompilerContext() {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const compilerContext = new compilation_context_1.CompilationContext(yield this.createDSLCompiler());
+            const { plugins } = yield this.getPlayerConfig();
+            for (let i = 0; i < plugins.length; i++) {
+                // eslint-disable-next-line no-await-in-loop
+                yield ((_b = (_a = plugins[i]).createCompilerContext) === null || _b === void 0 ? void 0 : _b.call(_a, compilerContext));
+            }
+            return compilerContext;
+        });
+    }
     exit(code) {
         if (process.env.NODE_ENV !== 'test') {
             super.exit(code);

package/dist/utils/compilation-context.d.ts

@@ -0,0 +1,31 @@
+import type { DSLCompiler, CompilerReturn, SerializeContext } from '@player-tools/dsl';
+import { AsyncSeriesBailHook } from 'tapable-ts';
+/**
+ *
+ */
+export declare class CompilationContext {
+    /** Hooks to wrap the context of the compilation */
+    hooks: {
+        /**
+         * Function for determining a specific or desired content type given on the file contents or other conditions
+         *
+         * @param fileName - The relative name of the file
+         * @param content - The contents in the file
+         * @returns string with the content type.
+         */
+        identifyContentType: AsyncSeriesBailHook<[string, any], string, Record<string, any>>;
+        /**
+         * Function for returning the compile content given an specific type or condition
+         *
+         * @param context - Settings for the content to be compiled, such as type
+         * @param content - The contents in the file
+         * @param fileName - The relative name of the file
+         * @returns CompilerReturn object instance or undefined
+         */
+        compileContent: AsyncSeriesBailHook<[SerializeContext, any, string], CompilerReturn, Record<string, any>>;
+    };
+    /** A DSL compiler instance */
+    dslCompiler: DSLCompiler;
+    constructor(dslCompiler: DSLCompiler);
+}
+//# sourceMappingURL=compilation-context.d.ts.map

package/dist/utils/compilation-context.js

@@ -0,0 +1,48 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CompilationContext = void 0;
+const dsl_1 = require("@player-tools/dsl");
+const tapable_ts_1 = require("tapable-ts");
+/**
+ *
+ */
+class CompilationContext {
+    constructor(dslCompiler) {
+        /** Hooks to wrap the context of the compilation */
+        this.hooks = {
+            /**
+             * Function for determining a specific or desired content type given on the file contents or other conditions
+             *
+             * @param fileName - The relative name of the file
+             * @param content - The contents in the file
+             * @returns string with the content type.
+             */
+            identifyContentType: new tapable_ts_1.AsyncSeriesBailHook(),
+            /**
+             * Function for returning the compile content given an specific type or condition
+             *
+             * @param context - Settings for the content to be compiled, such as type
+             * @param content - The contents in the file
+             * @param fileName - The relative name of the file
+             * @returns CompilerReturn object instance or undefined
+             */
+            compileContent: new tapable_ts_1.AsyncSeriesBailHook(),
+        };
+        this.dslCompiler = dslCompiler;
+        this.hooks.compileContent.tap('default', ({ type }, content) => __awaiter(this, void 0, void 0, function* () {
+            if ((0, dsl_1.isDefaultCompilerContentType)(type)) {
+                return this.dslCompiler.serialize(content, { type });
+            }
+        }));
+    }
+}
+exports.CompilationContext = CompilationContext;

package/dist/utils/fs.js

@@ -6,16 +6,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.normalizePath = exports.convertToFileGlob = void 0;
 const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
+/** To handle globby issue on windows https://github.com/sindresorhus/globby/issues/152 */
+function forcePathSeparatorToPosix(input) {
+    return path_1.default.sep === path_1.default.win32.sep
+        ? input.split(path_1.default.sep).join(path_1.default.posix.sep)
+        : input;
+}
 /** 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);
+                return forcePathSeparatorToPosix(path_1.default.join(i, glob));
             }
         }
         catch (e) { }
-        return i;
+        return forcePathSeparatorToPosix(i);
     });
 };
 exports.convertToFileGlob = convertToFileGlob;

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.4.0-next.4","commands":{"dsl:compile":{"id":"dsl:compile","description":"Compile Player DSL files into JSON","strict":false,"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":false,"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":false,"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":false,"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":{}}}}
+{"version":"0.4.0-next.5","commands":{"dsl:compile":{"id":"dsl:compile","description":"Compile Player DSL files into JSON","strict":false,"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":false,"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":false,"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":false,"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

@@ -1,6 +1,6 @@
 {
   "name": "@player-tools/cli",
-  "version": "0.4.0-next.4",
+  "version": "0.4.0-next.5",
   "private": false,
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
@@ -8,6 +8,8 @@
   "peerDependencies": {},
   "dependencies": {
     "@babel/core": "^7.15.5",
+    "react": "^17.0.2",
+    "tapable-ts": "^0.2.4",
     "@babel/preset-env": "^7.15.6",
     "@babel/preset-react": "^7.14.5",
     "@babel/preset-typescript": "^7.15.0",
@@ -28,11 +30,11 @@
     "vscode-languageserver-textdocument": "^1.0.1",
     "vscode-languageserver-types": "^3.15.1",
     "typescript": "4.8.4",
-    "@player-tools/dsl": "0.4.0-next.4",
-    "@player-tools/json-language-service": "0.4.0-next.4",
-    "@player-tools/xlr-sdk": "0.4.0-next.4",
-    "@player-tools/xlr-utils": "0.4.0-next.4",
-    "@player-tools/xlr-converters": "0.4.0-next.4"
+    "@player-tools/dsl": "0.4.0-next.5",
+    "@player-tools/json-language-service": "0.4.0-next.5",
+    "@player-tools/xlr-sdk": "0.4.0-next.5",
+    "@player-tools/xlr-utils": "0.4.0-next.5",
+    "@player-tools/xlr-converters": "0.4.0-next.5"
   },
   "main": "./dist/index.js",
   "module": "dist/index.esm.js",