style(*): clean up comments and remove unnecessary whitespace in multiple files #380

lumirlumir · 2025-06-29T08:39:29Z

This pull request includes various changes across multiple files to improve code clarity, adhere to linting rules, and refine documentation within the clang-format packages. The most important changes involve removing redundant comments, updating type annotations, and adding linting directives.

Code clarity improvements:

Removed redundant comments in packages/clang-format-git-python/src/cli.js, packages/clang-format-git/src/cli.js, and packages/clang-format-node/src/cli.js to streamline the code. [1] [2] [3]

Documentation refinements:

Updated type annotations in packages/clang-format-git-python/src/utils/gitClangFormatPath.js to specify {string} instead of string.
Removed redundant comments in documentation blocks across utility files such as gitClangFormatPath.js and getGitClangFormatPath.js in clang-format-git and clang-format-node packages. [1] [2] [3] [4]

Linting adherence:

Added a linting directive (eslint-disable-line no-console) to a console.error statement in packages/clang-format-git-python/src/cli.js to comply with linting rules.

…iple files

vercel · 2025-06-29T08:39:33Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
npm-clang-format-node-website	⬜️ Skipped (Inspect)			Jun 29, 2025 8:39am

Copilot

Pull Request Overview

This pull request cleans up code comments and whitespace across multiple files within the clang-format packages to improve clarity and documentation. Key changes include:

Removing redundant comment lines and unnecessary whitespace
Updating type annotations for improved documentation clarity
Adding a linting directive to comply with eslint rules

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
packages/clang-format-node/src/utils/getClangFormatPath.test.js	Removed an extra comment line to streamline the documentation block
packages/clang-format-node/src/utils/getClangFormatPath.js	Removed redundant asterisks within documentation comments
packages/clang-format-node/src/utils/clangFormatPath.js	Eliminated unnecessary whitespace in documentation blocks
packages/clang-format-node/src/cli.js	Cleaned up whitespace between module imports
packages/clang-format-git/src/utils/gitClangFormatPath.js	Removed extra comment lines in documentation for improved clarity
packages/clang-format-git/src/utils/getGitClangFormatPath.js	Removed redundant documentation comments
packages/clang-format-git/src/cli.js	Reduced extraneous whitespace in module imports
packages/clang-format-git-python/src/utils/gitClangFormatPath.js	Updated type annotation syntax from "string" to "{string}" for consistency
packages/clang-format-git-python/src/cli.js	Added a linting directive for the console.error statement to adhere to eslint rules

codecov · 2025-06-29T08:40:42Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (ea77118) to head (f150ec1).
Report is 1 commits behind head on main.

@@            Coverage Diff            @@
##              main      #380   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           11        11           
  Lines          439       422   -17     
=========================================
- Hits           439       422   -17

Files with missing lines	Coverage Δ
packages/clang-format-git-python/src/cli.js	`100.00% <100.00%> (ø)`
...-format-git-python/src/utils/gitClangFormatPath.js	`100.00% <100.00%> (ø)`
packages/clang-format-git/src/cli.js	`100.00% <ø> (ø)`
...lang-format-git/src/utils/getGitClangFormatPath.js	`100.00% <ø> (ø)`
...s/clang-format-git/src/utils/gitClangFormatPath.js	`100.00% <ø> (ø)`
packages/clang-format-node/src/cli.js	`100.00% <ø> (ø)`
...ges/clang-format-node/src/utils/clangFormatPath.js	`100.00% <ø> (ø)`
.../clang-format-node/src/utils/getClangFormatPath.js	`100.00% <ø> (ø)`

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ea77118...f150ec1. Read the comment docs.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

github-actions · 2025-06-29T08:43:01Z

Labels have been automatically applied based on the Conventional Commits specification.🏷️

@lumirlumir

