asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: change from detecting version to since tag (#13127)

Browse Source 
* update everything from version to since

* update events

* regenerate oas
This commit is contained in:
Shahed Nasser
2025-08-01 18:22:42 +03:00
committed by GitHub
parent 57ad8fc755
commit 522fc12d7a
36 changed files with 94 additions and 101 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
www/utils/packages/docs-generator/src/classes/kinds/default.ts
View File

@@ -600,16 +600,16 @@ class DefaultKindGenerator<T extends ts.Node = ts.Node> {
* Retrieve information from the tags of a node.
*
* @param node - The node to retrieve the information from.
* @returns An object containing the deprecated and version tags, if available.
* @returns An object containing the deprecated and since tags, if available.
*/
getInformationFromTags(node: ts.Node): {
deprecatedTag: ts.JSDocTag | undefined
versionTag: ts.JSDocTag | undefined
sinceTag: ts.JSDocTag | undefined
featureFlagTag: ts.JSDocTag | undefined
} {
const nodeComments = ts.getJSDocCommentsAndTags(node)
let deprecatedTag: ts.JSDocTag | undefined
let versionTag: ts.JSDocTag | undefined
let sinceTag: ts.JSDocTag | undefined
let featureFlagTag: ts.JSDocTag | undefined
nodeComments.forEach((comment) => {
@@ -622,8 +622,8 @@ class DefaultKindGenerator<T extends ts.Node = ts.Node> {
deprecatedTag = tag
}
if (tag.tagName.getText() === "version") {
versionTag = tag
if (tag.tagName.getText() === "since") {
sinceTag = tag
}
if (tag.tagName.getText() === "featureFlag") {
@@ -634,7 +634,7 @@ class DefaultKindGenerator<T extends ts.Node = ts.Node> {
return {
deprecatedTag,
versionTag,
sinceTag,
featureFlagTag,
}
}

8
www/utils/packages/docs-generator/src/classes/kinds/events.ts
View File

@@ -50,7 +50,7 @@ class EventsKindGenerator extends DefaultKindGenerator<ts.VariableDeclaration> {
const commentsAndTags = ts.getJSDocCommentsAndTags(propertyAssignment)
let payloadTag: ts.JSDocTag | undefined
let versionTag: ts.JSDocTag | undefined
let sinceTag: ts.JSDocTag | undefined
let deprecatedTag: ts.JSDocTag | undefined
let description: string | undefined
commentsAndTags.forEach((comment) => {
@@ -67,8 +67,8 @@ class EventsKindGenerator extends DefaultKindGenerator<ts.VariableDeclaration> {
payloadTag = tag
}
if (tag.tagName.getText() === "version") {
versionTag = tag
if (tag.tagName.getText() === "since") {
sinceTag = tag
}
if (tag.tagName.getText() === "deprecated") {
@@ -84,7 +84,7 @@ class EventsKindGenerator extends DefaultKindGenerator<ts.VariableDeclaration> {
payload: (payloadTag?.comment as string) ?? "",
description,
workflows,
version: versionTag?.comment as string,
since: sinceTag?.comment as string,
deprecated: deprecatedTag !== undefined,
deprecated_message: deprecatedTag?.comment as string,
}

20
www/utils/packages/docs-generator/src/classes/kinds/oas.ts
View File

@@ -448,7 +448,7 @@ class OasKindGenerator extends FunctionKindGenerator {
}
// check deprecation and version in tags
const { deprecatedTag, versionTag, featureFlagTag } =
const { deprecatedTag, sinceTag, featureFlagTag } =
this.getInformationFromTags(node)
if (deprecatedTag) {
@@ -458,9 +458,9 @@ class OasKindGenerator extends FunctionKindGenerator {
: undefined
}
if (versionTag) {
oas["x-version"] = versionTag.comment
? (versionTag.comment as string)
if (sinceTag) {
oas["x-since"] = sinceTag.comment
? (sinceTag.comment as string)
: undefined
}
@@ -804,7 +804,7 @@ class OasKindGenerator extends FunctionKindGenerator {
}
// check deprecation and version in tags
const { deprecatedTag, versionTag, featureFlagTag } =
const { deprecatedTag, sinceTag, featureFlagTag } =
this.getInformationFromTags(node)
if (deprecatedTag) {
@@ -817,12 +817,12 @@ class OasKindGenerator extends FunctionKindGenerator {
delete oas["x-deprecated_message"]
}
if (versionTag) {
oas["x-version"] = versionTag.comment
? (versionTag.comment as string)
if (sinceTag) {
oas["x-since"] = sinceTag.comment
? (sinceTag.comment as string)
: undefined
} else {
delete oas["x-version"]
delete oas["x-since"]
}
if (featureFlagTag) {
@@ -2807,7 +2807,7 @@ class OasKindGenerator extends FunctionKindGenerator {
description: event.description,
deprecated: event.deprecated,
deprecated_message: event.deprecated_message,
version: event.version,
since: event.since,
}))
)
}