fix: correctly parse `$id` and `$comment` JSDoc tags #1129

then3rdman · 2022-02-15T08:42:43Z

Resolves #1096.

Additionally fixes $comment tags that were also not functional.

Minor refactor made nest some interfaces to reduce clutter at the root of the src folder.

~~Set allowUnionTypes for AJV in the test suite to remove some of the console log spam.~~

Version

Published prerelease version: v0.98.0-next.1

Changelog

🎉 This release contains work from new contributors! 🎉

Thanks for all your work!

❤️ Marcus Mailer (@then3rdman)

❤️ Arthur Fiorette (@arthurfiorette)

❤️ Mark Sheinkman (@MarkSheinkman)

❤️ null@chimurai

❤️ Kari Lavikka (@tuner)

🚀 Enhancement

fix: correctly parse $id and $comment JSDoc tags #1129 (marcus.mailer@twobulls.com @then3rdman)
feat: --minify option (Add an option to minify the output. #1120) #1121 (@arthurfiorette)

🐛 Bug Fix

fix: failed to resolve type for typeof static class property #1119 (@MarkSheinkman)
docs: autocomplete configuration #1106 (@chimurai)
fix: always expose referred DefinitionType to avoid issues with recursive intersections of unions #1093 (@tuner @domoritz)
chore: upgrade deps #1092 (@domoritz)
chore: add descriptive error message to removeUnreachable #1048 (@tuner)
chore: move fetch-depth config to checkout action #1045 (@hydrosquall)

🔩 Dependency Updates

chore(deps-dev): bump @typescript-eslint/eslint-plugin from 5.10.2 to 5.11.0 #1123 (@dependabot[bot])
chore(deps-dev): bump @types/node from 17.0.15 to 17.0.17 #1122 (@dependabot[bot])
chore(deps-dev): bump @babel/core from 7.17.0 to 7.17.2 #1124 (@dependabot[bot])
chore(deps-dev): bump jest from 27.5.0 to 27.5.1 #1125 (@dependabot[bot])
chore(deps-dev): bump ts-node from 10.4.0 to 10.5.0 #1126 (@dependabot[bot])
chore(deps-dev): bump eslint from 8.8.0 to 8.9.0 #1127 (@dependabot[bot])
chore(deps-dev): bump @typescript-eslint/parser from 5.10.2 to 5.11.0 #1128 (@dependabot[bot])
chore(deps-dev): bump @typescript-eslint/eslint-plugin from 5.10.1 to 5.10.2 #1117 (@dependabot[bot])
chore(deps-dev): bump ajv from 8.9.0 to 8.10.0 #1113 (@dependabot[bot])
chore(deps-dev): bump jest from 27.4.7 to 27.5.0 #1114 (@dependabot[bot])
chore(deps-dev): bump @babel/core from 7.16.12 to 7.17.0 #1115 (@dependabot[bot])
chore(deps-dev): bump @types/node from 17.0.13 to 17.0.15 #1116 (@dependabot[bot])
chore(deps-dev): bump @typescript-eslint/parser from 5.10.1 to 5.10.2 #1118 (@dependabot[bot])
chore(deps-dev): bump @typescript-eslint/parser from 5.10.0 to 5.10.1 #1111 (@dependabot[bot])
chore(deps): bump commander from 8.3.0 to 9.0.0 #1109 (@dependabot[bot])
chore(deps-dev): bump chai from 4.3.4 to 4.3.6 #1107 (@dependabot[bot])
chore(deps-dev): bump eslint from 8.7.0 to 8.8.0 #1108 (@dependabot[bot])
chore(deps-dev): bump @types/node from 17.0.10 to 17.0.13 #1110 (@dependabot[bot])
chore(deps-dev): bump @typescript-eslint/eslint-plugin from 5.10.0 to 5.10.1 #1112 (@dependabot[bot])
chore(deps-dev): bump @babel/core from 7.16.7 to 7.16.12 #1102 (@dependabot[bot])
chore(deps-dev): bump @typescript-eslint/parser from 5.9.1 to 5.10.0 #1098 (@dependabot[bot])
chore(deps-dev): bump @auto-it/conventional-commits from 10.32.5 to 10.32.6 #1097 (@dependabot[bot])
chore(deps-dev): bump auto from 10.32.5 to 10.32.6 #1099 (@dependabot[bot])
chore(deps-dev): bump @types/node from 17.0.8 to 17.0.10 #1100 (@dependabot[bot])
chore(deps-dev): bump @auto-it/first-time-contributor from 10.32.5 to 10.32.6 #1101 (@dependabot[bot])
chore(deps-dev): bump @typescript-eslint/eslint-plugin from 5.9.1 to 5.10.0 #1103 (@dependabot[bot])
chore(deps): bump typescript from 4.5.4 to 4.5.5 #1104 (@dependabot[bot])
chore(deps-dev): bump @babel/preset-env from 7.16.8 to 7.16.11 #1105 (@dependabot[bot])
chore(deps-dev): bump eslint from 8.6.0 to 8.7.0 #1094 (@dependabot[bot])
chore(deps-dev): bump ajv from 8.8.2 to 8.9.0 #1095 (@dependabot[bot])
chore(deps-dev): bump @typescript-eslint/parser from 5.8.1 to 5.9.0 #1088 (@dependabot[bot])
chore(deps-dev): bump jest from 27.4.5 to 27.4.7 #1089 (@dependabot[bot])
chore(deps-dev): bump @typescript-eslint/eslint-plugin from 5.8.1 to 5.9.0 #1090 (@dependabot[bot])
chore(deps-dev): bump @types/node from 17.0.6 to 17.0.8 #1091 (@dependabot[bot])
chore(deps-dev): bump @babel/preset-typescript from 7.16.5 to 7.16.7 #1081 (@dependabot[bot])
chore(deps-dev): bump @typescript-eslint/eslint-plugin from 5.8.0 to 5.8.1 #1082 (@dependabot[bot])
chore(deps-dev): bump @babel/core from 7.16.5 to 7.16.7 #1084 (@dependabot[bot])
chore(deps-dev): bump @typescript-eslint/parser from 5.8.0 to 5.8.1 #1085 (@dependabot[bot])
chore(deps-dev): bump @types/node from 17.0.4 to 17.0.6 #1080 (@dependabot[bot])
chore(deps-dev): bump @types/jest from 27.0.3 to 27.4.0 #1083 (@dependabot[bot])
chore(deps-dev): bump eslint from 8.5.0 to 8.6.0 #1086 (@dependabot[bot])
chore(deps-dev): bump @babel/preset-env from 7.16.5 to 7.16.7 #1087 (@dependabot[bot])
chore(deps): bump actions/setup-node from 2.5.0 to 2.5.1 #1079 (@dependabot[bot])
chore(deps-dev): bump @typescript-eslint/eslint-plugin from 5.7.0 to 5.8.0 #1076 (@dependabot[bot])
chore(deps-dev): bump @typescript-eslint/parser from 5.7.0 to 5.8.0 #1077 (@dependabot[bot])
chore(deps-dev): bump @types/node from 17.0.0 to 17.0.4 #1078 (@dependabot[bot])
chore(deps-dev): bump @types/node from 16.11.12 to 17.0.0 #1071 (@dependabot[bot])
chore(deps-dev): bump @typescript-eslint/eslint-plugin from 5.6.0 to 5.7.0 #1067 (@dependabot[bot])
chore(deps-dev): bump @typescript-eslint/parser from 5.6.0 to 5.7.0 #1068 (@dependabot[bot])
chore(deps-dev): bump @babel/core from 7.16.0 to 7.16.5 #1066 (@dependabot[bot])
chore(deps-dev): bump @babel/preset-env from 7.16.4 to 7.16.5 #1069 (@dependabot[bot])
chore(deps): bump typescript from 4.5.3 to 4.5.4 #1070 (@dependabot[bot])
chore(deps-dev): bump jest from 27.4.4 to 27.4.5 #1072 (@dependabot[bot])
chore(deps-dev): bump @babel/preset-typescript from 7.16.0 to 7.16.5 #1073 (@dependabot[bot])
chore(deps-dev): bump eslint from 8.4.1 to 8.5.0 #1074 (@dependabot[bot])
chore(deps-dev): bump @typescript-eslint/eslint-plugin from 5.5.0 to 5.6.0 #1058 (@dependabot[bot])
chore(deps-dev): bump @typescript-eslint/parser from 5.5.0 to 5.6.0 #1059 (@dependabot[bot])
chore(deps-dev): bump @auto-it/first-time-contributor from 10.32.3 to 10.32.5 #1057 (@dependabot[bot])
chore(deps-dev): bump eslint from 8.4.0 to 8.4.1 #1060 (@dependabot[bot])
chore(deps-dev): bump @types/node from 16.11.11 to 16.11.12 #1061 (@dependabot[bot])
chore(deps-dev): bump jest from 27.4.3 to 27.4.4 #1062 (@dependabot[bot])
chore(deps-dev): bump @auto-it/conventional-commits from 10.32.3 to 10.32.5 #1063 (@dependabot[bot])
chore(deps-dev): bump auto from 10.32.3 to 10.32.5 #1064 (@dependabot[bot])
chore(deps): bump typescript from 4.5.2 to 4.5.3 #1065 (@dependabot[bot])
chore(deps-dev): bump @typescript-eslint/parser from 5.4.0 to 5.5.0 #1049 (@dependabot[bot])
chore(deps): bump safe-stable-stringify from 2.2.0 to 2.3.1 #1050 (@dependabot[bot])
chore(deps-dev): bump jest from 27.3.1 to 27.4.3 #1051 (@dependabot[bot])
chore(deps-dev): bump eslint from 8.3.0 to 8.4.0 #1052 (@dependabot[bot])
chore(deps-dev): bump prettier from 2.5.0 to 2.5.1 #1053 (@dependabot[bot])
chore(deps-dev): bump @types/node from 16.11.10 to 16.11.11 #1054 (@dependabot[bot])
chore(deps-dev): bump @typescript-eslint/eslint-plugin from 5.4.0 to 5.5.0 #1055 (@dependabot[bot])

Authors: 9

@chimurai
@dependabot[bot]
Arthur Fiorette (@arthurfiorette)
Cameron Yick (@hydrosquall)
Dominik Moritz (@domoritz)
Kari Lavikka (@tuner)
Marcus (marcus.mailer@twobulls.com)
Marcus Mailer (@then3rdman)
Mark Sheinkman (@MarkSheinkman)

…n tests

src/AnnotationsReader/BasicAnnotationsReader.ts

test/utils.ts

test/valid-data/annotation-comment/main.ts

MarcusAngel and others added 7 commits January 24, 2022 11:22

fix: generate $id

8cc50f3

refactor: move interfaces from src root

bab9edb

feat: ignore webstorm ide config

c9761d8

refactor: move annotations tests to own suite

c73a5e8

fix: set allowUnionTypes: true in AJV to prevent console warnings i…

93a385b

…n tests

feat: $id and $comment annotations parsed correctly

5be191a

Merge branch 'vega:next' into next

8e8c88b

domoritz requested changes Feb 15, 2022

View reviewed changes

src/AnnotationsReader/BasicAnnotationsReader.ts Outdated Show resolved Hide resolved

test/utils.ts Outdated Show resolved Hide resolved

MarcusAngel added 2 commits February 16, 2022 09:28

fix: remove allowUnionType falg from AJV

8e9e780

refactor: change to set

2d34e26

domoritz reviewed Feb 15, 2022

View reviewed changes

test/valid-data/annotation-comment/main.ts Show resolved Hide resolved

domoritz self-requested a review February 16, 2022 03:08

domoritz approved these changes Feb 16, 2022

View reviewed changes

domoritz merged commit ac172d8 into vega:next Feb 16, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: correctly parse `$id` and `$comment` JSDoc tags #1129

fix: correctly parse `$id` and `$comment` JSDoc tags #1129

then3rdman commented Feb 15, 2022 •

edited by github-actions bot

fix: correctly parse $id and $comment JSDoc tags #1129

fix: correctly parse $id and $comment JSDoc tags #1129

Conversation

then3rdman commented Feb 15, 2022 • edited by github-actions bot

Version

🚀 Enhancement

🐛 Bug Fix

🔩 Dependency Updates

Authors: 9

fix: correctly parse `$id` and `$comment` JSDoc tags #1129

fix: correctly parse `$id` and `$comment` JSDoc tags #1129

then3rdman commented Feb 15, 2022 •

edited by github-actions bot