teidesu/mtcute
1
0
Fork 0
Code Issues 15 Pull requests 1 Projects Releases Packages Wiki Activity Actions

fix(tl-utils): do not break @link tags

Browse source
This commit is contained in:
teidesu 2022-08-12 17:00:02 +03:00
parent b34a90ec30
commit e3dbe3b7d1
2 changed files with 91 additions and 62 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
packages/tl-utils/src/codegen/utils.ts
View file

@ -10,9 +10,12 @@ export const camelToPascal = (s: string): string =>
export function jsComment(s: string): string {
return (
'/**' +
// awesome hack not to break up {@link} links
s
.replace(/{@link (.*?)}/g, '{@linkƒ$1}')
.replace(/(?![^\n]{1,60}$)([^\n]{1,60})\s/g, '$1\n')
.replace(/\n|^/g, '\n * ') +
.replace(/\n|^/g, '\n * ')
.replace(/{@linkƒ(.*)?}/, '{@link $1}') +
'\n */'
)
}

148
packages/tl-utils/tests/codegen/types.spec.ts
View file

@ -65,66 +65,92 @@ describe('generateTypescriptDefinitionsForTlEntry', () => {
)
})
it('adds comments', () => {
test(
'// This is a test constructor\ntest = Test;',
'/**',
' * This is a test constructor',
' */',
'interface RawTest {',
" _: 'test';",
'}'
)
test(
'// @description This is a test constructor\n' +
'// @field Some field\n' +
'test field:int = Test;',
'/**',
' * This is a test constructor',
' */',
'interface RawTest {',
" _: 'test';",
' /**',
' * Some field',
' */',
' field: number;',
'}'
)
test(
'---functions---\n// This is a test method\ntest = Test;',
'/**',
' * This is a test method',
' * ',
' * RPC method returns {@see tl.TypeTest}',
' */',
'interface RawTestRequest {',
" _: 'test';",
'}'
)
describe('comments', () => {
it('adds tl style comments', () => {
test(
'// This is a test constructor\n' + 'test = Test;',
'/**',
' * This is a test constructor',
' */',
'interface RawTest {',
" _: 'test';",
'}'
)
test(
'---functions---\n' +
'// This is a test method\n' +
'test = Test;',
'/**',
' * This is a test method',
' * ',
' * RPC method returns {@link tl.TypeTest}',
' */',
'interface RawTestRequest {',
" _: 'test';",
'}'
)
})
test(
'// This is a test constructor with a very very very very very very very very long comment\ntest = Test;',
'/**',
' * This is a test constructor with a very very very very very',
' * very very very long comment',
' */',
'interface RawTest {',
" _: 'test';",
'}'
)
it('adds tdlib style comments', () => {
test(
'// @description This is a test constructor\n' +
'// @field Some field\n' +
'test field:int = Test;',
'/**',
' * This is a test constructor',
' */',
'interface RawTest {',
" _: 'test';",
' /**',
' * Some field',
' */',
' field: number;',
'}'
)
})
test(
'---functions---\n// This is a test method with a very very very very very very very very long comment\ntest = Test;',
'/**',
' * This is a test method with a very very very very very very',
' * very very long comment',
' * ',
' * RPC method returns {@see tl.TypeTest}',
' */',
'interface RawTestRequest {',
" _: 'test';",
'}'
)
it('wraps long comments', () => {
test(
'// This is a test constructor with a very very very very very very very very long comment\n' +
'test = Test;',
'/**',
' * This is a test constructor with a very very very very very',
' * very very very long comment',
' */',
'interface RawTest {',
" _: 'test';",
'}'
)
test(
'---functions---\n' +
'// This is a test method with a very very very very very very very very long comment\n' +
'test = Test;',
'/**',
' * This is a test method with a very very very very very very',
' * very very long comment',
' * ',
' * RPC method returns {@link tl.TypeTest}',
' */',
'interface RawTestRequest {',
" _: 'test';",
'}'
)
})
it('should not break @link tags', () => {
test(
'// This is a test constructor with a very long comment {@link whatever} more text\n' +
'test = Test;',
'/**',
' * This is a test constructor with a very long comment',
' * {@link whatever} more text',
' */',
'interface RawTest {',
" _: 'test';",
'}'
)
})
})
it('writes generic types', () => {
@ -242,7 +268,7 @@ describe('generateTypescriptDefinitionsForTlSchema', () => {
" _: 'test';",
'}',
'/**',
' * RPC method returns {@see tl.TypeTest}',
' * RPC method returns {@link tl.TypeTest}',
' */',
'interface RawGetTestRequest {',
" _: 'getTest';",
@ -284,7 +310,7 @@ interface RawTest2 {
_: 'test2';
}
/**
* RPC method returns {@see tl.TypeTest}
* RPC method returns {@link tl.TypeTest}
*/
interface RawGetTestRequest {
_: 'getTest';
@ -303,7 +329,7 @@ namespace test {
_: 'test.test2';
}
/**
* RPC method returns {@see tl.test.TypeTest}
* RPC method returns {@link tl.test.TypeTest}
*/
interface RawGetTestRequest {
_: 'test.getTest';