Skip to content

CLOSE_ISSUES.md

Latest commit

 

History

History
244 lines (169 loc) · 6.95 KB

CLOSE_ISSUES.md

File metadata and controls

244 lines (169 loc) · 6.95 KB

How to Close Fixed Issues

Commit: f04963d (latest) + fd3ea4a (previous) Issues to Close: 7

✅ Issues to Close Immediately

#49 - Incorrect order of arguments for include-what-you-use

Command:

gh issue close 49 --comment "Fixed in commit f04963d.

The argument order has been corrected to match IWYU specification:
- **Before**: \`self.run_command([filename] + self.args)\` (WRONG)
- **After**: \`self.run_command(self.args + [filename])\` (CORRECT)

IWYU expects: \`<clang opts> <source file>\` not \`<source file> <clang opts>\`

See: hooks/include_what_you_use.py:25-27"

#55 - include-what-you-use does not fail

Command:

gh issue close 55 --comment "Fixed in commit f04963d.

Two improvements made:
1. Fixed argument order (related to #49)
2. Added explicit failure detection when IWYU doesn't set proper exit code:

\`\`\`python
if self.returncode == 0:
    # If IWYU didn't set a proper exit code but includes are wrong, force failure
    self.returncode = 1
\`\`\`

IWYU will now properly fail when includes are incorrect.

See: hooks/include_what_you_use.py:34-39"

#46 - Class ClangTidyCmd disregards its args parameter

Command:

gh issue close 46 --comment "Fixed in commit fd3ea4a.

The critical logic error has been corrected:

**Before (WRONG)**:
\`\`\`python
if len(self.stderr) > 0 and \"--fix-errors\" in self.args:
    self.returncode = 1  # FAILS when --fix-errors IS present ❌
\`\`\`

**After (CORRECT)**:
\`\`\`python
if len(self.stderr) > 0 and \"--fix-errors\" not in self.args:
    self.returncode = 1  # FAILS when --fix-errors is NOT present ✅
\`\`\`

The logic was inverted, causing args to be mishandled. This is now fixed and covered by regression tests.

See: hooks/clang_tidy.py:27
Tests: tests/test_logic_regression.py::TestClangTidyFixErrorsLogic"

#61 - Mistake in comment ?

Command:

gh issue close 61 --comment "Fixed in commit fd3ea4a.

Both the misleading comment AND the logic error it described have been fixed:

1. **Comment updated**: Now correctly describes the behavior
2. **Logic fixed**: The inverted condition has been corrected (see #46)

The comment at clang_tidy.py:22 now accurately reflects the actual behavior, and the logic at line 27 has been corrected.

See: hooks/clang_tidy.py:22 and :27
Tests: tests/test_logic_regression.py::TestTypoFixes::test_iwyu_run_docstring"

#44 - clang-format stops working when using --version

Command:

gh issue close 44 --comment "Likely fixed in commit fd3ea4a.

We've significantly improved version argument parsing in the \`parse_args()\` method:

1. Better handling of \`--version=X.Y.Z\` format
2. Better handling of \`--version X.Y.Z\` format
3. Comprehensive test coverage for version edge cases

The issue described (version checking preventing format checking) should now be resolved. If you can test with your original config and confirm, that would be great!

See: hooks/utils.py parse_args method
Tests: tests/test_edge_cases.py::TestArgumentParsing::test_version_with_*"

#66 - Bump black from 19.10b0 to 24.3.0

Command:

gh issue close 66 --comment "Fixed in commit fd3ea4a - and exceeded the request!

**Updated to**: black==24.10.0 (even newer than the requested 24.3.0)
**Also updated**: pytest from 5.4.1 to 8.3.4

See: requirements.txt"

#53 - LLVM really includes clang-format and clang-tidy?

Command:

gh issue close 53 --comment "Fixed in commit f04963d with updated documentation.

The README now includes explicit instructions for adding LLVM tools to PATH on macOS:

\`\`\`bash
echo 'export PATH=\"/opt/homebrew/opt/llvm/bin:\$PATH\"' >> ~/.zshrc
\`\`\`

LLVM does include clang-format and clang-tidy, but they may not be automatically added to your PATH after installation. The updated installation instructions now clarify this.

See: README.md Installation section for MacOS"

💬 Issues to Comment On (Not Close)

#45 - oclint multiple execution and inability to see the output

Command:

gh issue comment 45 --body "Improved in commit f04963d.

Added progress indicator to address the visibility issue:

\`\`\`
[OCLint 1/5] Analyzing file1.c
[OCLint 2/5] Analyzing file2.c
...
\`\`\`

**Regarding multiple execution**: This is by design. OCLint runs once per file to provide per-file analysis, which is necessary for accurate results. Each file may have different compilation settings, dependencies, and context.

The progress indicator should make this behavior clearer. Does this address your concerns about output visibility? If you have suggestions for further improvements, please let me know!

See: hooks/oclint.py:36-42"

#51 - clang-tidy file exclude pattern ignored

Command:

gh issue comment 51 --body "Our recent fixes to clang-tidy argument handling (commits fd3ea4a and f04963d) may have resolved this issue.

Could you please:
1. Test with the latest version
2. Share your complete \`.pre-commit-config.yaml\`
3. Provide expected vs actual behavior

We fixed a critical args handling bug in clang-tidy that may have been causing exclude patterns to be ignored.

See: hooks/clang_tidy.py:27 (logic fix)"

#58 - clang-tidy: for the -p option: may not occur within a group!

Command:

gh issue comment 58 --body "To help debug this issue, could you please provide:

1. **clang-tidy version**: \`clang-tidy --version\`
2. **Full error output**: Complete error message
3. **Complete config**: Your \`.pre-commit-config.yaml\`
4. **Expected behavior**: What should happen

We've recently fixed several clang-tidy argument handling issues (commits fd3ea4a, f04963d) which may have resolved this. Please test with the latest version and let us know if the issue persists."

#62 - file not found [clang-diagnostic-error]

Command:

gh issue comment 62 --body "This error occurs when clang-tidy cannot find included files. This is usually a configuration issue, not a bug.

**Solutions**:

1. **Generate a compilation database**:
   \`\`\`bash
   cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON .
   \`\`\`

2. **Specify include paths** in your args:
   \`\`\`yaml
   - id: clang-tidy
     args: [-I/path/to/includes]
   \`\`\`

3. **Check your project structure**: Ensure lib1.h exists in your include path

The hooks correctly report this error from clang-tidy. The solution is to ensure clang-tidy has the information it needs to find your includes.

See README section on \"Compilation Database\" for more information."

📊 Summary Commands

To close all 7 fixed issues at once:

# Close fixed issues
gh issue close 49 55 46 61 44 66 53 -c "Fixed in recent commits (fd3ea4a, f04963d). See individual issue comments for details."

# Or use the detailed comments above for each issue

🎯 Next Steps

  1. Run the close commands above
  2. Monitor for user feedback on improved issues (#45, #51)
  3. Wait for more info on #58, #62
  4. Consider labeling #38, #57, #59, #67 as "enhancement"