@cparra/apexdocs 2.18.0 → 2.19.0-alpha.2

package/README.md

@@ -25,31 +25,6 @@ There are some key differences between ApexDocs and the Java based ApexDoc tool:
   Markdown like Github Pages or Netlify, and use site generators like Jekyll or Gatsby. This gives you the freedom to
   decide how to style your site to match your needs.
 
-## Version 2.X
-
-Version shares almost* all the same functionality (and more) of 1.X , but is a rewrite from the ground up of the tool,
-so please be aware if migrating from a 1.X version.
-
-The Apex code parsing logic for the 1.X codebase was almost a one-to-one translation of the Java based ApexDoc tool to
-Javascript. With 2.X the parsing logic has been improved and extracted out of this codebase, and into its own standalone
-NPM module which is solely focused on Apex code reflection: https://www.npmjs.com/package/@cparra/apex-reflection
-
-This allows for an improved code quality of both code bases and an increased ease of introducing future improvements and
-fixing issues.
-
-### Differences between the versions
-
-When migrating from 1.X please be aware of these changes between the major versions:
-
-#### Deprecated features
-
-* The `--group` CLI parameter has been deprecated. All files are grouped by default.
-
-#### Features from 1.X not supported in 2.X
-
-* The `--configPath` CLI parameter has been temporarily deprecated. We are planning on reintroducing it but the config
-  file will use a different format.
-
 #### New features
 
 * All Apex annotations are now supported through the `--scope` CLI parameter, not just `namespaceaccessible`. This means

package/apexdocs.config.ts

@@ -0,0 +1,9 @@
+export default {
+  onBeforeFileWrite: (dir: string, fileName: string) => {
+    console.log('onBefore writing', fileName);
+    return { dir, fileName };
+  },
+  onAfterProcess: (files: { dir: string; fileName: string }[]) => {
+    console.log('onAfterProcess files', files);
+  },
+};

package/lib/application/Apexdocs.js

