Skip to content

Commit b9373af

Browse files
PSScriptBuilderPSScriptBuilder
committed
1 parent 32a90a1 commit b9373af

5 files changed

Lines changed: 50 additions & 50 deletions

File tree

‎examples/index.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2235,7 +2235,7 @@ <h2 id="overview">Overview<a class="headerlink" href="#overview" title="Permanen
22352235
<hr />
22362236
<h2 id="01-functions-only">01 - Functions Only<a class="headerlink" href="#01-functions-only" title="Permanent link">&para;</a></h2>
22372237
<p>The simplest possible build: a <code>FunctionCollector</code> scans a source folder, extracts all
2238-
function definitions, and replaces the <code>{{FunctionDefinitions}}</code> placeholder in the template.
2238+
function definitions, and replaces the <code>{{FUNCTION_DEFINITIONS}}</code> placeholder in the template.
22392239
No enums, no classes, no configuration file — just the essential build pipeline.</p>
22402240
<p><a href="https://github.com/PSScriptBuilder/PSScriptBuilder/tree/main/examples/01-functions-only"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16"><path d="M8 0c4.42 0 8 3.58 8 8a8.01 8.01 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27s-1.36.09-2 .27c-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8"/></svg></span> examples/01-functions-only</a></p>
22412241
<hr />
@@ -2269,7 +2269,7 @@ <h2 id="05-all-collectors">05 - All Collectors<a class="headerlink" href="#05-al
22692269
<hr />
22702270
<h2 id="06-hybrid-mode">06 - Hybrid Mode<a class="headerlink" href="#06-hybrid-mode" title="Permanent link">&para;</a></h2>
22712271
<p>The template uses only the <code>{{ORDERED_COMPONENTS}}</code> placeholder instead of separate
2272-
<code>{{EnumDefinitions}}</code>, <code>{{ClassDefinitions}}</code>, and <code>{{FunctionDefinitions}}</code> placeholders.
2272+
<code>{{ENUM_DEFINITIONS}}</code>, <code>{{CLASS_DEFINITIONS}}</code>, and <code>{{FUNCTION_DEFINITIONS}}</code> placeholders.
22732273
Because no cross-dependencies exist in this project, PSScriptBuilder activates <strong>Hybrid Mode</strong>:
22742274
all components are emitted as a single topologically-sorted block.</p>
22752275
<p><code>Get-PSScriptBuilderTemplateAnalysis</code> is called before the build to make the selected mode visible.</p>
@@ -2278,7 +2278,7 @@ <h2 id="06-hybrid-mode">06 - Hybrid Mode<a class="headerlink" href="#06-hybrid-m
22782278
<h2 id="07-ordered-mode">07 - Ordered Mode<a class="headerlink" href="#07-ordered-mode" title="Permanent link">&para;</a></h2>
22792279
<p>Some projects have factory functions that depend on a type which is also a base class of other
22802280
classes. In this case the topological sort must interleave classes and functions — separate
2281-
<code>{{ClassDefinitions}}</code> and <code>{{FunctionDefinitions}}</code> placeholders are no longer sufficient.
2281+
<code>{{CLASS_DEFINITIONS}}</code> and <code>{{FUNCTION_DEFINITIONS}}</code> placeholders are no longer sufficient.
22822282
PSScriptBuilder detects this automatically and requires <code>{{ORDERED_COMPONENTS}}</code>, activating
22832283
<strong>Ordered Mode</strong>.</p>
22842284
<p><code>Get-PSScriptBuilderDependencyAnalysis</code> is called before the build to show <code>HasCrossDependencies: True</code>

