chore: enforce line endings, permissions, and ASCII encoding#37
Open
StrongWind1 wants to merge 6 commits intoMatrixEditor:masterfrom
Open
chore: enforce line endings, permissions, and ASCII encoding#37StrongWind1 wants to merge 6 commits intoMatrixEditor:masterfrom
StrongWind1 wants to merge 6 commits intoMatrixEditor:masterfrom
Conversation
File permissions (22 files):
- Set 644 on all source files that were incorrectly marked 755
(executable bit) across dementor/, docs/, tests/, and root configs.
- Affected: __init__.py, filters.py, paths.py, servers.py, loader.py,
protocols/{__init__,ftp,kerberos,ldap,llmnr,mdns,netbios,ntlm,
quic,smtp,spnego}.py, tui/{completer,commands/{config,env,ipconfig}}.py,
assets/Dementor.toml, docs/source/tui.rst, requirements.txt
Non-ASCII replacements in dementor/ and root files (13 files):
- Em-dash (U+2014) -> ' --' in comments and docstrings
- En-dash (U+2013) -> '-'
- Right arrow (U+2192) -> '->'
- Curly/smart quotes (U+201C/U+201D) -> straight quotes
- Section sign (U+00A7) -> 'S' for spec references
- Tab (0x09) -> spaces in mysql.py
- Fix 'donwngrade' typo (U+0175) in smtp.py
- Affected: Dementor.toml, config/{toml,util}.py, db/connector.py,
loader.py, protocols/{ftp,ntlm,smtp,ssdp}.py,
tui/{completer,commands/{config,database}}.py, pyproject.toml,
tests/test_db.py
Non-ASCII replacements in docs/ (14 .rst files):
- Em-dash (U+2014) -> '--'
- En-dash (U+2013) -> '-'
- Right single quote (U+2019) -> straight apostrophe
- Intentionally kept: section sign, arrows, gear emoji, double
vertical line, dagger, pointer arrows, greater-equal sign
(these render well in Sphinx HTML output)
Deleted:
- tests/.gitkeep (unnecessary, directory contains .py test files)
Add .gitattributes for LF line ending normalization (CRLF exception: docs/make.bat). Add pre-commit hook and CI script enforcing four invariants: 1. Line endings: LF only, no CR bytes in any text file 2. Permissions: mode 100644 on all files, no executable bit 3. Encoding: ASCII only (bytes 10, 32-126) outside docs/ and README.md 4. Python: repo-wide ruff format + ruff check via uv Enforcement layers: - .gitattributes: automatic line-ending normalization (primary for Rule 1) - .githooks/pre-commit: local pre-commit check for all 4 rules - .githooks/check-hygiene.sh: server-side hard gate via GitHub Actions - .github/workflows/hygiene.yml: triggers CI script on push and PR All three config files share synchronized lists for binary extensions, CRLF exceptions, ASCII-exempt paths, and exec allowlists. No functional changes. All checks pass.
MatrixEditor
added
Type - Enhancement
CI/CD
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
2 participants
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.
Summary
Adds enforcement infrastructure to prevent the issues fixed in #36 from recurring. Four invariants are checked automatically:
docs/make.batuses CRLF)docs/andREADME.mdruff format+ruff checkviauv run(pre-commit only)Files added
.gitattributesdocs/make.bat, binary declarations).githooks/pre-commit.githooks/check-hygiene.sh::errorannotations.github/workflows/hygiene.ymlcheck-hygiene.sh --diffon every push and PRActivation
Contributors run once per clone:
Configuration sync
Three shared lists are duplicated across
.gitattributes,.githooks/pre-commit, and.githooks/check-hygiene.shwith cross-reference comments:.gitattributesbinary declarations.gitattributeseol=crlfentries^docs/,^README\.md$Post-merge
Add
Repository Hygieneas a required status check in branch protection rules formaster.Depends on