@steambrew/ttc 2.4.3 → 2.5.3

package/dist/index.js

@@ -69,10 +69,18 @@ const Logger = {
  * @brief print the parameter list to the stdout
  */
 const PrintParamHelp = () => {
-    console.log("millennium-ttc parameter list:" +
-        "\n\t" + chalk.magenta("--help") + ": display parameter list" +
-        "\n\t" + chalk.bold.red("--build") + ": " + chalk.bold.red("(required)") + ": build type [dev, prod] (prod minifies code)" +
-        "\n\t" + chalk.magenta("--target") + ": path to plugin, default to cwd");
+    console.log('millennium-ttc parameter list:' +
+        '\n\t' +
+        chalk.magenta('--help') +
+        ': display parameter list' +
+        '\n\t' +
+        chalk.bold.red('--build') +
+        ': ' +
+        chalk.bold.red('(required)') +
+        ': build type [dev, prod] (prod minifies code)' +
+        '\n\t' +
+        chalk.magenta('--target') +
+        ': path to plugin, default to cwd');
 };
 var BuildType;
 (function (BuildType) {
@@ -81,24 +89,24 @@ var BuildType;
 })(BuildType || (BuildType = {}));
 const ValidateParameters = (args) => {
     let typeProp = BuildType.DevBuild, targetProp = process.cwd();
-    if (args.includes("--help")) {
+    if (args.includes('--help')) {
         PrintParamHelp();
         process.exit();
     }
     // startup args are invalid
-    if (!args.includes("--build")) {
-        Logger.Error("Received invalid arguments...");
+    if (!args.includes('--build')) {
+        Logger.Error('Received invalid arguments...');
         PrintParamHelp();
         process.exit();
     }
     for (let i = 0; i < args.length; i++) {
-        if (args[i] === "--build") {
+        if (args[i] === '--build') {
             const BuildMode = args[i + 1];
             switch (BuildMode) {
-                case "dev":
+                case 'dev':
                     typeProp = BuildType.DevBuild;
                     break;
-                case "prod":
+                case 'prod':
                     typeProp = BuildType.ProdBuild;
                     break;
                 default: {
@@ -107,7 +115,7 @@ const ValidateParameters = (args) => {
                 }
             }
         }
-        if (args[i] == "--target") {
+        if (args[i] == '--target') {
             if (args[i + 1] === undefined) {
                 Logger.Error('--target parameter must be preceded by system path');
                 process.exit();
@@ -117,7 +125,7 @@ const ValidateParameters = (args) => {
     }
     return {
         type: typeProp,
-        targetPlugin: targetProp
+        targetPlugin: targetProp,
     };
 };
 
@@ -149,13 +157,13 @@ const CheckForUpdates = async () => {
 const ValidatePlugin = (target) => {
     return new Promise((resolve, reject) => {
         if (!existsSync(target)) {
-            console.error(chalk.red.bold(`\n[-] --target [${target}] `) + chalk.red("is not a valid system path"));
+            console.error(chalk.red.bold(`\n[-] --target [${target}] `) + chalk.red('is not a valid system path'));
             reject();
             return;
         }
-        const pluginModule = path$2.join(target, "plugin.json");
+        const pluginModule = path$2.join(target, 'plugin.json');
         if (!existsSync(pluginModule)) {
-            console.error(chalk.red.bold(`\n[-] --target [${target}] `) + chalk.red("is not a valid plugin (missing plugin.json)"));
+            console.error(chalk.red.bold(`\n[-] --target [${target}] `) + chalk.red('is not a valid plugin (missing plugin.json)'));
             reject();
             return;
         }
@@ -166,7 +174,7 @@ const ValidatePlugin = (target) => {
                 return;
             }
             try {
-                if (!("name" in JSON.parse(data))) {
+                if (!('name' in JSON.parse(data))) {
                     console.error(chalk.red.bold(`\n[-] target plugin doesn't contain "name" in plugin.json [${pluginModule}]`));
                     reject();
                 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@steambrew/ttc",
-	"version": "2.4.3",
+	"version": "2.5.3",
 	"type": "module",
 	"main": "dist/index.js",
 	"module": "dist/index.js",

package/rollup.config.js

@@ -4,7 +4,7 @@ import json from '@rollup/plugin-json';
 import nodeResolve from '@rollup/plugin-node-resolve';
 
 export default {
-	input: 'index.ts',
+	input: 'src/index.ts',
 	context: 'window',
 	output: {
 		file: 'dist/index.js',

package/src/check-health.ts

@@ -0,0 +1,41 @@
+import chalk from 'chalk';
+import path from 'path';
+import { existsSync, readFile } from 'fs';
+
+export const ValidatePlugin = (target: string): Promise<any> => {
+	return new Promise<any>((resolve, reject) => {
+		if (!existsSync(target)) {
+			console.error(chalk.red.bold(`\n[-] --target [${target}] `) + chalk.red('is not a valid system path'));
+			reject();
+			return;
+		}
+
+		const pluginModule = path.join(target, 'plugin.json');
+
+		if (!existsSync(pluginModule)) {
+			console.error(chalk.red.bold(`\n[-] --target [${target}] `) + chalk.red('is not a valid plugin (missing plugin.json)'));
+			reject();
+			return;
+		}
+
+		readFile(pluginModule, 'utf8', (err, data) => {
+			if (err) {
+				console.error(chalk.red.bold(`\n[-] couldn't read plugin.json from [${pluginModule}]`));
+				reject();
+				return;
+			}
+
+			try {
+				if (!('name' in JSON.parse(data))) {
+					console.error(chalk.red.bold(`\n[-] target plugin doesn't contain "name" in plugin.json [${pluginModule}]`));
+					reject();
+				} else {
+					resolve(JSON.parse(data));
+				}
+			} catch (parseError) {
+				console.error(chalk.red.bold(`\n[-] couldn't parse JSON in plugin.json from [${pluginModule}]`));
+				reject();
+			}
+		});
+	});
+};

package/{index.ts → src/index.ts}

@@ -5,10 +5,10 @@
  * - typescript transpiler
  * - rollup configurator
  */
-import { BuildType, ValidateParameters } from './Parameters';
-import { CheckForUpdates } from './VersionMon';
-import { ValidatePlugin } from './Linter';
-import { TranspilerPluginComponent, TranspilerProps } from './Compiler';
+import { BuildType, ValidateParameters } from './query-parser';
+import { CheckForUpdates } from './version-control';
+import { ValidatePlugin } from './check-health';
+import { TranspilerPluginComponent, TranspilerProps } from './transpiler';
 import { performance } from 'perf_hooks';
 import chalk from 'chalk';
 // import { Logger } from './Logger'

package/src/query-parser.ts

@@ -0,0 +1,82 @@
+import chalk from 'chalk';
+import { Logger } from './logger';
+
+/***
+ * @brief print the parameter list to the stdout
+ */
+export const PrintParamHelp = () => {
+	console.log(
+		'millennium-ttc parameter list:' +
+			'\n\t' +
+			chalk.magenta('--help') +
+			': display parameter list' +
+			'\n\t' +
+			chalk.bold.red('--build') +
+			': ' +
+			chalk.bold.red('(required)') +
+			': build type [dev, prod] (prod minifies code)' +
+			'\n\t' +
+			chalk.magenta('--target') +
+			': path to plugin, default to cwd',
+	);
+};
+
+export enum BuildType {
+	DevBuild,
+	ProdBuild,
+}
+
+export interface ParameterProps {
+	type: BuildType;
+	targetPlugin: string; // path
+}
+
+export const ValidateParameters = (args: Array<string>): ParameterProps => {
+	let typeProp: BuildType = BuildType.DevBuild,
+		targetProp: string = process.cwd();
+
+	if (args.includes('--help')) {
+		PrintParamHelp();
+		process.exit();
+	}
+
+	// startup args are invalid
+	if (!args.includes('--build')) {
+		Logger.Error('Received invalid arguments...');
+		PrintParamHelp();
+		process.exit();
+	}
+
+	for (let i = 0; i < args.length; i++) {
+		if (args[i] === '--build') {
+			const BuildMode: string = args[i + 1];
+
+			switch (BuildMode) {
+				case 'dev':
+					typeProp = BuildType.DevBuild;
+					break;
+				case 'prod':
+					typeProp = BuildType.ProdBuild;
+					break;
+				default: {
+					Logger.Error('--build parameter must be preceded by build type [dev, prod]');
+					process.exit();
+				}
+			}
+		}
+
+		if (args[i] == '--target') {
+			if (args[i + 1] === undefined) {
+				Logger.Error('--target parameter must be preceded by system path');
+				process.exit();
+			}
+
+			targetProp = args[i + 1];
+		}
+	}
+
+	return {
+		type: typeProp,
+		targetPlugin: targetProp,
+	};
+};

package/{Compiler.ts → src/transpiler.ts}

@@ -13,13 +13,13 @@ import scss from 'rollup-plugin-scss';
 import * as sass from 'sass';
 
 import chalk from 'chalk';
-import { Logger } from './Logger';
+import { Logger } from './logger';
 import fs from 'fs';
 
 import injectProcessEnv from 'rollup-plugin-inject-process-env';
 import dotenv from 'dotenv';
-import { ExecutePluginModule, InitializePlugins } from './PluginSetup';
-import constSysfsExpr from './StaticEmbed';
+import { ExecutePluginModule, InitializePlugins } from './plugin-api';
+import constSysfsExpr from './static-embed';
 
 const envConfig = dotenv.config().parsed || {};
 

package/{VersionMon.ts → src/version-control.ts}

@@ -2,7 +2,7 @@ import path from 'path';
 import { fileURLToPath } from 'url';
 import { readFile } from 'fs/promises';
 import { dirname } from 'path';
-import { Logger } from './Logger';
+import { Logger } from './logger';
 
 export const CheckForUpdates = async (): Promise<boolean> => {
 	return new Promise<boolean>(async (resolve) => {

package/tsconfig.json

@@ -1,24 +1,23 @@
 {
-    "compilerOptions": {
-      "outDir": "dist",
-      "module": "ESNext",
-      "target": "ES2020",
-      "jsx": "react",
-      "jsxFactory": "window.SP_REACT.createElement",
-      "declaration": false,
-      "moduleResolution": "node",
-      "noUnusedLocals": true,
-      "noUnusedParameters": true,
-      "esModuleInterop": true,
-      "noImplicitReturns": true,
-      "noImplicitThis": true,
-      "noImplicitAny": true,
-      "strict": true,
-      "ignoreDeprecations": "5.0",
-      "allowSyntheticDefaultImports": true,
-      "skipLibCheck": true
-    },
-    "include": ["./"],
-    "exclude": ["node_modules"]
+	"compilerOptions": {
+		"outDir": "dist",
+		"module": "ESNext",
+		"target": "ES2020",
+		"jsx": "react",
+		"jsxFactory": "window.SP_REACT.createElement",
+		"declaration": false,
+		"moduleResolution": "node",
+		"noUnusedLocals": true,
+		"noUnusedParameters": true,
+		"esModuleInterop": true,
+		"noImplicitReturns": true,
+		"noImplicitThis": true,
+		"noImplicitAny": true,
+		"strict": true,
+		"ignoreDeprecations": "5.0",
+		"allowSyntheticDefaultImports": true,
+		"skipLibCheck": true
+	},
+	"include": ["./src/**/*"],
+	"exclude": ["node_modules"]
 }
-  

package/Linter.ts

@@ -1,44 +0,0 @@
-import chalk from 'chalk'
-import path from 'path'
-import { existsSync, readFile } from 'fs'
-
-export const ValidatePlugin = (target: string): Promise<any> => {
-
-    return new Promise<any>((resolve, reject) => {
-        if (!existsSync(target)) {
-            console.error(chalk.red.bold(`\n[-] --target [${target}] `) + chalk.red("is not a valid system path"))
-            reject() 
-            return
-        }
-        
-        const pluginModule = path.join(target, "plugin.json")
-        
-        if (!existsSync(pluginModule)) {
-            console.error(chalk.red.bold(`\n[-] --target [${target}] `) + chalk.red("is not a valid plugin (missing plugin.json)"))
-            reject()
-            return
-        }
-        
-        readFile(pluginModule, 'utf8', (err, data) => {
-            if (err) {
-                console.error(chalk.red.bold(`\n[-] couldn't read plugin.json from [${pluginModule}]`))
-                reject()
-                return
-            }
-        
-            try {
-                if (!("name" in JSON.parse(data))) {
-                    console.error(chalk.red.bold(`\n[-] target plugin doesn't contain "name" in plugin.json [${pluginModule}]`))
-                    reject()
-                }
-                else {
-                    resolve(JSON.parse(data)) 
-                }
-            } 
-            catch (parseError) {
-                console.error(chalk.red.bold(`\n[-] couldn't parse JSON in plugin.json from [${pluginModule}]`))
-                reject()
-            }
-        });
-    })
-}

package/Parameters.ts

@@ -1,72 +0,0 @@
-import chalk from 'chalk'
-import { Logger } from "./Logger"
-
-/***
- * @brief print the parameter list to the stdout
- */
-export const PrintParamHelp = () => {
-
-    console.log(
-        "millennium-ttc parameter list:" +
-        "\n\t" + chalk.magenta("--help") + ": display parameter list" +
-        "\n\t" + chalk.bold.red("--build") + ": " + chalk.bold.red("(required)") + ": build type [dev, prod] (prod minifies code)" +
-        "\n\t" + chalk.magenta("--target") + ": path to plugin, default to cwd"
-    );
-}
-
-export enum BuildType {
-    DevBuild, ProdBuild
-}
-
-export interface ParameterProps {
-    type: BuildType, 
-    targetPlugin: string // path
-}
-
-export const ValidateParameters = (args: Array<string>): ParameterProps => {
-
-    let typeProp: BuildType = BuildType.DevBuild, targetProp: string = process.cwd()
-
-    if (args.includes("--help")) {
-        PrintParamHelp()
-        process.exit();
-    }
-    
-    // startup args are invalid
-    if (!args.includes("--build")) {
-        Logger.Error("Received invalid arguments...");
-        PrintParamHelp();
-        process.exit();
-    }
-    
-    for (let i = 0; i < args.length; i++) 
-    {
-        if (args[i] === "--build") 
-        {
-            const BuildMode: string = args[i + 1]
-
-            switch (BuildMode) {
-                case "dev": typeProp = BuildType.DevBuild; break
-                case "prod": typeProp = BuildType.ProdBuild; break
-                default: {
-                    Logger.Error('--build parameter must be preceded by build type [dev, prod]');
-                    process.exit();
-                }
-            }
-        }
-    
-        if (args[i] == "--target") {
-            if (args[i + 1] === undefined) {
-                Logger.Error('--target parameter must be preceded by system path');
-                process.exit();
-            }
-
-            targetProp = args[i + 1]
-        }
-    }
-
-    return {
-        type: typeProp,
-        targetPlugin: targetProp
-    }
-}