path-to-prop 0.0.1 → 1.0.1

package/README.md

@@ -1,19 +1,37 @@
 # Path to prop 🛤
 
+<a href="https://www.npmjs.com/package/path-to-prop"><img src="https://img.shields.io/npm/v/path-to-prop.svg" alt="Total Downloads"></a>
+<a href="https://www.npmjs.com/package/path-to-prop"><img src="https://img.shields.io/npm/dw/path-to-prop.svg" alt="Latest Stable Version"></a>
+
 ```
 npm i path-to-prop
 ```
 
-Retrieves a property from an object based on a path.to.that.prop
+Retrieves a property from an object based on a `'path/to.that.prop'`
+
+- Supports paths with both `/` and `.` to separate props
+- Safely typed (with TypeScript) - returns `unknown`
 
 ## Usage
 
 ```js
-import pathToProp from 'path-to-prop'
+import { getProp } from 'path-to-prop'
 
 const target = {a: {b: {c: {d: {e: 1}}}}}
-const path = 'a.b.c.d.e'
+const path = 'a/b/c.d.e'
+
+getProp(target, path)
+  // returns 1
+
+getProp(target, 'nonexistent.prop')
+  // returns undefined
+```
+
+When you have `/` or `.` in your prop names, use an array:
+
+```js
+const target = {'a/b': {'c.d': 1}}
 
-pathToProp(target, path)
+getProp(target, ['a/b', 'c.d'])
   // returns 1
 ```

package/dist/index.cjs

@@ -0,0 +1,33 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/**
+ * Returns the keys of a path
+ *
+ * @param   {string} path   a/path/like.this
+ * @returns {string[]} with keys
+ */
+function getKeysFromPath(path) {
+    return path.split ? path.split(/\.|\//) : path;
+}
+/**
+ * Gets a deep property in an object, based on a path to that property. Pass the path as array when you have prop names with `.` or `/` in them
+ *
+ * @param {Record<string, unknown>} obj an object to wherefrom to retrieve the deep reference of
+ * @param {string | string[]} path 'path/to.prop' or ['path', 'to', 'prop']
+ * @returns {unknown} the last prop in the path
+ */
+function pathToProp(obj, path) {
+    const keys = getKeysFromPath(path);
+    let p;
+    for (p = 0; p < keys.length; p++) {
+        obj = (obj ? obj[keys[p]] : undefined);
+    }
+    return obj === undefined ? undefined : obj;
+}
+const getProp = pathToProp;
+
+exports.getKeysFromPath = getKeysFromPath;
+exports.getProp = getProp;
+exports.pathToProp = pathToProp;

package/dist/index.es.js

@@ -0,0 +1,27 @@
+/**
+ * Returns the keys of a path
+ *
+ * @param   {string} path   a/path/like.this
+ * @returns {string[]} with keys
+ */
+function getKeysFromPath(path) {
+    return path.split ? path.split(/\.|\//) : path;
+}
+/**
+ * Gets a deep property in an object, based on a path to that property. Pass the path as array when you have prop names with `.` or `/` in them
+ *
+ * @param {Record<string, unknown>} obj an object to wherefrom to retrieve the deep reference of
+ * @param {string | string[]} path 'path/to.prop' or ['path', 'to', 'prop']
+ * @returns {unknown} the last prop in the path
+ */
+function pathToProp(obj, path) {
+    const keys = getKeysFromPath(path);
+    let p;
+    for (p = 0; p < keys.length; p++) {
+        obj = (obj ? obj[keys[p]] : undefined);
+    }
+    return obj === undefined ? undefined : obj;
+}
+const getProp = pathToProp;
+
+export { getKeysFromPath, getProp, pathToProp };

package/dist/types/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Returns the keys of a path
+ *
+ * @param   {string} path   a/path/like.this
+ * @returns {string[]} with keys
+ */
+export declare function getKeysFromPath(path: string | string[]): string[];
+/**
+ * Gets a deep property in an object, based on a path to that property. Pass the path as array when you have prop names with `.` or `/` in them
+ *
+ * @param {Record<string, unknown>} obj an object to wherefrom to retrieve the deep reference of
+ * @param {string | string[]} path 'path/to.prop' or ['path', 'to', 'prop']
+ * @returns {unknown} the last prop in the path
+ */
+export declare function pathToProp(obj: Record<string, unknown>, path: string | string[]): unknown;
+export declare const getProp: typeof pathToProp;

package/package.json

@@ -1,32 +1,100 @@
 {
   "name": "path-to-prop",
-  "version": "0.0.1",
-  "description": "Retrieves a property from an object based on a path.to.that.prop",
-  "main": "dist/index.cjs.js",
-  "module": "dist/index.esm.js",
-  "typings": "types/index.d.ts",
-  "scripts": {
-    "test": "ava",
-    "rollup": "rollup -c build/rollup.js",
-    "build": "npm run rollup && npm run test"
+  "version": "1.0.1",
+  "sideEffects": false,
+  "type": "module",
+  "description": "Retrieves a property from an object based on a 'path/to.that.prop'",
+  "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"
+    }
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/mesqueeb/path-to-prop.git"
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=12.13",
+    "npm": ">=7"
+  },
+  "scripts": {
+    "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"
   },
   "keywords": [
-    "path-to-prop"
+    "path-to-prop",
+    "dot-prop",
+    "dotprop",
+    "propdot",
+    "dot-notation",
+    "dotnotation-prop",
+    "delve",
+    "prop-at-path",
+    "get-prop-at-path",
+    "get-property-at-path",
+    "get-dot-prop",
+    "get-dot-property"
   ],
   "author": "Luca Ban - Mesqueeb",
+  "funding": "https://github.com/sponsors/mesqueeb",
   "license": "MIT",
+  "homepage": "https://github.com/mesqueeb/path-to-prop#readme",
+  "devDependencies": {
+    "@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"
+  },
   "bugs": {
     "url": "https://github.com/mesqueeb/path-to-prop/issues"
   },
-  "homepage": "https://github.com/mesqueeb/path-to-prop#readme",
-  "devDependencies": {
-    "ava": "^2.4.0",
-    "rollup": "^1.25.1",
-    "rollup-plugin-typescript2": "^0.24.3",
-    "typescript": "^3.6.4"
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mesqueeb/path-to-prop.git"
+  },
+  "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"
+    ],
+    "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/build/rollup.js

@@ -1,56 +0,0 @@
-/* eslint-disable */
-
-// npm install rollup-plugin-typescript2 typescript --save-dev
-import typescript from 'rollup-plugin-typescript2'
-// import { terser } from 'rollup-plugin-terser'
-// import resolve from 'rollup-plugin-node-resolve'
-
-// ------------------------------------------------------------------------------------------
-// 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}),
-]
-
-// ------------------------------------------------------------------------------------------
-// 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.cjs.js

