@cparra/apexdocs 2.19.0-alpha.2 → 2.19.0-alpha.3

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.
@@ -1,7 +1,15 @@
1
+ import * as path from 'path';
2
+
3
+ type OutputDir = {
4
+ baseDir: string;
5
+ fileDir: string;
6
+ };
7
+
1
8
  export default {
2
- onBeforeFileWrite: (dir: string, fileName: string) => {
3
- console.log('onBefore writing', fileName);
4
- return { dir, fileName };
9
+ onBeforeFileWrite: (dir: OutputDir, fileName: string) => {
10
+ console.log('onBefore writing', dir, fileName);
11
+ const defaultDir = path.join(dir.baseDir, dir.fileDir);
12
+ return { dir: defaultDir, fileName };
5
13
  },
6
14
  onAfterProcess: (files: { dir: string; fileName: string }[]) => {
7
15
  console.log('onAfterProcess files', files);
@@ -1,10 +1,6 @@
1
1
  import { OutputFile } from '../model/outputFile';
2
+ import { TargetLocation } from '../settings';
2
3
  export declare class FileWriter {
3
4
  static write(files: OutputFile[], onWriteCallback: (file: TargetLocation) => void): void;
4
5
  private static getTargetLocation;
5
6
  }
6
- type TargetLocation = {
7
- dir: string;
8
- fileName: string;
9
- };
10
- export {};
@@ -18,9 +18,11 @@ class FileWriter {
18
18
  });
19
19
  }
20
20
  static getTargetLocation(file, onBeforeFileWrite) {
21
- const outputDir = path.join(settings_1.Settings.getInstance().outputDir, file.dir);
22
21
  const fileName = `${file.fileName}${file.fileExtension()}`;
23
- return onBeforeFileWrite(outputDir, fileName);
22
+ return onBeforeFileWrite({
23
+ baseDir: settings_1.Settings.getInstance().outputDir,
24
+ fileDir: file.dir,
25
+ }, fileName);
24
26
  }
25
27
  }
26
28
  exports.FileWriter = FileWriter;
@@ -1 +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,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"}
1
+ {"version":3,"file":"file-writer.js","sourceRoot":"","sources":["../../src/service/file-writer.ts"],"names":[],"mappings":";;;AAAA,yBAAyB;AACzB,6BAA6B;AAE7B,0CAAqF;AAErF,MAAa,UAAU;IACrB,MAAM,CAAC,KAAK,CAAC,KAAmB,EAAE,eAA+C;QAC/E,MAAM,iBAAiB,GAAG,CAAC,SAAoB,EAAE,QAAgB,EAAE,EAAE,CACnE,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,QAAQ,GAAG,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC;QAC3D,OAAO,iBAAiB,CACtB;YACE,OAAO,EAAE,mBAAQ,CAAC,WAAW,EAAE,CAAC,SAAS;YACzC,OAAO,EAAE,IAAI,CAAC,GAAG;SAClB,EACD,QAAQ,CACT,CAAC;IACJ,CAAC;CACF;AA1BD,gCA0BC"}
package/lib/settings.d.ts CHANGED
@@ -1,4 +1,13 @@
1
1
  import { GeneratorChoices } from './transpiler/generator-choices';
2
+ export type OnBeforeFileWrite = (outputDir: OutputDir, fileName: string) => TargetLocation;
3
+ export type TargetLocation = {
4
+ dir: string;
5
+ fileName: string;
6
+ };
7
+ export type OutputDir = {
8
+ baseDir: string;
9
+ fileDir: string;
10
+ };
2
11
  export interface SettingsConfig {
3
12
  sourceDirectory: string;
4
13
  recursive: boolean;
@@ -18,7 +27,7 @@ export interface SettingsConfig {
18
27
  dir: string;
19
28
  fileName: string;
20
29
  }[]) => void;
21
- onBeforeFileWrite?: (outputDir: string, fileName: string) => {
30
+ onBeforeFileWrite?: (outputDir: OutputDir, fileName: string) => {
22
31
  dir: string;
23
32
  fileName: string;
24
33
  };
@@ -48,7 +57,7 @@ export declare class Settings {
48
57
  dir: string;
49
58
  fileName: string;
50
59
  }[]): void;
