Skip to content

style: 🎨 apply format changes#1102

Merged
alandtse merged 2 commits into
community-shaders:devfrom
alandtse:style_format
May 29, 2025
Merged

style: 🎨 apply format changes#1102
alandtse merged 2 commits into
community-shaders:devfrom
alandtse:style_format

Conversation

@alandtse
Copy link
Copy Markdown
Collaborator

@alandtse alandtse commented May 28, 2025

We're trying to fix the auto formatter given security fixes. We'll need a single PR with all of the changes and then moving forward the auto formatter should work.

Summary by CodeRabbit

  • Style
    • Improved formatting and indentation across workflow, configuration, source code, and documentation files for consistency and readability.
  • Documentation
    • Standardized indentation and spacing in the README for better clarity.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 28, 2025

Walkthrough

This update applies consistent formatting and indentation across multiple YAML, JSON, Markdown, and C++ source files. No logic, control flow, or content is changed—only whitespace, indentation, and minor stylistic elements are adjusted for clarity and uniformity throughout the codebase and documentation.

Changes

File(s) Change Summary
.github/workflows/build.yaml
.github/workflows/cleanup-pr-releases.yaml
.github/workflows/lintpr.yaml
.github/workflows/wip.yaml
Reformatted YAML files with consistent 4-space indentation; no logic or structural changes.
CMakePresets.json
cmake/ports/clib-util/vcpkg.json
vcpkg.json
Reformatted JSON files with consistent space-based indentation; no changes to data or structure.
README.md Standardized indentation and spacing in Markdown; improved readability with blank lines.
src/Feature.h
src/FrameAnnotations.cpp
src/Hooks.cpp
src/ShaderCache.cpp
Adjusted code formatting and indentation; no changes to logic, declarations, or control flow.

Possibly related PRs

Suggested reviewers

  • jiayev
  • Pentalimbed

Poem

Hopping through the code so neat,
I tidy lines beneath my feet.
Spaces line up, tabs retreat,
Indents crisp, the look complete.
No logic changed, just style refined—
A garden of code, perfectly aligned!
🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@alandtse alandtse marked this pull request as draft May 28, 2025 06:19
@github-actions
Copy link
Copy Markdown

✅ A pre-release build is available for this PR:
Download

@alandtse alandtse marked this pull request as ready for review May 29, 2025 03:35
@alandtse alandtse closed this May 29, 2025
@alandtse alandtse reopened this May 29, 2025
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
.github/workflows/build.yaml (1)

125-125: Remove trailing whitespace
A trailing space at the end of this line triggers a YAMLlint warning. Removing it will prevent linter errors.

-                    .commits[] 
+                    .commits[]
🧰 Tools
🪛 YAMLlint (1.37.1)

[error] 125-125: trailing spaces

(trailing-spaces)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 56eba29 and 1195bd9.

⛔ Files ignored due to path filters (12)
  • features/IBL/Shaders/IBL/DiffuseIBLCS.hlsl is excluded by !**/*.hlsl
  • features/Skylighting/Shaders/Skylighting/UpdateProbesCS.hlsl is excluded by !**/*.hlsl
  • package/Shaders/AmbientCompositeCS.hlsl is excluded by !**/*.hlsl
  • package/Shaders/Common/Glints/noisegen.cs.hlsl is excluded by !**/*.hlsl
  • package/Shaders/CopyShadowDataCS.hlsl is excluded by !**/*.hlsl
  • package/Shaders/DeferredCompositeCS.hlsl is excluded by !**/*.hlsl
  • package/Shaders/ISVolumetricLightingGenerateCS.hlsl is excluded by !**/*.hlsl
  • package/Shaders/ISVolumetricLightingRaymarchCS.hlsl is excluded by !**/*.hlsl
  • package/Shaders/Lighting.hlsl is excluded by !**/*.hlsl
  • package/Shaders/RunGrass.hlsl is excluded by !**/*.hlsl
  • package/Shaders/Upscaling/EncodeTexturesCS.hlsl is excluded by !**/*.hlsl
  • package/Shaders/Upscaling/RCAS/RCAS.hlsl is excluded by !**/*.hlsl
