barbero 0.1.0-alpha.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 BhuannaichFhirinn
+
+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,175 @@
+# Barbero
+
+**Barbero** is a lightweight JavaScript utility library providing tools for Boolean evaluations, comparisons, and logical utilities. Simplify your true/false logic with this modern, easy-to-use toolkit.
+
+---
+
+## Features
+
+- **Lightweight**: Small and efficient, designed to integrate seamlessly with your projects.
+- **Boolean Utilities**: Perform truthy/falsey checks, comparisons, and validations.
+- **Easy to Use**: Clear and intuitive functions for common tasks.
+- **Tree-shakable**: Import only what you need to minimize bundle size.
+
+---
+
+## Installation
+
+Install Barbero via NPM:
+
+```bash
+npm install barbero
+```
+
+Or using Yarn:
+
+```bash
+yarn add barbero
+```
+
+---
+
+## Usage
+
+Import and use individual functions or the entire library:
+
+### Example 1: Truthy/Falsey Checks
+
+```javascript
+import { isTruthy, isFalsey } from 'barbero';
+
+console.log(isTruthy(1)); // true
+console.log(isFalsey(0)); // true
+```
+
+### Example 2: Null/Undefined/Empty Checks
+
+```javascript
+import { isNullOrUndefined, isEmptyArray } from 'barbero';
+
+console.log(isNullOrUndefined(null)); // true
+console.log(isEmptyArray([])); // true
+console.log(isEmptyArray([1, 2])); // false
+```
+
+### Example 3: Comparisons
+
+```javascript
+import { isEqual, isStrictEqual } from 'barbero';
+
+console.log(isEqual({ a: 1 }, { a: 1 })); // true
+console.log(isStrictEqual(1, '1')); // false
+```
+
+### Example 4: Logical Operations
+
+```javascript
+import { xor, nand } from 'barbero';
+
+console.log(xor(true, false)); // true
+console.log(nand(true, true)); // false
+```
+
+---
+
+## API
+
+### Core Functions
+
+#### `isTruthy(value)`
+Returns `true` if the value is truthy.
+
+```javascript
+isTruthy(1); // true
+isTruthy(0); // false
+```
+
+#### `isFalsey(value)`
+Returns `true` if the value is falsey.
+
+```javascript
+isFalsey(0); // true
+isFalsey('hello'); // false
+```
+
+### Validation Functions
+
+#### `isNullOrUndefined(value)`
+Returns `true` if the value is `null` or `undefined`.
+
+```javascript
+isNullOrUndefined(null); // true
+isNullOrUndefined(undefined); // true
+isNullOrUndefined(''); // false
+```
+
+#### `isEmptyArray(array)`
+Returns `true` if the array is empty.
+
+```javascript
+isEmptyArray([]); // true
+isEmptyArray([1]); // false
+```
+
+#### `isEmptyObject(object)`
+Returns `true` if the object has no keys.
+
+```javascript
+isEmptyObject({}); // true
+isEmptyObject({ a: 1 }); // false
+```
+
+### Comparison Functions
+
+#### `isEqual(a, b)`
+Performs deep equality comparison between two values.
+
+```javascript
+isEqual({ a: 1 }, { a: 1 }); // true
+isEqual([1, 2], [1, 2]); // true
+isEqual(1, '1'); // false
+```
+
+#### `isStrictEqual(a, b)`
+Performs strict equality comparison (no type coercion).
+
+```javascript
+isStrictEqual(1, 1); // true
+isStrictEqual(1, '1'); // false
+```
+
+### Logical Functions
+
+#### `xor(a, b)`
+Returns `true` if only one of the arguments is `true`.
+
+```javascript
+xor(true, false); // true
+xor(true, true); // false
+```
+
+#### `nand(a, b)`
+Returns `true` if **not both** arguments are `true`.
+
+```javascript
+nand(true, true); // false
+nand(true, false); // true
+```
+
+---
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request on [GitHub](https://github.com/your-username/barbero).
+
+---
+
+## License
+
+Barbero is licensed under the [MIT License](LICENSE).
+
+---
+
+## Acknowledgements
+
+Inspired by the need for clear and simple Boolean utilities in JavaScript.

package/dist/index.cjs

@@ -0,0 +1,31 @@
+// Import utilities
+import { isTruthy, isFalsey } from './core/truthy.js';
+import { isNullOrUndefined, isEmptyArray, isEmptyObject } from './utils/validation.js';
+import { isEqual, isStrictEqual } from './core/compare.js';
+import { xor, nand } from './utils/logic.js';
+
+// Export utilities
+export {
+  isTruthy,
+  isFalsey,
+  isNullOrUndefined,
+  isEmptyArray,
+  isEmptyObject,
+  isEqual,
+  isStrictEqual,
+  xor,
+  nand,
+};
+
+// Default export (optional for consumers who prefer this style)
+export default {
+  isTruthy,
+  isFalsey,
+  isNullOrUndefined,
+  isEmptyArray,
+  isEmptyObject,
+  isEqual,
+  isStrictEqual,
+  xor,
+  nand,
+};

package/dist/index.mjs

@@ -0,0 +1,31 @@
+// Import utilities
+import { isTruthy, isFalsey } from './core/truthy.js';
+import { isNullOrUndefined, isEmptyArray, isEmptyObject } from './utils/validation.js';
+import { isEqual, isStrictEqual } from './core/compare.js';
+import { xor, nand } from './utils/logic.js';
+
+// Export utilities
+export {
+  isTruthy,
+  isFalsey,
+  isNullOrUndefined,
+  isEmptyArray,
+  isEmptyObject,
+  isEqual,
+  isStrictEqual,
+  xor,
+  nand,
+};
+
+// Default export (optional for consumers who prefer this style)
+export default {
+  isTruthy,
+  isFalsey,
+  isNullOrUndefined,
+  isEmptyArray,
+  isEmptyObject,
+  isEqual,
+  isStrictEqual,
+  xor,
+  nand,
+};

package/package.json

@@ -0,0 +1,33 @@
+{
+    "name": "barbero",
+    "version": "0.1.0-alpha.1",
+    "description": "A lightweight utility library for Boolean logic.",
+    "main": "dist/index.cjs",
+    "module": "dist/index.mjs",
+    "type": "module",
+    "scripts": {
+        "build": "npm run build:cjs && npm run build:mjs",
+        "build:cjs": "cp src/index.js dist/index.cjs",
+        "build:mjs": "cp src/index.js dist/index.mjs",
+        "test": "echo 'No tests yet'"
+    },
+    "keywords": [
+        "boolean",
+        "utility",
+        "truthy",
+        "falsey",
+        "logic",
+        "barbero",
+        "javascript"
+    ],
+    "author": "Bhuannaich Fhirinn <BhuannaichFhirinn@gmail.com> (https://github.com/BhuannaichFhirinn)",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/BhuannaichFhirinn/barbero.git"
+    },
+    "bugs": {
+        "url": "https://github.com/BhuannaichFhirinn/barbero/issues"
+    },
+    "homepage": "https://github.com/BhuannaichFhirinn/barbero#readme"
+}

