remove-anything 0.0.2 → 1.0.0

package/README.md

@@ -1,5 +1,12 @@
 # Remove Anything ✂️
 
+<a href="https://www.npmjs.com/package/remove-anything"><img src="https://img.shields.io/npm/v/remove-anything.svg" alt="Total Downloads"></a>
+<a href="https://www.npmjs.com/package/remove-anything"><img src="https://img.shields.io/npm/dw/remove-anything.svg" alt="Latest Stable Version"></a>
+
+```
+npm i remove-anything
+```
+
 Removes props (eg. undefined) from an object
 
 An optimised way to remove any prop (eg. `undefined`) from an object. A small and simple integration.

package/dist/{index.cjs.js → index.cjs}

@@ -7,15 +7,19 @@ var isWhat = require('is-what');
 /**
  * Recursively remove props from an object, if the prop's value matches any of those in `valuesToRemove`
  */
-function removeProps(payload, valuesToRemove) {
-    if (valuesToRemove === void 0) { valuesToRemove = []; }
+function removeProps(payload, valuesToRemove = []) {
     if (!isWhat.isPlainObject(payload) || !isWhat.isFullArray(valuesToRemove))
         return payload;
-    return Object.entries(payload).reduce(function (carry, _a) {
-        var key = _a[0], value = _a[1];
+    const removeEmptyObjects = !!valuesToRemove.find((val) => isWhat.isEmptyObject(val));
+    return Object.entries(payload).reduce((carry, [key, value]) => {
+        if (removeEmptyObjects && isWhat.isEmptyObject(value))
+            return carry;
         if (valuesToRemove.includes(value))
             return carry;
-        carry[key] = removeProps(value, valuesToRemove);
+        const newVal = removeProps(value, valuesToRemove);
+        if (removeEmptyObjects && isWhat.isEmptyObject(newVal))
+            return carry;
+        carry[key] = newVal;
         return carry;
     }, {});
 }

package/dist/index.es.js

@@ -0,0 +1,29 @@
+import { isPlainObject, isFullArray, isEmptyObject } from 'is-what';
+
+/**
+ * Recursively remove props from an object, if the prop's value matches any of those in `valuesToRemove`
+ */
+function removeProps(payload, valuesToRemove = []) {
+    if (!isPlainObject(payload) || !isFullArray(valuesToRemove))
+        return payload;
+    const removeEmptyObjects = !!valuesToRemove.find((val) => isEmptyObject(val));
+    return Object.entries(payload).reduce((carry, [key, value]) => {
+        if (removeEmptyObjects && isEmptyObject(value))
+            return carry;
+        if (valuesToRemove.includes(value))
+            return carry;
+        const newVal = removeProps(value, valuesToRemove);
+        if (removeEmptyObjects && isEmptyObject(newVal))
+            return carry;
+        carry[key] = newVal;
+        return carry;
+    }, {});
+}
+/**
+ * Recursively remove props from an object, if the prop's value matches `valueToRemove`
+ */
+function removeProp(payload, valueToRemove) {
+    return removeProps(payload, [valueToRemove]);
+}
+
+export { removeProp, removeProps };

package/dist/types/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Recursively remove props from an object, if the prop's value matches any of those in `valuesToRemove`
+ */
+export declare function removeProps(payload: Record<string, any>, valuesToRemove?: any[]): Record<string, unknown>;
+export declare function removeProp<Payload extends Record<string, any>>(payload: Payload, valueToRemove: any): Payload;

package/package.json

@@ -1,32 +1,48 @@
 {
   "name": "remove-anything",
   "sideEffects": false,
-  "version": "0.0.2",
+  "type": "module",
+  "version": "1.0.0",
   "description": "Remove any prop (eg. `undefined`) from an object",
-  "main": "dist/index.cjs.js",
-  "module": "dist/index.esm.js",
-  "typings": "types/index.d.ts",
+  "module": "./dist/index.es.js",
+  "main": "./dist/index.cjs",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.es.js",
+      "require": "./dist/index.cjs",
+      "types": "./dist/types/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=12.13",
+    "npm": ">=7"
+  },
   "scripts": {
-    "test": "ava",
-    "lint": "eslint . --ext .js,.jsx,.ts,.tsx",
-    "rollup": "rollup -c build.js",
-    "build": "npm run lint && npm run test && npm run rollup"
+    "test": "vitest run",
+    "lint": "tsc --noEmit && eslint ./src --ext .ts",
+    "build": "rollup -c ./scripts/build.js",
+    "release": "npm run lint && del dist && npm run build && np"
   },
   "dependencies": {
-    "is-what": "^3.12.0"
+    "is-what": "^4.1.1"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^4.14.2",
-    "@typescript-eslint/parser": "^4.14.2",
-    "ava": "^3.15.0",
-    "eslint": "^7.19.0",
-    "eslint-config-prettier": "^7.2.0",
-    "eslint-plugin-tree-shaking": "^1.8.0",
-    "rollup": "^2.38.5",
-    "rollup-plugin-typescript2": "^0.29.0",
-    "ts-node": "^9.1.1",
-    "tsconfig-paths": "^3.9.0",
-    "typescript": "^4.1.3"
+    "@typescript-eslint/eslint-plugin": "^5.10.1",
+    "@typescript-eslint/parser": "^5.10.1",
+    "del-cli": "^4.0.1",
+    "eslint": "^8.7.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-tree-shaking": "^1.10.0",
+    "np": "^7.6.0",
+    "prettier": "^2.5.1",
+    "rollup": "^2.66.0",
+    "rollup-plugin-typescript2": "^0.31.1",
+    "typescript": "^4.5.5",
+    "vitest": "^0.2.1"
   },
   "keywords": [
     "remove",
@@ -35,6 +51,7 @@
     "remove-undefined"
   ],
   "author": "Luca Ban - Mesqueeb",
+  "funding": "https://github.com/sponsors/mesqueeb",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/mesqueeb/remove-anything/issues"
@@ -44,13 +61,35 @@
     "type": "git",
     "url": "git+https://github.com/mesqueeb/remove-anything.git"
   },
-  "ava": {
-    "extensions": [
-      "ts"
+  "np": {
+    "yarn": false,
+    "branch": "production"
+  },
+  "eslintConfig": {
+    "ignorePatterns": [
+      "node_modules",
+      "dist",
+      "scripts",
+      "test"
+    ],
+    "root": true,
+    "parser": "@typescript-eslint/parser",
+    "plugins": [
+      "@typescript-eslint",
+      "tree-shaking"
+    ],
+    "extends": [
+      "eslint:recommended",
+      "plugin:@typescript-eslint/eslint-recommended",
+      "plugin:@typescript-eslint/recommended",
+      "prettier"
     ],
-    "require": [
-      "tsconfig-paths/register",
-      "ts-node/register"
-    ]
+    "rules": {
+      "@typescript-eslint/no-empty-function": "off",
+      "@typescript-eslint/no-explicit-any": "off",
+      "@typescript-eslint/ban-ts-ignore": "off",
+      "tree-shaking/no-side-effects-in-initialization": "error",
+      "@typescript-eslint/ban-ts-comment": "off"
+    }
   }
 }

package/.eslintignore

@@ -1,9 +0,0 @@
-# don't ever lint node_modules
-node_modules
-# don't lint build output (make sure it's set to your correct build folder name)
-dist
-# don't lint nyc coverage output
-coverage
-
-test
-.eslintrc.js

package/.eslintrc.js

@@ -1,18 +0,0 @@
-// npm i -D @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-prettier eslint-plugin-tree-shaking
-module.exports = {
-  root: true,
-  parser: '@typescript-eslint/parser',
-  plugins: ['@typescript-eslint', 'tree-shaking'],
-  extends: [
-    'eslint:recommended',
-    'plugin:@typescript-eslint/eslint-recommended',
-    'plugin:@typescript-eslint/recommended',
-    'prettier/@typescript-eslint',
-  ],
-  rules: {
-    '@typescript-eslint/no-explicit-any': 'off',
-    '@typescript-eslint/ban-ts-ignore': 'off',
-    '@typescript-eslint/explicit-module-boundary-types': 'off',
-    'tree-shaking/no-side-effects-in-initialization': 'error',
-  },
-}

package/.prettierrc

@@ -1,9 +0,0 @@
-{
-  "printWidth": 100,
-  "tabWidth": 2,
-  "singleQuote": true,
-  "trailingComma": "es5",
-  "semi": false,
-  "bracketSpacing": true,
-  "quoteProps": "consistent"
-}

package/build.js

@@ -1,57 +0,0 @@
-/* eslint-disable */
-
-// npm install rollup-plugin-typescript2 typescript --save-dev
-import typescript from 'rollup-plugin-typescript2'
-
-// ------------------------------------------------------------------------------------------
-// formats
-// ------------------------------------------------------------------------------------------
-// amd – Asynchronous Module Definition, used with module loaders like RequireJS
-// cjs – CommonJS, suitable for Node and Browserify/Webpack
-// esm – Keep the bundle as an ES module file
-// iife – A self-executing function, suitable for inclusion as a <script> tag. (If you want to create a bundle for your application, you probably want to use this, because it leads to smaller file sizes.)
-// umd – Universal Module Definition, works as amd, cjs and iife all in one
-// system – Native format of the SystemJS loader
-
-// ------------------------------------------------------------------------------------------
-// setup
-// ------------------------------------------------------------------------------------------
-const pkg = require('./package.json')
-const name = pkg.name
-const className = name.replace(/(^\w|-\w)/g, c => c.replace('-', '').toUpperCase())
-const external = Object.keys(pkg.dependencies || [])
-const plugins = [
-  typescript({ useTsconfigDeclarationDir: true, tsconfigOverride: { exclude: ['test/**/*'] } }),
-]
-
-// ------------------------------------------------------------------------------------------
-// Builds
-// ------------------------------------------------------------------------------------------
-function defaults (config) {
-  // defaults
-  const defaults = {
-    plugins,
-    external,
-  }
-  // defaults.output
-  config.output = config.output.map(output => {
-    return Object.assign(
-      {
-        sourcemap: false,
-        name: className,
-      },
-      output
-    )
-  })
-  return Object.assign(defaults, config)
-}
-
-export default [
-  defaults({
-    input: 'src/index.ts',
-    output: [
-      { file: 'dist/index.cjs.js', format: 'cjs' },
-      { file: 'dist/index.esm.js', format: 'esm' },
-    ],
-  }),
-]

package/dist/index.esm.js

@@ -1,25 +0,0 @@
-import { isPlainObject, isFullArray } from 'is-what';
-
-/**
- * Recursively remove props from an object, if the prop's value matches any of those in `valuesToRemove`
- */
-function removeProps(payload, valuesToRemove) {
-    if (valuesToRemove === void 0) { valuesToRemove = []; }
-    if (!isPlainObject(payload) || !isFullArray(valuesToRemove))
-        return payload;
-    return Object.entries(payload).reduce(function (carry, _a) {
-        var key = _a[0], value = _a[1];
-        if (valuesToRemove.includes(value))
-            return carry;
-        carry[key] = removeProps(value, valuesToRemove);
-        return carry;
-    }, {});
-}
-/**
- * Recursively remove props from an object, if the prop's value matches `valueToRemove`
- */
-function removeProp(payload, valueToRemove) {
-    return removeProps(payload, [valueToRemove]);
-}
-
-export { removeProp, removeProps };

package/src/index.ts

@@ -1,38 +0,0 @@
-import { isFullArray, isPlainObject } from 'is-what'
-
-type PlainObject = Record<string, any>
-
-// function overload for external use & type accuracy
-export function removeProps<Payload extends PlainObject> (
-  payload: Payload,
-  valuesToRemove: any[]
-): Payload
-/**
- * Recursively remove props from an object, if the prop's value matches any of those in `valuesToRemove`
- */
-export function removeProps (
-  payload: PlainObject,
-  valuesToRemove: any[] = []
-): PlainObject {
-  if (!isPlainObject(payload) || !isFullArray(valuesToRemove)) return payload
-  return Object.entries(payload).reduce((carry, [key, value]) => {
-    if (valuesToRemove.includes(value)) return carry
-    carry[key] = removeProps(value, valuesToRemove)
-    return carry
-  }, {} as PlainObject)
-}
-
-// function overload for external use & type accuracy
-export function removeProp<Payload extends PlainObject> (
-  payload: Payload,
-  valueToRemove: any
-): Payload
-/**
- * Recursively remove props from an object, if the prop's value matches `valueToRemove`
- */
-export function removeProp (
-  payload: PlainObject,
-  valueToRemove: any
-): PlainObject {
-  return removeProps(payload, [valueToRemove])
-}

package/test/index.ts

@@ -1,13 +0,0 @@
-import test from 'ava'
-import { removeProp } from '../src/index'
-
-test('removeProp', t => {
-	t.deepEqual(
-		{ a: 1 } as any,
-		removeProp({ a: 1, b: undefined }, undefined)
-	)
-	t.deepEqual(
-		{ b: undefined } as any,
-		removeProp({ a: 1, b: undefined }, 1)
-	)
-})

package/tsconfig.json

@@ -1,14 +0,0 @@
-{
-  "compilerOptions": {
-    "baseUrl": ".",
-    "outDir": "./dist",
-    "declaration": true,
-    "declarationDir": "./types/",
-    "target": "es5",
-    "lib": ["es5", "es2015", "es2016", "es2017", "dom"]
-  },
-  "include": [
-    "src/**/*",
-    "test/**/*"
-  ]
-}

package/types/index.d.ts

@@ -1,4 +0,0 @@
-declare type PlainObject = Record<string, any>;
-export declare function removeProps<Payload extends PlainObject>(payload: Payload, valuesToRemove: any[]): Payload;
-export declare function removeProp<Payload extends PlainObject>(payload: Payload, valueToRemove: any): Payload;
-export {};