kist 0.0.0 → 0.1.31

package/ts/actions/JavaScriptMinifyAction/terser.config.ts

@@ -0,0 +1,177 @@
+// ============================================================================
+// Import
+// ============================================================================
+
+// ============================================================================
+// Constants
+// ============================================================================
+
+// https://terser.org/docs/api-reference/
+
+const terserConfig = {
+    parse: {
+        // parse options
+    },
+    compress: {
+        // compress options
+        drop_console: true, // Remove console.log statements
+        drop_debugger: true, // Remove debugger statements
+        pure_funcs: ["console.info", "console.debug", "console.warn"], // Remove specific console functions
+
+        // defaults (default: true) -- Pass false to disable most default enabled compress transforms. Useful when you only want to enable a few compress options while disabling the rest.
+
+        // Class and object literal methods are converted will also be
+        // converted to arrow expressions if the resultant code is shorter:
+        // m(){return x} becomes m:()=>x. To do this to regular ES5 functions
+        // which don't use this or arguments, see unsafe_arrows.
+        arrows: true, // (default: true)
+
+        // arguments (default: false) -- replace arguments[index] with function parameter name whenever possible.
+
+        // booleans (default: true) -- various optimizations for boolean context, for example !!a ? b : c → a ? b : c
+
+        // booleans_as_integers (default: false) -- Turn booleans into 0 and 1, also makes comparisons with booleans use == and != instead of === and !==.
+
+        // collapse_vars (default: true) -- Collapse single-use non-constant variables, side effects permitting.
+
+        // comparisons (default: true) -- apply certain optimizations to binary nodes, e.g. !(a <= b) → a > b (only when unsafe_comps), attempts to negate binary nodes, e.g. a = !b && !c && !d && !e → a=!(b||c||d||e) etc. Note: comparisons works best with lhs_constants enabled.
+
+        // computed_props (default: true) -- Transforms constant computed properties into regular ones: {["computed"]: 1} is converted to {computed: 1}.
+
+        // conditionals (default: true) -- apply optimizations for if-s and conditional expressions
+
+        // dead_code (default: true) -- remove unreachable code
+
+        // directives (default: true) -- remove redundant or non-standard directives
+
+        // drop_console (default: false) -- Pass true to discard calls to console.* functions. If you only want to discard a portion of console, you can pass an array like this ['log', 'info'], which will only discard console.log、 console.info.
+
+        // drop_debugger (default: true) -- remove debugger; statements
+
+        // ecma (default: 5) -- Pass 2015 or greater to enable compress options that will transform ES5 code into smaller ES6+ equivalent forms.
+
+        // evaluate (default: true) -- attempt to evaluate constant expressions
+
+        // expression (default: false) -- Pass true to preserve completion values from terminal statements without return, e.g. in bookmarklets.
+
+        // global_defs (default: {}) -- see conditional compilation
+
+        // hoist_funs (default: false) -- hoist function declarations
+
+        // hoist_props (default: true) -- hoist properties from constant object and array literals into regular variables subject to a set of constraints. For example: var o={p:1, q:2}; f(o.p, o.q); is converted to f(1, 2);. Note: hoist_props works best with mangle enabled, the compress option passes set to 2 or higher, and the compress option toplevel enabled.
+
+        // hoist_vars (default: false) -- hoist var declarations (this is false by default because it seems to increase the size of the output in general)
+
+        // if_return (default: true) -- optimizations for if/return and if/continue
+
+        // inline (default: true) -- inline calls to function with simple/return statement:
+
+        // false -- same as 0
+        // 0 -- disabled inlining
+        // 1 -- inline simple functions
+        // 2 -- inline functions with arguments
+        // 3 -- inline functions with arguments and variables
+        // true -- same as 3
+        // join_vars (default: true) -- join consecutive var, let and const statements
+
+        // keep_classnames (default: false) -- Pass true to prevent the compressor from discarding class names. Pass a regular expression to only keep class names matching that regex. See also: the keep_classnames mangle option.
+
+        // keep_fargs (default: true) -- Prevents the compressor from discarding unused function arguments. You need this for code which relies on Function.length.
+
+        // keep_fnames (default: false) -- Pass true to prevent the compressor from discarding function names. Pass a regular expression to only keep function names matching that regex. Useful for code relying on Function.prototype.name. See also: the keep_fnames mangle option.
+
+        // keep_infinity (default: false) -- Pass true to prevent Infinity from being compressed into 1/0, which may cause performance issues on Chrome.
+
+        // lhs_constants (default: true) -- Moves constant values to the left-hand side of binary nodes. foo == 42 → 42 == foo
+
+        // loops (default: true) -- optimizations for do, while and for loops when we can statically determine the condition.
+
+        // module (default false) -- Pass true when compressing an ES6 module. Strict mode is implied and the toplevel option as well.
+
+        // negate_iife (default: true) -- negate "Immediately-Called Function Expressions" where the return value is discarded, to avoid the parens that the code generator would insert.
+
+        // passes (default: 1) -- The maximum number of times to run compress. In some cases more than one pass leads to further compressed code. Keep in mind more passes will take more time.
+
+        // properties (default: true) -- rewrite property access using the dot notation, for example foo["bar"] → foo.bar
+
+        // pure_funcs (default: null) -- You can pass an array of names and Terser will assume that those functions do not produce side effects. DANGER: will not check if the name is redefined in scope. An example case here, for instance var q = Math.floor(a/b). If variable q is not used elsewhere, Terser will drop it, but will still keep the Math.floor(a/b), not knowing what it does. You can pass pure_funcs: [ 'Math.floor' ] to let it know that this function won't produce any side effect, in which case the whole statement would get discarded. The current implementation adds some overhead (compression will be slower).
+
+        // pure_getters (default: "strict") -- If you pass true for this, Terser will assume that object property access (e.g. foo.bar or foo["bar"]) doesn't have any side effects. Specify "strict" to treat foo.bar as side-effect-free only when foo is certain to not throw, i.e. not null or undefined.
+
+        // pure_new (default: false) -- Set to true to assume new X() never has side effects.
+
+        // reduce_vars (default: true) -- Improve optimization on variables assigned with and used as constant values.
+
+        // reduce_funcs (default: true) -- Inline single-use functions when possible. Depends on reduce_vars being enabled. Disabling this option sometimes improves performance of the output code.
+
+        // sequences (default: true) -- join consecutive simple statements using the comma operator. May be set to a positive integer to specify the maximum number of consecutive comma sequences that will be generated. If this option is set to true then the default sequences limit is 200. Set option to false or 0 to disable. The smallest sequences length is 2. A sequences value of 1 is grandfathered to be equivalent to true and as such means 200. On rare occasions the default sequences limit leads to very slow compress times in which case a value of 20 or less is recommended.
+
+        // side_effects (default: true) -- Remove expressions which have no side effects and whose results aren't used.
+
+        // switches (default: true) -- de-duplicate and remove unreachable switch branches
+
+        // toplevel (default: false) -- drop unreferenced functions ("funcs") and/or variables ("vars") in the top level scope (false by default, true to drop both unreferenced functions and variables)
+
+        // top_retain (default: null) -- prevent specific toplevel functions and variables from unused removal (can be array, comma-separated, RegExp or function. Implies toplevel)
+
+        // typeofs (default: true) -- Transforms typeof foo == "undefined" into foo === void 0. Note: recommend to set this value to false for IE10 and earlier versions due to known issues.
+
+        // unsafe (default: false) -- apply "unsafe" transformations (details).
+
+        // unsafe_arrows (default: false) -- Convert ES5 style anonymous function expressions to arrow functions if the function body does not reference this. Note: it is not always safe to perform this conversion if code relies on the the function having a prototype, which arrow functions lack. This transform requires that the ecma compress option is set to 2015 or greater.
+
+        // unsafe_comps (default: false) -- Reverse < and <= to > and >= to allow improved compression. This might be unsafe when an at least one of two operands is an object with computed values due the use of methods like get, or valueOf. This could cause change in execution order after operands in the comparison are switching. Compression only works if both comparisons and unsafe_comps are both set to true.
+
+        // unsafe_Function (default: false) -- compress and mangle Function(args, code) when both args and code are string literals.
+
+        // unsafe_math (default: false) -- optimize numerical expressions like 2 * x * 3 into 6 * x, which may give imprecise floating point results.
+
+        // unsafe_symbols (default: false) -- removes keys from native Symbol declarations, e.g Symbol("kDog") becomes Symbol().
+
+        // unsafe_methods (default: false) -- Converts { m: function(){} } to { m(){} }. ecma must be set to 6 or greater to enable this transform. If unsafe_methods is a RegExp then key/value pairs with keys matching the RegExp will be converted to concise methods. Note: if enabled there is a risk of getting a "<method name> is not a constructor" TypeError should any code try to new the former function.
+
+        // unsafe_proto (default: false) -- optimize expressions like Array.prototype.slice.call(a) into [].slice.call(a)
+
+        // unsafe_regexp (default: false) -- enable substitutions of variables with RegExp values the same way as if they are constants.
+
+        // unsafe_undefined (default: false) -- substitute void 0 if there is a variable named undefined in scope (variable name will be mangled, typically reduced to a single character)
+
+        // unused (default: true) -- drop unreferenced functions and variables (simple direct variable assignments do not count as references unless set to "keep_assign")
+    },
+    mangle: {
+        // mangle options
+        // Mangle names for obfuscation and size reduction
+        properties: true, // Mangle property names
+        // properties: {
+        //     // mangle property options // gives error messages
+        //     // bare_returns: false, //support top level return statements
+        //     html5_comments: true, // (default true)
+        //     shebang: true, //(default true) -- support #!command as the first line
+        //     spidermonkey: false, // (default false) -- accept a Spidermonkey (Mozilla) AST
+        // }
+    },
+    format: {
+        // format options (can also use `output` for backwards compatibility)
+        comments: false, // Remove comments to reduce file size
+        beautify: false, // Disable beautification for smaller file size
+    },
+    sourceMap: {
+        // source map options
+    },
+    // Define ECMAScript target version
+    ecma: 5, // specify one of: 5, 2015, 2016, etc.
+    enclose: false, // or specify true, or "args:values"
+    keep_classnames: false, // Remove class names
+    keep_fnames: false, // Remove function names
+    ie8: false,
+    module: false,
+    nameCache: null, // or specify a name cache object
+    safari10: false,
+    toplevel: true, // Enable top-level variable and function name mangling
+};
+
+// ============================================================================
+// Export
+// ============================================================================
+
+export default terserConfig;