📒 Files selected for processing (12)
  • .github/workflows/build.yaml (1 hunks)
  • .github/workflows/cleanup-pr-releases.yaml (1 hunks)
  • .github/workflows/lintpr.yaml (1 hunks)
  • .github/workflows/wip.yaml (1 hunks)
  • CMakePresets.json (1 hunks)
  • README.md (4 hunks)
  • cmake/ports/clib-util/vcpkg.json (1 hunks)
  • src/Feature.h (1 hunks)
  • src/FrameAnnotations.cpp (3 hunks)
  • src/Hooks.cpp (1 hunks)
  • src/ShaderCache.cpp (2 hunks)
  • vcpkg.json (1 hunks)
🧰 Additional context used
🪛 actionlint (1.7.7)
.github/workflows/cleanup-pr-releases.yaml

19-19: the runner of "actions/checkout@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

🪛 markdownlint-cli2 (0.17.2)
README.md

11-11: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


13-13: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


14-14: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


16-16: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


18-18: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


19-19: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


20-20: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


25-25: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


27-27: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)

🪛 LanguageTool
README.md

[uncategorized] ~53-~53: A comma might be missing here.
Context: ...an example CMakeUserPreset to start off with you can copy the `CMakeUserPresets.json...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)


[uncategorized] ~57-~57: You might be missing the article “the” here.
Context: ...UTO_PLUGIN_DEPLOYMENT - This option is default "OFF" - Make sure `"AUTO_PLUGIN_DEPLO...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~63-~63: You might be missing the article “the” here.
Context: ... #### AIO_ZIP_TO_DIST - This option is default "ON" - Make sure "AIO_ZIP_TO_DIST" ...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~69-~69: You might be missing the article “the” here.
Context: ...mod #### ZIP_TO_DIST - This option is default "ON" - Make sure "ZIP_TO_DIST" is s...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~72-~72: You might be missing the article “the” here.
Context: ...haders in /dist - If having a file with name CORE in the root of the features fold...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~76-~76: You might be missing the article “the” here.
Context: ...p #### TRACY_SUPPORT - This option is default "OFF" - This will enable tracy suppor...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~77-~77: You might be missing the article “the” here.
Context: ...ble tracy support, might need to delete build folder when this option is changed Whe...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[misspelling] ~79-~79: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...eset you can call BuildRelease.bat with an parameter to specify which preset to co...

(EN_A_VS_AN)


[uncategorized] ~82-~82: Possible missing comma found.
Context: ...MENT` When switching between different presets you might need to remove the build fold...

(AI_HYDRA_LEO_MISSING_COMMA)


[style] ~86-~86: Consider changing the order of words to improve your wording.
Context: ...Build with Docker For those who prefer to not install Visual Studio or other build de...

(TO_NOT_VB)


[uncategorized] ~88-~88: Possible missing comma found.
Context: ...ww.docker.com/products/docker-desktop/) first if not already there. 2. In a shell of ...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~89-~89: Possible missing comma found.
Context: ...ot already there. 2. In a shell of your choice run to switch to Windows containers and...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~103-~103: A comma might be missing here.
Context: ...he build/aio folder. 5. In subsequent builds only run the build step (3.) #### Trou...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)

🪛 YAMLlint (1.37.1)
.github/workflows/build.yaml

[error] 125-125: trailing spaces

(trailing-spaces)

🔇 Additional comments (13)
cmake/ports/clib-util/vcpkg.json (1)

2-6: Formatting changes only The JSON indentation has been standardized (four spaces) for consistency. No semantic or structural changes were introduced.

src/Feature.h (1)

47-47: Formatting changes only Added a space before the empty braces in ReflectionsPrepass() to align with the project's brace style. No API or behavior changes.

src/ShaderCache.cpp (2)

1001-1001: Formatting change only Adjusted the indentation of ++nameIndex in the for loop to match surrounding code. No logic changes.


1189-1189: Formatting change only Aligned the indentation of ++arrayIndex in the array-element loop for consistency. No functional impact.

vcpkg.json (1)

2-49: Formatting changes only Reformatted indentation and spacing throughout the JSON file. All keys, values, and dependency entries remain unchanged.

CMakePresets.json (1)

2-123: Formatting changes only Converted to uniform space-based indentation and aligned properties. No modifications to preset configurations or values.

src/Hooks.cpp (1)

64-64: LGTM: Consistent pointer declaration formatting.

The change from FILE * file to FILE* file improves consistency with common C++ style guidelines by placing the asterisk adjacent to the type name rather than the variable name.

.github/workflows/wip.yaml (1)

3-12: LGTM: Improved YAML indentation consistency.

The indentation adjustments create uniform formatting throughout the workflow file, enhancing readability while maintaining the same functional behavior.

.github/workflows/lintpr.yaml (1)

4-20: LGTM: Standardized YAML formatting.

The consistent 4-space indentation improves the file's readability and follows YAML formatting best practices without altering the workflow's functionality.

src/FrameAnnotations.cpp (1)

932-955: LGTM: Enhanced for-loop formatting consistency.

The indentation adjustments in the for-loop headers improve code readability and maintain consistent formatting style throughout the function without affecting the loop logic or functionality.

.github/workflows/build.yaml (1)

4-195: Consistent indentation applied across workflow file
Nested keys under on, permissions, and jobs now uniformly use 4-space indentation without altering any logic.

🧰 Tools
🪛 YAMLlint (1.37.1)

[error] 125-125: trailing spaces

(trailing-spaces)

.github/workflows/cleanup-pr-releases.yaml (1)

4-54: Workflow formatting looks good
All indentation changes under on, permissions, and jobs conform to the 4-space standard, matching other workflows. No behavior changes detected.

🧰 Tools
🪛 actionlint (1.7.7)

19-19: the runner of "actions/checkout@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

README.md (1)

11-134: List indentation and spacing normalized
Sub-list items and blank lines have been reformatted (4-space indents for nested bullets and consistent spacing around code blocks), improving readability. No content alterations.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~43-~43: You might be missing the article “a” here.
Context: ...at" amd64 ``` ## Clone and Build Open terminal (e.g., PowerShell) and run the followin...

