1298447741

Build Type

github

Committed by GitHub

Commit Message

<a href="https://github.com/jsdoc-type-pratt-parser/jsdoc-type-pratt-parser/commit/<a class=hub.com/jsdoc-type-pratt-parser/jsdoc-type-pratt-parser/commit/8f80d5ebc1968b0e56cbf36113483b127480e767">8f80d5ebc<a href="https://github.com/jsdoc-type-pratt-parser/jsdoc-type-pratt-parser/commit/8f80d5ebc1968b0e56cbf36113483b127480e767">">Merge </a><a class="double-link" href="https://github.com/jsdoc-type-pratt-parser/jsdoc-type-pratt-parser/commit/<a class="double-link" href="https://github.com/jsdoc-type-pratt-parser/jsdoc-type-pratt-parser/commit/ad3f0c9dbca50f01b810065bb341d50efbbaca2c">ad3f0c9db</a>">ad3f0c9db</a><a href="https://github.com/jsdoc-type-pratt-parser/jsdoc-type-pratt-parser/commit/8f80d5ebc1968b0e56cbf36113483b127480e767"> into fc8bf267c">fc8bf267c</a>

Pull Request Pull Request #98: feat(parser): add readonly modifier for object properties

Run Details

402 of 468 branches covered (85.9%)

Branch coverage included in aggregate %.

21 of 21 new or added lines in 5 files covered. (100.0%)

907 of 990 relevant lines covered (91.62%)

1736.97 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

90.57

/src/transforms/stringify.ts

import { transform, TransformRules } from './transform'
import { NonTerminalResult } from '../result/NonTerminalResult'
import { TerminalResult } from '../result/TerminalResult'

function applyPosition (position: 'prefix' | 'suffix', target: string, value: string): string {
  return position === 'prefix' ? value + target : target + value
}

export function quote (value: string, quote: 'single' | 'double' | undefined): string {
  switch (quote) {
    case 'double':
      return `"${value}"`
    case 'single':
      return `'${value}'`
    case undefined:
      return value
  }
}

