Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
37c0252
docs: improve documentation structure with unified command chains and…
djm81 Jan 4, 2026
a80e90a
docs: add integrations overview guide (optional task 6.4)
djm81 Jan 4, 2026
5f9d832
docs: fix linting errors in integrations-overview.md
djm81 Jan 4, 2026
0f3e37a
docs: simplify README and add links to new documentation
djm81 Jan 5, 2026
8d4812e
docs: add prominent SpecFact domain links with context
djm81 Jan 5, 2026
b83d16a
docs: update Quick Start with correct IDE setup workflow
djm81 Jan 5, 2026
112b5f9
fix: correct heading level for SpecFact Domains section
djm81 Jan 5, 2026
ae038d6
Merge branch 'main' into dev
djm81 Jan 5, 2026
eb5afa7
docs: fix GitHub Pages permalinks for all documentation pages
djm81 Jan 5, 2026
61968f9
merge: merge main into dev to resolve conflicts
djm81 Jan 5, 2026
f22a011
fix: resolve Jekyll build errors for GitHub Pages
djm81 Jan 5, 2026
fc600ef
merge: merge main into dev, resolve conflict in speckit-journey.md
djm81 Jan 5, 2026
cecc75e
docs: add new pages to GitHub Pages navigation menu
djm81 Jan 5, 2026
a34921a
merge: merge main into dev (no conflicts)
djm81 Jan 5, 2026
105f1e2
docs: add new pages to GitHub Pages sidebar navigation menu
djm81 Jan 5, 2026
366b7c9
merge: merge main into dev (no conflicts)
djm81 Jan 5, 2026
397c38b
feat: add Mermaid.js support for diagram rendering on GitHub Pages
djm81 Jan 5, 2026
40fe620
merge: merge main into dev (no conflicts)
djm81 Jan 5, 2026
bfd7ce2
feat: align GitHub Pages styling with specfact.io design
djm81 Jan 5, 2026
c375ca1
fix: improve YAML and code syntax highlighting for dark theme
djm81 Jan 5, 2026
4ae4eff
feat: update to custom domain docs.specfact.io
djm81 Jan 5, 2026
b2674ec
merge: merge main into dev, resolve conflicts
djm81 Jan 5, 2026
c85628b
docs: add CNAME file for GitHub Pages custom domain
djm81 Jan 5, 2026
6f3eaa3
Merge remote-tracking branch 'origin/main' into dev
djm81 Jan 5, 2026
dcd08b9
fix: update root _config.yml for custom domain
djm81 Jan 5, 2026
f620b4a
Merge remote-tracking branch 'origin/main' into dev
djm81 Jan 5, 2026
87d14a8
fix: correct Reference navigation link in top menu
djm81 Jan 5, 2026
2725303
Merge remote-tracking branch 'origin/main' into dev
djm81 Jan 5, 2026
63a2916
feat: Version 0.23.0 - Performance optimizations and progress reporti…
djm81 Jan 7, 2026
1f88cb7
Merge remote-tracking branch 'origin/main' into dev
djm81 Jan 7, 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
93 changes: 74 additions & 19 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,69 @@ All notable changes to this project will be documented in this file.

---

## [0.23.0] - 2026-01-07

### Added (0.23.0)

- **Import Command Performance Optimizations**: Major performance improvements for large codebases
- **Pre-computed Caches**: AST parsing and file hashes are pre-computed once before parallel processing (5-15x faster)
- **Function Mapping Cache**: Function names are extracted once per file and cached for reuse
- **Optimized for Large Codebases**: Handles 3000+ features efficiently (6-15 minutes vs 90+ minutes previously)
- **Progress Reporting**: Real-time progress bars for feature analysis, source linking, and contract extraction
- **Early Save Checkpoint**: Features are saved immediately after initial analysis to prevent data loss on interruption
- **Feature Validation**: Automatic validation of existing features when resuming imports
- Detects orphaned features (all source files missing)
- Identifies invalid features (some files missing or structure issues)
- Reports validation results with actionable tips
- **Re-validation Flag**: `--revalidate-features` flag to force re-analysis even if files haven't changed
- Useful when analysis logic improves or confidence threshold changes
- Forces full codebase analysis regardless of incremental change detection

### Changed (0.23.0)

- **Import Command Performance**: Source file linking is now 5-15x faster for large codebases
- Pre-computes all AST parsing before parallel processing
- Caches file hashes to avoid repeated computation
- Optimized matching logic with pre-computed feature title words
- **Import Command Progress**: Enhanced progress reporting with detailed status messages
- Shows feature count, themes, and stories during analysis
- Real-time progress bars for source file linking
- Clear checkpoint messages when features are saved
- **Enhanced Analysis Setup**: Added spinner progress for file discovery (`repo.rglob("*.py")`), filtering, and hash collection phases
- Eliminates 30-60 second silent wait periods during file discovery
- Shows real-time status: "Preparing enhanced analysis..." → "Discovering Python files..." → "Filtering X files..." → "Ready to analyze X files"
- **Contract Loading**: Added progress bar for parallel YAML contract loading
- Shows "Loading X existing contract(s)..." with completion count
- Provides visibility during potentially slow contract file I/O operations
- **Enrichment Context Operations**: Added spinner progress for hash comparison, context building, and file writing
- Shows progress during hash comparison (reading existing file, building temp context)
- Shows progress during context building (iterating through features and contracts)
- Shows progress during markdown conversion and file writing
- **Incremental Change Detection**: Improved progress feedback with completion status message
- **Changed File Collection**: Added status message during file path collection

