Skip to content

route-pattern: PartPattern #10919

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
pcattori wants to merge 5 commits into from
Closed

route-pattern: PartPattern #10919

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8fa7520
experimental: part pattern parsing
pcattori Jan 4, 2026
f779b96
experimental: route pattern split
pcattori Jan 5, 2026
03e016a
RoutePattern.parse
pcattori Jan 7, 2026
6764353
RoutePattern.join
pcattori Jan 7, 2026
7db81db
PartPattern.variants
pcattori Jan 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/route-pattern/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
"@ark/attest": "^0.49.0",
"@types/node": "catalog:",
"@typescript/native-preview": "catalog:",
"dedent": "^1.7.1",
"find-my-way": "^9.1.0",
"path-to-regexp": "^8.2.0",
"vitest": "4.0.15"
Expand Down
24 changes: 24 additions & 0 deletions packages/route-pattern/src/experimental/errors.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import dedent from 'dedent'
import { describe, expect, it } from 'vitest'

import { ParseError } from './errors.ts'

describe('ParseError', () => {
it('exposes type, source, and index properties', () => {
let error = new ParseError('unmatched (', 'foo(bar', 3)
expect(error.type).toBe('unmatched (')
expect(error.source).toBe('foo(bar')
expect(error.index).toBe(3)
expect(() => {}).toThrow()
})

it('shows caret under the problematic index', () => {
let error = new ParseError('unmatched (', 'api/(v:major', 4)
expect(error.toString()).toBe(dedent`
ParseError: unmatched (

api/(v:major
^
`)
})
})
20 changes: 20 additions & 0 deletions packages/route-pattern/src/experimental/errors.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
type ParseErrorType = 'unmatched (' | 'unmatched )' | 'missing variable name' | 'dangling escape'

export class ParseError extends Error {
type: ParseErrorType
source: string
index: number

constructor(type: ParseErrorType, source: string, index: number) {
let underline = ' '.repeat(index) + '^'
let message = `${type}\n\n${source}\n${underline}`

super(message)
this.name = 'ParseError'
this.type = type
this.source = source
this.index = index
}
}

export class InternalError extends Error {}
255 changes: 255 additions & 0 deletions packages/route-pattern/src/experimental/part-pattern.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,255 @@
import * as assert from 'node:assert/strict'
import test, { describe } from 'node:test'

import { PartPattern } from './part-pattern.ts'
import { ParseError } from './errors.ts'

