ric/dockge
1
0
Fork 0
mirror of https://github.com/louislam/dockge.git synced 2025-02-22 11:35:56 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix bug 176: preserve YAML comments when reordering items by matching… (#685)
Some checks failed
Node.js CI - Dockge / ci (22, ARM) (push) Has been cancelled
Details
Node.js CI - Dockge / ci (22, ARM64) (push) Has been cancelled
Details
Node.js CI - Dockge / ci (22, macos-latest) (push) Has been cancelled
Details
Node.js CI - Dockge / ci (22, ubuntu-latest) (push) Has been cancelled
Details
Node.js CI - Dockge / ci (22, windows-latest) (push) Has been cancelled
Details
json-yaml-validate / json-yaml-validate (push) Has been cancelled
Details

Browse source
This commit is contained in:
turnah 2024-12-31 07:43:17 +00:00 • committed by GitHub
parent 9b73e44cd9
commit a65a9f5549
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 42 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
common/util-common.ts
View file

@ -236,8 +236,7 @@ export function copyYAMLComments(doc : Document, src : Document) {
/** /**
* Copy yaml comments from srcItems to items * Copy yaml comments from srcItems to items
* Typescript is super annoying here, so I have to use any here * Attempts to preserve comments by matching content rather than just array indices
* TODO: Since comments are belong to the array index, the comments will be lost if the order of the items is changed or removed or added.
*/ */
// eslint-disable-next-line @typescript-eslint/no-explicit-any // eslint-disable-next-line @typescript-eslint/no-explicit-any
function copyYAMLCommentsItems(items: any, srcItems: any) { function copyYAMLCommentsItems(items: any, srcItems: any) {
@ -245,16 +244,23 @@ function copyYAMLCommentsItems(items : any, srcItems : any) {
return; return;
} }
// First pass - try to match items by their content
for (let i = 0; i < items.length; i++) { for (let i = 0; i < items.length; i++) {
// eslint-disable-next-line @typescript-eslint/no-explicit-any // eslint-disable-next-line @typescript-eslint/no-explicit-any
const item: any = items[i]; const item: any = items[i];
// Try to find matching source item by content
// eslint-disable-next-line @typescript-eslint/no-explicit-any // eslint-disable-next-line @typescript-eslint/no-explicit-any
const srcItem : any = srcItems[i]; const srcIndex = srcItems.findIndex((srcItem: any) =>
JSON.stringify(srcItem.value) === JSON.stringify(item.value) &&
JSON.stringify(srcItem.key) === JSON.stringify(item.key)
);
if (!srcItem) { if (srcIndex !== -1) {
continue; // eslint-disable-next-line @typescript-eslint/no-explicit-any
} const srcItem: any = srcItems[srcIndex];
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const nextSrcItem: any = srcItems[srcIndex + 1];
if (item.key && srcItem.key) { if (item.key && srcItem.key) {
item.key.comment = srcItem.key.comment; item.key.comment = srcItem.key.comment;
@ -265,6 +271,20 @@ function copyYAMLCommentsItems(items : any, srcItems : any) {
item.comment = srcItem.comment; item.comment = srcItem.comment;
} }
// Handle comments between array items
if (nextSrcItem && nextSrcItem.commentBefore) {
if (items[i + 1]) {
items[i + 1].commentBefore = nextSrcItem.commentBefore;
}
}
// Handle trailing comments after array items
if (srcItem.value && srcItem.value.comment) {
if (item.value) {
item.value.comment = srcItem.value.comment;
}
}
if (item.value && srcItem.value) { if (item.value && srcItem.value) {
if (typeof item.value === "object" && typeof srcItem.value === "object") { if (typeof item.value === "object" && typeof srcItem.value === "object") {
item.value.comment = srcItem.value.comment; item.value.comment = srcItem.value.comment;
@ -277,6 +297,7 @@ function copyYAMLCommentsItems(items : any, srcItems : any) {
} }
} }
} }
}
/** /**
* Possible Inputs: * Possible Inputs: