Repository navigation
Keep the lock files out of Codacy's Lizard, and use one-line docstrings - #162
Merged
Merged
Conversation
Codacy's Lizard reads composer.lock and package-lock.json as source code and flags their length; .codacy.yml now leaves them out, as the EngineScript repository does. The two multi-line docstrings keep their summary as a one-line docstring and the rest becomes a comment, which both of Codacy's contradicting docstring rules (D212, D213) accept. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
|
Thanks for contributing to EngineScript Site Optimizer! Before we review:
Security Reminder
We'll review your PR soon. |
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 0 |
| Duplication | 0 |
NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
composer.lockandpackage-lock.jsonas source code. They are this repository's only two open Codacy issues (file length). The same block is in the EngineScript repository's.codacy.yml.test-automation.pyand the docstring ofcheck_distignoreincheck-plugin-package.pykeep their summary as a one-line docstring; the rest becomes a comment. Codacy enables both D212 and D213, which contradict each other, so any multi-line docstring is flagged once that pair is checked here; EngineScript made the same change.Checked locally: Ruff 0.17.2 (check and format), mypy 2.4.0, pydocstyle with D212 and D213, yamllint, and
check-plugin-package.pyagainst a build made from the tracked files that.distignorekeeps (.codacy.ymlis left out by its.*rule). The release contents do not change.🤖 Generated with Claude Code