package/ts/actions/LintAction/LintAction.ts

@@ -0,0 +1,67 @@
+// ============================================================================
+// Import
+// ============================================================================
+
+import { ESLint } from "eslint";
+import { Action } from "../../core/pipeline/Action";
+import { ActionOptionsType } from "../../types/ActionOptionsType";
+
+// ============================================================================
+// Classes
+// ============================================================================
+
+/**
+ * LintAction handles linting TypeScript and JavaScript files using ESLint.
+ * This action can be configured to run in strict mode or automatically fix issues.
+ */
+export class LintAction extends Action {
+    private eslint: ESLint;
+
+    constructor() {
+        super(); // Call the parent class constructor
+        this.eslint = new ESLint({}); // Initialize ESLint with default config
+    }
+
+    async execute(options: ActionOptionsType): Promise<void> {
+        const {
+            targetFiles = ["src/**/*.ts"],
+            fix = false,
+            configPath = ".eslintrc.js",
+        } = options;
+
+        if (!targetFiles || targetFiles.length === 0) {
+            throw new Error(
+                "Invalid options: 'targetFiles' is required and must contain at least one file or directory.",
+            );
+        }
+
+        this.logInfo(`Starting ESLint on: ${targetFiles.join(", ")}`);
+
+        try {
+            // Update ESLint instance with correct configuration
+            this.eslint = new ESLint({ fix, overrideConfigFile: configPath });
+            const results = await this.eslint.lintFiles(targetFiles);
+
+            if (fix) {
+                await ESLint.outputFixes(results);
+            }
+
+            const formatter = await this.eslint.loadFormatter("stylish");
+            console.log(formatter.format(results));
+
+            this.logInfo("ESLint linting completed successfully.");
+        } catch (error) {
+            this.logError("ESLint encountered an error.", error);
+            throw error;
+        }
+    }
+
+    /**
+     * Provides a description of the action.
+     *
+     * @returns A string description of the action.
+     */
+    describe(): string {
+        return "Runs ESLint on specified files and directories, with optional auto-fixing.";
+    }
+}

