feat: add custom specification directory support with --spec-dir option #1082
Conversation
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
Adds ability to specify custom spec directory via --spec-dir parameter in specify init command. Updates CLI help documentation, refactors bash and PowerShell scripts to support custom directories via SPECIFY_SPEC_DIR environment variable, updates templates to use {SPEC_DIR} placeholder instead of hardcoded "specs", and adds validation for custom directory paths. Maintains backward compatibility by defaulting to "specs" directory.
Introduce pytest-based testing framework with dependencies and comprehensive validation suite for the new --spec-dir capability: - Add pytest and pytest-cov to project dependencies in pyproject.toml - Create test fixtures and configuration in conftest.py for consistent test setup - Implement 1100+ lines of test coverage across 5 specialized test modules - Cover edge cases including path traversal prevention, character validation, and unicode handling - Test both CLI integration and unit-level function validation - Verify file reference updates and directory renaming behavior The test infrastructure ensures reliability of the spec directory customization feature through thorough validation of input constraints, error handling, and functional correctness across multiple scenarios.
…ges and edge case handling Enhance the spec directory validation system to provide better user experience and handle edge cases more robustly: - Improved validation with detailed error messages and helpful tips - Added support for Unicode characters in directory names - Enhanced parent traversal and absolute path detection - Added reserved Windows system name validation - Better control character and invalid character detection - More precise regex patterns in update_spec_directory_references function - Consolidated test coverage in test_validate_spec_dir.py with comprehensive scenarios - Removed redundant test file test_spec_dir_validation.py - Minor improvements to helper function sourcing in bash/powershell scripts These changes make validation more comprehensive while maintaining backward compatibility and providing clearer feedback to users when validation fails.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
--spec-diroption tospecify initcommand for custom specification directoriesspecs/directoryDescription
This feature introduces significant flexibility to Spec Kit by allowing users to specify custom directory paths for their specifications instead of being limited to the default
specs/directory.Key Features
--spec-dir documentation,--spec-dir requirements, or any valid relative pathspecs/references with custom directory namesSPECIFY_SPEC_DIRenvironment variableImplementation Details
validate_spec_dir()function andinitcommand insrc/specify_cli/__init__.py{SPEC_DIR}placeholder support in template filesUsage Examples
Test Plan
--helpcommandinitcommand testing with various spec directory scenarioscheckcommand functionality verificationTest Coverage
Impact
specs/directoryFiles Changed
src/specify_cli/__init__.py(+262 lines){SPEC_DIR}placeholderThis enhancement represents a significant improvement to Spec Kit's flexibility while maintaining the robust specification-driven development workflow and ensuring excellent user experience through comprehensive validation and error handling.