`formatjson.ps1` - Sort manifest root properties #6494

o-l-a-v · 2025-09-19T09:59:56Z

Description

Reordered properties in schema.json so it matches the wanted order.
Created new function in json.ps1 named Sort-ScoopManifestRootProperties that:
- Sorts root properties according to schema.json properties.
- Sorts one level deep child properties alphabetically if the parent property is of type PSCustomObject.
Made formatjson.ps1 use this new function.

Motivation and Context

Closes #6491.

How Has This Been Tested?

# Path to formatjson.ps1 in branch "formatjson-sort-root-properties"
$FunctionPath = [string] 'D:\git\ScoopInstaller--Scoop\bin\formatjson.ps1'

# Path to main bucket in branch "master" pulled 2025-09-19T12:25:00+02:00
$Directory = [string] 'D:\git\ScoopInstaller--Main\bucket'

# Run format json, look at git afterwards
$ErrorActionPreference = 'Stop'
. $FunctionPath -Dir $Directory -App '*'

Checklist:

I have read the Contributing Guide.
I have ensured that I am targeting the develop branch.
I have updated the documentation accordingly.
- Info about formatjson.ps1 was added with feat: Add lint checks GithubActions#61: https://github.com/ScoopInstaller/GithubActions/wiki/Pull-Request-Checks
I have updated the tests accordingly.
I have added an entry in the CHANGELOG.

o-l-a-v · 2025-09-19T10:31:33Z

@deevus @HUMORCE @rashil2000 @z-Fng: What do you guys think?

coderabbitai · 2025-09-19T10:53:47Z

Warning

Rate limit exceeded

@o-l-a-v has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 6 minutes and 37 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 04b7ce7 and 37aa459.

📒 Files selected for processing (5)

CHANGELOG.md (1 hunks)
bin/formatjson.ps1 (2 hunks)
lib/json.ps1 (1 hunks)
lib/manifest.ps1 (1 hunks)
schema.json (3 hunks)

✨ Finishing touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

o-l-a-v · 2025-09-19T18:31:27Z

@coderabbitai review

z-Fng · 2025-09-20T08:23:23Z

bin/formatjson.ps1

+    # Convert to 4 spaces
+    $json = [string]($json -replace "`t", '    ')
+
+    # Overwrite file content
    [System.IO.File]::WriteAllLines($file, $json)


When JSON parsing fails, it will clear the manifest content. Should this behavior be adjusted to prevent contributors from losing their work?

Yup, maybe we should add some error handling.

z-Fng · 2025-09-20T08:34:11Z

bin/formatjson.ps1

+    $json = [PSCustomObject](parse_json -path $file)
+
+    # Sort JSON root properties
+    $json = [PSCustomObject](Sort-ScoopManifestRootProperties -JsonAsObject $json)


Is it possible to sort the keys recursively with global/local order?

I don't fully understand what you're asking for here, about the local/global order.

Recursice ordering keys by the schema.json should be possible. Or just sort child keys alphabetically.

local/global order

My description might be redundant. Jsut ignore it. Focus on recursive sorting.

I thought that when sorting keys like architecture.64bit/32bit , local order are used because the configuration file contains architecture.64bit/32bit. However, when sorting keys like architecture.64bit.url/hash, the configuration file lacks this entry, causing it to fall back to the global order.

As I'm not sure how to describe this, I called it local/global order.

Scoop/schema.json

Lines 217 to 231 in 37aa459

"architecture": {

"type": "object",

"additionalProperties": false,

"properties": {

"32bit": {

"$ref": "#/definitions/autoupdateArch"

},

"64bit": {

"$ref": "#/definitions/autoupdateArch"

},

"arm64": {

"$ref": "#/definitions/autoupdateArch"

}

}

},

I added sorting of first level child keys if parent is of type PSCustomObject. Going even deeper will be more complex. It's doable, but I think what we got now is a good start.

Maybe there are existing PowerShell or C# projects that can sort a JSON file by schema.json and handle all the complexity of going deeper we can use?

In Python there is: https://github.com/ikonst/jschon-sort.

But as I already said, I think this serves as a very good start for getting more uniform manifests.

z-Fng · 2025-09-20T08:51:10Z

bin/formatjson.ps1

+    $json = [PSCustomObject](Sort-ScoopManifestRootProperties -JsonAsObject $json)
+
+    # Beautify
+    $json = [string](ConvertToPrettyJson -data $json)


