compose-paths 1.2.2 → 1.3.0

package/CHANGELOG.md

@@ -2,16 +2,62 @@
 
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+The format is based on
+[Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this
+project adheres to
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+## [1.3.0] - 2026-07-19
+
+### Added
+
+- TypeScript: infer alias property names from static path-chart string
+  literals and `as const` line arrays (e.g. `paths.TEMPLATES`
+  type-checks; unknown aliases error)
+
+- TypeScript: declare `zip`, default export, `TPathChart`,
+  `TZipOptions`, and related helper types in `index.d.ts`
+
+- Tests: broader API coverage (zip modes, array input, comments, CRLF,
+  URL schemes); `test:types` and `test:coverage` scripts
+
+### Fixed
+
+- `//` comment stripping no longer treats the `//` in URL schemes (e.g.
+  `https://example.com`) as a comment
+
+- Full-line `//` comments are dropped cleanly (no leftover empty
+  segments / `.` path pieces)
+
+### Changed
+
+- `package.json` `exports` now include a `types` condition; `main`
+  points at `dist/cjs/…`
+
+- Document Node.js `>=20` as the supported engine (dev tooling and
+  `node:test`)
+
+- Tooling: native `node:test` instead of Jest; ESLint 10 flat config;
+  dependency upgrades (`url-join` 5, TypeScript 7 for type tests, etc.)
+
+- README: note TypeScript alias inference for static charts
+
+## [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.
+- 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
 
@@ -47,7 +93,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
-- Fix ESM build (import { ... } from 'compose-paths' was not working right)
+- Fix ESM build (import { ... } from 'compose-paths' was not working
+  right)
 
 ## [1.0.8] - 2021-06-04
 

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,18 @@ 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.
+
+**TypeScript:** when the path chart is a string literal or template (or an `as
+const` array of lines), alias names after `=` are inferred on the result — so
+`paths.TEMPLATES` type-checks and unknown aliases are errors. Dynamic `string`
+inputs stay loosely typed.
+
+## More examples
+
+### `Path` &rarr; `Route` (via aliases and `zip`)
 
 ```js
 const { composePaths, zip } = require('compose-paths')
@@ -76,7 +79,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,7 +1,7 @@
 /*
  * compose-paths
- * v1.2.2
+ * v1.3.0
  * https://github.com/shuckster/compose-paths
  * License: MIT
  */
-var composePaths=(()=>{var a=(n,e)=>()=>(e||n((e={exports:{}}).exports,e),e.exports);var h=a((p,u)=>{(function(n,e,t){typeof u!="undefined"&&u.exports?u.exports=t():typeof define=="function"&&define.amd?define(t):e[n]=t()})("urljoin",p,function(){function n(e){var t=[];if(e.length===0)return"";if(typeof e[0]!="string")throw new TypeError("Url must be a string. Received "+e[0]);if(e[0].match(/^[^/:]+:\/*$/)&&e.length>1){var i=e.shift();e[0]=i+e[0]}e[0].match(/^file:\/\/\//)?e[0]=e[0].replace(/^([^/:]+):\/*/,"$1:///"):e[0]=e[0].replace(/^([^/:]+):\/*/,"$1://");for(var o=0;o<e.length;o++){var s=e[o];if(typeof s!="string")throw new TypeError("Url must be a string. Received "+s);s!==""&&(o>0&&(s=s.replace(/^[\/]+/,"")),o<e.length-1?s=s.replace(/[\/]+$/,""):s=s.replace(/[\/]+$/,"/"),t.push(s))}var l=t.join("/");l=l.replace(/\/(\?|&|#[^!])/g,"$1");var c=l.split("?");return l=c.shift()+(c.length>0?"?":"")+c.join("&"),l}return function(){var e;return typeof arguments[0]=="object"?e=arguments[0]:e=[].slice.call(arguments),n(e)}})});var B=a((N,m)=>{m.exports={composePaths:v,zip:I};var g=h(),d="aliases";function v(n){let t=O(n).map(L),i=t.reduce(E,1/0),o=t.map(R(i)),s=_(o),l=x(s),c=s.map(r=>r==null?void 0:r.name).filter(Boolean),f=l;return s.forEach(w(f)),Object.defineProperty(f,d,{value:c,enumerable:!1})}function I(n,e,t){let{aliases:i=[],ignoreAliases:o=!1}=t||{};return(i.length&&!o?i:n[d]).reduce((l,c)=>(o&&i.includes(c)||l.push([n[c],e[c]]),l),[])}var j=/[\r\n]/,P=/(\s*\/\/[^\n\r]*)/,S=/^(\s*)([^$]*)/,$=/\s*=\s*([^$]+)/,b=/^\s*$/;function E(n,{indent:e}){return Math.min(n,e)}function R(n){return({indent:e,content:t})=>({indent:e-n,content:t})}function w(n){return({name:e,index:t})=>{if(!e)return n;let i=n[t];Object.defineProperty(n,e,{value:i,enumerable:!1})}}function x(n){let e=[],t=[],i=-1,o=-1;return n.forEach(({indent:s,content:l})=>{if(o<=0)o=s;else if(s<=i){let c=1+(i-s)/o;for(;c--;)e.pop()}e.push(l),t.push(g(...e)),i=s}),t}function _(n){return n.map((e,t)=>{let{content:i,indent:o}=e,s=i.match($);return s?{index:t,indent:o,content:i.slice(0,i.length-s[0].length),name:s[1]}:{index:t,indent:o,content:i}})}function L(n){var i;let e=[n,"",n],t=(i=n.match(S))!=null?i:e;return{indent:t[1].length,content:t[2]}}function O(n){return[n].flat().reduce((e,t)=>[...e,...t.split(j)],[]).filter(z).map(e=>e.replace(P,""))}function z(n){return!b.test(n)}});return B();})();
+var composePaths=(()=>{var r=Object.defineProperty;var m=Object.getOwnPropertyDescriptor;var v=Object.getOwnPropertyNames;var I=Object.prototype.hasOwnProperty;var j=(e,t,n)=>()=>{if(n)throw n[0];try{return e&&(t=e(e=0)),t}catch(s){throw n=[s],s}};var P=(e,t)=>()=>{try{return t||e((t={exports:{}}).exports,t),t.exports}catch(n){throw t=0,n}},S=(e,t)=>{for(var n in t)r(e,n,{get:t[n],enumerable:!0})},$=(e,t,n,s)=>{if(t&&typeof t=="object"||typeof t=="function")for(let i of v(t))!I.call(e,i)&&i!==n&&r(e,i,{get:()=>t[i],enumerable:!(s=m(t,i))||s.enumerable});return e};var b=e=>$(r({},"__esModule",{value:!0}),e);var p={};S(p,{default:()=>f});function E(e){var t=[];if(e.length===0)return"";if(typeof e[0]!="string")throw new TypeError("Url must be a string. Received "+e[0]);if(e[0].match(/^[^/:]+:\/*$/)&&e.length>1){var n=e.shift();e[0]=n+e[0]}e[0].match(/^file:\/\/\//)?e[0]=e[0].replace(/^([^/:]+):\/*/,"$1:///"):e[0]=e[0].replace(/^([^/:]+):\/*/,"$1://");for(var s=0;s<e.length;s++){var i=e[s];if(typeof i!="string")throw new TypeError("Url must be a string. Received "+i);i!==""&&(s>0&&(i=i.replace(/^[\/]+/,"")),s<e.length-1?i=i.replace(/[\/]+$/,""):i=i.replace(/[\/]+$/,"/"),t.push(i))}var l=t.join("/");l=l.replace(/\/(\?|&|#[^!])/g,"$1");var o=l.split("?");return l=o.shift()+(o.length>0?"?":"")+o.join("&"),l}function f(){var e;return typeof arguments[0]=="object"?e=arguments[0]:e=[].slice.call(arguments),E(e)}var h=j(()=>{});var D=P((G,g)=>{g.exports={composePaths:w,zip:x};var R=(h(),b(p)).default,d="aliases";function w(e){let n=W(e).map(F),s=n.reduce(C,1/0),i=n.map(J(s)),l=U(i),o=T(l),c=l.map(u=>u==null?void 0:u.name).filter(Boolean),a=o;return l.forEach(N(a)),Object.defineProperty(a,d,{value:c,enumerable:!1})}function x(e,t,n){let{aliases:s=[],ignoreAliases:i=!1}=n||{};return(s.length&&!i?s:e[d]).reduce((o,c)=>(i&&s.includes(c)||o.push([e[c],t[c]]),o),[])}var _=/[\r\n]/,L=/(^\s*\/\/[^\n\r]*|\s+\/\/[^\n\r]*)/,O=/^(\s*)([^$]*)/,z=/\s*=\s*([^$]+)/,B=/^\s*$/;function C(e,{indent:t}){return Math.min(e,t)}function J(e){return({indent:t,content:n})=>({indent:t-e,content:n})}function N(e){return({name:t,index:n})=>{if(!t)return e;let s=e[n];Object.defineProperty(e,t,{value:s,enumerable:!1})}}function T(e){let t=[],n=[],s=-1,i=-1;return e.forEach(({indent:l,content:o})=>{if(i<=0)i=l;else if(l<=s){let c=1+(s-l)/i;for(;c--;)t.pop()}t.push(o),n.push(R(...t)),s=l}),n}function U(e){return e.map((t,n)=>{let{content:s,indent:i}=t,l=s.match(z);return l?{index:n,indent:i,content:s.slice(0,s.length-l[0].length),name:l[1]}:{index:n,indent:i,content:s}})}function F(e){var s;let t=[e,"",e],n=(s=e.match(O))!=null?s:t;return{indent:n[1].length,content:n[2]}}function W(e){return[e].flat().reduce((t,n)=>[...t,...n.split(_)],[]).map(t=>t.replace(L,"")).filter(q)}function q(e){return!B.test(e)}});return D();})();

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

@@ -1,7 +1,7 @@
 /*
  * compose-paths
- * v1.2.2
+ * v1.3.0
  * 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 d=/[\r\n]/,m=/(^\s*\/\/[^\n\r]*|\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(d)],[]).map(t=>t.replace(m,"")).filter(E)}function E(n){return!P.test(n)}

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

@@ -1,7 +1,7 @@
 /*
  * compose-paths
- * v1.2.2
+ * v1.3.0
  * https://github.com/shuckster/compose-paths
  * License: MIT
  */
-var a=(n,e)=>()=>(e||n((e={exports:{}}).exports,e),e.exports);var h=a((p,u)=>{(function(n,e,t){typeof u!="undefined"&&u.exports?u.exports=t():typeof define=="function"&&define.amd?define(t):e[n]=t()})("urljoin",p,function(){function n(e){var t=[];if(e.length===0)return"";if(typeof e[0]!="string")throw new TypeError("Url must be a string. Received "+e[0]);if(e[0].match(/^[^/:]+:\/*$/)&&e.length>1){var i=e.shift();e[0]=i+e[0]}e[0].match(/^file:\/\/\//)?e[0]=e[0].replace(/^([^/:]+):\/*/,"$1:///"):e[0]=e[0].replace(/^([^/:]+):\/*/,"$1://");for(var o=0;o<e.length;o++){var s=e[o];if(typeof s!="string")throw new TypeError("Url must be a string. Received "+s);s!==""&&(o>0&&(s=s.replace(/^[\/]+/,"")),o<e.length-1?s=s.replace(/[\/]+$/,""):s=s.replace(/[\/]+$/,"/"),t.push(s))}var l=t.join("/");l=l.replace(/\/(\?|&|#[^!])/g,"$1");var c=l.split("?");return l=c.shift()+(c.length>0?"?":"")+c.join("&"),l}return function(){var e;return typeof arguments[0]=="object"?e=arguments[0]:e=[].slice.call(arguments),n(e)}})});var B=a((N,m)=>{m.exports={composePaths:v,zip:I};var g=h(),d="aliases";function v(n){let t=O(n).map(L),i=t.reduce(E,1/0),o=t.map(R(i)),s=_(o),l=x(s),c=s.map(r=>r==null?void 0:r.name).filter(Boolean),f=l;return s.forEach(w(f)),Object.defineProperty(f,d,{value:c,enumerable:!1})}function I(n,e,t){let{aliases:i=[],ignoreAliases:o=!1}=t||{};return(i.length&&!o?i:n[d]).reduce((l,c)=>(o&&i.includes(c)||l.push([n[c],e[c]]),l),[])}var j=/[\r\n]/,P=/(\s*\/\/[^\n\r]*)/,S=/^(\s*)([^$]*)/,$=/\s*=\s*([^$]+)/,b=/^\s*$/;function E(n,{indent:e}){return Math.min(n,e)}function R(n){return({indent:e,content:t})=>({indent:e-n,content:t})}function w(n){return({name:e,index:t})=>{if(!e)return n;let i=n[t];Object.defineProperty(n,e,{value:i,enumerable:!1})}}function x(n){let e=[],t=[],i=-1,o=-1;return n.forEach(({indent:s,content:l})=>{if(o<=0)o=s;else if(s<=i){let c=1+(i-s)/o;for(;c--;)e.pop()}e.push(l),t.push(g(...e)),i=s}),t}function _(n){return n.map((e,t)=>{let{content:i,indent:o}=e,s=i.match($);return s?{index:t,indent:o,content:i.slice(0,i.length-s[0].length),name:s[1]}:{index:t,indent:o,content:i}})}function L(n){var i;let e=[n,"",n],t=(i=n.match(S))!=null?i:e;return{indent:t[1].length,content:t[2]}}function O(n){return[n].flat().reduce((e,t)=>[...e,...t.split(j)],[]).filter(z).map(e=>e.replace(P,""))}function z(n){return!b.test(n)}});export default B();
+var r=Object.defineProperty;var m=Object.getOwnPropertyDescriptor;var v=Object.getOwnPropertyNames;var I=Object.prototype.hasOwnProperty;var j=(e,t,n)=>()=>{if(n)throw n[0];try{return e&&(t=e(e=0)),t}catch(s){throw n=[s],s}};var P=(e,t)=>()=>{try{return t||e((t={exports:{}}).exports,t),t.exports}catch(n){throw t=0,n}},S=(e,t)=>{for(var n in t)r(e,n,{get:t[n],enumerable:!0})},$=(e,t,n,s)=>{if(t&&typeof t=="object"||typeof t=="function")for(let i of v(t))!I.call(e,i)&&i!==n&&r(e,i,{get:()=>t[i],enumerable:!(s=m(t,i))||s.enumerable});return e};var b=e=>$(r({},"__esModule",{value:!0}),e);var p={};S(p,{default:()=>f});function E(e){var t=[];if(e.length===0)return"";if(typeof e[0]!="string")throw new TypeError("Url must be a string. Received "+e[0]);if(e[0].match(/^[^/:]+:\/*$/)&&e.length>1){var n=e.shift();e[0]=n+e[0]}e[0].match(/^file:\/\/\//)?e[0]=e[0].replace(/^([^/:]+):\/*/,"$1:///"):e[0]=e[0].replace(/^([^/:]+):\/*/,"$1://");for(var s=0;s<e.length;s++){var i=e[s];if(typeof i!="string")throw new TypeError("Url must be a string. Received "+i);i!==""&&(s>0&&(i=i.replace(/^[\/]+/,"")),s<e.length-1?i=i.replace(/[\/]+$/,""):i=i.replace(/[\/]+$/,"/"),t.push(i))}var l=t.join("/");l=l.replace(/\/(\?|&|#[^!])/g,"$1");var o=l.split("?");return l=o.shift()+(o.length>0?"?":"")+o.join("&"),l}function f(){var e;return typeof arguments[0]=="object"?e=arguments[0]:e=[].slice.call(arguments),E(e)}var h=j(()=>{});var D=P((G,g)=>{g.exports={composePaths:w,zip:x};var R=(h(),b(p)).default,d="aliases";function w(e){let n=W(e).map(F),s=n.reduce(C,1/0),i=n.map(J(s)),l=U(i),o=T(l),c=l.map(u=>u==null?void 0:u.name).filter(Boolean),a=o;return l.forEach(N(a)),Object.defineProperty(a,d,{value:c,enumerable:!1})}function x(e,t,n){let{aliases:s=[],ignoreAliases:i=!1}=n||{};return(s.length&&!i?s:e[d]).reduce((o,c)=>(i&&s.includes(c)||o.push([e[c],t[c]]),o),[])}var _=/[\r\n]/,L=/(^\s*\/\/[^\n\r]*|\s+\/\/[^\n\r]*)/,O=/^(\s*)([^$]*)/,z=/\s*=\s*([^$]+)/,B=/^\s*$/;function C(e,{indent:t}){return Math.min(e,t)}function J(e){return({indent:t,content:n})=>({indent:t-e,content:n})}function N(e){return({name:t,index:n})=>{if(!t)return e;let s=e[n];Object.defineProperty(e,t,{value:s,enumerable:!1})}}function T(e){let t=[],n=[],s=-1,i=-1;return e.forEach(({indent:l,content:o})=>{if(i<=0)i=l;else if(l<=s){let c=1+(s-l)/i;for(;c--;)t.pop()}t.push(o),n.push(R(...t)),s=l}),n}function U(e){return e.map((t,n)=>{let{content:s,indent:i}=t,l=s.match(z);return l?{index:n,indent:i,content:s.slice(0,s.length-l[0].length),name:l[1]}:{index:n,indent:i,content:s}})}function F(e){var s;let t=[e,"",e],n=(s=e.match(O))!=null?s:t;return{indent:n[1].length,content:n[2]}}function W(e){return[e].flat().reduce((t,n)=>[...t,...n.split(_)],[]).map(t=>t.replace(L,"")).filter(q)}function q(e){return!B.test(e)}});export default D();

package/index.d.ts

@@ -1,32 +1,205 @@
-type TComposedPaths = Array<string> & {
-  aliases: Array<string>
-  [key: string]: string
+// ---------------------------------------------------------------------------
+// Public path-chart types
+// ---------------------------------------------------------------------------
+
+export type TPathChart = string | readonly string[]
+
+/**
+ * Every composed path string, in chart order.
+ *
+ * Also has non-enumerable `.aliases` and one non-enumerable property per alias
+ * (e.g. `paths.TEMPLATES`). With a static chart string, those alias keys are
+ * inferred by TypeScript (see `composePaths` overloads).
+ */
+export interface TComposedPaths extends Array<string> {
+  /** Alias names in declaration order (non-enumerable at runtime). */
+  readonly aliases: readonly string[]
 }
 
-declare module 'compose-paths' {
+export interface TZipOptions {
+  /**
+   * Alias names to include. If `ignoreAliases` is true, these are excluded
+   * instead and every other alias on `keys` is kept.
+   */
+  aliases?: readonly string[]
   /**
-   * @example
-   * const paths = composePaths(`
-   *
-   *   ${__dirname}
-   *     /src
-   *       /html
-   *         /templates      = TEMPLATES
-   *         /pages          = PAGES
-   *
-   *     /public             = PUBLIC
-   *       /images           = IMAGES
-   *
-   * `)
-   *
-   * paths.TEMPLATES
-   * // "/dir/name/src/html/templates"
-   *
-   * paths.PUBLIC
-   * // "/dir/name/public"
-   *
-   * paths.aliases
-   * // ["TEMPLATES", "PAGES", "PUBLIC", "IMAGES"]
+   * When true, `aliases` is treated as an exclusion list.
+   * @default false
    */
-  export function composePaths(pathChart: string | string[]): TComposedPaths
+  ignoreAliases?: boolean
+}
+
+// ---------------------------------------------------------------------------
+// Type-level chart DSL (alias-name extraction only)
+// ---------------------------------------------------------------------------
+
+type TTrimLeft<S extends string> = S extends ` ${infer R}`
+  ? TTrimLeft<R>
+  : S extends `\t${infer R}`
+    ? TTrimLeft<R>
+    : S
+
+type TTrimRight<S extends string> = S extends `${infer R} `
+  ? TTrimRight<R>
+  : S extends `${infer R}\t`
+    ? TTrimRight<R>
+    : S
+
+type TTrim<S extends string> = TTrimLeft<TTrimRight<S>>
+
+/** Normalize CRLF so line splitting is `\n`-only. */
+type TNormalizeNewlines<S extends string> = S extends `${infer A}\r\n${infer B}`
+  ? `${A}\n${TNormalizeNewlines<B>}`
+  : S
+
+/**
+ * Strip `//` comments the same way as runtime: at line start (optional indent)
+ * or after whitespace — not the `//` inside `https://…`.
+ */
+type TStripLineComment<S extends string> = TTrimLeft<S> extends `//${string}`
+  ? ''
+  : S extends `${infer Code} //${string}`
+    ? Code
+    : S extends `${infer Code}\t//${string}`
+      ? Code
+      : S
+
+/**
+ * Split on newlines. Depth is unbounded in theory; real path charts stay small.
+ * Empty segments from trailing newlines become `never` aliases and drop out.
+ */
+type TSplitLines<S extends string> = TNormalizeNewlines<S> extends `${infer Line}\n${infer Rest}`
+  ? [Line, ...TSplitLines<Rest>]
+  : [TNormalizeNewlines<S>]
+
+/**
+ * Alias text after `=` on a chart line, or `never` if the line has no assignment.
+ * Distributes over unions of lines (`L extends unknown ? …`) so chart-wide
+ * `TSplitLines[number]` extracts each line’s alias correctly.
+ */
+export type TAliasFromLine<L extends string> = L extends unknown
+  ? TStripLineComment<L> extends `${string}=${infer Alias}`
+    ? TTrim<TStripLineComment<Alias>> extends infer A extends string
+      ? A extends ''
+        ? never
+        : A
+      : never
+    : never
+  : never
+
+/**
+ * Union of alias names in a static chart string.
+ * Dynamic `string` inputs fall back to `string`.
+ */
+export type TAliasesFromChart<S extends string> = string extends S
+  ? string
+  : TAliasFromLine<TSplitLines<S>[number]>
+
+/**
+ * Alias names from a `as const` array of chart lines.
+ */
+export type TAliasesFromLines<T extends readonly string[]> = string extends T[number]
+  ? string
+  : TAliasFromLine<T[number]>
+
+type TAliasPropsFromUnion<A extends string> = string extends A
+  ? { readonly [key: string]: string }
+  : { readonly [K in A]: string }
+
+export type TAliasPropsFromChart<S extends string> = TAliasPropsFromUnion<
+  TAliasesFromChart<S>
+>
+
+export type TAliasPropsFromLines<T extends readonly string[]> = TAliasPropsFromUnion<
+  TAliasesFromLines<T>
+>
+
+export type TComposedPathsFromChart<S extends string> = TComposedPaths &
+  TAliasPropsFromChart<S> & {
+    readonly aliases: ReadonlyArray<TAliasesFromChart<S>>
+  }
+
+export type TComposedPathsFromLines<T extends readonly string[]> = TComposedPaths &
+  TAliasPropsFromLines<T> & {
+    readonly aliases: ReadonlyArray<TAliasesFromLines<T>>
+  }
+
+// ---------------------------------------------------------------------------
+// composePaths
+// ---------------------------------------------------------------------------
+
+/**
+ * Compose indented path charts into a list of full paths + named aliases.
+ *
+ * When `pathChart` is a string literal / template, TypeScript infers alias
+ * property names from `= ALIAS` markers in the chart.
+ *
+ * @example
+ * const paths = composePaths(`
+ *   ${__dirname}
+ *     /src
+ *       /html
+ *         /templates      = TEMPLATES
+ *         /pages          = PAGES
+ *
+ *     /public             = PUBLIC
+ *       /images           = IMAGES
+ * `)
+ *
+ * paths.TEMPLATES
+ * // "/dir/name/src/html/templates"
+ *
+ * paths.PUBLIC
+ * // "/dir/name/public"
+ *
+ * paths.aliases
+ * // ["TEMPLATES", "PAGES", "PUBLIC", "IMAGES"]
+ */
+export function composePaths<const S extends string>(
+  pathChart: S
+): TComposedPathsFromChart<S>
+
+/**
+ * Compose from an `as const` array of chart lines (alias keys inferred).
+ *
+ * @example
+ * composePaths(['/src', '  /x = X'] as const).X
+ */
+export function composePaths<const T extends readonly string[]>(
+  pathChart: T
+): TComposedPathsFromLines<T>
+
+/**
+ * Compose when the chart type is a wide `string` or `string[]` (no key inference).
+ */
+export function composePaths(pathChart: TPathChart): TComposedPaths
+
+// ---------------------------------------------------------------------------
+// zip
+// ---------------------------------------------------------------------------
+
+/**
+ * Pair aliases from two composed charts (e.g. routes → filesystem paths).
+ *
+ * @returns `[keys[alias], values[alias]]` tuples in alias order
+ *
+ * @example
+ * zip(routes, paths)
+ * zip(routes, paths, { aliases: ['HOME', 'ABOUT'] })
+ * zip(routes, paths, { aliases: ['DEBUG'], ignoreAliases: true })
+ */
+export function zip<K extends TComposedPaths, V extends TComposedPaths>(
+  keys: K,
+  values: V,
+  options?: TZipOptions
+): Array<[string, string]>
+
+// ---------------------------------------------------------------------------
+// Default export (CJS/ESM interop shape)
+// ---------------------------------------------------------------------------
+
+declare const _default: {
+  composePaths: typeof composePaths
+  zip: typeof zip
 }
+export default _default

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "compose-paths",
   "browserGlobalName": "composePaths",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "description": "Define paths + routes without the repetition.",
   "author": "Conan Theobald",
   "license": "MIT",
@@ -12,13 +12,16 @@
     "routes",
     "concatenation"
   ],