### Documentation (0.23.0)

- **Import Features Guide**: New comprehensive guide `docs/guides/import-features.md`
- Progress reporting details
- Feature validation explanation
- Early save checkpoint benefits
- Performance optimization details
- Re-validation flag usage
- Best practices for large codebases
- Troubleshooting tips
- **Command Reference**: Updated `docs/reference/commands.md` with new `--revalidate-features` flag
- **Quick Examples**: Updated `docs/examples/quick-examples.md` with new import features
- **README**: Updated timing information and checkpoint details

### Fixed (0.23.0)

- **Linting Errors**: Fixed unused `progress_columns` variable warnings in enrichment context functions
- Prefixed unused variables with underscore (`_progress_columns`) to indicate intentional non-usage
- All linting checks now pass without errors

---

## [0.22.1] - 2026-01-03

### Added (0.22.1)
Expand Down Expand Up @@ -1993,25 +2056,6 @@ This patch release fixes the critical design issue identified during OSS validat

---

## [Unreleased]

### Added

- **Structured JSON/YAML Controls**
- New global `specfact --input-format/--output-format` options propagate preferred serialization across commands
- `specfact plan init` and `specfact import from-code` now expose `--output-format` overrides for per-command control
- `PlanGenerator` and `ReportGenerator` can emit JSON or YAML, and `validate_plan_bundle` / `FSMValidator` load either automatically
- Added regression tests covering JSON plan generation and validation to protect CI workflows

### Changed

- **CLI + Docs**
- Default plan-path helpers/search now detect both `.bundle.yaml` and `.bundle.json`
- Repository/prompt docs updated to describe the new format flags and reference `.bundle.<format>` placeholders for slash-commands
- `SpecFactStructure` utilities now emit enriched/brownfield filenames preserving the original format so Copilot/CI stay in sync

---

## [0.6.9]

### Added (0.6.9)
Expand All @@ -2023,6 +2067,12 @@ This patch release fixes the critical design issue identified during OSS validat
- Automatic detection of schema version mismatches and missing summary metadata
- Migration path: 1.0 → 1.1 (adds summary metadata)

- **Structured JSON/YAML Controls**
- New global `specfact --input-format/--output-format` options propagate preferred serialization across commands
- `specfact plan init` and `specfact import from-code` now expose `--output-format` overrides for per-command control
- `PlanGenerator` and `ReportGenerator` can emit JSON or YAML, and `validate_plan_bundle` / `FSMValidator` load either automatically
- Added regression tests covering JSON plan generation and validation to protect CI workflows

- **Summary Metadata for Performance**
- Plan bundles now include summary metadata (`metadata.summary`) for fast access
- Summary includes: `features_count`, `stories_count`, `themes_count`, `releases_count`, `content_hash`, `computed_at`
Expand Down Expand Up @@ -2051,6 +2101,11 @@ This patch release fixes the critical design issue identified during OSS validat
- Early filtering: when `--last N` is used, only processes N+10 most recent files
- Performance improved from 6.5s to 3.6s (44% faster) for typical workloads

- **CLI + Docs**
- Default plan-path helpers/search now detect both `.bundle.yaml` and `.bundle.json`
- Repository/prompt docs updated to describe the new format flags and reference `.bundle.<format>` placeholders for slash-commands
- `SpecFactStructure` utilities now emit enriched/brownfield filenames preserving the original format so Copilot/CI stay in sync

---

## [0.6.8] - 2025-11-20
Expand Down
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,11 @@ specfact init --ide cursor --install-deps
specfact import from-code my-project --repo .
```

**⏱️ Timing:** Analysis typically takes **10-15 minutes** for typical repositories (e.g., `specfact-cli` itself with several hundred features & contracts). Smaller codebases may complete in 2-5 minutes. The analysis performs AST parsing, Semgrep pattern detection, and Specmatic integration.
**⏱️ Timing:** Analysis typically takes **10-15 minutes** for typical repositories (e.g., `specfact-cli` itself with several hundred features & contracts). Smaller codebases may complete in 2-5 minutes. Large codebases (3000+ features) may take 15-30 minutes, but progress reporting shows real-time status. The analysis performs AST parsing, Semgrep pattern detection, and Specmatic integration.

**💾 Checkpointing:** Features are saved immediately after initial analysis, so you can safely interrupt and resume the import process without losing progress.

**⚡ Performance:** Optimized for large codebases with pre-computed AST parsing and file hashes (5-15x faster than previous versions).

**That's it!** SpecFact will extract features and stories from your code, find missing tests and contracts, and generate a plan bundle you can enforce.

Expand Down
202 changes: 202 additions & 0 deletions _site_local/LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(which shall not include Communications that are clearly marked or
otherwise designated in writing by the copyright owner as "Not a Work").

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is clearly marked or otherwise designated
in writing by the copyright owner as "Not a Contribution".

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2025 Nold AI (Owner: Dominikus Nold)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Loading
Loading