‎guides/collectors/index.html‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2224,32 +2224,32 @@ <h2 id="collector-types">Collector Types<a class="headerlink" href="#collector-t
22242224
<tr>
22252225
<td><code>Using</code></td>
22262226
<td><code>using</code> statements</td>
2227-
<td><code>UsingStatements</code></td>
2228-
<td><code>{{UsingStatements}}</code></td>
2227+
<td><code>USING_STATEMENTS</code></td>
2228+
<td><code>{{USING_STATEMENTS}}</code></td>
22292229
</tr>
22302230
<tr>
22312231
<td><code>Enum</code></td>
22322232
<td>Enum definitions</td>
2233-
<td><code>EnumDefinitions</code></td>
2234-
<td><code>{{EnumDefinitions}}</code></td>
2233+
<td><code>ENUM_DEFINITIONS</code></td>
2234+
<td><code>{{ENUM_DEFINITIONS}}</code></td>
22352235
</tr>
22362236
<tr>
22372237
<td><code>Class</code></td>
22382238
<td>Class definitions (with dependency tracking)</td>
2239-
<td><code>ClassDefinitions</code></td>
2240-
<td><code>{{ClassDefinitions}}</code></td>
2239+
<td><code>CLASS_DEFINITIONS</code></td>
2240+
<td><code>{{CLASS_DEFINITIONS}}</code></td>
22412241
</tr>
22422242
<tr>
22432243
<td><code>Function</code></td>
22442244
<td>Standalone function definitions</td>
2245-
<td><code>FunctionDefinitions</code></td>
2246-
<td><code>{{FunctionDefinitions}}</code></td>
2245+
<td><code>FUNCTION_DEFINITIONS</code></td>
2246+
<td><code>{{FUNCTION_DEFINITIONS}}</code></td>
22472247
</tr>
22482248
<tr>
22492249
<td><code>File</code></td>
22502250
<td>Complete file contents as-is</td>
2251-
<td><code>FileContents</code></td>
2252-
<td><code>{{FileContents}}</code></td>
2251+
<td><code>FILE_CONTENTS</code></td>
2252+
<td><code>{{FILE_CONTENTS}}</code></td>
22532253
</tr>
22542254
</tbody>
22552255
</table>
@@ -2278,7 +2278,7 @@ <h3 id="2-combining-collectors">2. Combining Collectors<a class="headerlink" hre
22782278
Reference section.</p>
22792279
<h3 id="3-custom-collection-keys">3. Custom Collection Keys<a class="headerlink" href="#3-custom-collection-keys" title="Permanent link">&para;</a></h3>
22802280
<p>By default, each collector maps to a <code>{{Token}}</code> in your template using its type's default key
2281-
(e.g. <code>{{ClassDefinitions}}</code>). Use <code>-CollectionKey</code> to assign a custom key — this is required
2281+
(e.g. <code>{{CLASS_DEFINITIONS}}</code>). Use <code>-CollectionKey</code> to assign a custom key — this is required
22822282
when you need multiple collectors of the same type for different source directories:</p>
22832283
<div class="highlight"><span class="filename">Custom keys for multiple collectors of the same type</span><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="nv">$contentCollector</span> <span class="p">=</span> <span class="nb">New-PSScriptBuilderContentCollector</span> <span class="p">|</span>
22842284
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a> <span class="nb">Add-PSScriptBuilderCollector</span> <span class="n">-Type</span> <span class="n">Class</span> <span class="n">-CollectionKey</span> <span class="s2">&quot;CORE_CLASSES&quot;</span> <span class="n">-IncludePath</span> <span class="s2">&quot;src\Core&quot;</span> <span class="p">|</span>
@@ -2316,7 +2316,7 @@ <h3 id="5-inspecting-results">5. Inspecting Results<a class="headerlink" href="#
23162316
<div class="highlight"><span class="filename">List collectors</span><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a><span class="nb">Get-PSScriptBuilderCollector</span> <span class="n">-ContentCollector</span> <span class="nv">$contentCollector</span>
23172317
</code></pre></div>
23182318
<p><strong>Get a specific collector by key:</strong></p>
2319-
<div class="highlight"><span class="filename">Get a specific collector</span><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a><span class="nv">$classCollector</span> <span class="p">=</span> <span class="nb">Get-PSScriptBuilderCollector</span> <span class="n">-ContentCollector</span> <span class="nv">$contentCollector</span> <span class="n">-CollectionKey</span> <span class="s2">&quot;ClassDefinitions&quot;</span>
2319+
<div class="highlight"><span class="filename">Get a specific collector</span><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a><span class="nv">$classCollector</span> <span class="p">=</span> <span class="nb">Get-PSScriptBuilderCollector</span> <span class="n">-ContentCollector</span> <span class="nv">$contentCollector</span> <span class="n">-CollectionKey</span> <span class="s2">&quot;CLASS_DEFINITIONS&quot;</span>
23202320
</code></pre></div>
23212321
<p><strong>Inspect the collected data:</strong></p>
23222322
<div class="highlight"><span class="filename">Inspect collected data</span><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a><span class="nv">$classes</span> <span class="p">=</span> <span class="nb">Get-PSScriptBuilderCollectorContent</span> <span class="n">-Collector</span> <span class="nv">$classCollector</span>

