Luan Taraschi
fe7c6d5657
Both property-path parsers ended an identifier at the first character outside `\w`, so `dependencies.some-package-name` tokenized as `some`, an unexpected `-`, and `package`, and `pnpm pkg get` / `pnpm pkg set` failed with ERR_PNPM_UNEXPECTED_TOKEN_IN_PROPERTY_PATH on a key that `npm pkg` reads. Hyphens now continue an identifier, in `pnpm11/object/property-path` and in `pnpm/crates/config` alike. The first character keeps its old rule, so `-foo` is still rejected, and the bracketed forms that already accepted these keys are untouched. `pnpm config set` shares the parser through `validateSimpleKey`, which short-circuits on strictly kebab-case keys. A key it does not short-circuit, such as `foo-Bar`, used to fail at the parse step and now reaches the config validation that has something useful to say about it: ERR_PNPM_CONFIG_SET_UNSUPPORTED_YAML_CONFIG_KEY. Both reject the key. Closes pnpm/pnpm#13163
141 lines
6.0 KiB
TypeScript
141 lines
6.0 KiB
TypeScript
import { expect, test } from '@jest/globals'
|
|
|
|
import {
|
|
type ExactToken,
|
|
parsePropertyPath,
|
|
type UnexpectedEndOfInputError,
|
|
type UnexpectedIdentifierError,
|
|
type UnexpectedLiteralError,
|
|
type UnexpectedToken,
|
|
type UnexpectedTokenError,
|
|
} from '../src/index.js'
|
|
|
|
test('valid property path', () => {
|
|
expect(Array.from(parsePropertyPath(''))).toStrictEqual([])
|
|
expect(Array.from(parsePropertyPath('foo'))).toStrictEqual(['foo'])
|
|
expect(Array.from(parsePropertyPath('.foo'))).toStrictEqual(['foo'])
|
|
expect(Array.from(parsePropertyPath('["foo"]'))).toStrictEqual(['foo'])
|
|
expect(Array.from(parsePropertyPath("['foo']"))).toStrictEqual(['foo'])
|
|
expect(Array.from(parsePropertyPath('[ "foo" ]'))).toStrictEqual(['foo'])
|
|
expect(Array.from(parsePropertyPath("[ 'foo' ]"))).toStrictEqual(['foo'])
|
|
expect(Array.from(parsePropertyPath('foo.bar[0]'))).toStrictEqual(['foo', 'bar', 0])
|
|
expect(Array.from(parsePropertyPath('.foo.bar[0]'))).toStrictEqual(['foo', 'bar', 0])
|
|
expect(Array.from(parsePropertyPath('foo["bar"][0]'))).toStrictEqual(['foo', 'bar', 0])
|
|
expect(Array.from(parsePropertyPath(".foo['bar'][0]"))).toStrictEqual(['foo', 'bar', 0])
|
|
expect(Array.from(parsePropertyPath('foo.bar["0"]'))).toStrictEqual(['foo', 'bar', '0'])
|
|
expect(Array.from(parsePropertyPath('a.b.c.d'))).toStrictEqual(['a', 'b', 'c', 'd'])
|
|
expect(Array.from(parsePropertyPath('.a.b.c.d'))).toStrictEqual(['a', 'b', 'c', 'd'])
|
|
expect(Array.from(parsePropertyPath('a .b .c .d'))).toStrictEqual(['a', 'b', 'c', 'd'])
|
|
expect(Array.from(parsePropertyPath('.a .b .c .d'))).toStrictEqual(['a', 'b', 'c', 'd'])
|
|
})
|
|
|
|
test('hyphenated keys', () => {
|
|
expect(Array.from(parsePropertyPath('dependencies.some-package-name')))
|
|
.toStrictEqual(['dependencies', 'some-package-name'])
|
|
expect(Array.from(parsePropertyPath('devDependencies.another-package')))
|
|
.toStrictEqual(['devDependencies', 'another-package'])
|
|
expect(Array.from(parsePropertyPath('a.b-c.d-e'))).toStrictEqual(['a', 'b-c', 'd-e'])
|
|
expect(Array.from(parsePropertyPath('foo-bar[0]'))).toStrictEqual(['foo-bar', 0])
|
|
expect(Array.from(parsePropertyPath('scripts.build-prod'))).toStrictEqual(['scripts', 'build-prod'])
|
|
// The bracketed and quoted forms already accepted these keys, and still do.
|
|
expect(Array.from(parsePropertyPath('dependencies["some-package-name"]')))
|
|
.toStrictEqual(['dependencies', 'some-package-name'])
|
|
})
|
|
|
|
test('invalid property path', () => {
|
|
expect(() => Array.from(parsePropertyPath('foo.bar.0'))).toThrow(expect.objectContaining({
|
|
code: 'ERR_PNPM_UNEXPECTED_LITERAL_IN_PROPERTY_PATH',
|
|
token: {
|
|
type: 'numeric-literal',
|
|
content: 0,
|
|
},
|
|
} as Partial<UnexpectedLiteralError>))
|
|
expect(() => Array.from(parsePropertyPath('foo.bar."baz"'))).toThrow(expect.objectContaining({
|
|
code: 'ERR_PNPM_UNEXPECTED_LITERAL_IN_PROPERTY_PATH',
|
|
token: {
|
|
type: 'string-literal',
|
|
quote: '"',
|
|
content: 'baz',
|
|
},
|
|
} as Partial<UnexpectedLiteralError>))
|
|
expect(() => Array.from(parsePropertyPath('foo.bar"baz"'))).toThrow(expect.objectContaining({
|
|
code: 'ERR_PNPM_UNEXPECTED_LITERAL_IN_PROPERTY_PATH',
|
|
token: {
|
|
type: 'string-literal',
|
|
quote: '"',
|
|
content: 'baz',
|
|
},
|
|
} as Partial<UnexpectedLiteralError>))
|
|
expect(() => Array.from(parsePropertyPath('foo.bar "baz"'))).toThrow(expect.objectContaining({
|
|
code: 'ERR_PNPM_UNEXPECTED_LITERAL_IN_PROPERTY_PATH',
|
|
token: {
|
|
type: 'string-literal',
|
|
quote: '"',
|
|
content: 'baz',
|
|
},
|
|
} as Partial<UnexpectedLiteralError>))
|
|
expect(() => Array.from(parsePropertyPath('foo.bar[baz]'))).toThrow(expect.objectContaining({
|
|
code: 'ERR_PNPM_UNEXPECTED_IDENTIFIER_IN_PROPERTY_PATH',
|
|
token: {
|
|
type: 'identifier',
|
|
content: 'baz',
|
|
},
|
|
} as Partial<UnexpectedIdentifierError>))
|
|
expect(() => Array.from(parsePropertyPath('foo.bar..baz'))).toThrow(expect.objectContaining({
|
|
code: 'ERR_PNPM_UNEXPECTED_TOKEN_IN_PROPERTY_PATH',
|
|
token: {
|
|
type: 'exact',
|
|
content: '.',
|
|
},
|
|
} as Partial<UnexpectedTokenError<ExactToken<'.'>>>))
|
|
expect(() => Array.from(parsePropertyPath('foo.bar[[0]]'))).toThrow(expect.objectContaining({
|
|
code: 'ERR_PNPM_UNEXPECTED_TOKEN_IN_PROPERTY_PATH',
|
|
token: {
|
|
type: 'exact',
|
|
content: '[',
|
|
},
|
|
} as Partial<UnexpectedTokenError<ExactToken<'['>>>))
|
|
expect(() => Array.from(parsePropertyPath('foo.bar[0]]'))).toThrow(expect.objectContaining({
|
|
code: 'ERR_PNPM_UNEXPECTED_TOKEN_IN_PROPERTY_PATH',
|
|
token: {
|
|
type: 'exact',
|
|
content: ']',
|
|
},
|
|
} as Partial<UnexpectedTokenError<ExactToken<']'>>>))
|
|
expect(() => Array.from(parsePropertyPath('dependencies.-foo'))).toThrow(expect.objectContaining({
|
|
code: 'ERR_PNPM_UNEXPECTED_TOKEN_IN_PROPERTY_PATH',
|
|
token: {
|
|
type: 'unexpected',
|
|
content: '-',
|
|
},
|
|
} as Partial<UnexpectedTokenError<UnexpectedToken>>))
|
|
expect(() => Array.from(parsePropertyPath('foo.bar?.baz'))).toThrow(expect.objectContaining({
|
|
code: 'ERR_PNPM_UNEXPECTED_TOKEN_IN_PROPERTY_PATH',
|
|
token: {
|
|
type: 'unexpected',
|
|
content: '?',
|
|
},
|
|
} as Partial<UnexpectedTokenError<UnexpectedToken>>))
|
|
expect(() => Array.from(parsePropertyPath('foo.bar.baz.'))).toThrow(expect.objectContaining({
|
|
code: 'ERR_PNPM_UNEXPECTED_END_OF_PROPERTY_PATH',
|
|
} as Partial<UnexpectedEndOfInputError>))
|
|
expect(() => Array.from(parsePropertyPath('foo.bar.baz[0'))).toThrow(expect.objectContaining({
|
|
code: 'ERR_PNPM_UNEXPECTED_END_OF_PROPERTY_PATH',
|
|
} as Partial<UnexpectedEndOfInputError>))
|
|
})
|
|
|
|
test('partial parse', () => {
|
|
const iter = parsePropertyPath('.foo.bar[123]?.baz')
|
|
expect(iter.next()).toStrictEqual({ done: false, value: 'foo' })
|
|
expect(iter.next()).toStrictEqual({ done: false, value: 'bar' })
|
|
expect(iter.next()).toStrictEqual({ done: false, value: 123 })
|
|
expect(() => iter.next()).toThrow(expect.objectContaining({
|
|
code: 'ERR_PNPM_UNEXPECTED_TOKEN_IN_PROPERTY_PATH',
|
|
token: {
|
|
type: 'unexpected',
|
|
content: '?',
|
|
},
|
|
} as Partial<UnexpectedTokenError<UnexpectedToken>>))
|
|
expect(iter.next()).toStrictEqual({ done: true, value: undefined })
|
|
})
|