export function stringifyRules (): TransformRules<string> {
  return {
    JsdocTypeParenthesis: (result, transform) => `(${result.element !== undefined ? transform(result.element) : ''})`,

    JsdocTypeKeyof: (result, transform) => `keyof ${transform(result.element)}`,

    JsdocTypeFunction: (result, transform) => {
      if (!result.arrow) {
        let stringified = 'function'
        if (!result.parenthesis) {
          return stringified
        }
        stringified += `(${result.parameters.map(transform).join(', ')})`
        if (result.returnType !== undefined) {
          stringified += `: ${transform(result.returnType)}`
        }
        return stringified
      } else {
        if (result.returnType === undefined) {
          throw new Error('Arrow function needs a return type.')
        }
        return `(${result.parameters.map(transform).join(', ')}) => ${transform(result.returnType)}`
      }
    },

    JsdocTypeName: result => result.value,

    JsdocTypeTuple: (result, transform) => `[${result.elements.map(transform).join(', ')}]`,

    JsdocTypeVariadic: (result, transform) => result.meta.position === undefined
      ? '...'
      : applyPosition(result.meta.position, transform(result.element as NonTerminalResult), '...'),

    JsdocTypeNamePath: (result, transform) => {
      const joiner = result.pathType === 'inner' ? '~' : result.pathType === 'instance' ? '#' : '.'
      return `${transform(result.left)}${joiner}${transform(result.right)}`
    },

    JsdocTypeStringValue: result => quote(result.value, result.meta.quote),

    JsdocTypeAny: () => '*',

    JsdocTypeGeneric: (result, transform) => {
      if (result.meta.brackets === 'square') {
        const element = result.elements[0]
        const transformed = transform(element)
        if (element.type === 'JsdocTypeUnion' || element.type === 'JsdocTypeIntersection') {
          return `(${transformed})[]`
        } else {
          return `${transformed}[]`
        }
      } else {
        return `${transform(result.left)}${result.meta.dot ? '.' : ''}<${result.elements.map(transform).join(', ')}>`
      }
    },

    JsdocTypeImport: (result, transform) => `import(${transform(result.element)})`,

    JsdocTypeKeyValue: (result, transform) => {
      if ('value' in result) {
        let text = ''
        if (result.readonly) {
          text += 'readonly '
        }
        text += quote(result.value, result.meta.quote)
        if (result.optional) {
          text += '?'
        }

        if (result.right === undefined) {
          return text
        } else {
          return text + `: ${transform(result.right)}`
        }
      } else {
        return `${transform(result.left)}: ${transform(result.right)}`
      }
    },

    JsdocTypeSpecialNamePath: result => `${result.specialType}:${quote(result.value, result.meta.quote)}`,

    JsdocTypeNotNullable: (result, transform) => applyPosition(result.meta.position, transform(result.element), '!'),

    JsdocTypeNull: () => 'null',

    JsdocTypeNullable: (result, transform) => applyPosition(result.meta.position, transform(result.element), '?'),

    JsdocTypeNumber: result => result.value.toString(),

    JsdocTypeObject: (result, transform) => `{${result.elements.map(transform).join((result.meta.separator === 'comma' ? ',' : ';') + ' ')}}`,

    JsdocTypeOptional: (result, transform) => applyPosition(result.meta.position, transform(result.element), '='),

    JsdocTypeSymbol: (result, transform) => `${result.value}(${result.element !== undefined ? transform(result.element) : ''})`,

    JsdocTypeTypeof: (result, transform) => `typeof ${transform(result.element)}`,

    JsdocTypeUndefined: () => 'undefined',

    JsdocTypeUnion: (result, transform) => result.elements.map(transform).join(' | '),

    JsdocTypeUnknown: () => '?',

    JsdocTypeIntersection: (result, transform) => result.elements.map(transform).join(' & '),

    JsdocTypeProperty: result => result.value
  }
}

const storedStringifyRules = stringifyRules()

export function stringify (result: TerminalResult): string {
  return transform(storedStringifyRules, result)
}

