add ci.yml #149

koilebeit · 2024-07-24T14:12:52Z

Pull request

Proposed changes

resolves #83

I have successfully tested it locally with act, so it should work.

Types of changes

New feature (non-breaking change which adds functionality).
Enhancement (non-breaking change which enhances functionality)
Bug Fix (non-breaking change which fixes an issue).
Breaking change (fix or feature that would cause existing functionality to change).

Checklist

I have read the CONTRIBUTING document.
My change requires a change to the documentation.
I have updated the documentation accordingly.

Summary by CodeRabbit

New Features
- Introduced a Continuous Integration (CI) workflow for automated code formatting checks using Prettier on pull requests.
- Added a .prettierignore file to specify directories and files to be excluded from formatting.
- Created a .prettierrc configuration file for formatting Liquid templates in HTML files.
- Established new scripts for checking and formatting code.
Improvements
- Enhanced code quality by enforcing consistent formatting across various file types (JavaScript, CSS, Markdown, Liquid, HTML), improving maintainability and readability.
- Integrated development dependencies for Prettier and Shopify's Liquid plugin to support automated formatting.

changeset-bot · 2024-07-24T14:12:55Z

⚠️ No Changeset found

Latest commit: e6e9e90

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

coderabbitai · 2024-07-24T14:12:59Z

Walkthrough

This change introduces a comprehensive Continuous Integration (CI) workflow using GitHub Actions to automate code formatting checks with Prettier. Triggered by pull requests to the main branch, it ensures consistent formatting across various file types, enhancing code quality and maintainability. Additionally, configuration files are added to manage formatting rules specifically for Liquid templates and to define scripts for efficient development workflows.

Changes

File Path	Change Summary
.github/workflows/ci.yml	New file added for CI workflow that checks code formatting using Prettier.
.prettierignore	New file created to specify files and directories to exclude from formatting.
.prettierrc	New configuration file for Prettier, adding support for Liquid templates and specifying parser options.
package.json	Updated to include scripts for checking and formatting code, along with development dependencies.

Assessment against linked issues

Objective	Addressed	Explanation
Add `ci.yml` to ensure files are formatted (83)	✅
Exclude specific files from formatting	✅

🐰 In the garden of code, oh what a sight,
Prettier hops in with all of its might.
With CI in place, and rules set just right,
Our code shines bright, pure and tight.
Let’s celebrate this joyful spree,
For clean code is the key, whee! 🌟

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

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 UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0870e38 and 268fb11.

Files selected for processing (1)

.github/workflows/ci.yml (1 hunks)

Files skipped from review due to trivial changes (1)

.github/workflows/ci.yml

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 268fb11 and 558a11f.

Files selected for processing (1)

.github/workflows/ci.yml (1 hunks)

Files skipped from review due to trivial changes (1)

.github/workflows/ci.yml

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 558a11f and 9011025.

Files selected for processing (1)

.github/workflows/ci.yml (1 hunks)

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

.github/workflows/ci.yml

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9011025 and 76c3947.

Files selected for processing (1)

.prettierignore (1 hunks)

Files skipped from review due to trivial changes (1)

.prettierignore

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 76c3947 and 865e05b.

Files ignored due to path filters (1)

package-lock.json is excluded by !**/package-lock.json

Files selected for processing (3)

.github/workflows/ci.yml (1 hunks)
.prettierrc (1 hunks)
package.json (1 hunks)

Files skipped from review due to trivial changes (2)

.prettierrc
package.json

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

.github/workflows/ci.yml

package.json

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 865e05b and a6aa0ff.

Files selected for processing (1)

package.json (1 hunks)

Additional comments not posted (2)

package.json (2)

2-5: Scripts for local formatting checks are well-defined.

The scripts for checking and formatting code using Prettier are correctly set up. This aligns with the existing comment suggesting their addition.

6-9: Dependencies for Prettier and Liquid plugin are correctly specified.

The dependencies for Prettier and the Shopify Liquid plugin are appropriately included, ensuring compatibility with the specified versions.

maehr

@koilebeit it looks good but I could not test whether prettier respects the prettier ignore locally. Thanks for checking this out

koilebeit · 2024-08-15T08:48:02Z

@koilebeit it looks good but I could not test whether prettier respects the prettier ignore locally. Thanks for checking this out

I have tested it and it works fine. However, I have adjusted the script so that run format does not format all files

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a6aa0ff and e6e9e90.

Files selected for processing (1)

package.json (1 hunks)

Files skipped from review due to trivial changes (1)

package.json

add ci.yml

268fb11

coderabbitai bot reviewed Jul 24, 2024

View reviewed changes

configure ref and repository

558a11f

koilebeit requested a review from maehr July 24, 2024 14:30

coderabbitai bot reviewed Jul 24, 2024

View reviewed changes

use node v22

9011025

coderabbitai bot reviewed Jul 25, 2024

View reviewed changes

add .prettierignore

76c3947

coderabbitai bot reviewed Jul 25, 2024

View reviewed changes

koilebeit added 2 commits July 26, 2024 16:16

update ci.yml

be47e22

add package-lock

865e05b

coderabbitai bot reviewed Jul 26, 2024

View reviewed changes

maehr reviewed Aug 9, 2024

View reviewed changes

package.json Show resolved Hide resolved

koilebeit mentioned this pull request Aug 9, 2024

Format all files #150

Merged

7 tasks

koilebeit added 2 commits August 14, 2024 16:35

Merge branch 'main' into prettier

396cc79

add scripts to run prettier locally

a6aa0ff

koilebeit requested a review from maehr August 14, 2024 14:45

coderabbitai bot reviewed Aug 14, 2024

View reviewed changes

maehr approved these changes Aug 14, 2024

View reviewed changes

format not all files

e6e9e90

coderabbitai bot reviewed Aug 15, 2024

View reviewed changes

maehr approved these changes Aug 15, 2024

View reviewed changes

koilebeit merged commit b7e437c into Stadt-Geschichte-Basel:main Aug 15, 2024
1 check passed

koilebeit deleted the prettier branch August 15, 2024 13:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add ci.yml #149

add ci.yml #149

koilebeit commented Jul 24, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Jul 24, 2024 •

edited

Loading

coderabbitai bot commented Jul 24, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot left a comment

coderabbitai bot left a comment

coderabbitai bot left a comment

coderabbitai bot left a comment

coderabbitai bot left a comment

maehr left a comment

koilebeit commented Aug 15, 2024

coderabbitai bot left a comment

add ci.yml #149

add ci.yml #149

Conversation

koilebeit commented Jul 24, 2024 • edited by coderabbitai bot Loading

Pull request

Proposed changes

Types of changes

Checklist

Summary by CodeRabbit

changeset-bot bot commented Jul 24, 2024 • edited Loading

⚠️ No Changeset found

coderabbitai bot commented Jul 24, 2024 • edited Loading

Walkthrough

Changes

Assessment against linked issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

maehr left a comment

Choose a reason for hiding this comment

koilebeit commented Aug 15, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

koilebeit commented Jul 24, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Jul 24, 2024 •

edited

Loading

coderabbitai bot commented Jul 24, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)