Skip to content

chore(docs): reconcile the inventory with what git archive actually produces #11

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.

Sign up for GitHub

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

Merged
mambax7 merged 1 commit into from
Aug 5, 2026
Merged

chore(docs): reconcile the inventory with what git archive actually produces #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions .gitattributes
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# Path-based git attributes — XOOPS module DevOps baseline.
# xoops-overlay:profile=core27
# https://git-scm.com/docs/gitattributes

# Stored with LF line endings, like everything else here.
# Normalize line endings.
* text=auto
*.php text eol=lf

# Keep development & CI files OUT of the release archive (git archive / GitHub release ZIP).
/.github export-ignore
/.build export-ignore
/stubs export-ignore
/tests export-ignore
/testdata export-ignore
# /docs export-ignore
/docs/00 export-ignore
/docs/00/** export-ignore
/.editorconfig export-ignore
/.gitattributes export-ignore
/.gitignore export-ignore
/.php-cs-fixer.dist.php export-ignore
/.php-cs-fixer.cache export-ignore
Expand All @@ -31,6 +31,7 @@
/sonar-project.properties export-ignore
/.git-blame-ignore-revs export-ignore
/composer.lock export-ignore
/.gitattributes export-ignore
# CHANGELOG.md deliberately SHIPS, diverging from the module-devops baseline.
# It is the industry-standard location, and the About tab will read the release
# history from it once docs/changelog.txt is retired.
Expand Down
6 changes: 4 additions & 2 deletions docs/file-list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This inventory describes the standalone `modules/debugbar` release tree. The thr

| Area | Files | Purpose |
|---|---:|---|
| Module root | 7 | Manifest, entry points, README, and changelog |
| Module root | 9 | Manifest, entry points, README, changelog, licence, and the Composer manifest |

@sourcery-ai sourcery-ai Bot Aug 5, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

nitpick (typo): Consider aligning the spelling of "licence" with the actual LICENSE filename for consistency.

Here you list "licence" while the file is actually named LICENSE. Please either use "license" or reference LICENSE directly so the wording matches the filename and avoids confusion.

Suggested change
| Module root | 9 | Manifest, entry points, README, changelog, licence, and the Composer manifest |
| Module root | 9 | Manifest, entry points, README, changelog, `LICENSE`, and the Composer manifest |

| Administration | 8 | Home, Analytics, Logs, Diagnostics, navigation, and wrappers |
| PHP classes | 27 | Collection, profiling, storage, diagnostics, event/template collectors, and optional Ray bridge |
| Install and preload | 4 | Autoloading, lifecycle registration, schema/assets/key setup |
Expand All @@ -15,14 +15,16 @@ This inventory describes the standalone `modules/debugbar` release tree. The thr
| SQL | 1 | Profile table definition |
| Module asset overlay | 6 | XOOPS-specific styles and scripts reapplied during update |
| Generated browser assets | 32 | Web-readable PHP DebugBar resources plus copied overlay files |
| **Total** | **127** | Excludes the three review notes, and the development and CI files that `.gitattributes` marks `export-ignore` — `tests/`, `stubs/`, `testdata/`, `.github/`, and the tooling configs — none of which reach the release archive |
| **Total** | **129** | Excludes the three review notes, and the development and CI files that `.gitattributes` marks `export-ignore` — `tests/`, `stubs/`, `testdata/`, `.github/`, and the tooling configs — none of which reach the release archive |

## Module-owned source tree

```text
debugbar/
|-- README.md
|-- CHANGELOG.md
|-- LICENSE
|-- composer.json
|-- xoops_version.php
|-- index.php
|-- explain.php
Expand Down
Loading