package/ts/actions/LintAction/index.ts

@@ -0,0 +1,11 @@
+// ============================================================================
+// Import
+// ============================================================================
+
+import { LintAction } from "./LintAction";
+
+// ============================================================================
+// Export
+// ============================================================================
+
+export { LintAction };

package/ts/actions/PackageManagerAction/PackageManagerAction.ts

@@ -0,0 +1,176 @@
+// ============================================================================
+// Import
+// ============================================================================
+
+import fs from "fs/promises";
+import path from "path";
+import { Action } from "../../core/pipeline/Action";
+import { ActionOptionsType } from "../../types/ActionOptionsType.js";
+import packageConfig from "./package.config.js";
+
+// ============================================================================
+// Classes
+// ============================================================================
+
+/**
+ * PackageManagerAction handles reading, validating, and creating `package.json`
+ * files, supporting custom configurations and merging with selected fields.
+ */
+export class PackageManagerAction extends Action {
+    /**
+     * Executes the package management action.
+     * Reads an existing `package.json`, extracts selected fields, and writes a new one.
+     *
+     * @param options - Options specifying input path, output directory, and fields to export.
+     * @returns A Promise that resolves when the action is completed successfully.
+     * @throws {Error} Throws an error if neither `packageJsonPath` nor `outputDir` is provided.
+     */
+    async execute(options: ActionOptionsType): Promise<void> {
+        const {
+            packageJsonPath,
+            outputDir,
+            fields = [], // Specify which fields to copy
+            customConfig = {},
+        } = options;
+
+        if (!packageJsonPath) {
+            throw new Error("The 'packageJsonPath' option is required.");
+        }
+        if (!outputDir) {
+            throw new Error("The 'outputDir' option is required.");
+        }
+
+        const existingConfig = await this.readPackageJson(packageJsonPath);
+        const filteredConfig = this.filterFields(existingConfig, fields);
+
+        await this.createPackageJson(outputDir, filteredConfig, customConfig);
+    }
+
+    /**
+     * Reads and parses an existing `package.json`.
+     *
+     * @param packageJsonPath - Path to the `package.json` file.
+     * @returns Parsed JSON object.
+     * @throws {Error} If the file does not exist or contains invalid JSON.
+     */
+    private async readPackageJson(
+        packageJsonPath: string,
+    ): Promise<Record<string, unknown>> {
+        const fullPath = path.resolve(packageJsonPath);
+
+        try {
+            const fileContent = await fs.readFile(fullPath, "utf-8");
+            const parsedContent = JSON.parse(fileContent);
+            this.logInfo(`Successfully read package.json from ${fullPath}`);
+            return parsedContent;
+        } catch (error: any) {
+            if (error.code === "ENOENT") {
+                throw new Error(
+                    `File not found at ${fullPath}. Please ensure the path is correct.`,
+                );
+            } else if (error.name === "SyntaxError") {
+                throw new Error(
+                    `Invalid JSON in ${fullPath}: ${error.message}`,
+                );
+            } else {
+                throw new Error(
+                    `Unexpected error while reading ${fullPath}: ${error.message}`,
+                );
+            }
+        }
+    }
+
+    /**
+     * Filters specified fields from a `package.json` object.
+     *
+     * @param config - The original package.json object.
+     * @param fields - List of fields to extract.
+     * @returns A new object containing only the selected fields.
+     */
+    private filterFields(
+        config: Record<string, unknown>,
+        fields: string[],
+    ): Record<string, unknown> {
+        if (!fields.length) {
+            return config; // If no fields are specified, return the full config.
+        }
+
+        const filteredConfig: Record<string, unknown> = {};
+        for (const field of fields) {
+            if (config[field] !== undefined) {
+                filteredConfig[field] = config[field];
+            }
+        }
+
+        this.logInfo(
+            `Filtered package.json fields: ${JSON.stringify(filteredConfig, null, 2)}`,
+        );
+        return filteredConfig;
+    }
+
+    /**
+     * Creates a `package.json` file with selected fields and custom overrides.
+     *
+     * @param outputDir - Directory where the new `package.json` will be created.
+     * @param filteredConfig - The filtered package.json fields.
+     * @param customConfig - Custom overrides to apply.
+     * @returns A Promise that resolves when the file has been successfully created.
+     * @throws {Error} If the file cannot be written.
+     */
+    private async createPackageJson(
+        outputDir: string,
+        filteredConfig: Record<string, any>,
+        customConfig: Record<string, any>,
+    ): Promise<void> {
+        const filePath = path.join(outputDir, "package.json");
+
+        // Merge default settings with filtered config and custom overrides
+        const finalConfig = {
+            ...packageConfig,
+            ...filteredConfig,
+            ...customConfig,
+        };
+        const data = JSON.stringify(finalConfig, null, 2);
+
+        try {
+            await this.ensureDirectoryExists(outputDir);
+            await fs.writeFile(filePath, data, "utf-8");
+            this.logInfo(`package.json successfully created at ${filePath}`);
+        } catch (error) {
+            this.logError("Error creating package.json", error);
+            throw error;
+        }
+    }
+
+    /**
+     * Ensures that the specified directory exists, creating it if it does not.
+     *
+     * @param dirPath - The path of the directory to verify or create.
+     * @returns A Promise that resolves once the directory is verified or created.
+     * @throws {Error} If the directory cannot be created.
+     */
+    private async ensureDirectoryExists(dirPath: string): Promise<void> {
+        try {
+            await fs.mkdir(dirPath, { recursive: true });
+        } catch (error) {
+            if ((error as NodeJS.ErrnoException).code !== "EEXIST") {
+                throw error;
+            }
+        }
+    }
+
+    /**
+     * Provides a description of the action.
+     *
+     * @returns A string description of the action.
+     */
+    describe(): string {
+        return "Reads an existing package.json, extracts selected fields, and creates a new one.";
+    }
+}
+
+// ============================================================================
+// Export
+// ============================================================================
+
+// export default PackageManagerAction;

