xcn 0.0.0 → 0.1.0

package/LICENSE

@@ -0,0 +1,6 @@
+Copyright (c) <2025> <earthnut.dev>
+    
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above  copyright notice and this permission notice appear in all copies.
+    
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES  
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -1,13 +1,33 @@
-# earthnut-vue
+# xcn
 
-## description
+[![version](<https://img.shields.io/npm/v/xcn.svg?logo=npm&logoColor=rgb(0,0,0)&label=版本号&labelColor=rgb(73,73,228)&color=rgb(0,0,0)>)](https://www.npmjs.com/package/xcn) [![Coverage Status](<https://img.shields.io/coverallsCoverage/github/earthnutDev/xcn?logo=coveralls&label=coveralls&labelColor=rgb(12, 244, 39)&color=rgb(0,0,0)>)](https://coveralls.io/github/earthnutDev/xcn?branch=main) [![codecov](<https://img.shields.io/codecov/c/github/earthnutDev/xcn/main?logo=codecov&label=codecov&labelColor=rgb(7, 245, 245)&color=rgb(0,0,0)>)](https://codecov.io/gh/earthnutDev/xcn) [![issues 提交](<https://img.shields.io/badge/issues-提交-rgb(255,0,63)?logo=github>)](https://github.com/earthnutDev/xcn/issues)
 
-earthnut-vue is a vue ui library.
+xcn = mix + class name
 
-aii
+组装 html 元素的 class 属性值.
 
-axg
+## 安装
 
-azg
+```sh
+npm install --save xcn@latest
+```
 
-bfq
+## 使用
+
+```ts
+import { xcn } from 'xcn';
+
+> xcn('a' , 'b' ,'c');
+
+'a b c'
+
+> xcn('a', { c: false }, true , false ,null , {d: true}, 'b');
+
+'a b d'
+
+
+```
+
+## 文档地址
+
+参看 [https://earthnut.dev/xcn/](https://earthnut.dev/xcn/)

package/cjs/index.cjs

@@ -0,0 +1,10 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var index = require('./src/index.cjs');
+
+
+
+exports.default = index.xcn;
+exports.xcn = index.xcn;

package/cjs/src/index.cjs

@@ -0,0 +1,73 @@
+'use strict';
+
+var aTypeOfJs = require('a-type-of-js');
+
+/**
+ *
+ * 合并 class
+ *
+ * merge class name
+ *
+ */
+function xcn(...classNameList) {
+    const template = [];
+    /**
+     * 移除空白
+     */
+    const removeBlank = (str) => str
+        .trim()
+        .replace(/undefined/g, ' ')
+        .replace(/\s+/g, ' ')
+        .split(' ')
+        .sort()
+        .join(' ');
+    /**
+     * 混合值
+     */
+    const mergeNewValue = (newValue) => {
+        if (newValue === undefined || typeof newValue !== 'string')
+            return;
+        const newList = removeBlank(newValue).split(' ');
+        if (newList.length)
+            template.push(...newList);
+    };
+    classNameList.forEach(classNameItem => {
+        // 数据为 undefined 或 null 或 false 或 true 或 '' 或 [] 或 {}
+        if (!classNameItem || classNameItem === true) {
+            return;
+        }
+        // 数据为数组类型
+        if (Array.isArray(classNameItem) === true) {
+            classNameItem.forEach(childItem => mergeNewValue(xcn(childItem)));
+        }
+        // 数据为 string 类型
+        else if ('string' === typeof classNameItem ||
+            'number' === typeof classNameItem) {
+            mergeNewValue(classNameItem.toString());
+        }
+        // 数据为函数类型
+        else if (aTypeOfJs.isFunction(classNameItem)) {
+            const result = classNameItem();
+            if (aTypeOfJs.isString(result)) {
+                mergeNewValue(result);
+            }
+            else {
+                result.forEach(item => mergeNewValue(xcn(item)));
+            }
+        }
+        else {
+            // 数据为 object 类型
+            for (const key in classNameItem) {
+                if (Object.prototype.hasOwnProperty.call(classNameItem, key)) {
+                    const element = classNameItem[key];
+                    if (true === element)
+                        mergeNewValue(key);
+                }
+            }
+        }
+    });
+    const result = removeBlank(new Array(...new Set(template)).join(' '));
+    return (result || undefined);
+}
+
+exports.xcn = xcn;

package/mjs/index.mjs

@@ -0,0 +1,5 @@
+import { xcn } from './src/index.mjs';
+
+
+
+export { xcn as default, xcn };

package/mjs/src/index.mjs

@@ -0,0 +1,71 @@
+import { isFunction, isString } from 'a-type-of-js';
+
+/**
+ *
+ * 合并 class
+ *
+ * merge class name
+ *
+ */
+function xcn(...classNameList) {
+    const template = [];
+    /**
+     * 移除空白
+     */
+    const removeBlank = (str) => str
+        .trim()
+        .replace(/undefined/g, ' ')
+        .replace(/\s+/g, ' ')
+        .split(' ')
+        .sort()
+        .join(' ');
+    /**
+     * 混合值
+     */
+    const mergeNewValue = (newValue) => {
+        if (newValue === undefined || typeof newValue !== 'string')
+            return;
+        const newList = removeBlank(newValue).split(' ');
+        if (newList.length)
+            template.push(...newList);
+    };
+    classNameList.forEach(classNameItem => {
+        // 数据为 undefined 或 null 或 false 或 true 或 '' 或 [] 或 {}
+        if (!classNameItem || classNameItem === true) {
+            return;
+        }
+        // 数据为数组类型
+        if (Array.isArray(classNameItem) === true) {
+            classNameItem.forEach(childItem => mergeNewValue(xcn(childItem)));
+        }
+        // 数据为 string 类型
+        else if ('string' === typeof classNameItem ||
+            'number' === typeof classNameItem) {
+            mergeNewValue(classNameItem.toString());
+        }
+        // 数据为函数类型
+        else if (isFunction(classNameItem)) {
+            const result = classNameItem();
+            if (isString(result)) {
+                mergeNewValue(result);
+            }
+            else {
+                result.forEach(item => mergeNewValue(xcn(item)));
+            }
+        }
+        else {
+            // 数据为 object 类型
+            for (const key in classNameItem) {
+                if (Object.prototype.hasOwnProperty.call(classNameItem, key)) {
+                    const element = classNameItem[key];
+                    if (true === element)
+                        mergeNewValue(key);
+                }
+            }
+        }
+    });
+    const result = removeBlank(new Array(...new Set(template)).join(' '));
+    return (result || undefined);
+}
+
+export { xcn };

package/package.json

@@ -1,26 +1,58 @@
 {
+  "main": "cjs/index.cjs",
+  "module": "mjs/index.mjs",
+  "types": "types/index.d.ts",
   "name": "xcn",
-  "version": "0.0.0",
-  "main": "index.js",
-  "author": "lmssee <lmssee@outlook.com>  (https://lmssee.com)",
-  "homepage": "https://earthnut.dev/vue",
+  "type": "module",
+  "version": "0.1.0",
+  "description": "一个用于字符串拼接的小工具，常用于 class name 的拼接",
   "license": "ISC",
-  "description": "email to earthnut.dev@outlook.com",
+  "dependencies": {
+    "a-type-of-js": ">=0.2.0 <1.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
   "files": [
-    "index.js"
+    "mjs/",
+    "cjs/",
+    "types/"
   ],
-  "bugs": {
-    "url": "https://github.com/lmssee/npm-earthnut-vue/issues"
+  "exports": {
+    ".": {
+      "import": {
+        "default": "./mjs/index.mjs",
+        "types": "./types/index.d.ts"
+      },
+      "require": {
+        "default": "./cjs/index.cjs",
+        "types": "./types/index.d.ts"
+      }
+    }
   },
-  "keywords": [
-    "earthnut"
-  ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/lmssee/npm-earthnut-vue.git"
+    "url": "git+https://github.com/earthnutDev/xcn.git"
   },
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org"
+  "author": {
+    "name": "earthnut",
+    "email": "earthnut.dev@outlook.com",
+    "url": "https://earthnut.dev"
+  },
+  "browserslist": [
+    "node>=18.0.0"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "keywords": [
+    "xcn",
+    "mix-cn"
+  ],
+  "homepage": "https://earthnut.dev/xcn",
+  "bugs": {
+    "url": "https://github.com/earthnutDev/xcn/issues",
+    "email": "earthnut.dev@outlook.com"
   }
-}
+}

package/types/index.d.ts

@@ -0,0 +1,3 @@
+import { xcn } from './src/index';
+export { xcn };
+export default xcn;

package/types/src/index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 参数的数据类型
+ */
+export type ClassNameItem = null | number | string | boolean | undefined | (() => string) | (() => ClassNameItem[]) | ClassNameItem[] | Record<string, boolean | undefined>;
+/**
+ * 使用 infer 判断出当前的数据类型
+ *
+ * 字符串为具体的字符串值而非 string
+ */
+type TypeofClassNameItem<T> = T extends null | boolean | undefined ? '' : T extends readonly [unknown, infer U] ? TypeofClassNameItem<U> | '' : T extends readonly [unknown, infer U, infer V] ? TypeofClassNameItem<U> | TypeofClassNameItem<V> : T extends Record<string, boolean | undefined> ? keyof T | '' : T extends () => string ? string : T;
+/**
+ * 递归判断当前返回的数据类型
+ */
+type XCN<T> = T extends [infer U, ...infer V] ? `${U & string}  ${XCN<V>}` : '';
+/**
+ *
+ * 合并 class
+ *
+ * merge class name
+ *
+ */
+export declare function xcn<T extends ClassNameItem[]>(...classNameList: T): XCN<{
+    [K in keyof T]: TypeofClassNameItem<T[K]>;
+}>;
+export {};

package/types/src/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/index.js

@@ -1 +0,0 @@
-console.log("hello ,iggg!");