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

package/CHANGELOG.md

@@ -5,78 +5,90 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.1.0] - 2024-08-20
+
+### Changed
+
+- Logging Enhancements:
+  Structured Log Levels: Implemented a new logging system with defined log levels (e.g., info, warn, error) to improve log readability and management.
+  Date-based Log Files: Logs are now stored in files organized by date, making it easier to track and analyze logs over time.
+- Type Generation:
+  Introduced a new type generation feature to improve type safety and consistency across the application.
+
 ## [2.0.0] - 2024-08-19
 
 ### Added
 
--   New logging system for better error tracking and debugging
--   Optional Babel integration for advanced JavaScript transpilation
--   Support for ES modules, allowing use of `import` statements in your projects
+- See Breaking Changes
 
 ### Changed
 
--   Switched from CommonJS (`require`) to ES modules (`import`) for better compatibility with modern JavaScript
--   Improved error handling and reporting, providing clearer messages for troubleshooting
--   Enhanced CLI interface with more user-friendly options and feedback
+- Switched from CommonJS (`require`) to ES modules (`import`) for better compatibility with modern JavaScript
+- Improved error handling and reporting, providing clearer messages for troubleshooting
+- Enhanced CLI interface with more user-friendly options and feedback
 
 ### Improved
 
--   Significantly faster processing of large directories with many files
--   More robust handling of different file types and encodings
--   Better preservation of source maps in minified files
+- Significantly faster processing of large directories with many files
+- More robust handling of different file types and encodings
+- Better preservation of source maps in minified files
 
 ### Breaking Changes
 
--   Minimum Node.js version requirement increased to v14.0.0
--   Configuration file format changed (see migration guide for details)
--   Some CLI options have been renamed for clarity (see documentation for new option names)
+- Minimum Node.js version requirement increased to v14.0.0
+- Configuration file format changed (see migration guide for details)
+- Some CLI options have been renamed for clarity (see documentation for new option names)
+- Support for ES modules, allowing use of `import` statements in your projects
+- New logging system for better error tracking and debugging
+- Optional Babel integration for advanced JavaScript transpilation
 
 ## [1.3.2] - 2023-05-28
 
 ### Added
 
--   New `CHANGELOG.md` file
+- New `CHANGELOG.md` file
 
 ### Changed
 
--   When CSS warnings exist, no code is minified (2022-04-13)
--   Updated UglifyJS to remove 'console.info, console.warn, console.error' (2021-11-12)
--   Updated UglifyJS to work without 'console.log' but keep console.error, info, etc. (2021-03-17)
+- When CSS warnings exist, no code is minified (2022-04-13)
+- Updated UglifyJS to remove 'console.info, console.warn, console.error' (2021-11-12)
+- Updated UglifyJS to work without 'console.log' but keep console.error, info, etc. (2021-03-17)
 
 ### Fixed
 
--   Bug fix (v1.1.7): Solved CleanCSS first line delete error (2020-08-21)
--   Bug fix (v1.1.3): [Description missing] (2020-08-15)
+- Bug fix (v1.1.7): Solved CleanCSS first line delete error (2020-08-21)
+- Bug fix (v1.1.3): [Description missing] (2020-08-15)
 
 ## [1.3.1] - 2020-11-03
 
 ### Changed
 
--   Updated UglifyJS to support minification of JavaScript files with ES6 syntax
+- Updated UglifyJS to support minification of JavaScript files with ES6 syntax
 
 ## [1.3.0] - 2020-08-26
 
 ### Changed
 
--   Moved DevDependencies to Dependencies for production use
+- Moved DevDependencies to Dependencies for production use
 
 ## [1.2.0] - 2020-08-21
 
 ### Fixed
 
--   Solved CleanCSS commentary issue due to changed CSS options
+- Solved CleanCSS commentary issue due to changed CSS options
 
 ### Added
 
--   Support for command line execution with 2 parameters
+- Support for command line execution with 2 parameters
 
 ## [1.1.0] - 2020-08-20
 
 ### Added
 
--   New `exceptFolder` parameter to exclude specific folders from minification
--   Support for using relative paths
+- New `exceptFolder` parameter to exclude specific folders from minification
+- Support for using relative paths
 
+[2.1.0]: https://github.com/oinochoe/uglify-js-minify-css-allfiles/compare/v2.0.0...v2.1.0
 [2.0.0]: https://github.com/oinochoe/uglify-js-minify-css-allfiles/compare/v1.3.2...v2.0.0
 [1.3.2]: https://github.com/oinochoe/uglify-js-minify-css-allfiles/compare/v1.3.1...v1.3.2
 [1.3.1]: https://github.com/oinochoe/uglify-js-minify-css-allfiles/compare/v1.3.0...v1.3.1