I am concerned whether the sort is a stable sort algorithm for keys that are not present in the index list.

Could multiple executions yield different results?

IMO there could and should be a check for keys we don't want to be present. Doesn't this exist already?

To make formatjson.ps1 safer we could do: If key is not present in the schema.json

Optian a) fail execution

Option b) remove key

Doesn't this exist already?

Does it? It will fail execution currently.

Sort-Object: D:\Scoop\apps\scoop\current\lib\json.ps1:241:9 Line | 241 | Sort-Object -Property @{ | ~~~~~~~~~~~~~~~~~~~~~~~~ | Cannot convert value "-1" to type "System.Byte". Error: "Value was either too large or too small for an unsigned byte."

I was thinking more about that other parts of the validation should catch manifest errors before it gets to formatjson.ps1. Thus validating that the manifest doesn't contain invalid keys is a task that formatjson.ps1 shouldn't try to solve.

Seems that's what the validator is for?

https://github.com/ScoopInstaller/Scoop/tree/master/supporting/validator

Thus I don't think the new function Sort-ScoopManifestRootProperties should have a lot of validation logic. It's a feature that it throws if manifest does not comply with schema.json IMO.

I added a check for parent keys not present in schema.json inside Sort-ScoopManifestRootProperties. Then users will get a better error message than what you posted in #6494 (comment).

Or we could write a warning, and just return the object as is / not try to sort the object at all. Instead of throwing.

Seems that's what the validator is for?

Yes, thanks for reminding.

I added a check for parent keys not present in schema.json inside Sort-ScoopManifestRootProperties. Then users will get a better error message than what you posted.

Totally agree. Great.

o-l-a-v added 5 commits September 19, 2025 11:35

Reorder properties to wanted order

21fd5d8

Add sort function to json.ps1

16ea655

Take PSCustomObject instead, let parse_json do the parsing

98ce740

Added sorting manifest as a step

5983d28

Make variable name more telling

cd06740

o-l-a-v marked this pull request as draft September 19, 2025 10:00

o-l-a-v added 5 commits September 19, 2025 12:02

Added changes to changelog

a579f69

Don't use aliases

c0b41a2

Use existing function parse_json instead

25a0b59

Make parse_json function more readable

2c21e14

Fix goof by me

d9f07a3

o-l-a-v marked this pull request as ready for review September 19, 2025 10:30

Read and parse schema.json once

37aa459

z-Fng reviewed Sep 20, 2025

View reviewed changes

o-l-a-v added 6 commits September 20, 2025 12:37

Add some failproof to make sure only expected keys are present

e440802

Remove debug

802b26f

Sort childs alphabetically

37d4073

Only overwrite JSON file if new content is not empty

13bd45f

Rename function and add synopsis

8f696f8

Use Scoop function abort instead of PowerShell native Throw

d25b11e

	"architecture": {
	"type": "object",
	"additionalProperties": false,
	"properties": {
	"32bit": {
	"$ref": "#/definitions/autoupdateArch"
	},
	"64bit": {
	"$ref": "#/definitions/autoupdateArch"
	},
	"arm64": {
	"$ref": "#/definitions/autoupdateArch"
	}
	}
	},

Uh oh!

formatjson.ps1 - Sort manifest root properties #6494

Are you sure you want to change the base?

formatjson.ps1 - Sort manifest root properties #6494

Conversation

o-l-a-v commented Sep 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Motivation and Context

How Has This Been Tested?

Checklist:

Uh oh!

o-l-a-v commented Sep 19, 2025

Uh oh!

coderabbitai bot commented Sep 19, 2025

Rate limit exceeded

Uh oh!

o-l-a-v commented Sep 19, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

o-l-a-v Sep 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

o-l-a-v Sep 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

o-l-a-v Sep 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

z-Fng Sep 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

o-l-a-v Sep 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

o-l-a-v Sep 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

`formatjson.ps1` - Sort manifest root properties #6494

`formatjson.ps1` - Sort manifest root properties #6494

o-l-a-v commented Sep 19, 2025 •

edited

Loading

o-l-a-v Sep 20, 2025 •

edited

Loading

o-l-a-v Sep 20, 2025 •

edited

Loading

o-l-a-v Sep 20, 2025 •

edited

Loading

z-Fng Sep 20, 2025 •

edited

Loading

o-l-a-v Sep 20, 2025 •

edited

Loading

o-l-a-v Sep 20, 2025 •

edited

Loading