Skip to content
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.

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

feat: add orChar/from chain for charIn/charNotIn #399

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
25 changes: 18 additions & 7 deletions src/core/inputs.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { Input } from './internal'
import type { CharInput, Input } from './internal'
import { createInput } from './internal'
import type { EscapeChar } from './types/escape'
import type { Join } from './types/join'
Expand All @@ -10,16 +10,27 @@ export type { Input }

const ESCAPE_REPLACE_RE = /[.*+?^${}()|[\]\\/]/g

/** This matches any character in the string provided */
export function charIn<T extends string>(chars: T) {
return createInput(`[${chars.replace(/[-\\^\]]/g, '\\$&')}]`) as Input<`[${EscapeChar<T>}]`>
function createCharInput <T extends string>(raw: T) {
const input = createInput(`[${raw}]`)
const from = <From extends string, To extends string>(charFrom: From, charTo: To) => createCharInput(`${raw}${escapeCharInput(charFrom)}-${escapeCharInput(charTo)}`)
const orChar = Object.assign((<T extends string>(chars: T) => createCharInput(`${raw}${escapeCharInput(chars)}`)), { from })
return Object.assign(input, { orChar, from }) as CharInput<T>
}

/** This matches any character that is not in the string provided */
export function charNotIn<T extends string>(chars: T) {
return createInput(`[^${chars.replace(/[-\\^\]]/g, '\\$&')}]`) as Input<`[^${EscapeChar<T>}]`>
function escapeCharInput <T extends string>(raw: T) {
return raw.replace(/[-\\^\]]/g, '\\$&') as EscapeChar<T>
}

/** This matches any character in the string provided */
export const charIn = Object.assign(<T extends string>(chars: T) => {
return createCharInput(escapeCharInput(chars))
}, createCharInput(''))

/** This matches any character that is not in the string provided */
export const charNotIn = Object.assign(<T extends string>(chars: T) => {
return createCharInput(`^${escapeCharInput(chars)}`)
}, createCharInput('^'))

/**
* This takes a variable number of inputs and matches any of them
* @example
Expand Down
6 changes: 6 additions & 0 deletions src/core/internal.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { exactly } from './inputs'
import type { EscapeChar } from './types/escape'
import type { Join } from './types/join'
import type { InputSource, MapToCapturedGroupsArr, MapToGroups, MapToValues } from './types/sources'
import type { IfUnwrapped } from './wrap'
Expand Down Expand Up @@ -134,6 +135,11 @@ export interface Input<
toString: () => string
}

export interface CharInput<T extends string> extends Input<`[${T}]`> {
orChar: (<Or extends string>(chars: Or) => CharInput<`${T}${EscapeChar<Or>}`>) & CharInput<T>
from: <From extends string, To extends string>(charFrom: From, charTo: To) => CharInput<`${T}${EscapeChar<From>}-${EscapeChar<To>}`>
}

export function createInput<
Value extends string,
Groups extends string = never,
Expand Down
30 changes: 30 additions & 0 deletions test/inputs.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,41 @@ describe('inputs', () => {
expect(new RegExp(input as any)).toMatchInlineSnapshot('/\\[fo\\\\\\]\\\\\\^\\]/')
expectTypeOf(extractRegExp(input)).toEqualTypeOf<'[fo\\]\\^]'>()
})
it('charIn.orChar', () => {
const input = charIn('a').orChar('b')
expect(new RegExp(input as any)).toMatchInlineSnapshot('/\\[ab\\]/')
expectTypeOf(extractRegExp(input)).toEqualTypeOf<'[ab]'>()
})
it('charIn.orChar.from', () => {
const input = charIn('a').orChar.from('a', 'b')
expect(new RegExp(input as any)).toMatchInlineSnapshot('/\\[aa-b\\]/')
expectTypeOf(extractRegExp(input)).toEqualTypeOf<'[aa-b]'>()
})
it('charIn.from', () => {
const input = charIn.from('a', 'b')
expect(new RegExp(input as any)).toMatchInlineSnapshot('/\\[a-b\\]/')
expectTypeOf(extractRegExp(input)).toEqualTypeOf<'[a-b]'>()
})
it('charNotIn', () => {
const input = charNotIn('fo^-')
expect(new RegExp(input as any)).toMatchInlineSnapshot('/\\[\\^fo\\\\\\^\\\\-\\]/')
expectTypeOf(extractRegExp(input)).toEqualTypeOf<'[^fo\\^\\-]'>()
})
it('charNotIn.orChar', () => {
const input = charNotIn('a').orChar('b')
expect(new RegExp(input as any)).toMatchInlineSnapshot('/\\[\\^ab\\]/')
expectTypeOf(extractRegExp(input)).toEqualTypeOf<'[^ab]'>()
})
it('charNotIn.orChar.from', () => {
const input = charNotIn('a').orChar.from('a', 'b')
expect(new RegExp(input as any)).toMatchInlineSnapshot('/\\[\\^aa-b\\]/')
expectTypeOf(extractRegExp(input)).toEqualTypeOf<'[^aa-b]'>()
})
it('charNotIn.from', () => {
const input = charNotIn.from('a', 'b')
expect(new RegExp(input as any)).toMatchInlineSnapshot('/\\[\\^a-b\\]/')
expectTypeOf(extractRegExp(input)).toEqualTypeOf<'[^a-b]'>()
})
it('anyOf', () => {
const values = ['fo/o', 'bar', 'baz', oneOrMore('this')] as const
const input = anyOf(...values)
Expand Down
Loading