1	import { transform, TransformRules } from './transform'	1✔
2	import { NonTerminalResult } from '../result/NonTerminalResult'
3	import { TerminalResult } from '../result/TerminalResult'
4
5	function applyPosition (position: 'prefix' \| 'suffix', target: string, value: string): string {
6	return position === 'prefix' ? value + target : target + value	71✔
7	}
8
9	export function quote (value: string, quote: 'single' \| 'double' \| undefined): string {	1✔
10	switch (quote) {	129✔
11	case 'double':	129✔
12	return `"${value}"`	11✔
13	case 'single':
14	return `'${value}'`	7✔
15	case undefined:
16	return value	111✔
17	}
18	}
19
20	export function stringifyRules (): TransformRules<string> {	1✔
21	return {	1✔
22	JsdocTypeParenthesis: (result, transform) => `(${result.element !== undefined ? transform(result.element) : ''})`,	27!
23
24	JsdocTypeKeyof: (result, transform) => `keyof ${transform(result.element)}`,	15✔
25
26	JsdocTypeFunction: (result, transform) => {
27	if (!result.arrow) {	60✔
28	let stringified = 'function'	45✔
29	if (!result.parenthesis) {	45!
30	return stringified	×
31	}
32	stringified += `(${result.parameters.map(transform).join(', ')})`	45✔
33	if (result.returnType !== undefined) {	45✔
34	stringified += `: ${transform(result.returnType)}`	27✔
35	}
36	return stringified	45✔
37	} else {
38	if (result.returnType === undefined) {	15!
39	throw new Error('Arrow function needs a return type.')	×
40	}
41	return `(${result.parameters.map(transform).join(', ')}) => ${transform(result.returnType)}`	15✔
42	}
43	},
44
45	JsdocTypeName: result => result.value,	318✔
46
47	JsdocTypeTuple: (result, transform) => `[${result.elements.map(transform).join(', ')}]`,	14✔
48
49	JsdocTypeVariadic: (result, transform) => result.meta.position === undefined	32✔
50	? '...'	32!
51	: applyPosition(result.meta.position, transform(result.element as NonTerminalResult), '...'),
52
53	JsdocTypeNamePath: (result, transform) => {
54	const joiner = result.pathType === 'inner' ? '~' : result.pathType === 'instance' ? '#' : '.'	49✔
55	return `${transform(result.left)}${joiner}${transform(result.right)}`	49✔
56	},
57
58	JsdocTypeStringValue: result => quote(result.value, result.meta.quote),	8✔
59
60	JsdocTypeAny: () => '*',	7✔
61
62	JsdocTypeGeneric: (result, transform) => {
63	if (result.meta.brackets === 'square') {	38✔
64	const element = result.elements[0]	12✔
65	const transformed = transform(element)	12✔
66	if (element.type === 'JsdocTypeUnion' \|\| element.type === 'JsdocTypeIntersection') {	12!
67	return `(${transformed})[]`	×
68	} else {
69	return `${transformed}[]`	12✔
70	}
71	} else {
72	return `${transform(result.left)}${result.meta.dot ? '.' : ''}<${result.elements.map(transform).join(', ')}>`	26✔
73	}
74	},
75
76	JsdocTypeImport: (result, transform) => `import(${transform(result.element)})`,	6✔
77
78	JsdocTypeKeyValue: (result, transform) => {
79	if ('value' in result) {	51✔
80	let text = ''	48✔
81	if (result.readonly) {	48!
82	text += 'readonly '	×
83	}
84	text += quote(result.value, result.meta.quote)	48✔
85	if (result.optional) {	48✔
86	text += '?'	1✔
87	}
88
89	if (result.right === undefined) {	48✔
90	return text	3✔
91	} else {
92	return text + `: ${transform(result.right)}`	45✔
93	}
94	} else {
95	return `${transform(result.left)}: ${transform(result.right)}`	3✔
96	}
97	},
98
99	JsdocTypeSpecialNamePath: result => `${result.specialType}:${quote(result.value, result.meta.quote)}`,	12✔
100
101	JsdocTypeNotNullable: (result, transform) => applyPosition(result.meta.position, transform(result.element), '!'),	12✔
102
103	JsdocTypeNull: () => 'null',	3✔
104
105	JsdocTypeNullable: (result, transform) => applyPosition(result.meta.position, transform(result.element), '?'),	11✔
106
107	JsdocTypeNumber: result => result.value.toString(),	7✔
108
109	JsdocTypeObject: (result, transform) => `{${result.elements.map(transform).join((result.meta.separator === 'comma' ? ',' : ';') + ' ')}}`,	24✔
110
111	JsdocTypeOptional: (result, transform) => applyPosition(result.meta.position, transform(result.element), '='),	16✔
112
113	JsdocTypeSymbol: (result, transform) => `${result.value}(${result.element !== undefined ? transform(result.element) : ''})`,	6✔
114
115	JsdocTypeTypeof: (result, transform) => `typeof ${transform(result.element)}`,	16✔
116
117	JsdocTypeUndefined: () => 'undefined',	6✔
118
119	JsdocTypeUnion: (result, transform) => result.elements.map(transform).join(' \| '),	33✔
120
121	JsdocTypeUnknown: () => '?',	5✔
122
123	JsdocTypeIntersection: (result, transform) => result.elements.map(transform).join(' & '),	5✔
124
125	JsdocTypeProperty: result => result.value	47✔
126	}
127	}
128
129	const storedStringifyRules = stringifyRules()	1✔
130
131	export function stringify (result: TerminalResult): string {	1✔
132	return transform(storedStringifyRules, result)	202✔
133	}

jsdoc-type-pratt-parser / jsdoc-type-pratt-parser / 1298447741

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous