feat: introduce ox

Author: rohmanhm

.github/workflows/pull_requests.yml

@@ -3,7 +3,7 @@ name: Pull Requests
 on:
   pull_request:
     branches:
-      - master
+      - main
 
 jobs:
   test:

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn tsdx lint

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Rohman Habib M
+Copyright (c) 2021 Rohman Habib M
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,54 +1,52 @@
-# purify-obj
+# @rohmanhm/ox
 
-> Purify & clean objects recursively, deleting undefined & null or falsy properties.
+> A Javascript utility to clean objects recursively, deleting undefined & null or falsy properties.
 
 ## Install
 
 ```
-$ npm install purify-obj
+$ npm install @rohmanhm/ox
 ```
 
 Or
 
 ```
-$ yarn add purify-obj
+$ yarn add @rohmanhm/ox
 ```
 
 ## Usage
 
 ```js
-import { PurifyObj } from "purify-obj";
+import ox from '@rohmanhm/ox';
 // Or
-const { PurifyObj } = require("purify-obj");
-// Or you can use the `po` shortcut
-import { po } from "purify-obj";
+const ox = require('@rohmanhm/ox').default;
 
 const object = {
-  className: "only-this-obj-key-will-persist",
-  disabled: "",
+  className: 'only-this-obj-key-will-persist',
+  disabled: '',
   autoComplete: false,
   checked: undefined,
-  spellCheck: null
+  spellCheck: null,
 };
-const newObject = po(object);
+const newObject = ox(object);
 //=> {className: 'only-this-obj-key-will-persist'}
 ```
 
 ## API
 
-### PurifyObj(source, strict)
+### ox(source, strict)
 
 #### source
 
 Type: `object`
 
-Source object to purify properties from.
+Source object to clean properties from.
 
 #### strict
 
 Type: `boolean`
-
-Strict will purify all falsy key
+Default: `true`
+Strict will clean all falsy key
 
 ## Local Development
 

package.json

@@ -1,18 +1,19 @@
 {
-  "name": "purify-obj",
+  "name": "@rohmanhm/ox",
   "version": "0.1.0",
   "license": "MIT",
   "main": "dist/index.js",
-  "module": "dist/purify-obj.esm.js",
+  "module": "dist/ox.esm.js",
   "typings": "dist/index.d.ts",
-  "repository": "rohmanhm/purify-obj",
-  "description": "Purify & clean objects recursively, deleting undefined & null or falsy properties.",
+  "repository": "rohmanhm/ox",
+  "description": "A Javascript utility to clean objects recursively, deleting undefined & null or falsy properties.  ",
   "author": {
     "name": "Rohman Habib M",
     "email": "rohmanhm@icloud.com",
-    "url": "https://rohmanhm.github.com"
+    "url": "https://rohmanhm.com"
   },
   "keywords": [
+    "utility",
     "purify",
     "clean",
     "object",
@@ -30,25 +31,24 @@
     "start": "tsdx watch",
     "build": "tsdx build",
     "test": "tsdx test",
-    "lint": "tsdx lint"
+    "lint": "tsdx lint",
+    "postinstall": "husky install",
+    "prepublishOnly": "pinst --disable",
+    "postpublish": "pinst --enable"
   },
   "peerDependencies": {},
-  "husky": {
-    "hooks": {
-      "pre-commit": "tsdx lint"
-    }
-  },
   "prettier": {
     "printWidth": 80,
     "semi": true,
     "singleQuote": true,
     "trailingComma": "es5"
   },
   "devDependencies": {
-    "@types/jest": "^24.0.23",
-    "husky": "^3.1.0",
-    "tsdx": "^0.11.0",
-    "tslib": "^1.10.0",
-    "typescript": "^3.7.2"
+    "@types/jest": "^26.0.20",
+    "husky": "5",
+    "pinst": "^2.1.4",
+    "tsdx": "^0.14.1",
+    "tslib": "^2.1.0",
+    "typescript": "^4.1.5"
   }
 }

src/index.ts

@@ -1,7 +1,7 @@
 import { isEmpty } from './isEmpty';
 
 // Type of object shape
-export type ObjectShape = { [key: string]: any };
+export type Obj = { [key: string]: any };
 // Type of ignored type
 export type IgnoredTypes = null | undefined;
 // Util to extract type from <T> value