-  "types": "index.d.ts",
-  "main": "./dist/compose-paths.cjs.js",
+  "types": "./index.d.ts",
+  "main": "./dist/cjs/compose-paths.cjs.js",
   "module": "index.mjs",
   "exports": {
-    "import": "./index.mjs",
-    "require": "./dist/cjs/compose-paths.cjs.js",
-    "default": "./dist/cjs/compose-paths.cjs.js"
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.mjs",
+      "require": "./dist/cjs/compose-paths.cjs.js",
+      "default": "./dist/cjs/compose-paths.cjs.js"
+    }
   },
   "files": [
     "dist/**/*.js",
@@ -30,7 +33,7 @@
     "LICENSE"
   ],
   "engines": {
-    "node": ">=10"
+    "node": ">=20"
   },
   "homepage": "https://github.com/shuckster/compose-paths",
   "repository": {
@@ -42,24 +45,25 @@
     "email": "bugs+compose-paths@conans.co.uk"
   },
   "devDependencies": {
-    "concurrently": "^7.1.0",
-    "cross-env": "^7.0.3",
-    "esbuild": "^0.14.36",
-    "eslint": "^8.13.0",
-    "eslint-plugin-jest": "^26.1.4",
-    "jest": "^27.5.1",
-    "match-iz": "^3.3.1",
-    "rimraf": "^3.0.2",
-    "typescript": "^4.6.3",
-    "url-join": "^4.0.1"
+    "@eslint/js": "^10.0.1",
+    "concurrently": "^10.0.3",
+    "cross-env": "^10.1.0",
+    "esbuild": "^0.28.1",
+    "eslint": "^10.7.0",
+    "globals": "^17.7.0",
+    "match-iz": "^5.0.8",
+    "rimraf": "^6.1.3",
+    "typescript": "^7.0.2",
+    "url-join": "^5.0.0"
   },
   "scripts": {
-    "test": "jest",
-    "lint": "pnpx eslint src/*.js tests/*.js",
+    "test": "node --test tests/*.test.js",
+    "test:coverage": "node --test --experimental-test-coverage --test-coverage-include='src/**' tests/*.test.js",
+    "test:types": "tsc --strict --noEmit --module NodeNext --moduleResolution NodeNext tests/types-fixture.ts",
+    "lint": "eslint src/*.js tests/*.js build-config/*.js eslint.config.js",
     "build": "cross-env NODE_ENV=production pnpm run build:esbuild",
     "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"
+  }
 }