feat: Add taplo as TOML formatter and linter #16
Conversation
Summary of ChangesHello @phuongfi91, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
PR Compliance Guide 🔍Below is a summary of compliance checks for this PR:
Compliance status legend🟢 - Fully Compliant🟡 - Partial Compliant 🔴 - Not Compliant ⚪ - Requires Further Human Verification 🏷️ - Compliance label |
|||||||||||||||||||||||
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds taplo, a TOML formatter and linter, to the development Docker image. The changes are well-structured, including updates to the Dockerfile to install taplo, modification of the README.md to document its inclusion, and an addition to tests/specs.yaml to verify its installation. My review includes one suggestion to improve the new test case for better robustness.
| - name: "taplo is installed in path" | ||
| command: "taplo" | ||
| args: ["--version"] | ||
|
|
There was a problem hiding this comment.
To make this test more robust, it's a good practice to also verify the output of the command. This ensures that we are running the correct executable. You can add an expectedOutput field to check for the tool's name in the version string.
- name: "taplo is installed in path"
command: "taplo"
args: ["--version"]
expectedOutput: ["taplo"]
PR Code Suggestions ✨Explore these optional code suggestions:
|
|||||||||||
There was a problem hiding this comment.
Pull request overview
This PR adds taplo as a TOML formatter and linter to the Python development image, providing developers with a tool for formatting and linting TOML configuration files.
Key Changes:
- Added taplo binary installation from the official Docker image
- Added installation verification test
- Updated documentation to list taplo as an available tool
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| Dockerfile | Added ARG for taplo version, FROM statement to pull taplo image, and COPY command to install taplo binary |
| tests/specs.yaml | Added test to verify taplo is installed and accessible via --version flag |
| README.md | Added taplo to the list of included linters and formatters with description |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| # Images which we can directly copy the binaries from | ||
| FROM rhysd/actionlint:${ACTIONLINT_VERSION} AS actionlint | ||
| FROM tamasfe/taplo:${TAPLO_VERSION} AS taplo |
There was a problem hiding this comment.
The FROM tamasfe/taplo:${TAPLO_VERSION} AS taplo stage pulls a third-party image using a mutable tag (latest by default), which creates a supply-chain risk if that image or its tag is ever compromised or changed unexpectedly. Because this image is used to provide a binary that runs in your CI/container context, a malicious update could execute arbitrary code with access to your build environment and any associated secrets. Pin this dependency to an immutable reference (such as a specific image digest or vetted fixed version) and manage upgrades explicitly to reduce this attack surface.
PR Type
Enhancement
Description
Add taplo TOML formatter and linter to Docker image
Configure taplo version argument with latest default
Copy taplo binary from official image to container
Add taplo installation verification test
Diagram Walkthrough
File Walkthrough
Dockerfile
Add taplo installation to Docker imageDockerfile
TAPLO_VERSIONbuild argument with latest as default valuetamasfe/taploimage/usr/local/bin/taploREADME.md
Document taplo tool in READMEREADME.md
specs.yaml
Add taplo installation verification testtests/specs.yaml
taplo --versioncommand to confirm installation