package/ts/actions/PackageManagerAction/index.ts

@@ -0,0 +1,11 @@
+// ============================================================================
+// Import
+// ============================================================================
+
+import { PackageManagerAction } from "./PackageManagerAction";
+
+// ============================================================================
+// Export
+// ============================================================================
+
+export { PackageManagerAction };

package/ts/actions/PackageManagerAction/package.config.ts

@@ -0,0 +1,94 @@
+// ============================================================================
+// Constants
+// ============================================================================
+
+/**
+ * Configuration object for package.json properties, used to define metadata,
+ * file inclusions, and other necessary project configurations.
+ */
+const packageConfig = {
+    name: "example-project",
+    version: "0.1.0",
+    description: "",
+    keywords: "",
+    license: "MIT",
+    homepage: "https://www.example.com",
+    // funding: [
+    //     {
+    //         "type": "github",
+    //         "url": "https://github.com/sponsors/scape-foundation"
+    //     }
+    // ],
+    // type: "module",
+    // main: "js/index",
+    main: "js/index.js",
+    // types: "js/index",
+    types: "js/index.d.ts",
+    // "module": "dist/js/unit.gl.js",
+    // "style": "dist/css/unit.gl.css",
+    // "sass": "src/scss/index.scss",
+    // main: 'index.js',
+    files: [
+        "code-snippets/**/*.code-snippets",
+        "css/**/*.{css,map}",
+        "font/**/*.{eot,otf,ttf,woff,woff2}",
+        "inkscape/**/*.inkscape",
+        "jinja/**/*.jinja",
+        "js/**/*.d.ts",
+        "js/**/*.{js,map}",
+        "less/**/*.less",
+        "md/**/*.md",
+        "oco/**/*.oco",
+        "png/**/*.png",
+        "py/**/*.py",
+        "rcpx/**/*.rcpx",
+        "scss/**/*.scss",
+        "sketchpalette/**/*.sketchpalette",
+        "styl/**/*.styl",
+        "svg/**/*.svg",
+        "tex/**/*.tex",
+        "ts/**/*.ts",
+        "!.DS_Store",
+    ],
+    // exports: {
+    //     ".": {
+    //         // "sass": "./src/scss/index.scss",
+    //         // "import": "./dist/js/index.mjs",
+    //         // "default": "./dist/js/index.js"
+    //         "sass": "./scss/index.scss",
+    //         "scss": "./scss/index.scss",
+    //         "typescript": "./ts/index.ts",
+    //         "default": "./js/index.js"
+    //     }
+    // }
+    // repository: {
+    //     type: pack.repository.type,
+    //     url: pack.repository.url,
+    // },
+
+    // author?: string | {
+    //     name: string;
+    //     email?: string;
+    //     url?: string;
+    // };
+    // bugs?: {
+    //     url?: string;
+    //     email?: string;
+    // };
+
+    // contributors?: Array<string | {
+    //     name: string;
+    //     email?: string;
+    //     url?: string;
+    // }>;
+    // funding?: string | {
+    //     type: string;
+    //     url: string;
+    // };
+};
+
+// ============================================================================
+// Export
+// ============================================================================
+
+export default packageConfig;