…ch`) (#399) ## Release Information: `v1.3.4` New release of `lumirlumir/npm-clang-format-node` has arrived! 🎉 This PR bumps the package versions from `v1.3.3` to `v1.3.4` (`patch`). See [Actions](https://github.com/lumirlumir/npm-clang-format-node/actions/runs/16236437387) for more details. | Info | Value | | ----------- | -------------------------- | | Repository | `lumirlumir/npm-clang-format-node` | | SEMVER | `patch` | | Pre ID | `canary` | | Short SHA | 5862509 | | Old Version | `v1.3.3` | | New Version | `v1.3.4` |  ## What's Changed ### 🐛 Bug Fixes * fix(*): update `postinstall` script to remove unnecessary build check by @lumirlumir in #398 ### 🧰 Chores * chore(*): update configuration files to use `.cjs` or `.mjs` extensions by @lumirlumir in #298 * chore(sync-server): update lint configs and bump package versions by @lumirlumir in #310 * chore(sync-server): update `lint-staged` and scripts by @lumirlumir in #314 * chore(sync-server): update `dependabot.yml` and `.gitignore` by @lumirlumir in #326 * chore(sync-server): remove `is-interactive` dependency and update Codecov configuration by @lumirlumir in #336 * chore(sync-server): update `dependabot.yml` by @lumirlumir in #351 * chore(*): run `npm dedupe` for cleanup by @lumirlumir in #362 * chore(*): remove `bananass-utils-vitepress` dependency by @lumirlumir in #377 * chore(*): move `FUNDING.yml` files to `.github` repository by @lumirlumir in #389 * chore(*): replace `shx` with native Node.js file operations in scripts by @lumirlumir in #397 ### 🔄 Continuous Integrations * ci(*): update actions to use docker native action by @lumirlumir in #393 * ci(*): update `test-cross-platform.yml` by @lumirlumir in #396 ### 🎨 Styles * style(*): clean up comments and remove unnecessary whitespace in multiple files by @lumirlumir in #380 ### 🧪 Tests * test(*): simplify describe blocks in test files by @lumirlumir in #331 ### ⬆️ Dependency Updates * chore(deps-dev): bump @types/node from 22.13.17 to 22.14.0 by @dependabot[bot] in #299 * chore(deps-dev): bump eslint-config-bananass from 0.0.6 to 0.0.7 in the bananass group across 1 directory by @dependabot[bot] in #300 * chore(deps-dev): bump eslint from 9.23.0 to 9.24.0 by @dependabot[bot] in #301 * chore(deps-dev): bump typescript from 5.8.2 to 5.8.3 by @dependabot[bot] in #302 * chore(deps-dev): bump vitepress-plugin-group-icons from 1.3.8 to 1.4.1 by @dependabot[bot] in #303 * chore(deps-dev): bump lerna from 8.2.1 to 8.2.2 by @dependabot[bot] in #305 * chore(deps-dev): bump @types/node from 22.14.0 to 22.14.1 by @dependabot[bot] in #306 * chore(deps-dev): bump textlint-rule-allowed-uris from 1.0.9 to 1.1.0 by @dependabot[bot] in #308 * chore(deps-dev): bump vitepress-plugin-group-icons from 1.4.1 to 1.5.1 by @dependabot[bot] in #307 * chore(deps-dev): bump lint-staged from 15.5.0 to 15.5.1 by @dependabot[bot] in #311 * chore(deps-dev): bump vitepress-plugin-group-icons from 1.5.1 to 1.5.2 by @dependabot[bot] in #312 * chore(deps-dev): bump eslint from 9.24.0 to 9.25.0 by @dependabot[bot] in #315 * chore(deps-dev): bump eslint from 9.25.0 to 9.25.1 by @dependabot[bot] in #316 * chore(deps-dev): bump @types/node from 22.14.1 to 22.15.0 by @dependabot[bot] in #318 * chore(deps-dev): bump the bananass group across 1 directory with 2 updates by @dependabot[bot] in #317 * chore(deps-dev): bump @types/node from 22.15.0 to 22.15.2 by @dependabot[bot] in #320 * chore(deps-dev): bump the bananass group across 1 directory with 2 updates by @dependabot[bot] in #319 * chore(deps-dev): bump @types/node from 22.15.2 to 22.15.3 by @dependabot[bot] in #321 * chore(deps-dev): bump the babel group across 1 directory with 3 updates by @dependabot[bot] in #322 * chore(deps-dev): bump textlint from 14.6.0 to 14.7.1 by @dependabot[bot] in #323 * chore(deps-dev): bump eslint from 9.25.1 to 9.26.0 by @dependabot[bot] in #324 * chore(deps-dev): bump @types/node from 22.15.3 to 22.15.9 by @dependabot[bot] in #325 * chore(deps-dev): bump the babel group across 1 directory with 2 updates by @dependabot[bot] in #327 * chore(deps-dev): bump lint-staged from 15.5.1 to 15.5.2 by @dependabot[bot] in #328 * chore(deps-dev): bump @types/node from 22.15.9 to 22.15.15 by @dependabot[bot] in #330 * chore(deps-dev): bump the bananass group across 1 directory with 2 updates by @dependabot[bot] in #332 * chore(deps-dev): bump @types/node from 22.15.16 to 22.15.17 by @dependabot[bot] in #333 * chore(deps-dev): bump lint-staged from 15.5.2 to 16.0.0 by @dependabot[bot] in #334 * chore(deps-dev): bump the bananass group across 2 directories with 3 updates by @dependabot[bot] in #335 * chore(deps): bump undici from 6.21.1 to 6.21.3 in the npm_and_yarn group across 1 directory by @dependabot[bot] in #340 * chore(deps-dev): bump vitepress-plugin-group-icons from 1.5.2 to 1.5.5 by @dependabot[bot] in #341 * chore(deps-dev): bump @types/node from 22.15.17 to 22.15.18 by @dependabot[bot] in #338 * chore(deps-dev): bump eslint from 9.26.0 to 9.27.0 by @dependabot[bot] in #345 * chore(deps-dev): bump markdownlint-cli from 0.44.0 to 0.45.0 by @dependabot[bot] in #344 * chore(deps-dev): bump @codecov/vite-plugin from 1.9.0 to 1.9.1 by @dependabot[bot] in #346 * chore(deps-dev): bump the bananass group across 2 directories with 3 updates by @dependabot[bot] in #348 * chore(deps-dev): bump @types/node from 22.15.18 to 22.15.21 by @dependabot[bot] in #350 * chore(deps-dev): bump textlint from 14.7.1 to 14.7.2 by @dependabot[bot] in #349 * chore(deps-dev): bump @types/node from 22.15.21 to 22.15.24 by @dependabot[bot] in #354 * chore(deps-dev): bump @babel/core from 7.27.1 to 7.27.3 in the babel group across 1 directory by @dependabot[bot] in #352 * chore(deps-dev): bump @types/node from 22.15.24 to 22.15.26 by @dependabot[bot] in #355 * chore(deps-dev): bump lint-staged from 16.0.0 to 16.1.0 by @dependabot[bot] in #356 * chore(deps-dev): bump eslint from 9.27.0 to 9.28.0 by @dependabot[bot] in #358 * chore(deps-dev): bump @babel/core from 7.27.3 to 7.27.4 in the babel group across 1 directory by @dependabot[bot] in #357 * chore(deps-dev): bump @types/node from 22.15.26 to 22.15.29 by @dependabot[bot] in #359 * chore(deps-dev): bump vitepress-plugin-group-icons from 1.5.5 to 1.6.0 by @dependabot[bot] in #360 * chore(deps-dev): bump the bananass group across 2 directories with 3 updates by @dependabot[bot] in #364 * chore(deps-dev): bump textlint-rule-allowed-uris from 1.1.0 to 1.1.1 by @dependabot[bot] in #366 * chore(deps-dev): bump @types/node from 22.15.29 to 24.0.0 by @dependabot[bot] in #367 * chore(deps-dev): bump @types/node from 24.0.0 to 24.0.1 by @dependabot[bot] in #368 * chore(deps-dev): bump eslint from 9.28.0 to 9.29.0 by @dependabot[bot] in #370 * chore(deps-dev): bump lint-staged from 16.1.0 to 16.1.2 by @dependabot[bot] in #369 * chore(deps-dev): bump @types/node from 24.0.1 to 24.0.3 by @dependabot[bot] in #371 * chore(deps-dev): bump concurrently from 9.1.2 to 9.2.0 by @dependabot[bot] in #372 * chore(deps-dev): bump prettier from 3.5.3 to 3.6.0 by @dependabot[bot] in #373 * chore(deps-dev): bump @babel/core from 7.27.4 to 7.27.7 in the babel group across 1 directory by @dependabot[bot] in #376 * chore(deps-dev): bump prettier from 3.6.0 to 3.6.2 by @dependabot[bot] in #378 * chore(deps-dev): bump eslint from 9.29.0 to 9.30.0 by @dependabot[bot] in #382 * chore(deps-dev): bump lerna from 8.2.2 to 8.2.3 by @dependabot[bot] in #381 * chore(deps-dev): bump vitepress-plugin-group-icons from 1.6.0 to 1.6.1 by @dependabot[bot] in #383 * chore(deps-dev): bump @types/node from 24.0.3 to 24.0.8 by @dependabot[bot] in #385 * chore(deps-dev): bump @types/node from 24.0.8 to 24.0.10 by @dependabot[bot] in #387 * chore(deps-dev): bump eslint from 9.30.0 to 9.30.1 by @dependabot[bot] in #386 * chore(deps-dev): bump the babel group across 1 directory with 3 updates by @dependabot[bot] in #388 * chore(deps-dev): bump the bananass group across 1 directory with 2 updates by @dependabot[bot] in #391 **Full Changelog**: v1.3.3...v1.3.4

style(*): clean up comments and remove unnecessary whitespace in mult…

f150ec1

…iple files

Copilot AI review requested due to automatic review settings June 29, 2025 08:39

Copilot AI reviewed Jun 29, 2025

View reviewed changes

github-actions bot added 🏷️ scope: * Auto-generated label based on Conventional Commits specification for GitHub release notes 🏷️ type: style Auto-generated label based on Conventional Commits specification for GitHub release notes labels Jun 29, 2025

lumirlumir merged commit bf114f1 into main Jun 29, 2025
41 of 42 checks passed

lumirlumir deleted the style-cleanup-comments branch June 29, 2025 08:44

lumirlumir mentioned this pull request Jul 12, 2025

chore(release): bump package versions from v1.3.3 to v1.3.4 (patch) #399

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

style(*): clean up comments and remove unnecessary whitespace in multiple files #380

style(*): clean up comments and remove unnecessary whitespace in multiple files #380

Uh oh!

lumirlumir commented Jun 29, 2025

Uh oh!

vercel bot commented Jun 29, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

codecov bot commented Jun 29, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jun 29, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

style(*): clean up comments and remove unnecessary whitespace in multiple files #380

style(*): clean up comments and remove unnecessary whitespace in multiple files #380

Uh oh!

Conversation

lumirlumir commented Jun 29, 2025

Code clarity improvements:

Documentation refinements:

Linting adherence:

Uh oh!

vercel bot commented Jun 29, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

codecov bot commented Jun 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions bot commented Jun 29, 2025

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Jun 29, 2025 •

edited

Loading