(AI_EN_LECTOR_MISSING_DETERMINER_A)


[uncategorized] ~53-~53: A comma might be missing here.
Context: ...an example CMakeUserPreset to start off with you can copy the `CMakeUserPresets.json...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)


[uncategorized] ~57-~57: You might be missing the article “the” here.
Context: ...UTO_PLUGIN_DEPLOYMENT - This option is default "OFF" - Make sure `"AUTO_PLUGIN_DEPLO...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~63-~63: You might be missing the article “the” here.
Context: ... #### AIO_ZIP_TO_DIST - This option is default "ON" - Make sure "AIO_ZIP_TO_DIST" ...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~69-~69: You might be missing the article “the” here.
Context: ...mod #### ZIP_TO_DIST - This option is default "ON" - Make sure "ZIP_TO_DIST" is s...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~72-~72: You might be missing the article “the” here.
Context: ...haders in /dist - If having a file with name CORE in the root of the features fold...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~76-~76: You might be missing the article “the” here.
Context: ...p #### TRACY_SUPPORT - This option is default "OFF" - This will enable tracy suppor...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~77-~77: You might be missing the article “the” here.
Context: ...ble tracy support, might need to delete build folder when this option is changed Whe...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[misspelling] ~79-~79: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...eset you can call BuildRelease.bat with an parameter to specify which preset to co...

(EN_A_VS_AN)


[uncategorized] ~82-~82: Possible missing comma found.
Context: ...MENT` When switching between different presets you might need to remove the build fold...

(AI_HYDRA_LEO_MISSING_COMMA)


[style] ~86-~86: Consider changing the order of words to improve your wording.
Context: ...Build with Docker For those who prefer to not install Visual Studio or other build de...

(TO_NOT_VB)


[uncategorized] ~88-~88: Possible missing comma found.
Context: ...ww.docker.com/products/docker-desktop/) first if not already there. 2. In a shell of ...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~89-~89: Possible missing comma found.
Context: ...ot already there. 2. In a shell of your choice run to switch to Windows containers and...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~103-~103: A comma might be missing here.
Context: ...he build/aio folder. 5. In subsequent builds only run the build step (3.) #### Trou...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)

🪛 markdownlint-cli2 (0.17.2)

11-11: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


13-13: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


14-14: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


16-16: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


18-18: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


19-19: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


20-20: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


25-25: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


27-27: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


45-45: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

@github-actions
Copy link
Copy Markdown

✅ A pre-release build is available for this PR:
Download

1 similar comment
@github-actions
Copy link
Copy Markdown

✅ A pre-release build is available for this PR:
Download

@alandtse alandtse merged commit 1873715 into community-shaders:dev May 29, 2025
10 checks passed
@coderabbitai coderabbitai Bot mentioned this pull request Jun 3, 2025
@alandtse alandtse deleted the style_format branch June 20, 2025 17:30
alandtse added a commit to alandtse/open-shaders that referenced this pull request Jul 20, 2025
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.

2 participants