chore: apply spotless precommit

[rishabhrathod01]

Description

This change will remove applying spotless when compiling code and instead will apply spotless in the precommit hook.
This will lead to faster build times and DX improvement as developer need not to manually run spotless anymore.

Fixes #35056

Automation

/test sanity

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/10040567648
Commit: 5872049
Cypress dashboard.
Tags: @tag.Sanity
Spec:

---

Mon, 22 Jul 2024 12:41:36 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

• Yes
• No

Summary by CodeRabbit

Summary by CodeRabbit

• New Features

  • Improved the formatting application process for server files, providing clearer feedback on success or failure.

• Bug Fixes

  • Adjusted the build process to ensure a more streamlined execution of plugin goals.

• Chores

  • Enhanced messaging and readability in scripts for better user experience.

[coderabbitai]

Walkthrough

The recent updates refine the check-staged-files.sh script, shifting its role from simply checking for formatting issues to actively applying corrections using the Spotless tool. Additionally, adjustments in the pom.xml file change the build plugin execution timing, potentially enhancing build efficiency. These improvements enhance user clarity and interaction while preserving the original code structure.

Changes

Files	Change Summary
app/client/.husky/...sh	Updated script to utilize spotless:apply instead of spotless:check, improving success/failure messaging.
app/server/pom.xml	Removed <phase> element and comment from build plugin configuration, altering execution timing.

Assessment against linked issues

Objective	Addressed	Explanation
Remove applying Spotless from build step (#35056)	✅

Poem

In the scripts where code does flow,
Spotless now applies with a cheerful glow.
Build phases shift, and messages shine,
Clarity blooms in each new line.
With every change, our workflow's bright,
A dance of code, in morning light! 🌟

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @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.

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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1b44d2c and 3739dbd.

Files selected for processing (2)

• app/client/.husky/check-staged-files.sh (1 hunks)
• app/server/pom.xml (1 hunks)

Files skipped from review due to trivial changes (1)

• app/server/pom.xml

Additional comments not posted (6)

app/client/.husky/check-staged-files.sh (6)

12-12: Good practice: Informing the user about the ongoing process.

The echo statement enhances user feedback by indicating that Spotless is being applied to server files.

---

14-14: Correct change: Applying Spotless instead of just checking.

Replacing mvn spotless:check with mvn spotless:apply aligns with the PR objective of automating code formatting tasks.

---

15-15: Good practice: Providing clear feedback on success.

The echo statement informs the user about the successful application of Spotless, enhancing the clarity of the script.

---

16-16: Necessary change: Staging the changes made by Spotless.

Adding git add . ensures that the changes made by Spotless are staged for commit.

---

19-19: Improvement: Clearer failure message.

The updated failure message accurately indicates that Spotless apply failed, which aids in debugging.

---

24-24: Good practice: Informing the user about skipped checks.

The echo statement enhances user feedback by indicating that server-side checks are being skipped.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3739dbd and 49c6f9c.

Files selected for processing (1)

• app/client/.husky/check-staged-files.sh (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• app/client/.husky/check-staged-files.sh

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 49c6f9c and 5872049.

Files selected for processing (1)

• app/client/.husky/check-staged-files.sh (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• app/client/.husky/check-staged-files.sh