@@ -11,34 +11,14 @@ export type MethodKeys<T, U> = {
 // Util to remove ignored key
 export type RemoveIgnoredKey<T> = Pick<T, MethodKeys<T, IgnoredTypes>> | null;
 // Type object return
-export type PurifyObjReturn<ObjectType> = RemoveIgnoredKey<ObjectType>;
+export type OxReturn<ObjectType> = RemoveIgnoredKey<ObjectType>;
 
 const toStr = Object.prototype.toString;
 
-export function PurifyObj<ObjectType extends ObjectShape>(
-  obj: ObjectType,
-  strict?: boolean
-): PurifyObjReturn<ObjectType> {
-  strict = strict || false;
-
-  let newObj = _purifyObj(obj, strict);
-
-  if (newObj === null) {
-    newObj = {} as any;
-  }
-
-  return newObj;
-}
-
-export const po = PurifyObj;
-
-function _purifyObj<ObjectType extends ObjectShape>(
-  obj: ObjectType,
-  strict: boolean
-): PurifyObjReturn<ObjectType> {
+function _ox<T extends Obj>(obj: T, strict: boolean): OxReturn<T> {
   let k: string;
   for (k in obj) {
-    purifyProperty(k, obj[k], obj);
+    cleanProperty(k, obj[k], obj);
   }
 
   // Check if the object is empty
@@ -49,8 +29,8 @@ function _purifyObj<ObjectType extends ObjectShape>(
     return null;
   }
 
-  function purifyProperty(key: string, value: any, ref: ObjectShape) {
-    if (!shouldPurifyProperty(value)) {
+  function cleanProperty(key: string, value: any, ref: Obj) {
+    if (!shouldCleanProperty(value)) {
       delete ref[key];
       return;
     }
@@ -61,9 +41,9 @@ function _purifyObj<ObjectType extends ObjectShape>(
     if (typeOfValue === 'object' && toStr.call(value) !== '[object Date]') {
       // Exception - If array
       if (toStr.call(obj[k]) === '[object Array]') {
-        ref[key] = ref[key].filter(shouldPurifyProperty);
+        ref[key] = ref[key].filter(shouldCleanProperty);
       } else {
-        _purifyObj(ref[key], strict);
+        _ox(ref[key], strict);
       }
 
       if (isEmpty(ref[key])) {
@@ -72,9 +52,23 @@ function _purifyObj<ObjectType extends ObjectShape>(
     }
   }
 
-  function shouldPurifyProperty(value: any) {
+  function shouldCleanProperty(value: any) {
     return !(!value && (strict || (!strict && value == null)));
   }
 }
 
+export default function ox<T extends Obj>(
+  obj: T,
+  strict?: boolean
+): OxReturn<T> {
+  strict = typeof strict === 'undefined' ? true : strict;
+  let newObj = _ox(obj, strict);
+
+  if (newObj === null) {
+    newObj = {} as any;
+  }
+
+  return newObj;
+}
+
 export { isEmpty };

test/index.test.ts

@@ -1,13 +1,11 @@
-import { po } from '../src';
+import ox from '../src';
 
 test('remove null and undefined key value', () => {
   const expected = {
     className: 'only-this-obj-key-will-persist',
-    disabled: '',
-    autoComplete: false,
   };
 
-  const actual = po({
+  const actual = ox({
     ...expected,
     disabled: '',
     autoComplete: false,
@@ -18,20 +16,22 @@ test('remove null and undefined key value', () => {
   expect(actual).toEqual(expected);
 });
 
-test('strict mode remove falsy key value', () => {
+test('disable strict mode not remove falsy key value', () => {
   const expected = {
     className: 'only-this-obj-key-will-persist',
+    disabled: '',
+    autoComplete: false,
   };
 
-  const actual = po(
+  const actual = ox(
     {
       ...expected,
       disabled: '',
       autoComplete: false,
       checked: undefined,
       spellCheck: null,
     },
-    true
+    false
   );
 
   expect(actual).toEqual(expected);

tsconfig.json

@@ -1,25 +1,35 @@
 {
-  "include": ["src", "types", "test"],
+  // see https://www.typescriptlang.org/tsconfig to better understand tsconfigs
+  "include": ["src", "types"],
   "compilerOptions": {
-    "target": "es5",
     "module": "esnext",
     "lib": ["dom", "esnext"],
     "importHelpers": true,
+    // output .d.ts declaration files for consumers
     "declaration": true,
+    // output .js.map sourcemap files for consumers
     "sourceMap": true,
-    "rootDir": "./",
+    // match output dir to input dir. e.g. dist/index instead of dist/src/index
+    "rootDir": "./src",
+    // stricter type-checking for stronger correctness. Recommended by TS
     "strict": true,
-    "strictNullChecks": true,
-    "strictFunctionTypes": true,
-    "strictPropertyInitialization": true,
-    "noImplicitThis": true,
-    "alwaysStrict": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
+    // linter checks for common issues
     "noImplicitReturns": true,
     "noFallthroughCasesInSwitch": true,
+    // noUnused* overlap with @typescript-eslint/no-unused-vars, can disable if duplicative
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    // use Node's module resolution algorithm, instead of the legacy TS one
     "moduleResolution": "node",
-    "baseUrl": "./",
-    "esModuleInterop": true
+    // transpile JSX to React.createElement
+    "jsx": "react",
+    // interop between ESM and CJS modules. Recommended by TS
+    "esModuleInterop": true,
+    // significant perf increase by skipping checking .d.ts files, particularly those in node_modules. Recommended by TS
+    "skipLibCheck": true,
+    // error out if import and file system have a casing mismatch. Recommended by TS
+    "forceConsistentCasingInFileNames": true,
+    // `tsdx build` ignores this option, but it is commonly used when type-checking separately with `tsc`
+    "noEmit": true
   }
 }