@cparra/apexdocs 3.3.0-alpha.0 → 3.3.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 +3 -3
- package/dist/Apexdocs-BXshUaEK.js +3779 -0
- package/dist/cli/generate.js +71 -71
- package/dist/index.d.ts +1 -2
- package/dist/index.js +8 -134
- package/dist/logger-B2PHch8U.js +3663 -0
- package/dist/logger-BBcPrmAO.js +3668 -0
- package/package.json +2 -3
package/README.md
CHANGED
|
@@ -168,6 +168,7 @@ apexdocs openapi -s force-app -t docs -n MyNamespace --title "My Custom OpenApi
|
|
|
168
168
|
| `--targetDir` | `-t` | The directory location where the changelog file will be generated. | `./docs/` | No |
|
|
169
169
|
| `--fileName` | N/A | The name of the changelog file to be generated. | `changelog` | No |
|
|
170
170
|
| `--scope` | N/A | The list of scope to respect when generating the changelog. | ['global'] | No |
|
|
171
|
+
| `--skipIfNoChanges` | N/A | Whether to skip generating the changelog if there are no changes. | `true` | No |
|
|
171
172
|
|
|
172
173
|
#### Sample Usage
|
|
173
174
|
|
|
@@ -263,9 +264,8 @@ export default {
|
|
|
263
264
|
|
|
264
265
|
Then you only need to run the top level `apexdocs` command, and it will generate both types of documentation.
|
|
265
266
|
|
|
266
|
-
|
|
267
|
-
apexdocs
|
|
268
|
-
```
|
|
267
|
+
Note that you can still run the individual commands if you only want to generate one type of documentation by
|
|
268
|
+
providing the subcommand, e.g `apexdocs markdown` or `apexdocs changelog`.
|
|
269
269
|
|
|
270
270
|
### Excluding Tags from Appearing in the Documentation
|
|
271
271
|
|