classnames-minifier 0.2.2 → 1.0.0

package/dist/ClassnamesMinifier.js

@@ -9,7 +9,7 @@ const configuration_1 = require("./lib/constants/configuration");
 const validateConfig_1 = __importDefault(require("./lib/validateConfig"));
 const ConverterMinified_1 = __importDefault(require("./lib/ConverterMinified"));
 const validateDist_1 = __importDefault(require("./lib/validateDist"));
-const rmDist_1 = __importDefault(require("./lib/rmDist"));
+const removeDist_1 = __importDefault(require("./lib/removeDist"));
 class ClassnamesMinifier {
     constructor(config) {
         (0, validateConfig_1.default)(config);
@@ -20,25 +20,37 @@ class ClassnamesMinifier {
         else {
             const manifestDir = path_1.default.join(config.cacheDir, "ncm-meta");
             const manifestPath = path_1.default.join(manifestDir, "manifest.json");
+            const { distDeletionPolicy = "error" } = config;
             let distCleared = false;
             if (config.cacheDir) {
                 const errors = (0, validateDist_1.default)(config, manifestPath);
                 if (errors) {
-                    if (!config.disableDistDeletion) {
-                        (0, rmDist_1.default)(config.distDir, errors);
+                    console.log(`classnames-minifier: "distDeletionPolicy" option was set to "${distDeletionPolicy}"`);
+                    if (distDeletionPolicy === "auto") {
+                        (0, removeDist_1.default)(config.distDir, errors);
                         distCleared = true;
                     }
+                    else if (distDeletionPolicy === "error") {
+                        throw new Error(`classnames-minifier: Please, remove dist dir manually. ${errors}`);
+                    }
                     else {
-                        console.log(`classnames-minifier: ${errors}"disableDistDeletion" option was set to true`);
+                        console.warn(`classnames-minifier: Please, remove dist dir manually. ${errors}`);
                     }
                 }
             }
-            const { freedNamesPolicy = "transmit", blockLimit = 100000 } = config.experimental || {};
-            if (freedNamesPolicy === "block" &&
-                this.converterMinified.freeClasses.length > blockLimit &&
-                config.distDir) {
-                distCleared = true;
-                (0, rmDist_1.default)(config.distDir, `Freed names exceeds the limit (${blockLimit})`);
+            const { syncFreedNames, freedNamesLimit = 100000 } = config.experimental || {};
+            if (!syncFreedNames && this.converterMinified.freeClasses.length > freedNamesLimit && config.distDir) {
+                console.log(`classnames-minifier: "distDeletionPolicy" option was set to "${distDeletionPolicy}"`);
+                if (distDeletionPolicy === "auto") {
+                    (0, removeDist_1.default)(config.distDir, `Freed names exceeds the limit (${freedNamesLimit})`);
+                    distCleared = true;
+                }
+                else if (distDeletionPolicy === "error") {
+                    throw new Error(`Please, remove dist dir manually. Freed names exceeds the limit (${freedNamesLimit})`);
+                }
+                else {
+                    console.warn(`Please, remove dist dir manually. Freed names exceeds the limit (${freedNamesLimit})`);
+                }
             }
             if (distCleared) {
                 this.converterMinified.reset();

package/dist/lib/ConverterMinified.d.ts

@@ -13,7 +13,7 @@ declare class ConverterMinified {
     private cacheDir?;
     private prefix;
     private reservedNames;
-    private freedNamesPolicy;
+    private syncFreedNames;
     private symbols;
     dirtyСache: CacheType;
     freeClasses: string[];

package/dist/lib/ConverterMinified.js

@@ -146,7 +146,7 @@ class ConverterMinified {
         };
         this.prefix = prefix;
         this.reservedNames = reservedNames;
-        this.freedNamesPolicy = (experimental === null || experimental === void 0 ? void 0 : experimental.freedNamesPolicy) || "transmit";
+        this.syncFreedNames = Boolean(experimental === null || experimental === void 0 ? void 0 : experimental.syncFreedNames);
         if (cacheDir)
             this.invalidateCache(path_1.default.join(cacheDir, "ncm"));
     }
@@ -174,7 +174,7 @@ class ConverterMinified {
     }
     getTargetClassName(origName) {
         let targetClassName;
-        if (this.freeClasses.length && this.freedNamesPolicy === "transmit") {
+        if (this.freeClasses.length && this.syncFreedNames) {
             targetClassName = this.freeClasses.shift();
         }
         else {
@@ -186,6 +186,7 @@ class ConverterMinified {
         }
         return targetClassName;
     }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     getLocalIdent({ resourcePath }, _localIdent, origName) {
         if (!this.dirtyСache[resourcePath]) {
             this.dirtyСache[resourcePath] = {

package/dist/lib/classnames-minifier-preloader.js

@@ -5,6 +5,9 @@ function default_1(source, map, meta) {
     const classnamesMinifier = options.classnamesMinifier;
     const maybeClassesList = source.match(/\.-?[_a-zA-Z]+[_a-zA-Z0-9-]*/g);
     const cache = classnamesMinifier.dirtyСache[this.resourcePath];
+    /**
+     * if some class has ceased to be used since the last time the file was loaded, we remove it from the cache
+     */
     if (cache && cache.matchings) {
         cache.matchings = maybeClassesList
             ? Object.fromEntries(Object.entries(cache.matchings).filter(([key]) => maybeClassesList === null || maybeClassesList === void 0 ? void 0 : maybeClassesList.includes(`.${key}`)))

package/dist/lib/constants/configuration.d.ts

@@ -1 +1,6 @@
-export declare const CODE_VERSION = "rabbit";
+/**
+ * Just a version of the code whose change means that the logic has a critical update
+ * and minifying the previous version is not compatible with the current one,
+ * which would mean that we should clean dist folder
+ */
+export declare const CODE_VERSION = "parrot";

package/dist/lib/constants/configuration.js

@@ -1,4 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CODE_VERSION = void 0;
-exports.CODE_VERSION = "rabbit";
+/**
+ * Just a version of the code whose change means that the logic has a critical update
+ * and minifying the previous version is not compatible with the current one,
+ * which would mean that we should clean dist folder
+ */
+exports.CODE_VERSION = "parrot";

package/dist/lib/removeDist.d.ts

@@ -0,0 +1,2 @@
+declare const removeDist: (distDir: string, message: string) => void;
+export default removeDist;

package/dist/lib/{rmDist.js → removeDist.js}

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs_1 = require("fs");
-const rmDist = (distDir, message) => {
+const removeDist = (distDir, message) => {
     console.log(`classnames-minifier: ${message}Cleaning the dist folder...`);
     (0, fs_1.rmSync)(distDir, { recursive: true, force: true });
     console.log("classnames-minifier: Dist folder cleared");
 };
-exports.default = rmDist;
+exports.default = removeDist;

package/dist/lib/types/plugin.d.ts

@@ -1,11 +1,60 @@
 export type Config = {
+    /**
+     * The directory where the package cache will be written
+     */
     cacheDir?: string;
+    /**
+     * Directory where the project is built
+     */
     distDir?: string;
+    /**
+     * Prefix which will be added to each generated name
+     */
     prefix?: string;
+    /**
+     * Reserved minified names. Use this option if you are adding short classes manually
+     */
     reservedNames?: string[];
-    disableDistDeletion?: boolean;
+    /**
+     * Package policy to resolve potential problems with minified classes
+     *
+     * This may happen due to the following reasons:
+     *
+     * 1. Launching the package for the first time. Package need clean next.js cache to put everything in the correct order
+     * 2. Changing the package configuration. Package need clean next.js cache to rebuild it with classes according to the new rules
+     * 3. Exceeding the limit on freed classes (these are classes that were used before, but are now *probably* no longer used)
+     *
+     * @param "warning" - a warning message will simply be displayed.
+     * With this option, there is a high risk of errors and duplicates of generated classes.
+     *
+     * @param "error" - an error will be thrown, and as a result the build will stop.
+     * If this option occurs, delete the next.js cache manually and restart the build.
+     *
+     * @param "auto" - the package will automatically delete the next.js cache directory.
+     *
+     * @default "error"
+     */
+    distDeletionPolicy?: "warning" | "error" | "auto";
+    /**
+     * Additional check of the dist directory for freshness
+     */
+    checkDistFreshness?: () => boolean;
     experimental?: {
-        freedNamesPolicy?: "transmit" | "block";
-        blockLimit?: number;
+        /**
+         * Automatically synchronize freed classes (for example, if you deleted the original styles)
+         * Such classes will be reused in new locations. In this case, there may be situations that the package
+         * will mistakenly consider them freed and reuse the class again, thereby creating duplicates.
+         *
+         * Be careful using this option
+         * @default false
+         */
+        syncFreedNames?: boolean;
+        /**
+         * Limit of unused minified classes. Such classes are not reused by default,
+         * since the package cannot be sure of this at this time.
+         *
+         * @default 100000
+         */
+        freedNamesLimit?: number;
     };
 };

package/dist/lib/validateConfig.js

@@ -1,6 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const validKeys = ["prefix", "reservedNames", "cacheDir", "distDir", "disableDistDeletion", "experimental"];
+const validKeys = [
+    "prefix",
+    "reservedNames",
+    "cacheDir",
+    "distDir",
+    "distDeletionPolicy",
+    "experimental",
+    "checkDistFreshness",
+];
 const validateIsObject = (config) => {
     if (!config)
         return false;

package/dist/lib/validateDist.js

@@ -16,7 +16,7 @@ const readManifest = (manifestPath) => {
 };
 const validateDist = (pluginOptions, manifestPath) => {
     var _a, _b, _c;
-    const { cacheDir, distDir, prefix, reservedNames, disableDistDeletion } = pluginOptions;
+    const { cacheDir, distDir, prefix, reservedNames, distDeletionPolicy, checkDistFreshness } = pluginOptions;
     if (!cacheDir || !distDir) {
         console.log("classnames-minifier: Failed to check the dist folder because cacheDir or distDir is not specified");
         return;
@@ -41,14 +41,14 @@ const validateDist = (pluginOptions, manifestPath) => {
         if (prevData.version !== configuration_1.CODE_VERSION) {
             configDiffMessages.push(`Different package version: "${prevData.version}" -> "${configuration_1.CODE_VERSION}"`);
         }
-        if (prevData.disableDistDeletion && !disableDistDeletion) {
-            configDiffMessages.push(`"disableDistDeletion" set to "${disableDistDeletion}"`);
+        if (prevData.distDeletionPolicy && !distDeletionPolicy) {
+            configDiffMessages.push(`"distDeletionPolicy" set to "${distDeletionPolicy}"`);
         }
         if (configDiffMessages.length) {
-            configurationError = `Changes found in package configuration: \n${configDiffMessages.map((message) => `- ${message};\n`)}`;
+            configurationError = `Changes found in package configuration: \n${configDiffMessages.map((message) => `- ${message};\n`).join("")}`;
         }
     }
-    else {
+    else if (!(checkDistFreshness === null || checkDistFreshness === void 0 ? void 0 : checkDistFreshness())) {
         configurationError = `Can not find the package cache manifest at ${manifestPath}\n`;
     }
     return configurationError;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "classnames-minifier",
-  "version": "0.2.2",
+  "version": "1.0.0",
   "description": "Library for configuring style modules to generate compressed classes",
   "main": "./dist/ClassnamesMinifier.js",
   "types": "./dist/ClassnamesMinifier.d.ts",

package/dist/lib/rmDist.d.ts

@@ -1,2 +0,0 @@
-declare const rmDist: (distDir: string, message: string) => void;
-export default rmDist;