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

feat(snippets): remove [in] and [out] from @params #1371

Merged
merged 2 commits into from
Aug 18, 2023

Conversation

YuryShkoda
Copy link
Member

@YuryShkoda YuryShkoda commented Aug 18, 2023

Issue

[in] and [out] @param entries don't bring value, but just use limited space in VS Code snippet description.

Intent

  • Remove [in] and [out] @param entries from snippet description.

Implementation

  • Improved param regular expression in src/commands/snippets/snippets.ts.
  • Adjusted unit test covering VS Code snippet generation.

Checks

  • Code is formatted correctly (npm run lint:fix).
  • Any new functionality has been unit tested.
  • All unit tests are passing (npm test).
  • Unit tests coverage has been increased and a new threshold is set.
  • All CI checks are green.
  • Development comments have been added or updated.
  • Development documentation coverage has been increased and a new threshold is set.
  • Reviewer is assigned.

Reviewer checks

  • Any new code is documented.

@github-actions github-actions bot requested a review from sabhas August 18, 2023 07:48
const briefRegExp = /^\s\s@brief\s/
// to get lines that has @param keyword and optionally [in] or [out] string
// following it
const paramRegExp = /^\s\s@param\s(\[(in|out)\]\s)?/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should be case insensitive ideally

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

@YuryShkoda YuryShkoda requested a review from allanbowe August 18, 2023 07:59
@github-actions
Copy link

github-actions bot commented Aug 18, 2023

Coverage report

Total coverage

Status Category Percentage Covered / Total
🟡 Statements 73.58% 3303/4489
🟡 Branches 60.6% 1309/2160
🟡 Functions 73.57% 668/908
🟢 Lines 82.46% 8494/10301

Status of coverage: 🟢 - ok, 🟡 - slightly more than threshold, 🔴 - under the threshold

Report generated by 🧪jest coverage report action from c2638cb

@YuryShkoda YuryShkoda merged commit aa276b8 into main Aug 18, 2023
@YuryShkoda YuryShkoda deleted the snippets-param-improvements branch August 18, 2023 08:35
@github-actions
Copy link

🎉 This PR is included in version 4.9.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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.

3 participants