@@ -30,9 +30,12 @@ class Apexdocs {
         const processor = factory_1.TypeTranspilerFactory.get(settings_1.Settings.getInstance().targetGenerator);
         transpiler_1.default.generate(filteredTypes, processor);
         const generatedFiles = processor.fileBuilder().files();
-        file_writer_1.FileWriter.write(generatedFiles, (fileName) => {
-            logger_1.Logger.logSingle(`${fileName} processed.`, false, 'green', false);
+        const generatedFilePaths = [];
+        file_writer_1.FileWriter.write(generatedFiles, (file) => {
+            logger_1.Logger.logSingle(`${file.fileName} processed.`, false, 'green', false);
+            generatedFilePaths.push(file);
         });
+        settings_1.Settings.getInstance().onAfterProcess(generatedFilePaths);
         // Error logging
         error_logger_1.default.logErrors(filteredTypes);
     }

package/lib/application/Apexdocs.js.map

@@ -1 +1 @@
-{"version":3,"file":"Apexdocs.js","sourceRoot":"","sources":["../../src/application/Apexdocs.ts"],"names":[],"mappings":";;;AAAA,kEAA6D;AAC7D,wDAA2D;AAC3D,6DAA0E;AAC1E,2CAAwC;AACxC,kEAA6D;AAC7D,8CAAkD;AAClD,0CAAuC;AACvC,yDAAkD;AAClD,wDAAoD;AACpD,uDAA+C;AAG/C,gEAA4D;AAC5D,mDAA8D;AAE9D;;GAEG;AACH,MAAa,QAAQ;IACnB;;OAEG;IACH,MAAM,CAAC,QAAQ;QACb,eAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC9B,MAAM,UAAU,GAAG,iCAAc,CAAC,YAAY,CAAC,IAAI,+BAAiB,EAAE,CAAC,CAAC;QACxE,MAAM,QAAQ,GAAG,IAAA,iCAAc,EAAC,IAAI,sBAAa,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAC3F,kCAAe,CAAC,WAAW,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC1D,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QACpD,kCAAe,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QAC5D,MAAM,SAAS,GAAG,+BAAqB,CAAC,GAAG,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC,CAAC;QACpF,oBAAU,CAAC,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;QAC9C,MAAM,cAAc,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC;QACvD,wBAAU,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,QAAgB,EAAE,EAAE;YACpD,eAAM,CAAC,SAAS,CAAC,GAAG,QAAQ,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;QAEH,gBAAgB;QAChB,sBAAW,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IACvC,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,QAAkB;QAC9C,IAAI,aAAqB,CAAC;QAC1B,IAAI,kBAAkB,CAAC;QACvB,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,eAAe,KAAK,SAAS,EAAE;YAC/D,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC;YAC9F,kBAAkB,GAAG,YAAY,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,4BAC3E,mBAAQ,CAAC,WAAW,EAAE,CAAC,KACzB,EAAE,CAAC;SACJ;aAAM;YACL,qGAAqG;YACrG,kDAAkD;YAClD,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC;gBAC9D,cAAc;gBACd,YAAY;gBACZ,SAAS;gBACT,WAAW;gBACX,UAAU;gBACV,SAAS;aACV,CAAC,CAAC;YACH,kBAAkB,GAAG,YACnB,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MACxC,4DAA4D,CAAC;SAC9D;QACD,eAAM,CAAC,KAAK,EAAE,CAAC;QAEf,eAAM,CAAC,SAAS,CAAC,kBAAkB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAC5D,eAAM,CAAC,SAAS,CAAC,8BAA8B,aAAa,CAAC,MAAM,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QACtG,OAAO,aAAa,CAAC;IACvB,CAAC;;AAlDH,4BA2DC;AAPQ,8BAAqB,GAAG,CAAC,UAAsB,EAAoB,EAAE;;IAC1E,MAAM,MAAM,GAAG,IAAA,yBAAO,EAAC,UAAU,CAAC,cAAc,CAAC,CAAC;IAClD,IAAI,MAAM,CAAC,KAAK,EAAE;QAChB,eAAM,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,QAAQ,oBAAoB,MAAA,MAAM,CAAC,KAAK,0CAAE,OAAO,EAAE,CAAC,CAAC;KACjF;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}
+{"version":3,"file":"Apexdocs.js","sourceRoot":"","sources":["../../src/application/Apexdocs.ts"],"names":[],"mappings":";;;AAAA,kEAA6D;AAC7D,wDAA2D;AAC3D,6DAA0E;AAC1E,2CAAwC;AACxC,kEAA6D;AAC7D,8CAAkD;AAClD,0CAAuC;AACvC,yDAAkD;AAClD,wDAAoD;AACpD,uDAA+C;AAG/C,gEAA4D;AAC5D,mDAA8D;AAE9D;;GAEG;AACH,MAAa,QAAQ;IACnB;;OAEG;IACH,MAAM,CAAC,QAAQ;QACb,eAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC9B,MAAM,UAAU,GAAG,iCAAc,CAAC,YAAY,CAAC,IAAI,+BAAiB,EAAE,CAAC,CAAC;QACxE,MAAM,QAAQ,GAAG,IAAA,iCAAc,EAAC,IAAI,sBAAa,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAC3F,kCAAe,CAAC,WAAW,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC1D,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QACpD,kCAAe,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QAC5D,MAAM,SAAS,GAAG,+BAAqB,CAAC,GAAG,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC,CAAC;QACpF,oBAAU,CAAC,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;QAC9C,MAAM,cAAc,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC;QAEvD,MAAM,kBAAkB,GAAwC,EAAE,CAAC;QACnE,wBAAU,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,IAAuC,EAAE,EAAE;YAC3E,eAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,QAAQ,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;YACvE,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;QAEH,mBAAQ,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;QAE1D,gBAAgB;QAChB,sBAAW,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IACvC,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,QAAkB;QAC9C,IAAI,aAAqB,CAAC;QAC1B,IAAI,kBAAkB,CAAC;QACvB,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,eAAe,KAAK,SAAS,EAAE;YAC/D,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC;YAC9F,kBAAkB,GAAG,YAAY,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,4BAC3E,mBAAQ,CAAC,WAAW,EAAE,CAAC,KACzB,EAAE,CAAC;SACJ;aAAM;YACL,qGAAqG;YACrG,kDAAkD;YAClD,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC;gBAC9D,cAAc;gBACd,YAAY;gBACZ,SAAS;gBACT,WAAW;gBACX,UAAU;gBACV,SAAS;aACV,CAAC,CAAC;YACH,kBAAkB,GAAG,YACnB,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MACxC,4DAA4D,CAAC;SAC9D;QACD,eAAM,CAAC,KAAK,EAAE,CAAC;QAEf,eAAM,CAAC,SAAS,CAAC,kBAAkB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAC5D,eAAM,CAAC,SAAS,CAAC,8BAA8B,aAAa,CAAC,MAAM,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QACtG,OAAO,aAAa,CAAC;IACvB,CAAC;;AAvDH,4BAgEC;AAPQ,8BAAqB,GAAG,CAAC,UAAsB,EAAoB,EAAE;;IAC1E,MAAM,MAAM,GAAG,IAAA,yBAAO,EAAC,UAAU,CAAC,cAAc,CAAC,CAAC;IAClD,IAAI,MAAM,CAAC,KAAK,EAAE;QAChB,eAAM,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,QAAQ,oBAAoB,MAAA,MAAM,CAAC,KAAK,0CAAE,OAAO,EAAE,CAAC,CAAC;KACjF;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}

package/lib/cli/generate.js

@@ -4,110 +4,120 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const yargs = require("yargs");
 const settings_1 = require("../settings");
 const Apexdocs_1 = require("../application/Apexdocs");
-const argv = yargs.options({
-    sourceDir: {
-        type: 'string',
-        alias: 's',
-        demandOption: true,
-        describe: 'The directory location which contains your apex .cls classes.',
-    },
-    targetDir: {
-        type: 'string',
-        alias: 't',
-        default: './docs/',
-        describe: 'The directory location where documentation will be generated to.',
-    },
-    recursive: {
-        type: 'boolean',
-        alias: 'r',
-        default: true,
-        describe: 'Whether .cls classes will be searched for recursively in the directory provided.',
-    },
-    scope: {
-        type: 'array',
-        alias: 'p',
-        default: ['global'],
-        describe: 'A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. ' +
-            'Annotations are supported and should be passed lowercased and without the @ symbol, e.g. namespaceaccessible auraenabled. ' +
-            'Note that this setting is ignored if generating an OpenApi REST specification since that looks for classes annotated with @RestResource.',
-    },
-    targetGenerator: {
-        type: 'string',
-        alias: 'g',
-        default: 'jekyll',
-        choices: ['jekyll', 'docsify', 'plain-markdown', 'openapi'],
-        describe: 'Define the static file generator for which the documents will be created. ' +
-            'Currently supports jekyll, docsify, plain markdown, and OpenAPI v3.1.0.',
-    },
-    indexOnly: {
-        type: 'boolean',
-        default: false,
-        describe: 'Defines whether only the index file should be generated.',
-    },
-    defaultGroupName: {
-        type: 'string',
-        default: 'Miscellaneous',
-        describe: 'Defines the @group name to be used when a file does not specify it.',
-    },
-    sanitizeHtml: {
-        type: 'boolean',
-        default: true,
-        describe: 'When on, any special character within your ApexDocs is converted into its HTML code representation. ' +
-            'This is specially useful when generic objects are described within the docs, e.g. "List< Foo>", "Map<Foo, Bar>" ' +
-            'because otherwise the content within < and > would be treated as HTML tags and not shown in the output. ' +
-            'Content in @example blocks are never sanitized.',
-    },
-    openApiTitle: {
-        type: 'string',
-        default: 'Apex REST Api',
-        describe: 'If using "openapi" as the target generator, this allows you to specify the OpenApi title value.',
-    },
-    title: {
-        type: 'string',
-        describe: "If this allows you to specify the title of the generated documentation's home file.",
-        default: 'Classes',
-    },
-    namespace: {
-        type: 'string',
-        describe: 'The package namespace, if any. If this value is provided the namespace will be added as a prefix to all of the parsed files. ' +
-            "If generating an OpenApi definition, it will be added to the file's Server Url.",
-    },
-    openApiFileName: {
-        type: 'string',
-        describe: 'If using "openapi" as the target generator, this allows you to specify the name of the output file.',
-        default: 'openapi',
-    },
-    includeMetadata: {
-        type: 'boolean',
-        describe: "Whether to include the file's meta.xml information: Whether it is active and and the API version",
-        default: false,
-    },
-    documentationRootDir: {
-        type: 'string',
-        describe: 'Allows you to specify the root documentation directory where the files are being generated. This can be helpful when embedding the generated docs into an existing site so that the links are generated correctly.',
-    },
-}).argv;
-settings_1.Settings.build({
-    sourceDirectory: argv.sourceDir,
-    recursive: argv.recursive,
-    scope: argv.scope,
-    outputDir: argv.targetDir,
-    targetGenerator: argv.targetGenerator,
-    indexOnly: argv.indexOnly,
-    defaultGroupName: argv.defaultGroupName,
-    sanitizeHtml: argv.sanitizeHtml,
-    openApiTitle: argv.openApiTitle,
-    title: argv.title,
-    namespace: argv.namespace,
-    openApiFileName: argv.openApiFileName,
-    includeMetadata: argv.includeMetadata,
-    rootDir: argv.documentationRootDir,
+const cosmiconfig_1 = require("cosmiconfig");
+const result = (0, cosmiconfig_1.cosmiconfig)('apexdocs').search();
+result.then((config) => {
+    var _a, _b;
+    let argv = yargs.options({
+        sourceDir: {
+            type: 'string',
+            alias: 's',
+            demandOption: true,
+            describe: 'The directory location which contains your apex .cls classes.',
+        },
+        targetDir: {
+            type: 'string',
+            alias: 't',
+            default: './docs/',
+            describe: 'The directory location where documentation will be generated to.',
+        },
+        recursive: {
+            type: 'boolean',
+            alias: 'r',
+            default: true,
+            describe: 'Whether .cls classes will be searched for recursively in the directory provided.',
+        },
+        scope: {
+            type: 'array',
+            alias: 'p',
+            default: ['global'],
+            describe: 'A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. ' +
+                'Annotations are supported and should be passed lowercased and without the @ symbol, e.g. namespaceaccessible auraenabled. ' +
+                'Note that this setting is ignored if generating an OpenApi REST specification since that looks for classes annotated with @RestResource.',
+        },
+        targetGenerator: {
+            type: 'string',
+            alias: 'g',
+            default: 'jekyll',
+            choices: ['jekyll', 'docsify', 'plain-markdown', 'openapi'],
+            describe: 'Define the static file generator for which the documents will be created. ' +
+                'Currently supports jekyll, docsify, plain markdown, and OpenAPI v3.1.0.',
+        },
+        indexOnly: {
+            type: 'boolean',
+            default: false,
+            describe: 'Defines whether only the index file should be generated.',
+        },
+        defaultGroupName: {
+            type: 'string',
+            default: 'Miscellaneous',
+            describe: 'Defines the @group name to be used when a file does not specify it.',
+        },
+        sanitizeHtml: {
+            type: 'boolean',
+            default: true,
+            describe: 'When on, any special character within your ApexDocs is converted into its HTML code representation. ' +
+                'This is specially useful when generic objects are described within the docs, e.g. "List< Foo>", "Map<Foo, Bar>" ' +
+                'because otherwise the content within < and > would be treated as HTML tags and not shown in the output. ' +
+                'Content in @example blocks are never sanitized.',
+        },
+        openApiTitle: {
+            type: 'string',
+            default: 'Apex REST Api',
+            describe: 'If using "openapi" as the target generator, this allows you to specify the OpenApi title value.',
+        },
+        title: {
+            type: 'string',
+            describe: "If this allows you to specify the title of the generated documentation's home file.",
+            default: 'Classes',
+        },
+        namespace: {
+            type: 'string',
+            describe: 'The package namespace, if any. If this value is provided the namespace will be added as a prefix to all of the parsed files. ' +
+                "If generating an OpenApi definition, it will be added to the file's Server Url.",
+        },
+        openApiFileName: {
+            type: 'string',
+            describe: 'If using "openapi" as the target generator, this allows you to specify the name of the output file.',
+            default: 'openapi',
+        },
+        includeMetadata: {
+            type: 'boolean',
+            describe: "Whether to include the file's meta.xml information: Whether it is active and and the API version",
+            default: false,
+        },
+        documentationRootDir: {
+            type: 'string',
+            describe: 'Allows you to specify the root documentation directory where the files are being generated. This can be helpful when embedding the generated docs into an existing site so that the links are generated correctly.',
+        },
+    }).argv;
+    if (config) {
+        argv = Object.assign(Object.assign({}, config.config), argv);
+    }
+    settings_1.Settings.build({
+        sourceDirectory: argv.sourceDir,
+        recursive: argv.recursive,
+        scope: argv.scope,
+        outputDir: argv.targetDir,
+        targetGenerator: argv.targetGenerator,
+        indexOnly: argv.indexOnly,
+        defaultGroupName: argv.defaultGroupName,
+        sanitizeHtml: argv.sanitizeHtml,
+        openApiTitle: argv.openApiTitle,
+        title: argv.title,
+        namespace: argv.namespace,
+        openApiFileName: argv.openApiFileName,
+        includeMetadata: argv.includeMetadata,
+        rootDir: argv.documentationRootDir,
+        onAfterProcess: (_a = config === null || config === void 0 ? void 0 : config.config) === null || _a === void 0 ? void 0 : _a.onAfterProcess,
+        onBeforeFileWrite: (_b = config === null || config === void 0 ? void 0 : config.config) === null || _b === void 0 ? void 0 : _b.onBeforeFileWrite,
+    });
+    try {
+        Apexdocs_1.Apexdocs.generate();
+    }
+    catch (error) {
+        console.error(error);
+        process.exit(1);
+    }
 });
-try {
-    Apexdocs_1.Apexdocs.generate();
-}
-catch (error) {
-    console.error(error);
-    process.exit(1);
-}
 //# sourceMappingURL=generate.js.map

package/lib/cli/generate.js.map

@@ -1 +1 @@
-{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../src/cli/generate.ts"],"names":[],"mappings":";;;AACA,+BAA+B;AAE/B,0CAAuC;AACvC,sDAAmD;AAGnD,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC;IACzB,SAAS,EAAE;QACT,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,YAAY,EAAE,IAAI;QAClB,QAAQ,EAAE,+DAA+D;KAC1E;IACD,SAAS,EAAE;QACT,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,SAAS;QAClB,QAAQ,EAAE,kEAAkE;KAC7E;IACD,SAAS,EAAE;QACT,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,IAAI;QACb,QAAQ,EAAE,kFAAkF;KAC7F;IACD,KAAK,EAAE;QACL,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,CAAC,QAAQ,CAAC;QACnB,QAAQ,EACN,sHAAsH;YACtH,4HAA4H;YAC5H,0IAA0I;KAC7I;IACD,eAAe,EAAE;QACf,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,QAAQ;QACjB,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,gBAAgB,EAAE,SAAS,CAAC;QAC3D,QAAQ,EACN,4EAA4E;YAC5E,yEAAyE;KAC5E;IACD,SAAS,EAAE;QACT,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,KAAK;QACd,QAAQ,EAAE,0DAA0D;KACrE;IACD,gBAAgB,EAAE;QAChB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,eAAe;QACxB,QAAQ,EAAE,qEAAqE;KAChF;IACD,YAAY,EAAE;QACZ,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,IAAI;QACb,QAAQ,EACN,sGAAsG;YACtG,kHAAkH;YAClH,0GAA0G;YAC1G,iDAAiD;KACpD;IACD,YAAY,EAAE;QACZ,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,eAAe;QACxB,QAAQ,EAAE,iGAAiG;KAC5G;IACD,KAAK,EAAE;QACL,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,qFAAqF;QAC/F,OAAO,EAAE,SAAS;KACnB;IACD,SAAS,EAAE;QACT,IAAI,EAAE,QAAQ;QACd,QAAQ,EACN,+HAA+H;YAC/H,iFAAiF;KACpF;IACD,eAAe,EAAE;QACf,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,qGAAqG;QAC/G,OAAO,EAAE,SAAS;KACnB;IACD,eAAe,EAAE;QACf,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,kGAAkG;QAC5G,OAAO,EAAE,KAAK;KACf;IACD,oBAAoB,EAAE;QACpB,IAAI,EAAE,QAAQ;QACd,QAAQ,EACN,oNAAoN;KACvN;CACF,CAAC,CAAC,IAAI,CAAC;AAER,mBAAQ,CAAC,KAAK,CAAC;IACb,eAAe,EAAE,IAAI,CAAC,SAAS;IAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;IACzB,KAAK,EAAE,IAAI,CAAC,KAAK;IACjB,SAAS,EAAE,IAAI,CAAC,SAAS;IACzB,eAAe,EAAE,IAAI,CAAC,eAAmC;IACzD,SAAS,EAAE,IAAI,CAAC,SAAS;IACzB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;IACvC,YAAY,EAAE,IAAI,CAAC,YAAY;IAC/B,YAAY,EAAE,IAAI,CAAC,YAAY;IAC/B,KAAK,EAAE,IAAI,CAAC,KAAK;IACjB,SAAS,EAAE,IAAI,CAAC,SAAS;IACzB,eAAe,EAAE,IAAI,CAAC,eAAe;IACrC,eAAe,EAAE,IAAI,CAAC,eAAe;IACrC,OAAO,EAAE,IAAI,CAAC,oBAAoB;CACnC,CAAC,CAAC;AAEH,IAAI;IACF,mBAAQ,CAAC,QAAQ,EAAE,CAAC;CACrB;AAAC,OAAO,KAAK,EAAE;IACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;CACjB"}
+{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../src/cli/generate.ts"],"names":[],"mappings":";;;AACA,+BAA+B;AAE/B,0CAAuC;AACvC,sDAAmD;AAEnD,6CAA0C;AAE1C,MAAM,MAAM,GAAG,IAAA,yBAAW,EAAC,UAAU,CAAC,CAAC,MAAM,EAAE,CAAC;AAChD,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;;IACrB,IAAI,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC;QACvB,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,YAAY,EAAE,IAAI;YAClB,QAAQ,EAAE,+DAA+D;SAC1E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,SAAS;YAClB,QAAQ,EAAE,kEAAkE;SAC7E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,kFAAkF;SAC7F;QACD,KAAK,EAAE;YACL,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,CAAC,QAAQ,CAAC;YACnB,QAAQ,EACN,sHAAsH;gBACtH,4HAA4H;gBAC5H,0IAA0I;SAC7I;QACD,eAAe,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,QAAQ;YACjB,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,gBAAgB,EAAE,SAAS,CAAC;YAC3D,QAAQ,EACN,4EAA4E;gBAC5E,yEAAyE;SAC5E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,0DAA0D;SACrE;QACD,gBAAgB,EAAE;YAChB,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,eAAe;YACxB,QAAQ,EAAE,qEAAqE;SAChF;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,QAAQ,EACN,sGAAsG;gBACtG,kHAAkH;gBAClH,0GAA0G;gBAC1G,iDAAiD;SACpD;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,eAAe;YACxB,QAAQ,EAAE,iGAAiG;SAC5G;QACD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,qFAAqF;YAC/F,OAAO,EAAE,SAAS;SACnB;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,QAAQ,EACN,+HAA+H;gBAC/H,iFAAiF;SACpF;QACD,eAAe,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,qGAAqG;YAC/G,OAAO,EAAE,SAAS;SACnB;QACD,eAAe,EAAE;YACf,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,kGAAkG;YAC5G,OAAO,EAAE,KAAK;SACf;QACD,oBAAoB,EAAE;YACpB,IAAI,EAAE,QAAQ;YACd,QAAQ,EACN,oNAAoN;SACvN;KACF,CAAC,CAAC,IAAI,CAAC;IAER,IAAI,MAAM,EAAE;QACV,IAAI,mCAAQ,MAAM,CAAC,MAAM,GAAK,IAAI,CAAE,CAAC;KACtC;IAED,mBAAQ,CAAC,KAAK,CAAC;QACb,eAAe,EAAE,IAAI,CAAC,SAAS;QAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,eAAe,EAAE,IAAI,CAAC,eAAmC;QACzD,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;QACvC,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,OAAO,EAAE,IAAI,CAAC,oBAAoB;QAClC,cAAc,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,cAAc;QAC9C,iBAAiB,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,iBAAiB;KACrD,CAAC,CAAC;IAEH,IAAI;QACF,mBAAQ,CAAC,QAAQ,EAAE,CAAC;KACrB;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;AACH,CAAC,CAAC,CAAC"}

package/lib/service/file-writer.d.ts

@@ -1,4 +1,10 @@
 import { OutputFile } from '../model/outputFile';
 export declare class FileWriter {
-    static write(files: OutputFile[], onWriteCallback: (fileName: string) => void): void;
+    static write(files: OutputFile[], onWriteCallback: (file: TargetLocation) => void): void;
+    private static getTargetLocation;
 }
+type TargetLocation = {
+    dir: string;
+    fileName: string;
+};
+export {};

package/lib/service/file-writer.js

@@ -6,21 +6,22 @@ const path = require("path");
 const settings_1 = require("../settings");
 class FileWriter {
     static write(files, onWriteCallback) {
-        const outputDir = settings_1.Settings.getInstance().outputDir;
-        if (!fs.existsSync(outputDir)) {
-            fs.mkdirSync(outputDir);
-        }
+        const onBeforeFileWrite = (outputDir, fileName) => settings_1.Settings.getInstance().onBeforeFileWrite(outputDir, fileName);
         files.forEach((file) => {
-            const dirPath = path.join(outputDir, file.dir);
+            const { dir: dirPath, fileName } = this.getTargetLocation(file, onBeforeFileWrite);
             if (!fs.existsSync(dirPath)) {
-                fs.mkdirSync(dirPath);
+                fs.mkdirSync(dirPath, { recursive: true });
             }
-            const filePath = path.join(dirPath, `${file.fileName}${file.fileExtension()}`);
-            fs.writeFile(filePath, file.body, 'utf8', () => {
-                onWriteCallback(file.fileName);
-            });
+            const filePath = path.join(dirPath, fileName);
+            fs.writeFileSync(filePath, file.body, 'utf8');
+            onWriteCallback({ dir: dirPath, fileName });
         });
     }
+    static getTargetLocation(file, onBeforeFileWrite) {
+        const outputDir = path.join(settings_1.Settings.getInstance().outputDir, file.dir);
+        const fileName = `${file.fileName}${file.fileExtension()}`;
+        return onBeforeFileWrite(outputDir, fileName);
+    }
 }
 exports.FileWriter = FileWriter;
 //# sourceMappingURL=file-writer.js.map

package/lib/service/file-writer.js.map

@@ -1 +1 @@
-{"version":3,"file":"file-writer.js","sourceRoot":"","sources":["../../src/service/file-writer.ts"],"names":[],"mappings":";;;AAAA,yBAAyB;AACzB,6BAA6B;AAE7B,0CAAuC;AAEvC,MAAa,UAAU;IACrB,MAAM,CAAC,KAAK,CAAC,KAAmB,EAAE,eAA2C;QAC3E,MAAM,SAAS,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC;QACnD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;YAC7B,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;SACzB;QAED,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACrB,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;YAC/C,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;gBAC3B,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;aACvB;YAED,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;YAC/E,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE;gBAC7C,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACjC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAnBD,gCAmBC"}
+{"version":3,"file":"file-writer.js","sourceRoot":"","sources":["../../src/service/file-writer.ts"],"names":[],"mappings":";;;AAAA,yBAAyB;AACzB,6BAA6B;AAE7B,0CAAuC;AAEvC,MAAa,UAAU;IACrB,MAAM,CAAC,KAAK,CAAC,KAAmB,EAAE,eAA+C;QAC/E,MAAM,iBAAiB,GAAG,CAAC,SAAiB,EAAE,QAAgB,EAAE,EAAE,CAChE,mBAAQ,CAAC,WAAW,EAAE,CAAC,iBAAiB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAChE,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACrB,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;YACnF,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;gBAC3B,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;aAC5C;YAED,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YAC9C,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAC9C,eAAe,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,iBAAiB,CAAC,IAAgB,EAAE,iBAAoC;QACrF,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QACxE,MAAM,QAAQ,GAAG,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC;QAC3D,OAAO,iBAAiB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAChD,CAAC;CACF;AArBD,gCAqBC"}

package/lib/settings.d.ts

@@ -14,6 +14,14 @@ export interface SettingsConfig {
     openApiFileName: string;
     includeMetadata: boolean;
     rootDir?: string;
+    onAfterProcess?: (files: {
+        dir: string;
+        fileName: string;
+    }[]) => void;
+    onBeforeFileWrite?: (outputDir: string, fileName: string) => {
+        dir: string;
+        fileName: string;
+    };
 }
 export declare class Settings {
     config: SettingsConfig;
@@ -36,4 +44,12 @@ export declare class Settings {
     openApiFileName(): string;
     includeMetadata(): boolean;
     getRootDir(): string | undefined;
+    onAfterProcess(files: {
+        dir: string;
+        fileName: string;
+    }[]): void;
+    onBeforeFileWrite(outputDir: string, fileName: string): {
+        dir: string;
+        fileName: string;
+    };
 }

package/lib/settings.js

@@ -63,6 +63,17 @@ class Settings {
     getRootDir() {
         return this.config.rootDir;
     }
+    onAfterProcess(files) {
+        if (this.config.onAfterProcess) {
+            this.config.onAfterProcess(files);
+        }
+    }
+    onBeforeFileWrite(outputDir, fileName) {
+        if (this.config.onBeforeFileWrite) {
+            return this.config.onBeforeFileWrite(outputDir, fileName);
+        }
+        return { dir: outputDir, fileName };
+    }
 }
 exports.Settings = Settings;
 //# sourceMappingURL=settings.js.map

package/lib/settings.js.map

@@ -1 +1 @@
-{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":";;;AAmBA,MAAa,QAAQ;IAGnB,YAA2B,MAAsB;QAAtB,WAAM,GAAN,MAAM,CAAgB;IAAG,CAAC;IAE9C,MAAM,CAAC,KAAK,CAAC,MAAsB;QACxC,QAAQ,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAEM,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;SACtD;QACD,OAAO,QAAQ,CAAC,QAAQ,CAAC;IAC3B,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;IAClC,CAAC;IAEM,mBAAmB;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;IACtC,CAAC;IAEM,eAAe;;QACpB,OAAO,MAAA,IAAI,CAAC,MAAM,CAAC,YAAY,mCAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IACvD,CAAC;IAEM,QAAQ;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAEM,YAAY;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAEM,kBAAkB;QACvB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;YAC1B,OAAO,EAAE,CAAC;SACX;QACD,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC;IACrC,CAAC;IAEM,eAAe;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAEM,eAAe;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAEM,UAAU;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;IAC7B,CAAC;CACF;AA9ED,4BA8EC"}
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":";;;AAqBA,MAAa,QAAQ;IAGnB,YAA2B,MAAsB;QAAtB,WAAM,GAAN,MAAM,CAAgB;IAAG,CAAC;IAE9C,MAAM,CAAC,KAAK,CAAC,MAAsB;QACxC,QAAQ,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAEM,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;SACtD;QACD,OAAO,QAAQ,CAAC,QAAQ,CAAC;IAC3B,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;IAClC,CAAC;IAEM,mBAAmB;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;IACtC,CAAC;IAEM,eAAe;;QACpB,OAAO,MAAA,IAAI,CAAC,MAAM,CAAC,YAAY,mCAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IACvD,CAAC;IAEM,QAAQ;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAEM,YAAY;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAEM,kBAAkB;QACvB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;YAC1B,OAAO,EAAE,CAAC;SACX;QACD,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC;IACrC,CAAC;IAEM,eAAe;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAEM,eAAe;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAEM,UAAU;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;IAC7B,CAAC;IAEM,cAAc,CAAC,KAA0C;QAC9D,IAAI,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE;YAC9B,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;SACnC;IACH,CAAC;IAEM,iBAAiB,CAAC,SAAiB,EAAE,QAAgB;QAC1D,IAAI,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE;YACjC,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;SAC3D;QACD,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC;IACtC,CAAC;CACF;AA3FD,4BA2FC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "2.18.0",
+  "version": "2.19.0-alpha.2",
   "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
   "keywords": [
     "apex",
@@ -68,6 +68,7 @@
   "dependencies": {
     "@cparra/apex-reflection": "2.5.0",
     "chalk": "^4.1.2",
+    "cosmiconfig": "^9.0.0",
     "fast-xml-parser": "^4.0.1",
     "js-yaml": "^4.1.0",
     "log-update": "4.0.0",

package/src/application/Apexdocs.ts

@@ -30,10 +30,15 @@ export class Apexdocs {
     const processor = TypeTranspilerFactory.get(Settings.getInstance().targetGenerator);
     Transpiler.generate(filteredTypes, processor);
     const generatedFiles = processor.fileBuilder().files();
-    FileWriter.write(generatedFiles, (fileName: string) => {
-      Logger.logSingle(`${fileName} processed.`, false, 'green', false);
+
+    const generatedFilePaths: { dir: string; fileName: string }[] = [];
+    FileWriter.write(generatedFiles, (file: { dir: string; fileName: string }) => {
+      Logger.logSingle(`${file.fileName} processed.`, false, 'green', false);
+      generatedFilePaths.push(file);
     });
 
+    Settings.getInstance().onAfterProcess(generatedFilePaths);
+
     // Error logging
     ErrorLogger.logErrors(filteredTypes);
   }

package/src/cli/generate.ts

@@ -4,116 +4,126 @@ import * as yargs from 'yargs';
 import { Settings } from '../settings';
 import { Apexdocs } from '../application/Apexdocs';
 import { GeneratorChoices } from '../transpiler/generator-choices';
+import { cosmiconfig } from 'cosmiconfig';
 
-const argv = yargs.options({
-  sourceDir: {
-    type: 'string',
-    alias: 's',
-    demandOption: true,
-    describe: 'The directory location which contains your apex .cls classes.',
-  },
-  targetDir: {
-    type: 'string',
-    alias: 't',
-    default: './docs/',
-    describe: 'The directory location where documentation will be generated to.',
-  },
-  recursive: {
-    type: 'boolean',
-    alias: 'r',
-    default: true,
-    describe: 'Whether .cls classes will be searched for recursively in the directory provided.',
-  },
-  scope: {
-    type: 'array',
-    alias: 'p',
-    default: ['global'],
-    describe:
-      'A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. ' +
-      'Annotations are supported and should be passed lowercased and without the @ symbol, e.g. namespaceaccessible auraenabled. ' +
-      'Note that this setting is ignored if generating an OpenApi REST specification since that looks for classes annotated with @RestResource.',
-  },
-  targetGenerator: {
-    type: 'string',
-    alias: 'g',
-    default: 'jekyll',
-    choices: ['jekyll', 'docsify', 'plain-markdown', 'openapi'],
-    describe:
-      'Define the static file generator for which the documents will be created. ' +
-      'Currently supports jekyll, docsify, plain markdown, and OpenAPI v3.1.0.',
-  },
-  indexOnly: {
-    type: 'boolean',
-    default: false,
-    describe: 'Defines whether only the index file should be generated.',
-  },
-  defaultGroupName: {
-    type: 'string',
-    default: 'Miscellaneous',
-    describe: 'Defines the @group name to be used when a file does not specify it.',
-  },
-  sanitizeHtml: {
-    type: 'boolean',
-    default: true,
-    describe:
-      'When on, any special character within your ApexDocs is converted into its HTML code representation. ' +
-      'This is specially useful when generic objects are described within the docs, e.g. "List< Foo>", "Map<Foo, Bar>" ' +
-      'because otherwise the content within < and > would be treated as HTML tags and not shown in the output. ' +
-      'Content in @example blocks are never sanitized.',
-  },
-  openApiTitle: {
-    type: 'string',
-    default: 'Apex REST Api',
-    describe: 'If using "openapi" as the target generator, this allows you to specify the OpenApi title value.',
-  },
-  title: {
-    type: 'string',
-    describe: "If this allows you to specify the title of the generated documentation's home file.",
-    default: 'Classes',
-  },
-  namespace: {
-    type: 'string',
-    describe:
-      'The package namespace, if any. If this value is provided the namespace will be added as a prefix to all of the parsed files. ' +
-      "If generating an OpenApi definition, it will be added to the file's Server Url.",
-  },
-  openApiFileName: {
-    type: 'string',
-    describe: 'If using "openapi" as the target generator, this allows you to specify the name of the output file.',
-    default: 'openapi',
-  },
-  includeMetadata: {
-    type: 'boolean',
-    describe: "Whether to include the file's meta.xml information: Whether it is active and and the API version",
-    default: false,
-  },
-  documentationRootDir: {
-    type: 'string',
-    describe:
-      'Allows you to specify the root documentation directory where the files are being generated. This can be helpful when embedding the generated docs into an existing site so that the links are generated correctly.',
-  },
-}).argv;
+const result = cosmiconfig('apexdocs').search();
+result.then((config) => {
+  let argv = yargs.options({
+    sourceDir: {
+      type: 'string',
+      alias: 's',
+      demandOption: true,
+      describe: 'The directory location which contains your apex .cls classes.',
+    },
+    targetDir: {
+      type: 'string',
+      alias: 't',
+      default: './docs/',
+      describe: 'The directory location where documentation will be generated to.',
+    },
+    recursive: {
+      type: 'boolean',
+      alias: 'r',
+      default: true,
+      describe: 'Whether .cls classes will be searched for recursively in the directory provided.',
+    },
+    scope: {
+      type: 'array',
+      alias: 'p',
+      default: ['global'],
+      describe:
+        'A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. ' +
+        'Annotations are supported and should be passed lowercased and without the @ symbol, e.g. namespaceaccessible auraenabled. ' +
+        'Note that this setting is ignored if generating an OpenApi REST specification since that looks for classes annotated with @RestResource.',
+    },
+    targetGenerator: {
+      type: 'string',
+      alias: 'g',
+      default: 'jekyll',
+      choices: ['jekyll', 'docsify', 'plain-markdown', 'openapi'],
+      describe:
+        'Define the static file generator for which the documents will be created. ' +
+        'Currently supports jekyll, docsify, plain markdown, and OpenAPI v3.1.0.',
+    },
+    indexOnly: {
+      type: 'boolean',
+      default: false,
+      describe: 'Defines whether only the index file should be generated.',
+    },
+    defaultGroupName: {
+      type: 'string',
+      default: 'Miscellaneous',
+      describe: 'Defines the @group name to be used when a file does not specify it.',
+    },
+    sanitizeHtml: {
+      type: 'boolean',
+      default: true,
+      describe:
+        'When on, any special character within your ApexDocs is converted into its HTML code representation. ' +
+        'This is specially useful when generic objects are described within the docs, e.g. "List< Foo>", "Map<Foo, Bar>" ' +
+        'because otherwise the content within < and > would be treated as HTML tags and not shown in the output. ' +
+        'Content in @example blocks are never sanitized.',
+    },
+    openApiTitle: {
+      type: 'string',
+      default: 'Apex REST Api',
+      describe: 'If using "openapi" as the target generator, this allows you to specify the OpenApi title value.',
+    },
+    title: {
+      type: 'string',
+      describe: "If this allows you to specify the title of the generated documentation's home file.",
+      default: 'Classes',
+    },
+    namespace: {
+      type: 'string',
+      describe:
+        'The package namespace, if any. If this value is provided the namespace will be added as a prefix to all of the parsed files. ' +
+        "If generating an OpenApi definition, it will be added to the file's Server Url.",
+    },
+    openApiFileName: {
+      type: 'string',
+      describe: 'If using "openapi" as the target generator, this allows you to specify the name of the output file.',
+      default: 'openapi',
+    },
+    includeMetadata: {
+      type: 'boolean',
+      describe: "Whether to include the file's meta.xml information: Whether it is active and and the API version",
+      default: false,
+    },
+    documentationRootDir: {
+      type: 'string',
+      describe:
+        'Allows you to specify the root documentation directory where the files are being generated. This can be helpful when embedding the generated docs into an existing site so that the links are generated correctly.',
+    },
+  }).argv;
 
-Settings.build({
-  sourceDirectory: argv.sourceDir,
-  recursive: argv.recursive,
-  scope: argv.scope,
-  outputDir: argv.targetDir,
-  targetGenerator: argv.targetGenerator as GeneratorChoices,
-  indexOnly: argv.indexOnly,
-  defaultGroupName: argv.defaultGroupName,
-  sanitizeHtml: argv.sanitizeHtml,
-  openApiTitle: argv.openApiTitle,
-  title: argv.title,
-  namespace: argv.namespace,
-  openApiFileName: argv.openApiFileName,
-  includeMetadata: argv.includeMetadata,
-  rootDir: argv.documentationRootDir,
-});
+  if (config) {
+    argv = { ...config.config, ...argv };
+  }
+
+  Settings.build({
+    sourceDirectory: argv.sourceDir,
+    recursive: argv.recursive,
+    scope: argv.scope,
+    outputDir: argv.targetDir,
+    targetGenerator: argv.targetGenerator as GeneratorChoices,
+    indexOnly: argv.indexOnly,
+    defaultGroupName: argv.defaultGroupName,
+    sanitizeHtml: argv.sanitizeHtml,
+    openApiTitle: argv.openApiTitle,
+    title: argv.title,
+    namespace: argv.namespace,
+    openApiFileName: argv.openApiFileName,
+    includeMetadata: argv.includeMetadata,
+    rootDir: argv.documentationRootDir,
+    onAfterProcess: config?.config?.onAfterProcess,
+    onBeforeFileWrite: config?.config?.onBeforeFileWrite,
+  });
 
-try {
-  Apexdocs.generate();
-} catch (error) {
-  console.error(error);
-  process.exit(1);
-}
+  try {
+    Apexdocs.generate();
+  } catch (error) {
+    console.error(error);
+    process.exit(1);
+  }
+});

package/src/service/file-writer.ts

@@ -4,22 +4,31 @@ import { OutputFile } from '../model/outputFile';
 import { Settings } from '../settings';
 
 export class FileWriter {
-  static write(files: OutputFile[], onWriteCallback: (fileName: string) => void) {
-    const outputDir = Settings.getInstance().outputDir;
-    if (!fs.existsSync(outputDir)) {
-      fs.mkdirSync(outputDir);
-    }
-
+  static write(files: OutputFile[], onWriteCallback: (file: TargetLocation) => void) {
+    const onBeforeFileWrite = (outputDir: string, fileName: string) =>
+      Settings.getInstance().onBeforeFileWrite(outputDir, fileName);
     files.forEach((file) => {
-      const dirPath = path.join(outputDir, file.dir);
+      const { dir: dirPath, fileName } = this.getTargetLocation(file, onBeforeFileWrite);
       if (!fs.existsSync(dirPath)) {
-        fs.mkdirSync(dirPath);
+        fs.mkdirSync(dirPath, { recursive: true });
       }
 
-      const filePath = path.join(dirPath, `${file.fileName}${file.fileExtension()}`);
-      fs.writeFile(filePath, file.body, 'utf8', () => {
-        onWriteCallback(file.fileName);
-      });
+      const filePath = path.join(dirPath, fileName);
+      fs.writeFileSync(filePath, file.body, 'utf8');
+      onWriteCallback({ dir: dirPath, fileName });
     });
   }
+
+  private static getTargetLocation(file: OutputFile, onBeforeFileWrite: OnBeforeFileWrite): TargetLocation {
+    const outputDir = path.join(Settings.getInstance().outputDir, file.dir);
+    const fileName = `${file.fileName}${file.fileExtension()}`;
+    return onBeforeFileWrite(outputDir, fileName);
+  }
 }
+
+type OnBeforeFileWrite = (outputDir: string, fileName: string) => TargetLocation;
+
+type TargetLocation = {
+  dir: string;
+  fileName: string;
+};

package/src/settings.ts

@@ -15,6 +15,8 @@ export interface SettingsConfig {
   openApiFileName: string;
   includeMetadata: boolean;
   rootDir?: string;
+  onAfterProcess?: (files: { dir: string; fileName: string }[]) => void;
+  onBeforeFileWrite?: (outputDir: string, fileName: string) => { dir: string; fileName: string };
 }
 
 export class Settings {
@@ -95,4 +97,17 @@ export class Settings {
   public getRootDir(): string | undefined {
     return this.config.rootDir;
   }
+
+  public onAfterProcess(files: { dir: string; fileName: string }[]) {
+    if (this.config.onAfterProcess) {
+      this.config.onAfterProcess(files);
+    }
+  }
+
+  public onBeforeFileWrite(outputDir: string, fileName: string): { dir: string; fileName: string } {
+    if (this.config.onBeforeFileWrite) {
+      return this.config.onBeforeFileWrite(outputDir, fileName);
+    }
+    return { dir: outputDir, fileName };
+  }
 }