chore: update configuration files for consistency and clarity; adjust .editorconfig, .gitattributes, .gitignore, .styleci.yml, and README.md.#6
Conversation
… `.editorconfig`, `.gitattributes`, `.gitignore`, `.styleci.yml`, and `README.md`.
|
Warning Rate limit exceeded
To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThe PR implements a scaffolding system for distributing ECS and Rector configuration files through ChangesScaffolding System Implementation
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.gitattributes:
- Around line 27-29: Remove the redundant export-ignore entries: since
'/.github' is already listed, delete the individual '/.github/dependabot.yml'
and '/.github/workflows' lines so only '/.github
export-ignore' remains; update the .gitattributes to keep just the
directory-level entry ('/.github') and remove the two child-path entries
('/.github/dependabot.yml' and '/.github/workflows').
In @.gitignore:
- Line 62: The .gitignore currently contains a self-reference entry ".gitignore"
which should be removed; open the .gitignore file and delete the line that lists
".gitignore" so the repository and scaffolded copies won't be inadvertently
ignored (release exclusion is already handled by .gitattributes export-ignore),
leaving other ignore rules intact.
- Around line 5-6: The negation rule "!src/assets/package-lock.json" is
currently before the broader "package-lock.json" ignore rule so it gets
overridden; move the "!src/assets/package-lock.json" entry so it appears
immediately after the general "package-lock.json" pattern (i.e., place the
negation below the "package-lock.json" rule) so Git will un-ignore
src/assets/package-lock.json as intended.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 7c858d50-6289-4b5f-a28a-1f220297b684
📒 Files selected for processing (7)
.editorconfig.gitattributes.github/linters/.codespellrc.gitignore.styleci.ymlREADME.mdcomposer.json
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: linter / Super Linter
- GitHub Check: easy-coding-standard / PHP 8.5-ubuntu-latest
- GitHub Check: linter / Super Linter
🔇 Additional comments (6)
.github/linters/.codespellrc (1)
2-2: Skip list expansion looks good.This change appropriately reduces codespell noise from generated and third-party directories while preserving source-focused linting.
README.md (1)
215-215: LGTM! Semantic improvement.The emoji change from 📚 (books) to 📥 (download/inbox tray) better represents the action-oriented nature of an installation guide. The new icon more clearly conveys "getting" or "installing" rather than just "reading documentation."
.styleci.yml (2)
4-4:version: 8.3is valid but not the current StyleCI default.
7.4, 8.0, 8.1, 8.2, 8.3, and 8.4are all allowed values for the StyleCIversionfield, so8.3is accepted. However, PHP version8.4is the current default version. If the intent is to target PHP 8.3 (matchingcomposer.json's"php": ">=8.3"), this is intentional and fine.
4-4: StyleCIversion: 8.3is a valid configuration value and supported by StyleCI..editorconfig (1)
16-27: LGTM!The new
*.scss,*.css,package.json, andpackage-lock.jsonsections are consistent with the existing*.js,*.md,*.yaml, and*.ymloverrides.composer.json (1)
46-46: LGTM!Using
"append"mode for.editorconfigis consistent with the treatment of.gitignoreand makes sense given the newly added per-glob sections that downstream consumers may want to extend.
|
@codex review |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: bc5e9c1d22
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 950bd097a0
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
.github/linters/.gitleaks.toml (1)
3-7:⚠️ Potential issue | 🔴 CriticalChange
[allowlist]to[[allowlists]]to use current Gitleaks syntax.Gitleaks v8.25.0+ deprecated the
[allowlist]syntax in favor of[[allowlists]]. Using the old singular-table form will cause the allowlist to be ignored, potentially triggering false positives in secret detection.Change required:
- [allowlist] + [[allowlists]] description = "Allow test fixture data with dummy credentials" paths = [ '''tests/support/data/.*\.php''', ]🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.github/linters/.gitleaks.toml around lines 3 - 7, Replace the deprecated single-table header [allowlist] with the current multi-table header [[allowlists]] so Gitleaks v8.25.0+ recognizes the rule; keep the existing keys (description and paths array) under the new [[allowlists]] block (the same entries shown for description and paths/'''tests/support/data/.*\.php''') so the allowlist continues to work and avoid false positives.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 179-180: Fix the run-on sentence in the README by inserting
appropriate punctuation between "independent" and "adopt" in the sentence "The
two packages are independent adopt either, both, or neither."; update it to
either "The two packages are independent; adopt either, both, or neither." or
"The two packages are independent—adopt either, both, or neither." to correct
the grammar and improve readability.
---
Outside diff comments:
In @.github/linters/.gitleaks.toml:
- Around line 3-7: Replace the deprecated single-table header [allowlist] with
the current multi-table header [[allowlists]] so Gitleaks v8.25.0+ recognizes
the rule; keep the existing keys (description and paths array) under the new
[[allowlists]] block (the same entries shown for description and
paths/'''tests/support/data/.*\.php''') so the allowlist continues to work and
avoid false positives.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 89ccf589-ce64-4474-b4eb-212976c9892c
📒 Files selected for processing (14)
.ecrc.gitattributes.github/linters/.editorconfig-checker.json.github/linters/.gitleaks.toml.gitignore.prettierignoreCHANGELOG.mdREADME.mdcomposer.jsondocs/installation.mdscaffold-lock.jsonscaffold.jsonsrc/config/ecs.phpsrc/config/rector.php
💤 Files with no reviewable changes (1)
- docs/installation.md
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: linter / Super Linter
- GitHub Check: easy-coding-standard / PHP 8.5-ubuntu-latest
- GitHub Check: easy-coding-standard / PHP 8.5-ubuntu-latest
- GitHub Check: linter / Super Linter
🔇 Additional comments (9)
.gitignore (1)
30-31:package-lock.jsonexception ordering is now correct.The unignore rule placement on Line 31 correctly overrides the broader ignore on Line 30.
.prettierignore (1)
20-21: Good exclusion for generated scaffold lockfile.Ignoring
scaffold-lock.jsonhere is consistent with the “generated, not hand-edited” model..github/linters/.editorconfig-checker.json (1)
1-11: New editorconfig-checker exclusions look consistent.This config aligns with existing generated/runtime/minified exclusions and should reduce false positives in CI.
scaffold.json (1)
2-9: Scaffold manifest is clear and internally consistent.
copysources/destinations andpreservemodes are aligned for both wrapper files..gitattributes (1)
25-39: Archive exclusion updates are coherent.The expanded
export-ignorelist is consistent with the scaffold/config-only files being repository tooling artifacts rather than release payload.composer.json (1)
13-23: ⚡ Quick win[Rewritten review comment]
[Classification tag]scaffold-lock.json (2)
18-18: ⚡ Quick winThe source path for
.gitattributesis correct as-is.The source path
"metadata/gitattributes"matches the actual filename stored in the php-forge/baseline provider's metadata directory. No inconsistency exists; this is the correct path format for this entry.> Likely an incorrect or invalid review comment.
4-4: ⚖️ Poor tradeoffVerify if
php-forge/baselinehas stable releases available.The concern about using
"dev-main"in a lockfile is valid in principle—branch references can change and affect reproducibility. However, this project explicitly declares"minimum-stability": "dev"incomposer.jsonand uses"dev-main"for its own package alias ("dev-main": "0.3.x-dev"). Additionally,php-forge/baselinecould not be verified to exist as a public repository or to have stable tagged releases. For development-focused projects with explicit dev-stability, using"dev-main"for development dependencies is acceptable. Ifphp-forge/baselinehas stable releases available, consider pinning to a tagged version; otherwise, the current approach aligns with the project's development status.README.md (1)
18-18: ⚡ Quick winNo action needed. The PHP version requirement is correctly documented. The configuration files (
ecs-81.phpthroughecs-84.php, etc.) are reusable templates for end-user projects with different minimum PHP versions, not requirements for the package itself. The README clearly states: "Pick the version that matches the minimum PHP your project supports." The package itself requires PHP 8.3+, while it provides configurations for users whose projects target PHP 8.1+.> Likely an incorrect or invalid review comment.
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: f243d793e6
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
1 participant
Pull Request