Skip to content

Commit 63a2916

Browse files
authored
feat: Version 0.23.0 - Performance optimizations and progress reporting for large codebases (#92)
1 parent 2725303 commit 63a2916

File tree

191 files changed

+111249
-1016
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

191 files changed

+111249
-1016
lines changed

CHANGELOG.md

Lines changed: 74 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,69 @@ All notable changes to this project will be documented in this file.
99

1010
---
1111

12+
## [0.23.0] - 2026-01-07
13+
14+
### Added (0.23.0)
15+
16+
- **Import Command Performance Optimizations**: Major performance improvements for large codebases
17+
- **Pre-computed Caches**: AST parsing and file hashes are pre-computed once before parallel processing (5-15x faster)
18+
- **Function Mapping Cache**: Function names are extracted once per file and cached for reuse
19+
- **Optimized for Large Codebases**: Handles 3000+ features efficiently (6-15 minutes vs 90+ minutes previously)
20+
- **Progress Reporting**: Real-time progress bars for feature analysis, source linking, and contract extraction
21+
- **Early Save Checkpoint**: Features are saved immediately after initial analysis to prevent data loss on interruption
22+
- **Feature Validation**: Automatic validation of existing features when resuming imports
23+
- Detects orphaned features (all source files missing)
24+
- Identifies invalid features (some files missing or structure issues)
25+
- Reports validation results with actionable tips
26+
- **Re-validation Flag**: `--revalidate-features` flag to force re-analysis even if files haven't changed
27+
- Useful when analysis logic improves or confidence threshold changes
28+
- Forces full codebase analysis regardless of incremental change detection
29+
30+
### Changed (0.23.0)
31+
32+
- **Import Command Performance**: Source file linking is now 5-15x faster for large codebases
33+
- Pre-computes all AST parsing before parallel processing
34+
- Caches file hashes to avoid repeated computation
35+
- Optimized matching logic with pre-computed feature title words
36+
- **Import Command Progress**: Enhanced progress reporting with detailed status messages
37+
- Shows feature count, themes, and stories during analysis
38+
- Real-time progress bars for source file linking
39+
- Clear checkpoint messages when features are saved
40+
- **Enhanced Analysis Setup**: Added spinner progress for file discovery (`repo.rglob("*.py")`), filtering, and hash collection phases
41+
- Eliminates 30-60 second silent wait periods during file discovery
42+
- Shows real-time status: "Preparing enhanced analysis..." → "Discovering Python files..." → "Filtering X files..." → "Ready to analyze X files"
43+
- **Contract Loading**: Added progress bar for parallel YAML contract loading
44+
- Shows "Loading X existing contract(s)..." with completion count
45+
- Provides visibility during potentially slow contract file I/O operations
46+
- **Enrichment Context Operations**: Added spinner progress for hash comparison, context building, and file writing
47+
- Shows progress during hash comparison (reading existing file, building temp context)
48+
- Shows progress during context building (iterating through features and contracts)
49+
- Shows progress during markdown conversion and file writing
50+
- **Incremental Change Detection**: Improved progress feedback with completion status message
51+
- **Changed File Collection**: Added status message during file path collection
52+
53+
### Documentation (0.23.0)
54+
55+
- **Import Features Guide**: New comprehensive guide `docs/guides/import-features.md`
56+
- Progress reporting details
57+
- Feature validation explanation
58+
- Early save checkpoint benefits
59+
- Performance optimization details
60+
- Re-validation flag usage
61+
- Best practices for large codebases
62+
- Troubleshooting tips
63+
- **Command Reference**: Updated `docs/reference/commands.md` with new `--revalidate-features` flag
64+
- **Quick Examples**: Updated `docs/examples/quick-examples.md` with new import features
65+
- **README**: Updated timing information and checkpoint details
66+
67+
### Fixed (0.23.0)
68+
69+
- **Linting Errors**: Fixed unused `progress_columns` variable warnings in enrichment context functions
70+
- Prefixed unused variables with underscore (`_progress_columns`) to indicate intentional non-usage
71+
- All linting checks now pass without errors
72+
73+
---
74+
1275
## [0.22.1] - 2026-01-03
1376

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

19942057
---
19952058

1996-
## [Unreleased]
1997-
1998-
### Added
1999-
2000-
- **Structured JSON/YAML Controls**
2001-
- New global `specfact --input-format/--output-format` options propagate preferred serialization across commands
2002-
- `specfact plan init` and `specfact import from-code` now expose `--output-format` overrides for per-command control
2003-
- `PlanGenerator` and `ReportGenerator` can emit JSON or YAML, and `validate_plan_bundle` / `FSMValidator` load either automatically
2004-
- Added regression tests covering JSON plan generation and validation to protect CI workflows
2005-
2006-
### Changed
2007-
2008-
- **CLI + Docs**
2009-
- Default plan-path helpers/search now detect both `.bundle.yaml` and `.bundle.json`
2010-
- Repository/prompt docs updated to describe the new format flags and reference `.bundle.<format>` placeholders for slash-commands
2011-
- `SpecFactStructure` utilities now emit enriched/brownfield filenames preserving the original format so Copilot/CI stay in sync
2012-
2013-
---
2014-
20152059
## [0.6.9]
20162060

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

2070+
- **Structured JSON/YAML Controls**
2071+
- New global `specfact --input-format/--output-format` options propagate preferred serialization across commands
2072+
- `specfact plan init` and `specfact import from-code` now expose `--output-format` overrides for per-command control
2073+
- `PlanGenerator` and `ReportGenerator` can emit JSON or YAML, and `validate_plan_bundle` / `FSMValidator` load either automatically
2074+
- Added regression tests covering JSON plan generation and validation to protect CI workflows
2075+
20262076
- **Summary Metadata for Performance**
20272077
- Plan bundles now include summary metadata (`metadata.summary`) for fast access
20282078
- Summary includes: `features_count`, `stories_count`, `themes_count`, `releases_count`, `content_hash`, `computed_at`
@@ -2051,6 +2101,11 @@ This patch release fixes the critical design issue identified during OSS validat
20512101
- Early filtering: when `--last N` is used, only processes N+10 most recent files
20522102
- Performance improved from 6.5s to 3.6s (44% faster) for typical workloads
20532103

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

20562111
## [0.6.8] - 2025-11-20

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,11 @@ specfact init --ide cursor --install-deps
9595
specfact import from-code my-project --repo .
9696
```
9797

98-
**⏱️ 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.
98+
**⏱️ 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.
99+
100+
**💾 Checkpointing:** Features are saved immediately after initial analysis, so you can safely interrupt and resume the import process without losing progress.
101+
102+
**⚡ Performance:** Optimized for large codebases with pre-computed AST parsing and file hashes (5-15x faster than previous versions).
99103

100104
**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.
101105

_site_local/LICENSE.md

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(which shall not include Communications that are clearly marked or
39+
otherwise designated in writing by the copyright owner as "Not a Work").
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is clearly marked or otherwise designated
61+
in writing by the copyright owner as "Not a Contribution".
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright 2025 Nold AI (Owner: Dominikus Nold)
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

0 commit comments

Comments
 (0)