@cparra/apexdocs 3.15.0-beta.2 → 3.15.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 +22 -18
- package/dist/cli/generate.js +6 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1 -1
- package/dist/{logger-CIddBRH5.js → logger-Cqxjp5OT.js} +6 -2
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -138,24 +138,25 @@ apexdocs changelog --previousVersionDir force-app-previous --currentVersionDir f
|
|
|
138
138
|
|
|
139
139
|
#### Flags
|
|
140
140
|
|
|
141
|
-
| Flag | Alias | Description | Default
|
|
142
|
-
|
|
143
|
-
| `--sourceDir` | `-s` | The directory or directories where the source files are located. | N/A
|
|
144
|
-
| `--useSfdxProjectJson` | N/A | Read source directories from `sfdx-project.json` packageDirectories. Cannot be used with `--sourceDir`. | `false`
|
|
145
|
-
| `--sfdxProjectPath` | N/A | Path to directory containing `sfdx-project.json` (defaults to current directory). Only used with `--useSfdxProjectJson`. | `process.cwd()`
|
|
146
|
-
| `--targetDir` | `-t` | The directory where the generated files will be placed. | `docs`
|
|
147
|
-
| `--scope` | `-p` | A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. | `[global]`
|
|
148
|
-
| `--customObjectVisibility` | `-v` | Controls which custom objects are documented. Values should be separated by a space. | `[public]`
|
|
149
|
-
| `--defaultGroupName` | N/A | The default group name to use when a group is not specified. | `Miscellaneous`
|
|
150
|
-
| `--namespace` | N/A | The package namespace, if any. If provided, it will be added to the generated files. | N/A
|
|
151
|
-
| `--sortAlphabetically` | N/A | Sorts files appearing in the Reference Guide alphabetically, as well as the members of a class, interface or enum alphabetically. If false, the members will be displayed in the same order as the code. | `false`
|
|
152
|
-
| `--includeMetadata ` | N/A | Whether to include the file's meta.xml information: Whether it is active and the API version | `false`
|
|
153
|
-
| `--linkingStrategy` | N/A | The strategy to use when linking to other classes. Possible values are `relative`, `no-link`, and `none` | `relative`
|
|
154
|
-
| `--customObjectsGroupName` | N/A | The name under which custom objects will be grouped in the Reference Guide | `Custom Objects`
|
|
155
|
-
| `--triggersGroupName` | N/A | The name under which triggers will be grouped in the Reference Guide | `Triggers`
|
|
156
|
-
| `--
|
|
157
|
-
| `--
|
|
158
|
-
| `--
|
|
141
|
+
| Flag | Alias | Description | Default | Required |
|
|
142
|
+
|-----------------------------------|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|----------|
|
|
143
|
+
| `--sourceDir` | `-s` | The directory or directories where the source files are located. | N/A | * |
|
|
144
|
+
| `--useSfdxProjectJson` | N/A | Read source directories from `sfdx-project.json` packageDirectories. Cannot be used with `--sourceDir`. | `false` | * |
|
|
145
|
+
| `--sfdxProjectPath` | N/A | Path to directory containing `sfdx-project.json` (defaults to current directory). Only used with `--useSfdxProjectJson`. | `process.cwd()` | No |
|
|
146
|
+
| `--targetDir` | `-t` | The directory where the generated files will be placed. | `docs` | No |
|
|
147
|
+
| `--scope` | `-p` | A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. | `[global]` | No |
|
|
148
|
+
| `--customObjectVisibility` | `-v` | Controls which custom objects are documented. Values should be separated by a space. | `[public]` | No |
|
|
149
|
+
| `--defaultGroupName` | N/A | The default group name to use when a group is not specified. | `Miscellaneous` | No |
|
|
150
|
+
| `--namespace` | N/A | The package namespace, if any. If provided, it will be added to the generated files. | N/A | No |
|
|
151
|
+
| `--sortAlphabetically` | N/A | Sorts files appearing in the Reference Guide alphabetically, as well as the members of a class, interface or enum alphabetically. If false, the members will be displayed in the same order as the code. | `false` | No |
|
|
152
|
+
| `--includeMetadata ` | N/A | Whether to include the file's meta.xml information: Whether it is active and the API version | `false` | No |
|
|
153
|
+
| `--linkingStrategy` | N/A | The strategy to use when linking to other classes. Possible values are `relative`, `no-link`, and `none` | `relative` | No |
|
|
154
|
+
| `--customObjectsGroupName` | N/A | The name under which custom objects will be grouped in the Reference Guide | `Custom Objects` | No |
|
|
155
|
+
| `--triggersGroupName` | N/A | The name under which triggers will be grouped in the Reference Guide | `Triggers` | No |
|
|
156
|
+
| `--experimentalLwcSupport` | N/A | Whether to document LWC files or not. | `false` | No |
|
|
157
|
+
| `--lwcGroupName` | N/A | The name under which Lightning Web Components will be grouped in the Reference Guide | `Lightning Web Components` | No |
|
|
158
|
+
| `--includeFieldSecurityMetadata` | N/A | Whether to include the compliance category and security classification for fields in the generated files. | `false` | No |
|
|
159
|
+
| `--includeInlineHelpTextMetadata` | N/A | Whether to include the inline help text for fields in the generated files. | `false` | No |
|
|
159
160
|
|
|
160
161
|
> **Note:** The `*` in the Required column indicates that **one** of the source directory options must be specified:
|
|
161
162
|
> - `--sourceDir` (single directory or array of directories)
|
|
@@ -339,6 +340,9 @@ providing the subcommand, e.g `apexdocs markdown` or `apexdocs changelog`.
|
|
|
339
340
|
|
|
340
341
|
### LWC Documentation Limitations
|
|
341
342
|
|
|
343
|
+
⚠️ LWC documentation is only enabled when providing the `--experimentalLwcSupport` flag or setting the
|
|
344
|
+
`experimentalLwcSupport` property to `true` in the configuration file.
|
|
345
|
+
|
|
342
346
|
ApexDocs supports generating documentation for Lightning Web Components (LWC) as well, but please
|
|
343
347
|
be aware of the following limitations:
|
|
344
348
|
|
package/dist/cli/generate.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
'use strict';
|
|
3
3
|
|
|
4
|
-
var logger$1 = require('../logger-
|
|
4
|
+
var logger$1 = require('../logger-Cqxjp5OT.js');
|
|
5
5
|
var cosmiconfig = require('cosmiconfig');
|
|
6
6
|
var yargs = require('yargs');
|
|
7
7
|
var E = require('fp-ts/Either');
|
|
@@ -146,6 +146,11 @@ const markdownOptions = {
|
|
|
146
146
|
includeInlineHelpTextMetadata: {
|
|
147
147
|
type: "boolean",
|
|
148
148
|
describe: "Whether to include the inline help text for fields in the generated files."
|
|
149
|
+
},
|
|
150
|
+
experimentalLwcSupport: {
|
|
151
|
+
type: "boolean",
|
|
152
|
+
describe: "Enable experimental support for documenting Lightning Web Components (LWC).",
|
|
153
|
+
default: logger$1.markdownDefaults.experimentalLwcSupport
|
|
149
154
|
}
|
|
150
155
|
};
|
|
151
156
|
|
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
|
@@ -1822,7 +1822,8 @@ const markdownDefaults = __spreadProps$j(__spreadValues$k({}, markdownAndChangel
|
|
|
1822
1822
|
referenceGuideTitle: "Reference Guide",
|
|
1823
1823
|
excludeTags: [],
|
|
1824
1824
|
includeFieldSecurityMetadata: false,
|
|
1825
|
-
includeInlineHelpTextMetadata: false
|
|
1825
|
+
includeInlineHelpTextMetadata: false,
|
|
1826
|
+
experimentalLwcSupport: false
|
|
1826
1827
|
});
|
|
1827
1828
|
const openApiDefaults = __spreadProps$j(__spreadValues$k({}, commonDefaults), {
|
|
1828
1829
|
fileName: "openapi",
|
|
@@ -3110,9 +3111,12 @@ function generateDocs(unparsedBundles, config) {
|
|
|
3110
3111
|
);
|
|
3111
3112
|
}),
|
|
3112
3113
|
TE__namespace.chain((parsedFiles) => {
|
|
3114
|
+
if (!config.experimentalLwcSupport) {
|
|
3115
|
+
return TE__namespace.right(parsedFiles);
|
|
3116
|
+
}
|
|
3113
3117
|
return _function.pipe(
|
|
3114
3118
|
reflectLwcSource(filterLwcFiles(unparsedBundles)),
|
|
3115
|
-
TE__namespace.map((parsedFiles2) => parsedFiles2),
|
|
3119
|
+
TE__namespace.map((parsedFiles2) => parsedFiles2.filter((file) => file.type.isExposed)),
|
|
3116
3120
|
TE__namespace.map((parsedLwcFiles) => [...parsedFiles, ...parsedLwcFiles])
|
|
3117
3121
|
);
|
|
3118
3122
|
}),
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cparra/apexdocs",
|
|
3
|
-
"version": "3.15.0
|
|
3
|
+
"version": "3.15.0",
|
|
4
4
|
"description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"apex",
|
|
@@ -92,7 +92,7 @@
|
|
|
92
92
|
]
|
|
93
93
|
},
|
|
94
94
|
"dependencies": {
|
|
95
|
-
"@cparra/apex-reflection": "2.
|
|
95
|
+
"@cparra/apex-reflection": "2.21.1",
|
|
96
96
|
"@salesforce/source-deploy-retrieve": "^12.20.1",
|
|
97
97
|
"@types/js-yaml": "^4.0.9",
|
|
98
98
|
"@types/yargs": "^17.0.32",
|