compose-paths 1.2.1 → 1.2.3

package/CHANGELOG.md

@@ -7,6 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.2.3] - 2023-06-06
+
+### Updated
+
+- README tweaks
+- Update build dependencies
+
+## [1.2.2] - 2022-04-15
+
+### Removed / Fixed
+
+- Remove `browser` setting from `package.json`; seems to cause issues with CodeSandbox build process, and isn't really necessary since the browser-build is something that's interacted with manually.
+
 ## [1.2.1] - 2022-02-07
 
 ### Fixed

package/README.md

@@ -18,15 +18,7 @@
     /></a>
 </p>
 
-```sh
-$ pnpm i compose-paths
-```
-
-`compose-paths` looks at the indentation-level of its input as the cue to concatenate lines together. Either `tabs` or `spaces` should be fine, so long as you're consistent.
-
-## Usage
-
-### `Path` &rarr; `Alias`
+Quickly throw together a few local paths and have them assigned to aliases or routes.
 
 ```js
 const { composePaths } = require('compose-paths')
@@ -54,7 +46,11 @@ paths.aliases
 // ["TEMPLATES", "PAGES", "PUBLIC", "IMAGES"]
 ```
 
-### `Path` &rarr; `Route` (via aliases)
+`compose-paths` looks at the indentation-level of its input as the cue to concatenate lines together. Either `tabs` or `spaces` should be fine, so long as you're consistent.
+
+## More examples
+
+### `Path` &rarr; `Route` (via aliases and `zip`)
 
 ```js
 const { composePaths, zip } = require('compose-paths')
@@ -76,7 +72,6 @@ const paths = composePaths(`
 
 const staticRoutes = zip(routes, paths)
 
-// Then, for example:
 staticRoutes.forEach(([route, path]) => {
   app.get(route, sendFile(path))
 })

package/dist/browser/compose-paths.browser.js

@@ -1,6 +1,6 @@
 /*
  * compose-paths
- * v1.2.1
+ * v1.2.3
  * https://github.com/shuckster/compose-paths
  * License: MIT
  */

package/dist/cjs/compose-paths.cjs.js

@@ -1,7 +1,7 @@
 /*
  * compose-paths
- * v1.2.1
+ * v1.2.3
  * https://github.com/shuckster/compose-paths
  * License: MIT
  */
-module.exports={composePaths:f,zip:h};const p=require("path").join,a="aliases";function f(n){const e=x(n).map(v),s=e.reduce(S,1/0),i=e.map(g(s)),o=b(i),r=_(o),c=o.map(u=>u==null?void 0:u.name).filter(Boolean),l=r;return o.forEach(j(l)),Object.defineProperty(l,a,{value:c,enumerable:!1})}function h(n,t,e){const{aliases:s=[],ignoreAliases:i=!1}=e||{};return(s.length&&!i?s:n[a]).reduce((r,c)=>(i&&s.includes(c)||r.push([n[c],t[c]]),r),[])}const m=/[\r\n]/,d=/(\s*\/\/[^\n\r]*)/,I=/^(\s*)([^$]*)/,A=/\s*=\s*([^$]+)/,P=/^\s*$/;function S(n,{indent:t}){return Math.min(n,t)}function g(n){return({indent:t,content:e})=>({indent:t-n,content:e})}function j(n){return({name:t,index:e})=>{if(!t)return n;const s=n[e];Object.defineProperty(n,t,{value:s,enumerable:!1})}}function _(n){const t=[],e=[];let s=-1,i=-1;return n.forEach(({indent:o,content:r})=>{if(i<=0)i=o;else if(o<=s){let c=1+(s-o)/i;for(;c--;)t.pop()}t.push(r),e.push(p(...t)),s=o}),e}function b(n){return n.map((t,e)=>{const{content:s,indent:i}=t,o=s.match(A);return o?{index:e,indent:i,content:s.slice(0,s.length-o[0].length),name:o[1]}:{index:e,indent:i,content:s}})}function v(n){var s;const t=[n,"",n],e=(s=n.match(I))!=null?s:t;return{indent:e[1].length,content:e[2]}}function x(n){return[n].flat().reduce((t,e)=>[...t,...e.split(m)],[]).filter(E).map(t=>t.replace(d,""))}function E(n){return!P.test(n)}
+module.exports={composePaths:p,zip:h};const f=require("path").join,a="aliases";function p(n){const e=x(n).map(v),s=e.reduce(S,1/0),i=e.map(g(s)),o=b(i),r=_(o),c=o.map(u=>u==null?void 0:u.name).filter(Boolean),l=r;return o.forEach(j(l)),Object.defineProperty(l,a,{value:c,enumerable:!1})}function h(n,t,e){const{aliases:s=[],ignoreAliases:i=!1}=e||{};return(s.length&&!i?s:n[a]).reduce((r,c)=>(i&&s.includes(c)||r.push([n[c],t[c]]),r),[])}const m=/[\r\n]/,d=/(\s*\/\/[^\n\r]*)/,I=/^(\s*)([^$]*)/,A=/\s*=\s*([^$]+)/,P=/^\s*$/;function S(n,{indent:t}){return Math.min(n,t)}function g(n){return({indent:t,content:e})=>({indent:t-n,content:e})}function j(n){return({name:t,index:e})=>{if(!t)return n;const s=n[e];Object.defineProperty(n,t,{value:s,enumerable:!1})}}function _(n){const t=[],e=[];let s=-1,i=-1;return n.forEach(({indent:o,content:r})=>{if(i<=0)i=o;else if(o<=s){let c=1+(s-o)/i;for(;c--;)t.pop()}t.push(r),e.push(f(...t)),s=o}),e}function b(n){return n.map((t,e)=>{const{content:s,indent:i}=t,o=s.match(A);return o?{index:e,indent:i,content:s.slice(0,s.length-o[0].length),name:o[1]}:{index:e,indent:i,content:s}})}function v(n){var s;const t=[n,"",n],e=(s=n.match(I))!=null?s:t;return{indent:e[1].length,content:e[2]}}function x(n){return[n].flat().reduce((t,e)=>[...t,...e.split(m)],[]).filter(E).map(t=>t.replace(d,""))}function E(n){return!P.test(n)}

