You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add .presetignore support so preset authors can exclude development-only files from installed presets, matching the existing .extensionignore behavior.
Share ignore loading and matching between extensions and presets, preserving extension behavior.
Support Git-style patterns, comments, negation, directory patterns, root anchoring, UTF-8, and existing whitespace/backslash normalization.
Exclude .presetignore itself. Preserve existing copying behavior when absent; do not use .gitignore or introduce default exclusions.
Validate ignore files before the source-directory installer removes existing files or registration state.
Apply filtering to directory installs, archive installs, reinstalls, and update replacements.
Document supported semantics and examples.
preset update retains its documented remove-then-add behavior. The existing extension force-removal ordering remains unchanged.
Testing
Commands use this checkout’s virtual environment, following repository guidance.
Tested locally with .venv/bin/specify --help
Ran existing tests with uv sync --extra test and .venv/bin/python -m pytest tests -q
Tested with a sample project
Results:
12,673 passed and 101 skipped across the full run and targeted retries. The sandboxed run encountered 9 failures and 628 setup errors involving network access and local HTTP servers; all 637 cases passed outside the sandbox without code changes. The initial run emitted 62 warnings.
Captured 25 failing preset cases before implementation and verified they pass afterward.
Added mirrored helper tests and installer regression coverage.
Validated specify init --preset, template resolution, and preset update in a temporary Codex project.
Executed the installed speckit-specify skill; the generated specification retained the preset template marker and satisfied all 16 quality-checklist criteria.
Ruff 0.15.10 and git diff --check passed.
Validation ran on macOS with Python 3.11.15. The cross-platform CI matrix remains pending.
AI Disclosure
I did not use AI assistance for this contribution
I did use AI assistance (fill in the disclosure below)
AI disclosure: OpenAI Codex using GPT-6 in autonomous coding-agent mode authored the implementation, tests, documentation, commit messages, and this PR description. Codex also reviewed repository guidance, ran automated tests, and executed the sample-project workflow validation. This does not claim human manual testing or line-by-line review.
Share extension ignore loading and matching with presets while preserving
extension behavior. Validate preset ignore files before the directory
installer removes existing files, registry entries, or registered commands.
Cover pattern semantics, encoding failures, ignored manifests and assets,
archive reinstalls, and CLI updates. Document filtering rules and the
existing remove-then-add update limitation.
Validation: 1,520 tests pass in this checkout's virtual environment, with
three failure-path warnings. Capture 25 failing preset cases before the
implementation and verify that they pass afterward.
Assisted-by: Codex (model: GPT-6, autonomous)
Move all 16 pattern cases into the mirrored test_install_ignore suite and
run them for both extension and preset ignore files. Retain installer
lifecycle coverage and test absent files, self-exclusion, domain validation
errors, and read failures at the shared helper boundary.
Validation:
- 1,546 relevant tests pass with three existing failure-path warnings.
- Full-suite collection increases from 12,748 to 12,774; all original
pattern parameter sets remain represented.
- Ruff 0.15.10 and git diff --check pass for the follow-up.
- Initialize a temporary Codex skills project with a local preset using
.presetignore and confirm development files are excluded while a template
matched by .gitignore remains installed.
- Execute the installed speckit-specify skill in the Codex session, resolve
the preset template, and create a reading-list specification with its
preset marker retained and all 16 quality-checklist criteria satisfied.
- Run preset update with replacement ignore rules and verify the new
retained file replaces the previously retained file.
Manual workflow validation was performed by Codex on macOS with Bash
project scripts; no human testing or cross-platform CI result is claimed.
The full test suite and CI OS/Python matrix were not executed.
Assisted-by: Codex (model: GPT-6, autonomous)
Decode preset and extension ignore files with utf-8-sig so an optional BOM does not become part of the first pattern. Cover ASCII and non-ASCII first patterns with BOM and CRLF fixtures, and document BOM support.
Validation: four new regression cases failed before the fix; the relevant preset, extension, and shared-ignore suites passed with 1550 tests and 3 warnings. Ruff and git diff --check passed.
Assisted-by: Codex (model: GPT-6, autonomous)
The reason will be displayed to describe this comment to others. Learn more.
🔵 Needs a closer look
Shared installation and replacement behavior needs human sign-off while cross-platform validation remains pending.
No open issues 🎉
1 previously missed issue
In code that hasn't changed since last review
Malformed patterns can raise an unhandled ValueError
src/specify_cli/_install_ignore.py:51
Malformed patterns can bypass the normal validation message. A lone ! is rejected by supported pathspec versions with a ValueError, but this helper only translates decoding errors. preset add catches preset-domain errors, not ValueError, so this typo can produce a traceback instead of a useful validation error.
Wrap pattern-parsing failures in the supplied validation_error and add a shared contract test for malformed input. This improves error reporting without changing when validation occurs or when existing files are removed.
Translate pathspec parsing failures into the caller's domain validation error, retaining the ignore-file path and parser message. Add shared regression coverage for malformed preset and extension patterns without changing installation ordering.
Validation: all four new regression cases failed before the fix. Relevant suites passed with 1554 tests and 3 warnings in this checkout's virtual environment. Ruff and git diff --check passed.
Assisted-by: Codex (model: GPT-6, autonomous)
Decode as UTF-8 before removing one leading BOM so invalid-encoding errors report file-relative byte offsets. Cover BOM-prefixed and BOM-free invalid input for both presets and extensions.
Validation: both new BOM-prefixed cases failed before the fix. Relevant suites passed with 1603 tests and 3 warnings. Ruff and git diff --check passed.
Assisted-by: Codex (model: GPT-6, autonomous)
Clarify nested .presetignore exclusion depends on root file presence
docs/reference/presets.md:81
Optional: Qualify this exclusion with the presence of a root .presetignore. When that file is absent, the loader returns no filter and nested .presetignore files are copied, as covered by test_nested_ignore_is_not_loaded. The current sentence suggests these files are always excluded.
Document that nested .presetignore files are excluded only when a root .presetignore exists and are otherwise copied unchanged. No code changes; git diff --check passed.
Assisted-by: Codex (model: GPT-6, autonomous)
Catch regular expression errors from pathspec alongside ValueError, preserving the file-specific validation message. Add reversed-range regression coverage for preset and extension ignore files.
Validation: both new reversed-range cases failed before the fix. Relevant suites passed with 1605 tests and 3 warnings. Ruff and git diff --check passed.
Assisted-by: Codex (model: GPT-6, autonomous)
The reason will be displayed to describe this comment to others. Learn more.
🔵 Needs a closer look
Shared filtering affects destructive reinstall paths, and the reported cross-platform CI validation remains pending.
No open issues 🎉
1 previously missed issue
In code that hasn't changed since last review
Clarify glob negation to avoid re-including unintended docs files
docs/reference/presets.md:76
Optional clarification: docs/, !docs/, !docs/api.md re-includes all files under docs/, not just api.md. The parent-negation advice can therefore include development files an author intended to exclude. Show docs/* followed by !docs/api.md for keeping just that file, consistent with the extension guide's “Negation inside excluded directories” section.
Show how to retain only docs/api.md by excluding docs/*, and explain that re-including the parent directory can restore its other contents. Documentation only; git diff --check passed.
Assisted-by: Codex (model: GPT-6, autonomous)
The reason will be displayed to describe this comment to others. Learn more.
🔵 Needs a closer look
Shared installation behavior changes for both presets and extensions, while cross-platform validation remains pending.
No open issues 🎉
1 previously missed issue
In code that hasn't changed since last review
Document malformed ignore patterns and pre-removal validation
docs/reference/presets.md:103
Optional: Mention malformed patterns alongside invalid UTF-8: load_install_ignore also raises PresetValidationError for a bare !, as covered by the shared contract tests. Naming local directories and extracted archives here would also clarify that both receive pre-removal validation. Keep the separate preset update exception.
@mnriem I’ve been addressing Copilot feedback across successive review rounds. The latest comment concerns documenting the malformed-pattern validation added in an earlier round. That behavior is implemented and tested, but the documentation still mentions only invalid UTF-8. This clarification is applicable, and I’ll update it.
Document malformed patterns alongside invalid UTF-8 and identify local directories and extracted archives as using pre-removal validation. Preserve the separate preset update exception. Documentation only; git diff --check passed.
Assisted-by: Codex (model: GPT-6, autonomous)
The reason will be displayed to describe this comment to others. Learn more.
🔵 Needs a closer look
Shared filtering affects installation replacements, and cross-platform validation remains pending.
No open issues 🎉
1 previously missed issue
In code that hasn't changed since last review
Improve malformed ignore rule error diagnostics
src/specify_cli/_install_ignore.py:58
Optional: include the malformed rule's line number and normalized pattern in this error. The message currently names only the file, and a re.error position refers to the generated regular expression rather than a location in the ignore file. That makes a bad rule harder to find in a long file. Diagnose the offending line only after compilation fails, preserving the original cause without compiling valid ignore files twice.
Diagnose individual source rules only after compilation fails, retaining the original exception as the cause. Add shared coverage for line numbering, normalization, the first malformed rule, and single compilation of valid files.
Validation: eight malformed-input regression cases failed before the fix. Relevant suites passed with 1609 tests and 3 warnings. Ruff and git diff --check passed.
Assisted-by: Codex (model: GPT-6, autonomous)
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
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.
mnriem
added
the
triage-nice-to-have
Description
Add
.presetignoresupport so preset authors can exclude development-only files from installed presets, matching the existing.extensionignorebehavior..presetignoreitself. Preserve existing copying behavior when absent; do not use.gitignoreor introduce default exclusions.preset updateretains its documented remove-then-add behavior. The existing extension force-removal ordering remains unchanged.Testing
Commands use this checkout’s virtual environment, following repository guidance.
.venv/bin/specify --helpuv sync --extra testand.venv/bin/python -m pytest tests -qResults:
specify init --preset, template resolution, andpreset updatein a temporary Codex project.speckit-specifyskill; the generated specification retained the preset template marker and satisfied all 16 quality-checklist criteria.git diff --checkpassed.Validation ran on macOS with Python 3.11.15. The cross-platform CI matrix remains pending.
AI Disclosure
AI disclosure: OpenAI Codex using GPT-6 in autonomous coding-agent mode authored the implementation, tests, documentation, commit messages, and this PR description. Codex also reviewed repository guidance, ran automated tests, and executed the sample-project workflow validation. This does not claim human manual testing or line-by-line review.