package/src/core/compare.js

@@ -0,0 +1,27 @@
+// Perform a deep equality check between two values
+export const isEqual = (a, b) => {
+    if (a === b) return true;
+  
+    if (typeof a !== typeof b) return false;
+  
+    if (typeof a === 'object' && a !== null && b !== null) {
+      const keysA = Object.keys(a);
+      const keysB = Object.keys(b);
+  
+      if (keysA.length !== keysB.length) return false;
+  
+      for (const key of keysA) {
+        if (!keysB.includes(key) || !isEqual(a[key], b[key])) {
+          return false;
+        }
+      }
+  
+      return true;
+    }
+  
+    return false;
+  };
+  
+  // Perform a strict equality check between two values
+  export const isStrictEqual = (a, b) => Object.is(a, b);
+  

package/src/core/truthy.js

@@ -0,0 +1,5 @@
+// Check if a value is truthy
+export const isTruthy = (value) => !!value;
+
+// Check if a value is falsey
+export const isFalsey = (value) => !value;

package/src/index.js

@@ -0,0 +1,31 @@
+// Import utilities
+import { isTruthy, isFalsey } from './core/truthy.js';
+import { isNullOrUndefined, isEmptyArray, isEmptyObject } from './utils/validation.js';
+import { isEqual, isStrictEqual } from './core/compare.js';
+import { xor, nand } from './utils/logic.js';
+
+// Export utilities
+export {
+  isTruthy,
+  isFalsey,
+  isNullOrUndefined,
+  isEmptyArray,
+  isEmptyObject,
+  isEqual,
+  isStrictEqual,
+  xor,
+  nand,
+};
+
+// Default export (optional for consumers who prefer this style)
+export default {
+  isTruthy,
+  isFalsey,
+  isNullOrUndefined,
+  isEmptyArray,
+  isEmptyObject,
+  isEqual,
+  isStrictEqual,
+  xor,
+  nand,
+};

package/src/utiles/logic.js

@@ -0,0 +1,5 @@
+// Perform an XOR (exclusive OR) operation between two values
+export const xor = (a, b) => !!a !== !!b;
+
+// Perform a NAND (NOT AND) operation between two values
+export const nand = (a, b) => !(a && b);

package/src/utiles/validation.js

@@ -0,0 +1,9 @@
+// Check if a value is null or undefined
+export const isNullOrUndefined = (value) => value === null || value === undefined;
+
+// Check if an array is empty
+export const isEmptyArray = (array) => Array.isArray(array) && array.length === 0;
+
+// Check if an object is empty
+export const isEmptyObject = (object) => 
+  object && typeof object === 'object' && Object.keys(object).length === 0;