@cparra/apexdocs 3.17.0-beta.7 → 3.17.1-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -33
- package/dist/{logger-H9NRKPFV.js → Apexdocs-ChhmlY0h.js} +776 -551
- package/dist/apex-reflection.worker.js +19 -18
- package/dist/cli/generate.js +99 -44
- package/dist/index.d.ts +0 -30
- package/dist/index.js +12 -12
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -89,14 +89,6 @@ Here are some live projects using ApexDocs:
|
|
|
89
89
|
* Custom tag support
|
|
90
90
|
* And much, much more!
|
|
91
91
|
|
|
92
|
-
## ⚡ Parallel reflection (performance)
|
|
93
|
-
|
|
94
|
-
ApexDocs can speed up documentation generation by running reflection work in parallel (enabled by default).
|
|
95
|
-
If you run into issues or want deterministic behavior, you can disable it with:
|
|
96
|
-
|
|
97
|
-
- `--parallelReflection false`
|
|
98
|
-
- or via config: `parallelReflection: false`
|
|
99
|
-
|
|
100
92
|
## 💿 Installation
|
|
101
93
|
|
|
102
94
|
```bash
|
|
@@ -166,7 +158,8 @@ apexdocs changelog --previousVersionDir force-app-previous --currentVersionDir f
|
|
|
166
158
|
| `--includeFieldSecurityMetadata` | N/A | Whether to include the compliance category and security classification for fields in the generated files. | `false` | No |
|
|
167
159
|
| `--includeInlineHelpTextMetadata` | N/A | Whether to include the inline help text for fields in the generated files. | `false` | No |
|
|
168
160
|
| `--parallelReflection` | N/A | Parallelize CPU-heavy reflection via worker threads. | `true` | No |
|
|
169
|
-
| `--parallelReflectionMaxWorkers` | N/A | Maximum number of worker threads to use for parallel reflection. Defaults to a reasonable value based on CPU count.
|
|
161
|
+
| `--parallelReflectionMaxWorkers` | N/A | Maximum number of worker threads to use for parallel reflection. Defaults to a reasonable value based on CPU count. | N/A | No |
|
|
162
|
+
| `--debug` | N/A | Enable debug logging. Prints file-by-file parsing progress and success/failure. | `false` | No |
|
|
170
163
|
|
|
171
164
|
> **Note:** The `*` in the Required column indicates that **one** of the source directory options must be specified:
|
|
172
165
|
> - `--sourceDir` (single directory or array of directories)
|
|
@@ -214,16 +207,17 @@ apexdocs markdown -s force-app -t docs -p global public namespaceaccessible -n M
|
|
|
214
207
|
|
|
215
208
|
#### Flags
|
|
216
209
|
|
|
217
|
-
| Flag
|
|
218
|
-
|
|
219
|
-
| `--sourceDir`
|
|
220
|
-
| `--targetDir`
|
|
221
|
-
| `--fileName`
|
|
222
|
-
| `--namespace`
|
|
223
|
-
| `--title`
|
|
224
|
-
| `--apiVersion`
|
|
225
|
-
| `--parallelReflection`
|
|
226
|
-
| `--parallelReflectionMaxWorkers` | N/A
|
|
210
|
+
| Flag | Alias | Description | Default | Required |
|
|
211
|
+
|----------------------------------|-------|--------------------------------------------------------------------------------------------------|-----------------|----------|
|
|
212
|
+
| `--sourceDir` | `-s` | The directory where the source files are located. | N/A | Yes |
|
|
213
|
+
| `--targetDir` | `-t` | The directory where the generated files will be placed. | `docs` | No |
|
|
214
|
+
| `--fileName` | N/A | The name of the OpenApi file. | `openapi.json` | No |
|
|
215
|
+
| `--namespace` | N/A | The package namespace, if any. This will be added to the API file Server Url. | N/A | No |
|
|
216
|
+
| `--title` | N/A | The title of the OpenApi file. | `Apex REST API` | No |
|
|
217
|
+
| `--apiVersion` | N/A | The version of the API. | `1.0.0` | No |
|
|
218
|
+
| `--parallelReflection` | N/A | Parallelize CPU-heavy reflection via worker threads. | `true` | No |
|
|
219
|
+
| `--parallelReflectionMaxWorkers` | N/A | Maximum number of worker threads to use for parallel reflection. Defaults to a reasonable value. | N/A | No |
|
|
220
|
+
| `--debug` | N/A | Enable debug logging. Prints file-by-file parsing progress and success/failure. | `false` | No |
|
|
227
221
|
|
|
228
222
|
#### Sample Usage
|
|
229
223
|
|
|
@@ -237,17 +231,18 @@ apexdocs openapi -s force-app -t docs -n MyNamespace --title "My Custom OpenApi
|
|
|
237
231
|
|
|
238
232
|
#### Flags
|
|
239
233
|
|
|
240
|
-
| Flag
|
|
241
|
-
|
|
242
|
-
| `--previousVersionDir`
|
|
243
|
-
| `--currentVersionDir`
|
|
244
|
-
| `--targetDir`
|
|
245
|
-
| `--fileName`
|
|
246
|
-
| `--scope`
|
|
247
|
-
| `--customObjectVisibility`
|
|
248
|
-
| `--skipIfNoChanges`
|
|
249
|
-
| `--parallelReflection`
|
|
250
|
-
| `--parallelReflectionMaxWorkers` | N/A
|
|
234
|
+
| Flag | Alias | Description | Default | Required |
|
|
235
|
+
|----------------------------------|-------|--------------------------------------------------------------------------------------------------|-------------|----------|
|
|
236
|
+
| `--previousVersionDir` | `-p` | The directory location of the previous version of the source code. | N/A | Yes |
|
|
237
|
+
| `--currentVersionDir` | `-t` | The directory location of the current version of the source code. | N/A | Yes |
|
|
238
|
+
| `--targetDir` | `-t` | The directory location where the changelog file will be generated. | `./docs/` | No |
|
|
239
|
+
| `--fileName` | N/A | The name of the changelog file to be generated. | `changelog` | No |
|
|
240
|
+
| `--scope` | N/A | The list of scope to respect when generating the changelog. | ['global'] | No |
|
|
241
|
+
| `--customObjectVisibility` | `-v` | Controls which custom objects are documented. Values should be separated by a space. | ['public'] | No |
|
|
242
|
+
| `--skipIfNoChanges` | N/A | Whether to skip generating the changelog if there are no changes. | `true` | No |
|
|
243
|
+
| `--parallelReflection` | N/A | Parallelize CPU-heavy reflection via worker threads. | `true` | No |
|
|
244
|
+
| `--parallelReflectionMaxWorkers` | N/A | Maximum number of worker threads to use for parallel reflection. Defaults to a reasonable value. | N/A | No |
|
|
245
|
+
| `--debug` | N/A | Enable debug logging. Prints file-by-file parsing progress and success/failure. | `false` | No |
|
|
251
246
|
|
|
252
247
|
#### Sample Usage
|
|
253
248
|
|
|
@@ -591,12 +586,14 @@ public class MyClass {
|
|
|
591
586
|
|
|
592
587
|
##### **templates**
|
|
593
588
|
|
|
594
|
-
Allows providing custom templates for generating Markdown documentation, giving you control over the output format.
|
|
589
|
+
Allows providing custom templates for generating Markdown documentation, giving you control over the output format.
|
|
595
590
|
You can define templates for each type of metadata
|
|
596
591
|
supported by the `markdown` command (class, interface, enum, trigger, LWC, custom object, and reference guide) .
|
|
597
592
|
|
|
598
|
-
For detailed information about creating custom templates, including examples, available helpers, and configuration
|
|
599
|
-
|
|
593
|
+
For detailed information about creating custom templates, including examples, available helpers, and configuration
|
|
594
|
+
options,
|
|
595
|
+
please refer to the [wiki documentation](https://github.com/cesarParra/apexdocs/wiki/5.-Custom-Templates). You can also
|
|
596
|
+
find a working example in the
|
|
600
597
|
`examples/markdown-custom-templates` directory.
|
|
601
598
|
|
|
602
599
|
#### Changelog Hooks
|