describe('PartPattern', () => {
describe('parse', () => {
type AST = ConstructorParameters<typeof PartPattern>[0]
function assertParse(source: string, ast: AST) {
assert.deepStrictEqual(PartPattern.parse(source), new PartPattern(ast))
}

function assertParseError(source: string, type: ParseError['type'], index: number) {
assert.throws(() => PartPattern.parse(source), new ParseError(type, source, index))
}

test('parses static text', () => {
assertParse('abc', {
tokens: [{ type: 'text', text: 'abc' }],
paramNames: [],
optionals: new Map(),
})
})

test('parses a variable', () => {
assertParse(':abc', {
tokens: [{ type: ':', nameIndex: 0 }],
paramNames: ['abc'],
optionals: new Map(),
})
assertParse(':_hello_WORLD', {
tokens: [{ type: ':', nameIndex: 0 }],
paramNames: ['_hello_WORLD'],
optionals: new Map(),
})
assertParse(':$_hello_WORLD$123$', {
tokens: [{ type: ':', nameIndex: 0 }],
paramNames: ['$_hello_WORLD$123$'],
optionals: new Map(),
})
})

test('parses a wildcard', () => {
assertParse('*', {
tokens: [{ type: '*', nameIndex: 0 }],
paramNames: ['*'],
optionals: new Map(),
})
assertParse('*abc', {
tokens: [{ type: '*', nameIndex: 0 }],
paramNames: ['abc'],
optionals: new Map(),
})
assertParse('*_hello_WORLD', {
tokens: [{ type: '*', nameIndex: 0 }],
paramNames: ['_hello_WORLD'],
optionals: new Map(),
})
assertParse('*$_hello_WORLD$123$', {
tokens: [{ type: '*', nameIndex: 0 }],
paramNames: ['$_hello_WORLD$123$'],
optionals: new Map(),
})
})

test('parses an optional', () => {
assertParse('aa(bb)cc', {
tokens: [
{ type: 'text', text: 'aa' },
{ type: '(' },
{ type: 'text', text: 'bb' },
{ type: ')' },
{ type: 'text', text: 'cc' },
],
paramNames: [],
optionals: new Map([[1, 3]]),
})
assertParse('(aa(bb)cc)', {
tokens: [
{ type: '(' },
{ type: 'text', text: 'aa' },
{ type: '(' },
{ type: 'text', text: 'bb' },
{ type: ')' },
{ type: 'text', text: 'cc' },
{ type: ')' },
],
paramNames: [],
optionals: new Map([
[0, 6],
[2, 4],
]),
})
})

test('parses combinations of text, variables, wildcards, optionals', () => {
assertParse('api/(v:major(.:minor)/)run', {
tokens: [
{ type: 'text', text: 'api/' },
{ type: '(' },
{ type: 'text', text: 'v' },
{ type: ':', nameIndex: 0 },
{ type: '(' },
{ type: 'text', text: '.' },
{ type: ':', nameIndex: 1 },
{ type: ')' },
{ type: 'text', text: '/' },
{ type: ')' },
{ type: 'text', text: 'run' },
],
paramNames: ['major', 'minor'],
optionals: new Map([
[1, 9],
[4, 7],
]),
})

assertParse('*/node_modules/(*path/):package/dist/index.:ext', {
tokens: [
{ type: '*', nameIndex: 0 },
{ type: 'text', text: '/node_modules/' },
{ type: '(' },
{ type: '*', nameIndex: 1 },
{ type: 'text', text: '/' },
{ type: ')' },
{ type: ':', nameIndex: 2 },
{ type: 'text', text: '/dist/index.' },
{ type: ':', nameIndex: 3 },
],
paramNames: ['*', 'path', 'package', 'ext'],
optionals: new Map([[2, 5]]),
})
})

test('parses repeated param names', () => {
assertParse(':id/:id', {
tokens: [
{ type: ':', nameIndex: 0 },
{ type: 'text', text: '/' },
{ type: ':', nameIndex: 1 },
],
paramNames: ['id', 'id'],
optionals: new Map(),
})
assertParse('*id/*id', {
tokens: [
{ type: '*', nameIndex: 0 },
{ type: 'text', text: '/' },
{ type: '*', nameIndex: 1 },
],
paramNames: ['id', 'id'],
optionals: new Map(),
})
assertParse('*/*', {
tokens: [
{ type: '*', nameIndex: 0 },
{ type: 'text', text: '/' },
{ type: '*', nameIndex: 1 },
],
paramNames: ['*', '*'],
optionals: new Map(),
})
assertParse(':a/*a/:b/*b/:b/*a/:a', {
tokens: [
{ type: ':', nameIndex: 0 },
{ type: 'text', text: '/' },
{ type: '*', nameIndex: 1 },
{ type: 'text', text: '/' },
{ type: ':', nameIndex: 2 },
{ type: 'text', text: '/' },
{ type: '*', nameIndex: 3 },
{ type: 'text', text: '/' },
{ type: ':', nameIndex: 4 },
{ type: 'text', text: '/' },
{ type: '*', nameIndex: 5 },
{ type: 'text', text: '/' },
{ type: ':', nameIndex: 6 },
],
paramNames: ['a', 'a', 'b', 'b', 'b', 'a', 'a'],
optionals: new Map(),
})
})

test("throws 'unmatched ('", () => {
assertParseError('(', 'unmatched (', 0)
assertParseError('(()', 'unmatched (', 0)
assertParseError('()(', 'unmatched (', 2)
})
test("throws 'unmatched )'", () => {
assertParseError(')', 'unmatched )', 0)
assertParseError(')()', 'unmatched )', 0)
assertParseError('())', 'unmatched )', 2)
})
test("throws 'missing variable name'", () => {
assertParseError(':', 'missing variable name', 0)
assertParseError('a:', 'missing variable name', 1)
assertParseError('(a:)', 'missing variable name', 2)
assertParseError(':(a)', 'missing variable name', 0)
assertParseError(':123', 'missing variable name', 0)
assertParseError('::', 'missing variable name', 0)
})
test("throws 'dangling escape'", () => {
assertParseError('\\', 'dangling escape', 0)
})
})

describe('variants', () => {
function assertVariants(source: string, variants: PartPattern['variants']) {
assert.deepStrictEqual(PartPattern.parse(source).variants, variants)
}

test('produces all possible combinations of optionals', () => {
assertVariants('a(:b)*c', [
{ key: 'a{*}', paramNames: ['c'] },
{ key: 'a{:}{*}', paramNames: ['b', 'c'] },
])
assertVariants('a(:b)*c', [
{ key: 'a{*}', paramNames: ['c'] },
{ key: 'a{:}{*}', paramNames: ['b', 'c'] },
])
assertVariants('a(:b)c(*d)e', [
{ key: 'ace', paramNames: [] },
{ key: 'ac{*}e', paramNames: ['d'] },
{ key: 'a{:}ce', paramNames: ['b'] },
{ key: 'a{:}c{*}e', paramNames: ['b', 'd'] },
])
assertVariants('a(:b(*c):d)e', [
{ key: 'ae', paramNames: [] },
{ key: 'a{:}{:}e', paramNames: ['b', 'd'] },
{ key: 'a{:}{*}{:}e', paramNames: ['b', 'c', 'd'] },
])
assertVariants('a(:b(*c):d)e(*f)g', [
{ key: 'aeg', paramNames: [] },
{ key: 'ae{*}g', paramNames: ['f'] },
{ key: 'a{:}{:}eg', paramNames: ['b', 'd'] },
{ key: 'a{:}{:}e{*}g', paramNames: ['b', 'd', 'f'] },
{ key: 'a{:}{*}{:}eg', paramNames: ['b', 'c', 'd'] },
{ key: 'a{:}{*}{:}e{*}g', paramNames: ['b', 'c', 'd', 'f'] },
])
})
})

describe('toString', () => {
test('stringifies combinations of text, variables, wildcards, optionals', () => {
let examples = [
'api/(v:major(.:minor)/)run',
'*/node_modules/(*path/):package/dist/index.:ext',
]
for (let source of examples) {
assert.equal(PartPattern.parse(source).toString(), source)
}
})
})
})
Loading