package/dist/esm/compose-paths.esm.js

@@ -1,6 +1,6 @@
 /*
  * compose-paths
- * v1.2.1
+ * v1.2.3
  * https://github.com/shuckster/compose-paths
  * License: MIT
  */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "compose-paths",
   "browserGlobalName": "composePaths",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "description": "Define paths + routes without the repetition.",
   "author": "Conan Theobald",
   "license": "MIT",
@@ -18,7 +18,6 @@
   "exports": {
     "import": "./index.mjs",
     "require": "./dist/cjs/compose-paths.cjs.js",
-    "browser": "./dist/browser/compose-paths.browser.js",
     "default": "./dist/cjs/compose-paths.cjs.js"
   },
   "files": [
@@ -43,15 +42,15 @@
     "email": "bugs+compose-paths@conans.co.uk"
   },
   "devDependencies": {
-    "concurrently": "^7.0.0",
+    "concurrently": "^8.1.0",
     "cross-env": "^7.0.3",
-    "esbuild": "^0.14.19",
-    "eslint": "^8.8.0",
-    "eslint-plugin-jest": "^26.1.0",
-    "jest": "^27.5.0",
-    "match-iz": "^2.0.4",
-    "rimraf": "^3.0.2",
-    "typescript": "^4.5.5",
+    "esbuild": "^0.17.19",
+    "eslint": "^8.42.0",
+    "eslint-plugin-jest": "^27.2.1",
+    "jest": "^29.5.0",
+    "match-iz": "^4.0.0",
+    "rimraf": "^5.0.1",
+    "typescript": "^5.1.3",
     "url-join": "^4.0.1"
   },
   "scripts": {
@@ -61,6 +60,5 @@
     "build:clean": "rimraf dist/; mkdir -p dist/{esm,cjs,browser}",
     "build:all": "pnpm run build:clean ; cross-env NODE_ENV=production pnpm run build",
     "build:esbuild": "node ./build-config/esbuild.js"
-  },
-  "readme": "<h1 align=\"center\"><code>compose-paths</code> 🛣</h1>\n\n<p align=\"center\">\n  <a href=\"https://github.com/shuckster/compose-paths/blob/master/LICENSE\">\n    <img\n      alt=\"MIT license\"\n      src=\"https://img.shields.io/npm/l/compose-paths?style=plastic\"\n    /></a>\n  <a href=\"https://bundlephobia.com/result?p=compose-paths\">\n    <img\n      alt=\"npm bundle size\"\n      src=\"https://img.shields.io/bundlephobia/minzip/compose-paths?style=plastic\"\n    /></a>\n  <a href=\"https://www.npmjs.com/package/compose-paths\">\n    <img\n      alt=\"Version\"\n      src=\"https://img.shields.io/npm/v/compose-paths?style=plastic\"\n    /></a>\n</p>\n\n```sh\n$ pnpm i compose-paths\n```\n\n`compose-paths` looks at the indentation-level of its input as the cue to concatenate lines together. Either `tabs` or `spaces` should be fine, so long as you're consistent.\n\n## Usage\n\n### `Path` &rarr; `Alias`\n\n```js\nconst { composePaths } = require('compose-paths')\n\nconst paths = composePaths(`\n\n  ${__dirname}\n    /src\n      /html\n        /templates      = TEMPLATES\n        /pages          = PAGES\n\n    /public             = PUBLIC\n      /images           = IMAGES\n\n`)\n\npaths.TEMPLATES\n// \"/dir/name/src/html/templates\"\n\npaths.PUBLIC\n// \"/dir/name/public\"\n\npaths.aliases\n// [\"TEMPLATES\", \"PAGES\", \"PUBLIC\", \"IMAGES\"]\n```\n\n### `Path` &rarr; `Route` (via aliases)\n\n```js\nconst { composePaths, zip } = require('compose-paths')\n\nconst routes = composePaths(`\n    /                   = HOME\n    /about              = ABOUT\n    /contact            = CONTACT\n`)\n\nconst paths = composePaths(`\n  ${__dirname}\n    /src\n      /html/pages\n        /index.html     = HOME\n        /about.html     = ABOUT\n        /contact.html   = CONTACT\n`)\n\nconst staticRoutes = zip(routes, paths)\n\n// Then, for example:\nstaticRoutes.forEach(([route, path]) => {\n  app.get(route, sendFile(path))\n})\n```\n\n### `Path` &rarr; `Route` (directly)\n\n```js\nconst { composePaths } = require('compose-paths')\n\nconst pathFromRoute = composePaths(`\n\n  ${__dirname}\n    /src/html/pages\n      /index.html        = /\n      /about.html        = /about\n      /contact.html      = /contact\n\n`)\n\npathFromRoute['/']\n// \"/dir/name/src/html/pages/index.html\"\n\npathFromRoute['/contact']\n// \"/dir/name/src/html/pages/contact.html\"\n\npathFromRoute.aliases.forEach(route => {\n  console.log(pathFromRoute[route])\n})\n```\n\nThat's it!\n\n# Credits\n\n`compose-paths` was written by [Conan Theobald](https://github.com/shuckster/).\n\nDid you find this useful? If so, I like [coffee ☕️](https://www.buymeacoffee.com/shuckster) :)\n\n## License\n\nMIT licensed: See [LICENSE](LICENSE)\n"
+  }
 }