@amekusa/util.js 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Satoshi Soma
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,60 @@
+# @amekusa/util.js
+General purpose utility for JS
+
+## INSTALL
+```sh
+npm i @amekusa/util.js
+```
+
+## USAGE
+
+### ES
+```js
+// A) import functions
+import {
+	arr,
+	isEmpty,
+	clean,
+	merge,
+} from '@amekusa/util.js';
+
+// B) import as an object
+import util from '@amekusa/util.js';
+```
+
+### CJS
+```js
+// A) import functions
+const {
+	arr,
+	isEmpty,
+	clean,
+	merge,
+} = require('@amekusa/util.js');
+
+// B) import as an object
+const util = require('@amekusa/util.js');
+```
+
+## LICENSE
+MIT License
+
+Copyright (c) 2024 Satoshi Soma
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/import/bundle.js

@@ -0,0 +1,130 @@
+/*!
+ * MIT License
+ *
+ * Copyright (c) 2024 Satoshi Soma
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+/**
+ * Coerces the given value into an array.
+ * @param {any} x
+ * @return {any[]}
+ */
+function arr(x) {
+	return Array.isArray(x) ? x : [x];
+}
+
+/**
+ * Returns whether the given value can be considered as "empty".
+ * @param {any} x
+ * @return {boolean}
+ */
+function isEmpty(x) {
+	if (Array.isArray(x)) return x.length == 0;
+	switch (typeof x) {
+	case 'string':
+		return !x;
+	case 'object':
+		if (x === null) return true;
+		for (let i in x) return false;
+	case 'undefined':
+		return true;
+	}
+	return false;
+}
+
+/**
+ * Removes "empty" values from the given object or array.
+ * @param {object|any[]} x
+ * @param {number} recurse - Recursion limit
+ * @return {object|any[]} modified `x`
+ */
+function clean(x, recurse = 8) {
+	if (recurse) {
+		if (Array.isArray(x)) {
+			let r = [];
+			for (let i = 0; i < x.length; i++) {
+				let I = clean(x[i], recurse - 1);
+				if (!isEmpty(I)) r.push(I);
+			}
+			return r;
+		}
+		if (typeof x == 'object') {
+			let r = {};
+			for (let k in x) {
+				let v = clean(x[k], recurse - 1);
+				if (!isEmpty(v)) r[k] = v;
+			}
+			return r;
+		}
+	}
+	return x;
+}
+
+/**
+ * Merges the 2nd object into the 1st object recursively (deep-merge). The 1st object will be modified.
+ * @param {object} x - The 1st object
+ * @param {object} y - The 2nd object
+ * @param {object} [opts] - Options
+ * @param {number} opts.recurse=8 - Recurstion limit. Negative number means unlimited
+ * @param {boolean|string} opts.mergeArrays - How to merge arrays
+ * - `true`: merge x with y
+ * - 'push': push y elements to x
+ * - 'concat': concat x and y
+ * - other: replace x with y
+ * @return {object} The 1st object
+ */
+function merge(x, y, opts = {}) {
+	if (!('recurse' in opts)) opts.recurse = 8;
+	switch (Array.isArray(x) + Array.isArray(y)) {
+	case 0: // no array
+		if (opts.recurse && x && y && typeof x == 'object' && typeof y == 'object') {
+			opts.recurse--;
+			for (let k in y) x[k] = merge(x[k], y[k], opts);
+			opts.recurse++;
+			return x;
+		}
+	case 1: // 1 array
+		return y;
+	}
+	// 2 arrays
+	switch (opts.mergeArrays) {
+	case true:
+		for (let i = 0; i < y.length; i++) {
+			if (!x.includes(y[i])) x.push(y[i]);
+		}
+		return x;
+	case 'push':
+		x.push(...y);
+		return x;
+	case 'concat':
+		return x.concat(y);
+	}
+	return y;
+}
+
+var main = {
+	arr,
+	isEmpty,
+	clean,
+	merge,
+};
+
+export { arr, clean, main as default, isEmpty, merge };

package/dist/require/bundle.cjs