package/README.md

@@ -23,12 +23,12 @@ You can easily minify all files in a specific folder, with the option to exclude
 
 ## Table of Contents
 
--   [Installation](#installation)
--   [Usage](#usage)
--   [Parameters](#parameters)
--   [BabelOptions](#babeloptions)
--   [Changelog](#changelog)
--   [License](#license)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Parameters](#parameters)
+- [Options](#options)
+- [Changelog](#changelog)
+- [License](#license)
 
 ## Installation
 
@@ -42,57 +42,100 @@ $ npm i uglify-js-minify-css-allfiles
 
 1. Basic usage (no Babel):
 
-    ```js
-    import minifyAll from 'uglify-js-minify-css-allfiles';
+   ```js
+   import minifyAll from 'uglify-js-minify-css-allfiles';
+
+   await minifyAll('./src/');
+   ```
+
+2. Using options:
+
+   ```js
+   import minifyAll from 'uglify-js-minify-css-allfiles';
+
+   await minifyAll('./src/', {
+     excludeFolder: 'node_modules',
+     useBabel: {
+       targets: 'chrome 40',
+       modules: false,
+       useBuiltIns: 'usage',
+       corejs: 3,
+     },
+     useLog: {
+       logDir: 'logs',
+       retentionDays: 30,
+       logLevel: 'info',
+       dateFormat: 'YYYY-MM-DD',
+       timeZone: 'UTC',
+       logToConsole: true,
+       logToFile: true,
+     },
+   });
+   ```
+
+3. Using Babel and custom logging options:
+
+   ```js
+   import minifyAll from 'uglify-js-minify-css-allfiles';
+
+   await minifyAll('./src/', {
+     useBabel: { targets: 'chrome 40' },
+     useLog: {
+       logDir: 'logs',
+       retentionDays: 30,
+       logLevel: 'info',
+       dateFormat: 'YYYY-MM-DD',
+       timeZone: 'UTC',
+       logToConsole: true,
+       logToFile: true,
+     },
+   });
+   ```
 
-    await minifyAll('./src/', 'node_modules');
-    ```
+## Parameters
 
-2. Using Babel with default settings:
+The `minifyAll` function accepts the following parameters:
 
-    ```js
-    import minifyAll from 'uglify-js-minify-css-allfiles';
+| Parameter     | Type   | Default | Description                                                                                  |
+| ------------- | ------ | ------- | -------------------------------------------------------------------------------------------- |
+| `contentPath` | string | -       | The path to the directory containing the files to be minified. This is a required parameter. |
+| `options`     | object | `{}`    | An object containing options for minification, Babel, and logging.                           |
 
-    await minifyAll('./src/', 'node_modules', { useBabel: true });
-    ```
+## Options
 
-3. Using custom Babel presets:
+The `options` object can have the following properties:
 
-    ```js
-    import minifyAll from 'uglify-js-minify-css-allfiles';
+| Property        | Type              | Default | Description                                                                                |
+| --------------- | ----------------- | ------- | ------------------------------------------------------------------------------------------ |
+| `excludeFolder` | string            | `''`    | The name of a folder to exclude from minification.                                         |
+| `useBabel`      | boolean \| object | `false` | If `true`, enables Babel with default settings. If an object, specifies Babel options.     |
+| `useLog`        | boolean \| object | `true`  | If `true`, enables logging with default settings. If an object, specifies logging options. |
 
-    await minifyAll('./src/', 'node_modules', {
-        presets: [
-            [
-                '@babel/preset-env',
-                {
-                    targets: {
-                        esmodules: false, // Target ES2015
-                    },
-                },
-            ],
-        ],
-    });
-    ```
+### Babel Options
 
-## Parameters
-
-The `minifyAll` function accepts the following parameters:
+When `useBabel` is an object, it can have the following properties:
 
-| Parameter       | Type           | Default | Description                                                                                  |
-| --------------- | -------------- | ------- | -------------------------------------------------------------------------------------------- |
-| `contentPath`   | string         | -       | The path to the directory containing the files to be minified. This is a required parameter. |
-| `excludeFolder` | string         | `''`    | The name of a folder to exclude from minification. Leave empty to include all folders.       |
-| `babelOptions`  | object or null | `null`  | An object containing Babel options or a flag to use default Babel settings.                  |
+| Property                              | Type                        | Description                                                                                               |
+| ------------------------------------- | --------------------------- | --------------------------------------------------------------------------------------------------------- |
+| `targets`                             | string \| object            | Specifies the target environments.                                                                        |
+| `modules`                             | string \| false             | Enables transformation of ES6 module syntax to another module type.                                       |
+| `useBuiltIns`                         | 'usage' \| 'entry' \| false | Configures how babel-preset-env handles polyfills.                                                        |
+| `corejs`                              | number \| object            | Specifies the core-js version.                                                                            |
+| ... (other @babel/preset-env options) | Various                     | Refer to [@babel/preset-env documentation](https://babeljs.io/docs/en/babel-preset-env) for more options. |
 
-## BabelOptions
+### Log Options
 
-The `babelOptions` parameter can have the following properties:
+When `useLog` is an object, it can have the following properties:
 
-| Property   | Type    | Default | Description                                                                                   |
-| ---------- | ------- | ------- | --------------------------------------------------------------------------------------------- |
-| `useBabel` | boolean | `false` | If set to `true`, enables Babel transformation with default presets targeting ES2015.         |
-| `presets`  | array   | -       | Custom Babel presets to use for transformation. If provided, overrides the `useBabel` option. |
+| Property        | Type    | Default        | Description                                                           |
+| --------------- | ------- | -------------- | --------------------------------------------------------------------- |
+| `logDir`        | string  | `'logs'`       | Specifies the directory for log files.                                |
+| `retentionDays` | number  | 30             | Number of days to retain log files.                                   |
+| `logLevel`      | string  | `'info'`       | Specifies the level of logging (e.g., `'info'`, `'warn'`, `'error'`). |
+| `dateFormat`    | string  | `'YYYY-MM-DD'` | Format for the date in log entries.                                   |
+| `timeZone`      | string  | `'UTC'`        | Time zone for timestamps in log entries.                              |
+| `logToConsole`  | boolean | `true`         | Determines if logs should also be output to the console.              |
+| `logToFile`     | boolean | `true`         | Determines if logs should be written to a file.                       |
 
 ## Changelog
 

package/demo.js

@@ -1,18 +1,8 @@
 import minifyAll from './dist/module.js';
 
-minifyAll('./test/', 'lib', { useBabel: true });
-
-// minifyAll('./test/', 'lib', {
-//     presets: [
-//         [
-//             '@babel/preset-env',
-//             {
-//                 targets: {
-//                     esmodules: false, // Target ES2015
-//                 },
-//             },
-//         ],
-//     ],
-// });
-// console.log(process.argv.slice(2)[0], process.argv.slice(2)[1]);
-// minifyAll(process.argv.slice(2)[0], process.argv.slice(2)[1]);
+minifyAll('./test/', {
+  excludeFolder: 'lib',
+  useBabel: {
+    targets: 'chrome 40',
+  },
+});

package/dist/module.js

@@ -1,7 +1,6 @@
 /**
  * uglify-js and minify-css for all files
  * Released under the terms of MIT license
- *
  * Copyright (C) 2024 yeongmin
  */
 
@@ -13,31 +12,29 @@ import { minifyJS, minifyCSS } from './modules/minifier.js';
 import babelCore from '@babel/core';
 
 const FILE_HANDLERS = {
-    '.js': async (filePath, content, logger, babelOptions) => {
-        try {
-            // Transform the code using Babel with preset-env
-            let transformed = content;
-
-            // Convert code to Babel when Babel option is provided
-            if (babelOptions) {
-                transformed = babelCore.transformSync(content, babelOptions).code;
-            }
-
-            const result = minifyJS(transformed);
-            await writeFile(filePath, result, logger);
-        } catch (error) {
-            await logger.logError(filePath, `Babel transformation failed: ${error.message}`);
-        }
-    },
-    '.css': async (filePath, content, logger) => {
-        const output = await minifyCSS(content);
-        if (output.warnings.length > 0) {
-            await logger.logError(filePath, `CSS warnings: ${output.warnings.join(', ')}`);
-            await writeFile(filePath, null, logger);
-        } else {
-            await writeFile(filePath, output.styles, logger);
-        }
-    },
+  '.js': async (filePath, content, logger, babelOptions) => {
+    try {
+      let transformed = content;
+      if (babelOptions) {
+        transformed = babelCore.transformSync(content, babelOptions).code;
+      }
+      const result = minifyJS(transformed);
+      await writeFile(filePath, result, logger);
+    } catch (error) {
+      await logger?.error('JavaScript minification failed', { filePath, error: error.message });
+    }
+  },
+  '.css': async (filePath, content, logger) => {
+    try {
+      const output = await minifyCSS(content);
+      if (0 < output.warnings.length) {
+        await logger?.warn('CSS minification warnings', { filePath, warnings: output.warnings });
+      }
+      await writeFile(filePath, output.styles, logger);
+    } catch (error) {
+      await logger?.error('CSS minification failed', { filePath, error: error.message });
+    }
+  },
 };
 
 /**
@@ -49,43 +46,72 @@ const FILE_HANDLERS = {
  * @returns {Promise<void>}
  */
 async function processFile(filePath, logger, babelOptions = null) {
+  try {
     const fileContent = await fs.readFile(filePath, 'utf-8');
-    const fileExtension = path.extname(filePath);
+    const fileExtension = path.extname(filePath).toLowerCase();
     const handler = FILE_HANDLERS[fileExtension];
 
     if (handler) {
-        await handler(filePath, fileContent, logger, babelOptions);
+      await handler(filePath, fileContent, logger, babelOptions);
     } else {
-        logger.logInfo(`지원되지 않는 파일 형식 건너뜀: ${filePath}`);
+      await logger?.info(`Unsupported file type, skipping: ${filePath}`);
     }
+  } catch (error) {
+    await logger?.error('Error processing file', { filePath, error: error.message });
+  }
 }
 
 /**
  * Resolves Babel options based on the provided configuration.
  *
- * @param {Object|null} options - The Babel options object or null.
+ * @param {Object|null} useBabel - The Babel options object or null.
  * @returns {Object|null} The resolved Babel options or null if no valid options are provided.
  */
-function resolveBabelOptions(options) {
-    if (!options) return null;
+function resolveBabelOptions(useBabel) {
+  if (!useBabel) return null;
+  return {
+    presets: [['@babel/preset-env', typeof useBabel === 'object' ? useBabel : {}]],
+  };
+}
 
-    if (options.useBabel) {
-        return {
-            presets: [
-                [
-                    '@babel/preset-env',
-                    {
-                        targets: {
-                            esmodules: false, // Target ES2015
-                        },
-                    },
-                ],
-            ],
-        };
-    }
+/**
+ * Options for Babel configuration.
+ *
+ * @typedef {Object} BabelOptions
+ * @property {string|string[]|Object<string, string>} [targets] - Specifies the target environments for the code.
+ * @property {'amd'|'umd'|'systemjs'|'commonjs'|'cjs'|'auto'|false} [modules] - Module format to use for the output.
+ * @property {boolean} [debug] - Enables or disables debug mode.
+ * @property {string[]} [include] - List of plugins or features to include.
+ * @property {string[]} [exclude] - List of plugins or features to exclude.
+ * @property {'usage'|'entry'|false} [useBuiltIns] - Determines how polyfills are added.
+ * @property {2|3|{version: 2|3, proposals: boolean}} [corejs] - Specifies the version of core-js to use and whether to include proposals.
+ * @property {boolean} [forceAllTransforms] - Forces the application of all transformations.
+ * @property {string} [configPath] - Path to the configuration file.
+ * @property {boolean} [ignoreBrowserslistConfig] - Ignores the browserslist configuration.
+ * @property {boolean} [shippedProposals] - Enables support for shipped proposals.
+ */
 
-    return options.presets ? options : null;
-}
+/**
+ * Options for logging configuration.
+ *
+ * @typedef {Object} LogOptions
+ * @property {string} [logDir] - Specifies the directory for log files.
+ * @property {number} [retentionDays] - Number of days to retain log files.
+ * @property {string} [logLevel] - Specifies the level of logging (e.g., 'info', 'warn', 'error').
+ * @property {string} [dateFormat] - Format for the date in log entries.
+ * @property {string} [timeZone] - Time zone for timestamps in log entries.
+ * @property {boolean} [logToConsole] - Determines if logs should also be output to the console.
+ * @property {boolean} [logToFile] - Determines if logs should be written to a file.
+ */
+
+/**
+ * Options for minification configuration.
+ *
+ * @typedef {Object} MinifyOptions
+ * @property {string} [excludeFolder] - Folder to exclude from minification.
+ * @property {boolean|BabelOptions} [useBabel] - Whether to use Babel for transformation, and the options for Babel if used.
+ * @property {boolean|LogOptions} [useLog] - Whether to use logging, and the options for logging if used.
+ */
 
 /**
  * Minifies all JavaScript and CSS files in the specified directory and its subdirectories.
@@ -93,47 +119,38 @@ function resolveBabelOptions(options) {
  * @async
  * @function minifyAll
  * @param {string} contentPath - The path to the directory containing the files to be minified.
- * @param {string} [excludeFolder=''] - The name of a folder to exclude from minification.
- * @param {Object} [babelOptions=null] - Babel options for converting JavaScript files.
+ * @param {MinifyOptions} [options={}] - Options for minification, Babel, and logging.
  * @returns {Promise<void>} A promise that resolves when all files have been processed.
  * @throws {Error} If there's an issue reading or writing files.
- *
- * @example
- * // Minify all files in './test/' directory, excluding 'lib' folder
- * import minifyAll from './main.js';
- * await minifyAll('./test/', 'lib');
- *
- * @example
- * // Minify all files in a directory specified as a command line argument
- * import minifyAll from './main.js';
- * await minifyAll(process.argv[2], process.argv[3]);
- *
- * @example
- * // Add babel options for converting JavaScript files.
- * minifyAll('./test/', 'lib', {
- *     presets: [
- *         [
- *             '@babel/preset-env',
- *             {
- *                 targets: {
- *                     esmodules: false, // Target ES2015
- *                 },
- *             },
- *         ],
- *     ],
- * });
  */
-export default async function minifyAll(contentPath, excludeFolder = '', babelOptions = null) {
-    const logger = new Logger();
+export default async function minifyAll(contentPath, options = {}) {
+  const { excludeFolder = '', useBabel = false, useLog = true, logOptions = {} } = options;
+
+  const logger = useLog ? new Logger(logOptions) : null;
+
+  if (logger) {
     await logger.initialize();
+    await logger.info('Starting minification process', { contentPath, excludeFolder, useBabel });
+  }
 
-    const rootDir = contentPath || '';
-    const finalBabelOptions = resolveBabelOptions(babelOptions);
+  const rootDir = path.resolve(contentPath || '');
+  const finalBabelOptions = resolveBabelOptions(useBabel);
 
+  try {
     await getAllFiles(rootDir, async (filePath) => {
-        if (excludeFolder && filePath.includes(excludeFolder)) return;
-        await processFile(filePath, logger, finalBabelOptions);
+      if (excludeFolder && path.relative(rootDir, filePath).startsWith(excludeFolder)) {
+        await logger?.debug('Skipping excluded file', { filePath });
+        return;
+      }
+
+      await processFile(filePath, logger, finalBabelOptions);
+      logger?.incrementProcessedFiles(filePath);
     });
+  } catch (error) {
+    await logger?.error('Error in minification process', { error: error.message });
+  }
 
+  if (logger) {
     await logger.summarize();
+  }
 }

package/dist/modules/fileHandler.js

@@ -15,16 +15,16 @@ import path from 'path';
  * @returns {Promise<void>}
  */
 export async function getAllFiles(dirPath, callback) {
-    const files = await fs.readdir(dirPath);
-    for (const file of files) {
-        const filePath = path.join(dirPath, file);
-        const fileStat = await fs.stat(filePath);
-        if (fileStat.isFile()) {
-            await callback(filePath, fileStat);
-        } else if (fileStat.isDirectory()) {
-            await getAllFiles(filePath, callback);
-        }
+  const files = await fs.readdir(dirPath);
+  for (const file of files) {
+    const filePath = path.join(dirPath, file);
+    const fileStat = await fs.stat(filePath);
+    if (fileStat.isFile()) {
+      await callback(filePath, fileStat);
+    } else if (fileStat.isDirectory()) {
+      await getAllFiles(filePath, callback);
     }
+  }
 }
 
 /**
@@ -37,15 +37,15 @@ export async function getAllFiles(dirPath, callback) {
  * @returns {Promise<void>}
  */
 export async function writeFile(filePath, content, logger) {
-    if (typeof content === 'undefined' || content === '' || content === null) {
-        await logger.logError(filePath, 'Invalid or empty content');
-        return;
-    }
+  if (typeof content === 'undefined' || content === '' || content === null) {
+    await logger?.error('Invalid or empty content', { filePath });
+    return;
+  }
 
-    logger.logInfo(`Writing file: ${filePath}`);
-    try {
-        await fs.writeFile(filePath, content, 'utf-8');
-    } catch (error) {
-        await logger.logError(filePath, `Write failed: ${error.message}`);
-    }
+  await logger?.info(`Writing file: ${filePath}`);
+  try {
+    await fs.writeFile(filePath, content, 'utf-8');
+  } catch (error) {
+    await logger?.error(`Write failed: ${error.message}`, { filePath });
+  }
 }