uglify-js-minify-css-allfiles 2.1.0 → 2.1.1

package/minify.d.ts

@@ -1,31 +1,135 @@
 declare module 'uglify-js-minify-css-allfiles' {
+  /**
+   * Babel configuration options.
+   * These options are passed directly to @babel/preset-env.
+   */
   export interface BabelOptions {
+    /**
+     * Describes the environments you support/target for your project.
+     * Can be a string (e.g., "last 2 versions", "safari >= 7"), an array of strings, or an object of minimum environment versions to support.
+     */
     targets?: string | string[] | { [key: string]: string };
+
+    /**
+     * Enables transformation of ES6 module syntax to another module type.
+     * Use false to preserve ES modules.
+     */
     modules?: 'amd' | 'umd' | 'systemjs' | 'commonjs' | 'cjs' | 'auto' | false;
+
+    /** Enable debug output to see what Babel is doing. */
     debug?: boolean;
+
+    /** Array of plugins to always include. */
     include?: string[];
+
+    /** Array of plugins to always exclude/remove. */
     exclude?: string[];
+
+    /**
+     * Configures how Babel handles polyfills.
+     * 'usage' adds specific imports for polyfills when they are used in each file.
+     * 'entry' imports the full polyfill based on your target environments.
+     */
     useBuiltIns?: 'usage' | 'entry' | false;
+
+    /**
+     * Specifies the core-js version used when useBuiltIns is set to 'usage' or 'entry'.
+     */
     corejs?: 2 | 3 | { version: 2 | 3; proposals: boolean };
+
+    /**
+     * Forces Babel to apply all transformations, even if the target environment(s) support them natively.
+     */
     forceAllTransforms?: boolean;
+
+    /**
+     * Path to a .browserslistrc file to use instead of targets.
+     */
     configPath?: string;
+
+    /**
+     * Toggles whether or not browserslist config sources are used, which includes searching for any browserslist files or referencing the browserslist key inside package.json.
+     */
     ignoreBrowserslistConfig?: boolean;
+
+    /**
+     * Toggles enabling support for builtin/feature proposals that have shipped in browsers.
+     */
     shippedProposals?: boolean;
   }
 
+  /**
+   * Logging configuration options.
+   */
   export interface LogOptions {
+    /**
+     * Specifies the directory where log files will be stored.
+     * @default 'logs'
+     */
     logDir?: string;
+
+    /**
+     * Number of days to keep log files before they are deleted.
+     * @default 30
+     */
     retentionDays?: number;
-    logLevel?: string;
+
+    /**
+     * Sets the minimum level of messages that will be logged.
+     * @default 'info'
+     */
+    logLevel?: 'error' | 'warn' | 'info' | 'debug';
+
+    /**
+     * Format for dates in log file names and entries.
+     * @default 'YYYY-MM-DD'
+     */
     dateFormat?: string;
+
+    /**
+     * Time zone used for timestamps in log entries.
+     * @default 'UTC'
+     */
     timeZone?: string;
+
+    /**
+     * Whether to output logs to the console in addition to (or instead of) writing to files.
+     * @default true
+     */
     logToConsole?: boolean;
+
+    /**
+     * Whether to write logs to files.
+     * @default true
+     */
     logToFile?: boolean;
   }
 
+  /**
+   * Configuration options for the minifyAll function.
+   */
   export interface MinifyOptions {
+    /**
+     * Name of a folder to exclude from the minification process.
+     * Useful for skipping already minified files or third-party libraries.
+     * @default ''
+     */
     excludeFolder?: string;
+
+    /**
+     * Enables Babel transformation of JavaScript files.
+     * If true, uses default Babel settings.
+     * If an object is provided, it should conform to the BabelOptions interface.
+     * @default false
+     */
     useBabel?: boolean | BabelOptions;
+
+    /**
+     * Configures logging behavior.
+     * If true, uses default logging settings.
+     * If an object is provided, it should conform to the LogOptions interface.
+     * @default true
+     */
     useLog?: boolean | LogOptions;
   }
 
@@ -33,9 +137,29 @@ declare module 'uglify-js-minify-css-allfiles' {
    * Minifies all JavaScript and CSS files in the specified directory and its subdirectories.
    *
    * @param contentPath - The path to the directory containing the files to be minified.
-   * @param options - Options for minification and logging.
+   *                      This is the root directory from which the function will start searching for files.
+   * @param options - Configuration options for the minification process.
+   *                  These options control Babel usage, logging, and allow excluding certain folders.
    * @returns A promise that resolves when all files have been processed.
-   * @throws {Error} If there's an issue reading or writing files.
+   * @throws {Error} If there's an issue reading or writing files, or if the minification process fails.
+   *
+   * @example
+   * ```typescript
+   * import minifyAll from 'uglify-js-minify-css-allfiles';
+   *
+   * await minifyAll('./src', {
+   *   excludeFolder: 'node_modules',
+   *   useBabel: {
+   *     targets: '> 0.25%, not dead',
+   *     useBuiltIns: 'usage',
+   *     corejs: 3
+   *   },
+   *   useLog: {
+   *     logLevel: 'warn',
+   *     retentionDays: 7
+   *   }
+   * });
+   * ```
    */
   export default function minifyAll(contentPath: string, options?: MinifyOptions): Promise<void>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "uglify-js-minify-css-allfiles",
-    "version": "2.1.0",
+    "version": "2.1.1",
     "description": "you will be able to minify all files as same file names which is js or css",
     "main": "minify.js",
     "type": "module",
@@ -15,6 +15,9 @@
         "type": "git",
         "url": "git+https://github.com/oinochoe/uglify-js-minify-css-allfiles.git"
     },
+    "publishConfig": {
+        "registry": "https://registry.npmjs.org/"
+    },
     "keywords": [
         "ugly-code",
         "uglyCode",

package/.vscode/settings.json

@@ -1,13 +0,0 @@
-{
-    "cSpell.words": [
-        "allfile",
-        "allfiles",
-        "comporessor",
-        "corejs",
-        "esmodules",
-        "minifycss",
-        "oinochoe",
-        "uglifyjs",
-        "yeongmin"
-    ]
-}