@@ -1,40 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-/**
- * Returns the keys of a path
- *
- * @param   {string} path   a/path/like.this
- * @returns {string[]} with keys
- */
-function getKeysFromPath(path) {
-    if (!path)
-        return [];
-    // eslint-disable-next-line no-useless-escape
-    return path.match(/[^\/^\.]+/g);
-}
-/**
- * Gets a deep property in an object, based on a path to that property
- *
- * @param {object} target an object to wherefrom to retrieve the deep reference of
- * @param {string} path   'path/to.prop'
- * @returns {*} the last prop in the path
- */
-function pathToProp(target, path) {
-    var keys = getKeysFromPath(path);
-    if (!keys.length)
-        return target;
-    var obj = target;
-    while (obj && keys.length > 1) {
-        obj = obj[keys.shift()];
-    }
-    var key = keys.shift();
-    if (obj && obj.hasOwnProperty(key)) {
-        return obj[key];
-    }
-}
-
-exports.default = pathToProp;
-exports.getKeysFromPath = getKeysFromPath;
-exports.pathToProp = pathToProp;

package/dist/index.esm.js

@@ -1,35 +0,0 @@
-/**
- * Returns the keys of a path
- *
- * @param   {string} path   a/path/like.this
- * @returns {string[]} with keys
- */
-function getKeysFromPath(path) {
-    if (!path)
-        return [];
-    // eslint-disable-next-line no-useless-escape
-    return path.match(/[^\/^\.]+/g);
-}
-/**
- * Gets a deep property in an object, based on a path to that property
- *
- * @param {object} target an object to wherefrom to retrieve the deep reference of
- * @param {string} path   'path/to.prop'
- * @returns {*} the last prop in the path
- */
-function pathToProp(target, path) {
-    var keys = getKeysFromPath(path);
-    if (!keys.length)
-        return target;
-    var obj = target;
-    while (obj && keys.length > 1) {
-        obj = obj[keys.shift()];
-    }
-    var key = keys.shift();
-    if (obj && obj.hasOwnProperty(key)) {
-        return obj[key];
-    }
-}
-
-export default pathToProp;
-export { getKeysFromPath, pathToProp };

package/src/index.ts

@@ -1,34 +0,0 @@
-
-/**
- * Returns the keys of a path
- *
- * @param   {string} path   a/path/like.this
- * @returns {string[]} with keys
- */
-export function getKeysFromPath (path: string): string[] {
-  if (!path) return []
-  // eslint-disable-next-line no-useless-escape
-  return path.match(/[^\/^\.]+/g)
-}
-
-/**
- * Gets a deep property in an object, based on a path to that property
- *
- * @param {object} target an object to wherefrom to retrieve the deep reference of
- * @param {string} path   'path/to.prop'
- * @returns {*} the last prop in the path
- */
-export function pathToProp (target: object, path: string): any {
-  const keys = getKeysFromPath(path)
-  if (!keys.length) return target
-  let obj = target
-  while (obj && keys.length > 1) {
-    obj = obj[keys.shift()]
-  }
-  const key = keys.shift()
-  if (obj && obj.hasOwnProperty(key)) {
-    return obj[key]
-  }
-}
-
-export default pathToProp

package/test/index.js

@@ -1,36 +0,0 @@
-import test from 'ava'
-import pathToProp from '../dist/index.cjs'
-
-test('test', t => {
-  let res, target, path
-  target = {a: {b: {c: {d: {e: 1}}}}}
-  path = 'a.b.c.d.e'
-  res = pathToProp(target, path)
-  t.is(res, 1)
-  path = 'a.b.c.d'
-  res = pathToProp(target, path)
-  t.deepEqual(res, {e: 1})
-  path = 'a.b'
-  res = pathToProp(target, path)
-  t.deepEqual(res, {c: {d: {e: 1}}})
-})
-
-test('not an object', t => {
-  let target, path, res
-  path = 'a.b'
-  target = null
-  res = pathToProp(target, path)
-  t.is(res, undefined)
-  target = 1
-  res = pathToProp(target, path)
-  t.is(res, undefined)
-  target = true
-  res = pathToProp(target, path)
-  t.is(res, undefined)
-  target = new Date()
-  res = pathToProp(target, path)
-  t.is(res, undefined)
-  target = function () {}
-  res = pathToProp(target, path)
-  t.is(res, undefined)
-})