‎search/search_index.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎sitemap.xml‎

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -2,138 +2,138 @@
22
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
33
<url>
44
<loc>https://docs.psscriptbuilder.com/</loc>
5-
<lastmod>2026-04-01</lastmod>
5+
<lastmod>2026-04-02</lastmod>
66
</url>
77
<url>
88
<loc>https://docs.psscriptbuilder.com/examples/</loc>
9-
<lastmod>2026-04-01</lastmod>
9+
<lastmod>2026-04-02</lastmod>
1010
</url>
1111
<url>
1212
<loc>https://docs.psscriptbuilder.com/troubleshooting/</loc>
13-
<lastmod>2026-04-01</lastmod>
13+
<lastmod>2026-04-02</lastmod>
1414
</url>
1515
<url>
1616
<loc>https://docs.psscriptbuilder.com/cmdlets/</loc>
17-
<lastmod>2026-04-01</lastmod>
17+
<lastmod>2026-04-02</lastmod>
1818
</url>
1919
<url>
2020
<loc>https://docs.psscriptbuilder.com/cmdlets/Add-PSScriptBuilderCollector/</loc>
21-
<lastmod>2026-04-01</lastmod>
21+
<lastmod>2026-04-02</lastmod>
2222
</url>
2323
<url>
2424
<loc>https://docs.psscriptbuilder.com/cmdlets/Format-PSScriptBuilderBuildResult/</loc>
25-
<lastmod>2026-04-01</lastmod>
25+
<lastmod>2026-04-02</lastmod>
2626
</url>
2727
<url>
2828
<loc>https://docs.psscriptbuilder.com/cmdlets/Format-PSScriptBuilderBumpResult/</loc>
29-
<lastmod>2026-04-01</lastmod>
29+
<lastmod>2026-04-02</lastmod>
3030
</url>
3131
<url>
3232
<loc>https://docs.psscriptbuilder.com/cmdlets/Format-PSScriptBuilderReleaseDataResult/</loc>
33-
<lastmod>2026-04-01</lastmod>
33+
<lastmod>2026-04-02</lastmod>
3434
</url>
3535
<url>
3636
<loc>https://docs.psscriptbuilder.com/cmdlets/Get-PSScriptBuilderBumpConfiguration/</loc>
37-
<lastmod>2026-04-01</lastmod>
37+
<lastmod>2026-04-02</lastmod>
3838
</url>
3939
<url>
4040
<loc>https://docs.psscriptbuilder.com/cmdlets/Get-PSScriptBuilderCollector/</loc>
41-
<lastmod>2026-04-01</lastmod>
41+
<lastmod>2026-04-02</lastmod>
4242
</url>
4343
<url>
4444
<loc>https://docs.psscriptbuilder.com/cmdlets/Get-PSScriptBuilderCollectorContent/</loc>
45-
<lastmod>2026-04-01</lastmod>
45+
<lastmod>2026-04-02</lastmod>
4646
</url>
4747
<url>
4848
<loc>https://docs.psscriptbuilder.com/cmdlets/Get-PSScriptBuilderConfiguration/</loc>
49-
<lastmod>2026-04-01</lastmod>
49+
<lastmod>2026-04-02</lastmod>
5050
</url>
5151
<url>
5252
<loc>https://docs.psscriptbuilder.com/cmdlets/Get-PSScriptBuilderDependencyAnalysis/</loc>
53-
<lastmod>2026-04-01</lastmod>
53+
<lastmod>2026-04-02</lastmod>
5454
</url>
5555
<url>
5656
<loc>https://docs.psscriptbuilder.com/cmdlets/Get-PSScriptBuilderReleaseData/</loc>
57-
<lastmod>2026-04-01</lastmod>
57+
<lastmod>2026-04-02</lastmod>
5858
</url>
5959
<url>
6060
<loc>https://docs.psscriptbuilder.com/cmdlets/Get-PSScriptBuilderReleaseDataTokens/</loc>
61-
<lastmod>2026-04-01</lastmod>
61+
<lastmod>2026-04-02</lastmod>
6262
</url>
6363
<url>
6464
<loc>https://docs.psscriptbuilder.com/cmdlets/Get-PSScriptBuilderTemplateAnalysis/</loc>
65-
<lastmod>2026-04-01</lastmod>
65+
<lastmod>2026-04-02</lastmod>
6666
</url>
6767
<url>
6868
<loc>https://docs.psscriptbuilder.com/cmdlets/Invoke-PSScriptBuilderBuild/</loc>
69-
<lastmod>2026-04-01</lastmod>
69+
<lastmod>2026-04-02</lastmod>
7070
</url>
7171
<url>
7272
<loc>https://docs.psscriptbuilder.com/cmdlets/New-PSScriptBuilderCollector/</loc>
73-
<lastmod>2026-04-01</lastmod>
73+
<lastmod>2026-04-02</lastmod>
7474
</url>
7575
<url>
7676
<loc>https://docs.psscriptbuilder.com/cmdlets/New-PSScriptBuilderConfiguration/</loc>
77-
<lastmod>2026-04-01</lastmod>
77+
<lastmod>2026-04-02</lastmod>
7878
</url>
7979
<url>
8080
<loc>https://docs.psscriptbuilder.com/cmdlets/New-PSScriptBuilderContentCollector/</loc>
81-
<lastmod>2026-04-01</lastmod>
81+
<lastmod>2026-04-02</lastmod>
8282
</url>
8383
<url>
8484
<loc>https://docs.psscriptbuilder.com/cmdlets/New-PSScriptBuilderReleaseData/</loc>
85-
<lastmod>2026-04-01</lastmod>
85+
<lastmod>2026-04-02</lastmod>
8686
</url>
8787
<url>
8888
<loc>https://docs.psscriptbuilder.com/cmdlets/Remove-PSScriptBuilderCollector/</loc>
89-
<lastmod>2026-04-01</lastmod>
89+
<lastmod>2026-04-02</lastmod>
9090
</url>
9191
<url>
9292
<loc>https://docs.psscriptbuilder.com/cmdlets/Set-PSScriptBuilderProjectRoot/</loc>
93-
<lastmod>2026-04-01</lastmod>
93+
<lastmod>2026-04-02</lastmod>
9494
</url>
9595
<url>
9696
<loc>https://docs.psscriptbuilder.com/cmdlets/Test-PSScriptBuilderBumpConfiguration/</loc>
97-
<lastmod>2026-04-01</lastmod>
97+
<lastmod>2026-04-02</lastmod>
9898
</url>
9999
<url>
100100
<loc>https://docs.psscriptbuilder.com/cmdlets/Test-PSScriptBuilderReleaseData/</loc>
101-
<lastmod>2026-04-01</lastmod>
101+
<lastmod>2026-04-02</lastmod>
102102
</url>
103103
<url>
104104
<loc>https://docs.psscriptbuilder.com/cmdlets/Test-PSScriptBuilderTemplate/</loc>
105-
<lastmod>2026-04-01</lastmod>
105+
<lastmod>2026-04-02</lastmod>
106106
</url>
107107
<url>
108108
<loc>https://docs.psscriptbuilder.com/cmdlets/Update-PSScriptBuilderBumpFiles/</loc>
109-
<lastmod>2026-04-01</lastmod>
109+
<lastmod>2026-04-02</lastmod>
110110
</url>
111111
<url>
112112
<loc>https://docs.psscriptbuilder.com/cmdlets/Update-PSScriptBuilderReleaseData/</loc>
113-
<lastmod>2026-04-01</lastmod>
113+
<lastmod>2026-04-02</lastmod>
114114
</url>
115115
<url>
116116
<loc>https://docs.psscriptbuilder.com/getting-started/installation/</loc>
117-
<lastmod>2026-04-01</lastmod>
117+
<lastmod>2026-04-02</lastmod>
118118
</url>
119119
<url>
120120
<loc>https://docs.psscriptbuilder.com/getting-started/quick-start/</loc>
121-
<lastmod>2026-04-01</lastmod>
121+
<lastmod>2026-04-02</lastmod>
122122
</url>
123123
<url>
124124
<loc>https://docs.psscriptbuilder.com/guides/collectors/</loc>
125-
<lastmod>2026-04-01</lastmod>
125+
<lastmod>2026-04-02</lastmod>
126126
</url>
127127
<url>
128128
<loc>https://docs.psscriptbuilder.com/guides/dependency-analysis/</loc>
129-
<lastmod>2026-04-01</lastmod>
129+
<lastmod>2026-04-02</lastmod>
130130
</url>
131131
<url>
132132
<loc>https://docs.psscriptbuilder.com/guides/release-management/</loc>
133-
<lastmod>2026-04-01</lastmod>
133+
<lastmod>2026-04-02</lastmod>
134134
</url>
135135
<url>
136136
<loc>https://docs.psscriptbuilder.com/guides/templates/</loc>
137-
<lastmod>2026-04-01</lastmod>
137+
<lastmod>2026-04-02</lastmod>
138138
</url>
139139
</urlset>

‎sitemap.xml.gz‎

-1 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)