@@ -0,0 +1,138 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/*!
+ * MIT License
+ *
+ * Copyright (c) 2024 Satoshi Soma
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+/**
+ * Coerces the given value into an array.
+ * @param {any} x
+ * @return {any[]}
+ */
+function arr(x) {
+	return Array.isArray(x) ? x : [x];
+}
+
+/**
+ * Returns whether the given value can be considered as "empty".
+ * @param {any} x
+ * @return {boolean}
+ */
+function isEmpty(x) {
+	if (Array.isArray(x)) return x.length == 0;
+	switch (typeof x) {
+	case 'string':
+		return !x;
+	case 'object':
+		if (x === null) return true;
+		for (let i in x) return false;
+	case 'undefined':
+		return true;
+	}
+	return false;
+}
+
+/**
+ * Removes "empty" values from the given object or array.
+ * @param {object|any[]} x
+ * @param {number} recurse - Recursion limit
+ * @return {object|any[]} modified `x`
+ */
+function clean(x, recurse = 8) {
+	if (recurse) {
+		if (Array.isArray(x)) {
+			let r = [];
+			for (let i = 0; i < x.length; i++) {
+				let I = clean(x[i], recurse - 1);
+				if (!isEmpty(I)) r.push(I);
+			}
+			return r;
+		}
+		if (typeof x == 'object') {
+			let r = {};
+			for (let k in x) {
+				let v = clean(x[k], recurse - 1);
+				if (!isEmpty(v)) r[k] = v;
+			}
+			return r;
+		}
+	}
+	return x;
+}
+
+/**
+ * Merges the 2nd object into the 1st object recursively (deep-merge). The 1st object will be modified.
+ * @param {object} x - The 1st object
+ * @param {object} y - The 2nd object
+ * @param {object} [opts] - Options
+ * @param {number} opts.recurse=8 - Recurstion limit. Negative number means unlimited
+ * @param {boolean|string} opts.mergeArrays - How to merge arrays
+ * - `true`: merge x with y
+ * - 'push': push y elements to x
+ * - 'concat': concat x and y
+ * - other: replace x with y
+ * @return {object} The 1st object
+ */
+function merge(x, y, opts = {}) {
+	if (!('recurse' in opts)) opts.recurse = 8;
+	switch (Array.isArray(x) + Array.isArray(y)) {
+	case 0: // no array
+		if (opts.recurse && x && y && typeof x == 'object' && typeof y == 'object') {
+			opts.recurse--;
+			for (let k in y) x[k] = merge(x[k], y[k], opts);
+			opts.recurse++;
+			return x;
+		}
+	case 1: // 1 array
+		return y;
+	}
+	// 2 arrays
+	switch (opts.mergeArrays) {
+	case true:
+		for (let i = 0; i < y.length; i++) {
+			if (!x.includes(y[i])) x.push(y[i]);
+		}
+		return x;
+	case 'push':
+		x.push(...y);
+		return x;
+	case 'concat':
+		return x.concat(y);
+	}
+	return y;
+}
+
+var main = {
+	arr,
+	isEmpty,
+	clean,
+	merge,
+};
+
+exports.arr = arr;
+exports.clean = clean;
+exports.default = main;
+exports.isEmpty = isEmpty;
+exports.merge = merge;

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@amekusa/util.js",
+  "private": false,
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "version": "1.0.0",
+  "description": "General purpose utility for JS",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/import/bundle.js",
+      "require": "./dist/require/bundle.cjs"
+    }
+  },
+  "scripts": {
+    "dev": "npm-watch",
+    "test": "c8 mocha",
+    "lint": "eslint .",
+    "build": "npm run lint && rollup -c rollup.js",
+    "clean": "rm -rf ./dist",
+    "prod": "npm run clean; NODE_ENV=production npm run build",
+    "docs": "npm run docs:gen && npm run docs:publish",
+    "docs:gen": "npm run docs:clean; jsdoc -c jsdoc.json && cd docs/@amekusa/util.js && ln -sfn $npm_package_version latest",
+    "docs:clean": "rm -rf docs/@amekusa/util.js/$npm_package_version",
+    "docs:publish": "git subtree push --prefix docs/@amekusa/util.js origin gh-pages"
+  },
+  "watch": {
+    "build": {
+      "inherit": true,
+      "patterns": ["src"],
+      "extensions": "js"
+    },
+    "test": {
+      "inherit": true,
+      "patterns": ["test", "dist/**"],
+      "extensions": "js",
+      "delay": 500
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/amekusa/util.js.git"
+  },
+  "keywords": [
+    "utility",
+    "general"
+  ],
+  "author": "Satoshi Soma (https://amekusa.com)",
+  "license": "MIT",
+  "devDependencies": {
+    "@amekusa/nodeutil": "^1.5.1"
+  }
+}