Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test: enhance test files with structured comments and file overviews #143

Merged
merged 1 commit into from
Dec 15, 2024

Conversation

lumirlumir
Copy link
Owner

This pull request adds file overview comments and organizes test files for better readability across multiple packages. The changes primarily include adding documentation comments and structuring sections within the test files.

Documentation and structure improvements:

  • Added file overview comments to test files in packages/clang-format-git-python/src (cli.test.js, index.test.js, utils/gitClangFormatPath.test.js). [1] [2] [3]
  • Added file overview comments to test files in packages/clang-format-git/src (cli.test.js, index.test.js, utils/getGitClangFormatPath.test.js, utils/gitClangFormatPath.test.js). [1] [2] [3] [4]
  • Added file overview comments to test files in packages/clang-format-node/src (cli.test.js, index.test.js, utils/clangFormatPath.test.js, utils/getClangFormatPath.test.js). [1] [2] [3] [4]

Structural organization:

  • Added sections for "Require", "Declaration", and "Test" within test files to improve readability and organization. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]

@github-actions github-actions bot added the test label Dec 15, 2024
Copy link

Labels have been automatically applied based on the conventional commit types.🏷️

Copy link

codecov bot commented Dec 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (209f1cf) to head (1c9e967).
Report is 1 commits behind head on main.

@@            Coverage Diff            @@
##              main      #143   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           11        11           
  Lines           61        61           
=========================================
  Hits            61        61           

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 209f1cf...1c9e967. Read the comment docs.

@lumirlumir lumirlumir merged commit eb9d11f into main Dec 15, 2024
33 checks passed
@lumirlumir lumirlumir deleted the test-comments-fileoverview branch December 15, 2024 10:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant