Skip to content

Fix region #48

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

Open
layfield-ccdc wants to merge 4 commits into
base: main
Choose a base branch
from
+660 −203
Open

Fix region #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a3f7254
Add BOM handling for region directives and corresponding tests NO_JIRA
layfield-ccdc Oct 21, 2026
9449474
Enhance header detection and repair logic for region-wrapped headers …
layfield-ccdc Oct 22, 2026
af44d35
Fix encoding for fixed content in licence header processing NO_JIRA
layfield-ccdc Oct 22, 2026
df34fb1
Enhance header processing and recovery logic for various edge cases i…
layfield-ccdc Oct 22, 2026
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
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,20 @@ When licence header validation/formatting is enabled, files are filtered using t
* Suffixes: `.designer.cs`, `.g.cs`, `.min.js`, `.lock`
* Any file containing `.generated.` in its name

### Header Detection

* The header may appear anywhere in the file's leading preamble (blank lines, comments,
region directives, and directives such as C# `using`/`#nullable`/`#pragma`, `#pragma once`
or `'use strict'`) before the first line of code.
* Matching ignores comment markers, whitespace, line wrapping and marker-only (`//` or `#`)
padding lines, and accepts any copyright year.
* Headers wrapped in regions are supported for C# (`#region`/`#endregion`) and Python
(`#region`/`# region`). Further languages can be added to `REGION_SYNTAX` in
`main/licence_headers.py`.
* In fix mode, damaged headers are repaired in place, duplicate headers are removed, and a
missing header is inserted inside a region labelled `Licence`/`License`/`Copyright`/`Header`
if one exists, otherwise at the top of the file (after any shebang or encoding line).

## Recommended settings
### To ensure the line endings are correctly converted:
1. On Windows: `git config --global core.autocrlf true`
Expand Down
Loading
Loading