Skip to content

chore: format codebase with prettier#1100

Open
Aamod007 wants to merge 2 commits into
layer5io:masterfrom
Aamod007:chore-format-codebase-1015
Open

chore: format codebase with prettier#1100
Aamod007 wants to merge 2 commits into
layer5io:masterfrom
Aamod007:chore-format-codebase-1015

Conversation

@Aamod007

@Aamod007 Aamod007 commented Jun 14, 2026

Copy link
Copy Markdown
Contributor

Description

This PR resolves Issue #1015 by applying the configured Prettier code formatter across the entire repository. A code formatter was previously introduced in PR #947, but this is the first time it has been executed globally to bring all existing files up to standard.

Changes Made

  • Executed the make format command (which runs npm run format / prettier --write .).
  • Applied consistent formatting to over 1,300 files, unifying the styling across Markdown, HTML, JSON, SCSS, YAML, and JavaScript files.
  • The formatting adheres strictly to the existing .prettierignore configuration, ensuring that:
    • Compiled and static assets (public/, resources/) remain untouched.
    • Dependencies (node_modules/) are ignored.
    • Hugo layout templates (layouts/) are excluded to prevent breaking Go template syntax.

Rationale

Running the formatter on the entire codebase at once eliminates tech debt related to styling inconsistencies. It establishes a unified, clean code style moving forward and prevents tedious, incremental styling debates on future PRs.

Verification

  • Tested locally by running the npm run format script.
  • Verified that all excluded directories in .prettierignore were correctly skipped during the execution.
  • Build logs confirm no build-breaking changes were introduced.

Closes #1015

@welcome

welcome Bot commented Jun 14, 2026

Copy link
Copy Markdown

Yay, your first pull request! 👍 A contributor will be by to give feedback soon. In the meantime, please review the Layer5 Community Welcome Guide and sure to join the community Slack.
Be sure to double-check that you have signed your commits. Here are instructions for making signing an implicit activity while peforming a commit.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request applies comprehensive formatting and style updates across numerous Markdown, SCSS, JavaScript, and YAML files to enforce consistency. A critical issue was found in assets/scss/_elements_project.scss where the border-top and border-bottom properties were wrapped in quotes, which makes them invalid CSS/SCSS and prevents the borders from rendering.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread assets/scss/_elements_project.scss Outdated
@github-actions

github-actions Bot commented Jun 14, 2026

Copy link
Copy Markdown
Contributor

🚀 Preview deployment: https://docs.layer5.io/pr-preview/pr-1100/

Note: Preview may take a moment (GitHub Pages deployment in progress). Please wait and refresh. Track deployment here

Aamod007 added 2 commits June 14, 2026 16:26
Signed-off-by: Aamod007 <aamodkumar2006@gmail.com>
Signed-off-by: Aamod007 <aamodkumar2006@gmail.com>
@Aamod007

Copy link
Copy Markdown
Contributor Author

@sudhanshutech , could you please take a look and review it when you have a chance?

@NSTKrishna

NSTKrishna commented Jun 14, 2026

Copy link
Copy Markdown
Contributor

@Aamod007 @rishiraj38 Given that this change affects 1,300+ files, do we need a repository wide formatting pass right now?

@Aamod007

Copy link
Copy Markdown
Contributor Author

@NSTKrishna I think it's better to just rip the band-aid off now. Issue #1015 specifically asked for a repo-wide pass to finally get a baseline established.If we don't do it all at once, future feature PRs are just going to get bloated with random formatting changes every time someone saves a file in their IDE. Once we merge this, we can enforce it in CI and never have to worry about messy styling diffs again. I know it's going to cause some merge conflicts for open PRs right now, but it permanently solves the tech debt.

@NSTKrishna

Copy link
Copy Markdown
Contributor

@Aamod007 i suggest you to put this into Website Meeting

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Debt] The codebase needs to be formatted

2 participants