package/ts/actions/SassDocAction/SassDocAction.ts

@@ -0,0 +1,66 @@
+// // ============================================================================
+// // Imports
+// // ============================================================================
+
+// // @ts-ignore: Implicit any type for sassdoc module
+// import path from "path";
+// import sassdoc from "sassdoc";
+// import { Action } from "../../core/pipeline/Action";
+// import { ActionOptionsType } from "../../types/ActionOptionsType";
+
+// // ============================================================================
+// // Classes
+// // ============================================================================
+
+// /**
+//  * SassDocAction generates SASS documentation using SassDoc.
+//  * This action allows specifying source directories, destination paths, and additional options.
+//  */
+// export class SassDocAction extends Action {
+//     /**
+//      * Executes the SASS documentation generation process.
+//      *
+//      * @param options - The options specifying source directories, output path, and SassDoc configurations.
+//      * @returns A Promise that resolves when the documentation generation is completed successfully.
+//      * @throws {Error} Throws an error if the documentation process fails.
+//      */
+//     async execute(options: ActionOptionsType): Promise<void> {
+//         const {
+//             sourcePaths = ["src/styles"],
+//             outputPath = "docs/sass",
+//             sassdocOptions = {},
+//         } = options;
+
+//         if (!Array.isArray(sourcePaths) || sourcePaths.length === 0) {
+//             throw new Error("Invalid options: 'sourcePaths' must be a non-empty array.");
+//         }
+
+//         this.logInfo(`Generating SASS documentation in ${outputPath}...`);
+
+//         try {
+//             // Merge custom options with default options
+//             const config: sassdoc.Options = {
+//                 dest: path.resolve(outputPath),
+//                 verbose: true,
+//                 ...sassdocOptions,
+//             };
+
+//             // Run SassDoc to generate documentation
+//             await sassdoc(sourcePaths, config);
+
+//             this.logInfo(`SASS documentation successfully generated at: ${config.dest}`);
+//         } catch (error) {
+//             this.logError("An error occurred while generating SASS documentation.", error);
+//             throw error;
+//         }
+//     }
+
+//     /**
+//      * Provides a description of the action.
+//      *
+//      * @returns A string description of the action.
+//      */
+//     describe(): string {
+//         return "Generates SASS documentation using SassDoc.";
+//     }
+// }

package/ts/actions/SassDocAction/index.ts

@@ -0,0 +1,11 @@
+// ============================================================================
+// Import
+// ============================================================================
+
+// import { SassDocAction } from "./SassDocAction";
+
+// ============================================================================
+// Export
+// ============================================================================
+
+// export { SassDocAction };