@cparra/apexdocs 3.17.1-beta.0 → 3.17.1-beta.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.
|
@@ -3561,7 +3561,7 @@ var __async$3 = (__this, __arguments, generator) => {
|
|
|
3561
3561
|
step((generator = generator.apply(__this, __arguments)).next());
|
|
3562
3562
|
});
|
|
3563
3563
|
};
|
|
3564
|
-
function generateDocs(unparsedBundles, config) {
|
|
3564
|
+
function generateDocs(unparsedBundles, config, debugLogger) {
|
|
3565
3565
|
const translations = mergeTranslations({ markdown: config.translations });
|
|
3566
3566
|
const convertToReferences = apply(parsedFilesToReferenceGuide, config);
|
|
3567
3567
|
const convertToRenderableBundle = apply(parsedFilesToRenderableBundle, config);
|
|
@@ -3580,7 +3580,7 @@ function generateDocs(unparsedBundles, config) {
|
|
|
3580
3580
|
}
|
|
3581
3581
|
return _function.pipe(
|
|
3582
3582
|
TE__namespace.right(replaceMacros(unparsedBundles, config.macros)),
|
|
3583
|
-
TE__namespace.flatMap((unparsedBundles2) => generateForApex(filterApexSourceFiles(unparsedBundles2), config)),
|
|
3583
|
+
TE__namespace.flatMap((unparsedBundles2) => generateForApex(filterApexSourceFiles(unparsedBundles2), config, debugLogger)),
|
|
3584
3584
|
TE__namespace.chain((parsedApexFiles) => {
|
|
3585
3585
|
return _function.pipe(
|
|
3586
3586
|
reflectCustomFieldsAndObjectsAndMetadataRecords(
|
|
@@ -3643,10 +3643,9 @@ function replaceMacros(unparsedBundles, macros) {
|
|
|
3643
3643
|
});
|
|
3644
3644
|
});
|
|
3645
3645
|
}
|
|
3646
|
-
function generateForApex(apexBundles, config) {
|
|
3646
|
+
function generateForApex(apexBundles, config, debugLogger) {
|
|
3647
3647
|
const filterOutOfScope = apply(filterScope, config.scope);
|
|
3648
3648
|
const removeExcluded = apply(removeExcludedTags, config.excludeTags);
|
|
3649
|
-
const debugLogger = void 0;
|
|
3650
3649
|
return _function.pipe(
|
|
3651
3650
|
apexBundles,
|
|
3652
3651
|
(bundles) => reflectApexSourceBestEffort(
|
|
@@ -3657,13 +3656,24 @@ function generateForApex(apexBundles, config) {
|
|
|
3657
3656
|
},
|
|
3658
3657
|
debugLogger
|
|
3659
3658
|
),
|
|
3660
|
-
TE__namespace.
|
|
3661
|
-
|
|
3662
|
-
|
|
3663
|
-
|
|
3664
|
-
|
|
3665
|
-
|
|
3666
|
-
|
|
3659
|
+
TE__namespace.flatMap(({ successes, errors }) => {
|
|
3660
|
+
const filtered = _function.pipe(
|
|
3661
|
+
TE__namespace.right(successes),
|
|
3662
|
+
TE__namespace.map(filterOutOfScope),
|
|
3663
|
+
TE__namespace.map(addInheritedMembersToTypes),
|
|
3664
|
+
TE__namespace.map(addInheritanceChainToTypes),
|
|
3665
|
+
TE__namespace.map(removeExcluded)
|
|
3666
|
+
);
|
|
3667
|
+
return _function.pipe(
|
|
3668
|
+
filtered,
|
|
3669
|
+
TE__namespace.flatMap((parsed) => {
|
|
3670
|
+
if (errors.errors.length > 0) {
|
|
3671
|
+
return TE__namespace.left(errors);
|
|
3672
|
+
}
|
|
3673
|
+
return TE__namespace.right(parsed);
|
|
3674
|
+
})
|
|
3675
|
+
);
|
|
3676
|
+
})
|
|
3667
3677
|
);
|
|
3668
3678
|
}
|
|
3669
3679
|
function transformReferenceHook(config) {
|
|
@@ -3833,16 +3843,20 @@ var __spreadValues$7 = (a, b) => {
|
|
|
3833
3843
|
return a;
|
|
3834
3844
|
};
|
|
3835
3845
|
var __spreadProps$6 = (a, b) => __defProps$6(a, __getOwnPropDescs$6(b));
|
|
3836
|
-
function generate$1(bundles, config) {
|
|
3846
|
+
function generate$1(bundles, config, debugLogger) {
|
|
3837
3847
|
return _function.pipe(
|
|
3838
|
-
generateDocumentationBundle(bundles, config),
|
|
3848
|
+
generateDocumentationBundle(bundles, config, debugLogger),
|
|
3839
3849
|
TE__namespace.flatMap((files) => writeFilesToSystem$1(files, config.targetDir))
|
|
3840
3850
|
);
|
|
3841
3851
|
}
|
|
3842
|
-
function generateDocumentationBundle(bundles, config) {
|
|
3843
|
-
return generateDocs(
|
|
3844
|
-
|
|
3845
|
-
|
|
3852
|
+
function generateDocumentationBundle(bundles, config, debugLogger) {
|
|
3853
|
+
return generateDocs(
|
|
3854
|
+
bundles,
|
|
3855
|
+
__spreadProps$6(__spreadValues$7({}, config), {
|
|
3856
|
+
referenceGuideTemplate
|
|
3857
|
+
}),
|
|
3858
|
+
debugLogger
|
|
3859
|
+
);
|
|
3846
3860
|
}
|
|
3847
3861
|
function writeFilesToSystem$1(files, outputDir) {
|
|
3848
3862
|
return _function.pipe(
|
|
@@ -4823,12 +4837,15 @@ function openApi(logger, fileBodies, config) {
|
|
|
4823
4837
|
});
|
|
4824
4838
|
const debugLogger = {
|
|
4825
4839
|
onStart: (filePath) => {
|
|
4840
|
+
if (!logger.isDebugEnabled()) return;
|
|
4826
4841
|
logger.debug(`Parsing: ${filePath}`);
|
|
4827
4842
|
},
|
|
4828
4843
|
onSuccess: (filePath) => {
|
|
4844
|
+
if (!logger.isDebugEnabled()) return;
|
|
4829
4845
|
logger.logSingle(`Parsing: ${filePath} OK`, "green");
|
|
4830
4846
|
},
|
|
4831
4847
|
onFailure: (filePath, errorMessage) => {
|
|
4848
|
+
if (!logger.isDebugEnabled()) return;
|
|
4832
4849
|
logger.logSingle(`Parsing: ${filePath} FAILED`, "red");
|
|
4833
4850
|
logger.debug(`Parsing error: ${filePath} - ${errorMessage}`);
|
|
4834
4851
|
}
|
|
@@ -4842,9 +4859,7 @@ function openApi(logger, fileBodies, config) {
|
|
|
4842
4859
|
debugLogger
|
|
4843
4860
|
)();
|
|
4844
4861
|
if (E__namespace.isLeft(reflectedEither)) {
|
|
4845
|
-
|
|
4846
|
-
logger.error(errors);
|
|
4847
|
-
return;
|
|
4862
|
+
return E__namespace.left(reflectedEither.left);
|
|
4848
4863
|
}
|
|
4849
4864
|
const { successes: parsedFiles, errors: recoverableErrors } = reflectedEither.right;
|
|
4850
4865
|
if (recoverableErrors.errors.length > 0) {
|
|
@@ -4879,13 +4894,24 @@ function openApi(logger, fileBodies, config) {
|
|
|
4879
4894
|
const processor = new OpenApiDocsProcessor(logger);
|
|
4880
4895
|
Transpiler.generate(filteredTypes, processor);
|
|
4881
4896
|
const generatedFiles = processor.fileBuilder().files();
|
|
4882
|
-
yield _function.pipe(
|
|
4897
|
+
const writeResult = yield _function.pipe(
|
|
4883
4898
|
writeFiles(generatedFiles, config.targetDir, (file) => {
|
|
4884
4899
|
logger.logSingle(`${file.outputDocPath} processed.`, "green");
|
|
4885
4900
|
}),
|
|
4886
|
-
TE__namespace.
|
|
4901
|
+
TE__namespace.mapLeft((error) => new FileWritingError("An error occurred while writing files to the system.", error))
|
|
4887
4902
|
)();
|
|
4903
|
+
if (E__namespace.isLeft(writeResult)) {
|
|
4904
|
+
return E__namespace.left(writeResult.left);
|
|
4905
|
+
}
|
|
4888
4906
|
ErrorLogger.logErrors(logger, filteredTypes);
|
|
4907
|
+
if (recoverableErrors.errors.length > 0) {
|
|
4908
|
+
return E__namespace.left(
|
|
4909
|
+
new ReflectionErrors(
|
|
4910
|
+
recoverableErrors.errors.map((e) => __spreadValues$2({}, e))
|
|
4911
|
+
)
|
|
4912
|
+
);
|
|
4913
|
+
}
|
|
4914
|
+
return E__namespace.right(void 0);
|
|
4889
4915
|
});
|
|
4890
4916
|
}
|
|
4891
4917
|
function filterByScopes(logger, manifest) {
|
|
@@ -6277,6 +6303,21 @@ class Apexdocs {
|
|
|
6277
6303
|
const readFiles = apply(processFiles, new DefaultFileSystem());
|
|
6278
6304
|
function processMarkdown(config, logger) {
|
|
6279
6305
|
return __async(this, null, function* () {
|
|
6306
|
+
const debugLogger = {
|
|
6307
|
+
onStart: (filePath) => {
|
|
6308
|
+
if (!logger.isDebugEnabled()) return;
|
|
6309
|
+
logger.debug(`Parsing: ${filePath}`);
|
|
6310
|
+
},
|
|
6311
|
+
onSuccess: (filePath) => {
|
|
6312
|
+
if (!logger.isDebugEnabled()) return;
|
|
6313
|
+
logger.logSingle(`Parsing: ${filePath} OK`, "green");
|
|
6314
|
+
},
|
|
6315
|
+
onFailure: (filePath, errorMessage) => {
|
|
6316
|
+
if (!logger.isDebugEnabled()) return;
|
|
6317
|
+
logger.logSingle(`Parsing: ${filePath} FAILED`, "red");
|
|
6318
|
+
logger.debug(`Parsing error: ${filePath} - ${errorMessage}`);
|
|
6319
|
+
}
|
|
6320
|
+
};
|
|
6280
6321
|
return _function.pipe(
|
|
6281
6322
|
resolveAndValidateSourceDirectories(config),
|
|
6282
6323
|
E__namespace.mapLeft((error) => new FileReadingError(`Failed to resolve source directories: ${error.message}`, error)),
|
|
@@ -6289,7 +6330,7 @@ function processMarkdown(config, logger) {
|
|
|
6289
6330
|
)
|
|
6290
6331
|
),
|
|
6291
6332
|
TE__namespace.fromEither,
|
|
6292
|
-
TE__namespace.flatMap((fileBodies) => generate$1(fileBodies, config)),
|
|
6333
|
+
TE__namespace.flatMap((fileBodies) => generate$1(fileBodies, config, debugLogger)),
|
|
6293
6334
|
TE__namespace.map(() => "\u2714\uFE0F Documentation generated successfully!"),
|
|
6294
6335
|
// Best-effort behavior: if there were recoverable parse/reflection failures, they should be returned here
|
|
6295
6336
|
// (for presentation to the user at the end of the run), not thrown earlier.
|
package/dist/cli/generate.js
CHANGED
package/dist/index.js
CHANGED