@cparra/apexdocs 3.7.2-alpha.0 → 3.7.2
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 +33 -0
- package/dist/cli/generate.js +1 -1
- package/dist/index.js +1 -1
- package/dist/{logger-DC5HNMQO.js → logger-Y4IyA77j.js} +8 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -463,6 +463,39 @@ Allows changing the frontmatter and content of the changelog page.
|
|
|
463
463
|
type TransformChangeLogPage = (
|
|
464
464
|
changelog: ChangeLogPageData,
|
|
465
465
|
) => Partial<ChangeLogPageData> | Promise<Partial<ChangeLogPageData>>
|
|
466
|
+
|
|
467
|
+
// Supporting types
|
|
468
|
+
|
|
469
|
+
type ChangeLogPageData = {
|
|
470
|
+
source: SourceChangelog;
|
|
471
|
+
frontmatter: string | Record<string, any>;
|
|
472
|
+
content: string;
|
|
473
|
+
outputDocPath: string;
|
|
474
|
+
};
|
|
475
|
+
|
|
476
|
+
type SourceChangelog = {
|
|
477
|
+
fileChanges: FileChange[];
|
|
478
|
+
};
|
|
479
|
+
|
|
480
|
+
type FileChange = {
|
|
481
|
+
name: string;
|
|
482
|
+
fileType: 'apex' | 'customobject';
|
|
483
|
+
changeType: 'added' | 'removed' | 'changed';
|
|
484
|
+
changes?: {
|
|
485
|
+
addedMethods?: string[];
|
|
486
|
+
removedMethods?: string[];
|
|
487
|
+
addedFields?: string[];
|
|
488
|
+
removedFields?: string[];
|
|
489
|
+
addedProperties?: string[];
|
|
490
|
+
removedProperties?: string[];
|
|
491
|
+
addedCustomFields?: string[];
|
|
492
|
+
removedCustomFields?: string[];
|
|
493
|
+
addedSubtypes?: string[];
|
|
494
|
+
removedSubtypes?: string[];
|
|
495
|
+
addedEnumValues?: string[];
|
|
496
|
+
removedEnumValues?: string[];
|
|
497
|
+
};
|
|
498
|
+
};
|
|
466
499
|
```
|
|
467
500
|
|
|
468
501
|
Example
|
package/dist/cli/generate.js
CHANGED
package/dist/index.js
CHANGED
|
@@ -1942,12 +1942,19 @@ function toPickListValues(customField) {
|
|
|
1942
1942
|
const valueSetDefinition = valueSet.valueSetDefinition;
|
|
1943
1943
|
if ("value" in valueSetDefinition) {
|
|
1944
1944
|
const pickListValues = valueSetDefinition.value;
|
|
1945
|
-
|
|
1945
|
+
if (isArrayOfValues(pickListValues)) {
|
|
1946
|
+
return pickListValues.filter((each) => "fullName" in each).map((current) => current.fullName);
|
|
1947
|
+
} else {
|
|
1948
|
+
return [pickListValues.fullName];
|
|
1949
|
+
}
|
|
1946
1950
|
}
|
|
1947
1951
|
}
|
|
1948
1952
|
}
|
|
1949
1953
|
return void 0;
|
|
1950
1954
|
}
|
|
1955
|
+
function isArrayOfValues(value) {
|
|
1956
|
+
return Array.isArray(value);
|
|
1957
|
+
}
|
|
1951
1958
|
|
|
1952
1959
|
var __defProp$b = Object.defineProperty;
|
|
1953
1960
|
var __defProps$b = Object.defineProperties;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cparra/apexdocs",
|
|
3
|
-
"version": "3.7.2
|
|
3
|
+
"version": "3.7.2",
|
|
4
4
|
"description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"apex",
|
|
@@ -61,7 +61,7 @@
|
|
|
61
61
|
]
|
|
62
62
|
},
|
|
63
63
|
"dependencies": {
|
|
64
|
-
"@cparra/apex-reflection": "2.16.
|
|
64
|
+
"@cparra/apex-reflection": "2.16.1",
|
|
65
65
|
"@salesforce/source-deploy-retrieve": "^12.8.1",
|
|
66
66
|
"@types/js-yaml": "^4.0.9",
|
|
67
67
|
"@types/yargs": "^17.0.32",
|