51
- onBeforeFileWrite(outputDir: string, fileName: string): {
60
+ onBeforeFileWrite(outputDir: OutputDir, fileName: string): {
52
61
  dir: string;
53
62
  fileName: string;
54
63
  };
package/lib/settings.js CHANGED
@@ -1,6 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.Settings = void 0;
4
+ const path = require("path");
4
5
  class Settings {
5
6
  constructor(config) {
6
7
  this.config = config;
@@ -72,7 +73,8 @@ class Settings {
72
73
  if (this.config.onBeforeFileWrite) {
73
74
  return this.config.onBeforeFileWrite(outputDir, fileName);
74
75
  }
75
- return { dir: outputDir, fileName };
76
+ const defaultDir = path.join(outputDir.baseDir, outputDir.fileDir);
77
+ return { dir: defaultDir, fileName };
76
78
  }
77
79
  }
78
80
  exports.Settings = Settings;
@@ -1 +1 @@
1
- {"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"}
1
+ {"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":";;;AACA,6BAA6B;AAiC7B,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,SAAoB,EAAE,QAAgB;QAC7D,IAAI,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE;YACjC,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;SAC3D;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;QACnE,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC;IACvC,CAAC;CACF;AA5FD,4BA4FC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cparra/apexdocs",
3
- "version": "2.19.0-alpha.2",
3
+ "version": "2.19.0-alpha.3",
4
4
  "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
5
5
  "keywords": [
6
6
  "apex",
@@ -1,11 +1,11 @@
1
1
  import * as fs from 'fs';
2
2
  import * as path from 'path';
3
3
  import { OutputFile } from '../model/outputFile';
4
- import { Settings } from '../settings';
4
+ import { OnBeforeFileWrite, OutputDir, Settings, TargetLocation } from '../settings';
5
5
 
6
6
  export class FileWriter {
7
7
  static write(files: OutputFile[], onWriteCallback: (file: TargetLocation) => void) {
8
- const onBeforeFileWrite = (outputDir: string, fileName: string) =>
8
+ const onBeforeFileWrite = (outputDir: OutputDir, fileName: string) =>
9
9
  Settings.getInstance().onBeforeFileWrite(outputDir, fileName);
10
10
  files.forEach((file) => {
11
11
  const { dir: dirPath, fileName } = this.getTargetLocation(file, onBeforeFileWrite);
@@ -20,15 +20,13 @@ export class FileWriter {
20
20
  }
21
21
 
22
22
  private static getTargetLocation(file: OutputFile, onBeforeFileWrite: OnBeforeFileWrite): TargetLocation {
23
- const outputDir = path.join(Settings.getInstance().outputDir, file.dir);
24
23
  const fileName = `${file.fileName}${file.fileExtension()}`;
25
- return onBeforeFileWrite(outputDir, fileName);
24
+ return onBeforeFileWrite(
25
+ {
26
+ baseDir: Settings.getInstance().outputDir,
27
+ fileDir: file.dir,
28
+ },
29
+ fileName,
30
+ );
26
31
  }
27
32
  }
28
-
29
- type OnBeforeFileWrite = (outputDir: string, fileName: string) => TargetLocation;
30
-
31
- type TargetLocation = {
32
- dir: string;
33
- fileName: string;
34
- };
package/src/settings.ts CHANGED
@@ -1,4 +1,17 @@
1
1
  import { GeneratorChoices } from './transpiler/generator-choices';
2
+ import * as path from 'path';
3
+
4
+ export type OnBeforeFileWrite = (outputDir: OutputDir, fileName: string) => TargetLocation;
5
+
6
+ export type TargetLocation = {
7
+ dir: string;
8
+ fileName: string;
9
+ };
10
+
11
+ export type OutputDir = {
12
+ baseDir: string;
13
+ fileDir: string;
14
+ };
2
15
 
3
16
  export interface SettingsConfig {
4
17
  sourceDirectory: string;
@@ -16,7 +29,7 @@ export interface SettingsConfig {
16
29
  includeMetadata: boolean;
17
30
  rootDir?: string;
18
31
  onAfterProcess?: (files: { dir: string; fileName: string }[]) => void;
19
- onBeforeFileWrite?: (outputDir: string, fileName: string) => { dir: string; fileName: string };
32
+ onBeforeFileWrite?: (outputDir: OutputDir, fileName: string) => { dir: string; fileName: string };
20
33
  }
21
34
 
22
35
  export class Settings {
@@ -104,10 +117,11 @@ export class Settings {
104
117
  }
105
118
  }
106
119
 
107
- public onBeforeFileWrite(outputDir: string, fileName: string): { dir: string; fileName: string } {
120
+ public onBeforeFileWrite(outputDir: OutputDir, fileName: string): { dir: string; fileName: string } {
108
121
  if (this.config.onBeforeFileWrite) {
109
122
  return this.config.onBeforeFileWrite(outputDir, fileName);
110
123
  }
111
- return { dir: outputDir, fileName };
124
+ const defaultDir = path.join(outputDir.baseDir, outputDir.fileDir);
125
+ return { dir: defaultDir, fileName };
112
126
  }
113
127
  }