Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement default formatting to all resources #5480

Merged
merged 3 commits into from
Nov 29, 2024
Merged

Conversation

ykuijs
Copy link
Member

@ykuijs ykuijs commented Nov 28, 2024

Pull Request (PR) description

This PR implements default formatting to all resources. Since these are only formatting updates, these should not have any impact on the resources itself.

This Pull Request (PR) fixes the following issues

Task list

  • Added an entry to the change log under the Unreleased section of the file CHANGELOG.md.
    Entry should say what was changed and how that affects users (if applicable), and
    reference the issue being resolved (if applicable).
  • Resource parameter descriptions added/updated in the schema.mof.
  • Resource documentation added/updated in README.md.
  • Resource settings.json file contains all required permissions.
  • Examples appropriately added/updated.
  • Unit tests added/updated.
  • New/changed code adheres to DSC Community Style Guidelines.

@ykuijs
Copy link
Member Author

ykuijs commented Nov 28, 2024

@ricmestre This is a pretty big PR that impacts lots of files. They should not break anything, but just to be sure: Would you have the possibility to run your tests on them?

No problem if you don't 😉

@FabienTschanz
Copy link
Contributor

@ykuijs Can we enforce this formatting in the .vscode settings.json file with indentation, new line enforcement, spaces between brackets etc.?

@ykuijs
Copy link
Member Author

ykuijs commented Nov 28, 2024

@FabienTschanz Good suggestion. We already have formatting settings in the vscode settings.json file. Any suggestions on what might be good to add?

One remark: These settings only work if you use VSCode (which is the recommended tool). But if you are using any other tool, these settings would not make any difference.

@ricmestre
Copy link
Contributor

@ykuijs Indeed this is a big one, but are you just changing the format of the files themselves and not the output formatting of exports? If yes then just go ahead, no need to test it.

@ykuijs
Copy link
Member Author

ykuijs commented Nov 28, 2024

This PR indeed only updates the formatting of the files itself: I had VSCode run through all the files and apply the formatting rules as specified in the VSCode settings.json.

So the impact should be absolutely zero, since this does not update any actual logic.

@FabienTschanz
Copy link
Contributor

@ykuijs I would love to have method names in Upper case:

  • Wrong: myObject.add("key", "value")
  • Correct: myObject.Add("key", "value")

Currently checking how this could be done.

@FabienTschanz
Copy link
Contributor

@ykuijs I have a version that supports methods in upper case with autocorrection. Currently testing that, you can go ahead and merge this one. Looks all good.

@ykuijs ykuijs merged commit 6995d50 into microsoft:Dev Nov 29, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants