@cparra/apexdocs 1.13.4 → 2.0.0-alpha.14

package/lib/ClassFileGeneratorHelper.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const Settings_1 = require("./Settings");
-const Configuration_1 = require("./Configuration");
-class ClassFileGeneratorHelper {
-    static getSanitizedGroup(classModel) {
-        return classModel
-            .getClassGroup()
-            .replace(/ /g, '-')
-            .replace('.', '');
-    }
-    static getFileLink(classModel) {
-        var _a, _b;
-        const root = ((_a = Configuration_1.default.getConfig()) === null || _a === void 0 ? void 0 : _a.root) ? (_b = Configuration_1.default.getConfig()) === null || _b === void 0 ? void 0 : _b.root : '';
-        let fileLink;
-        if (Settings_1.default.getInstance().getShouldGroup()) {
-            fileLink = `[${classModel.getClassName()}](${root}/${this.getSanitizedGroup(classModel)}/${classModel.getClassName()}.md)`;
-        }
-        else {
-            fileLink = `[${classModel.getClassName()}](${root}/${classModel.getClassName()}.md)`;
-        }
-        return fileLink;
-    }
-}
-exports.default = ClassFileGeneratorHelper;

package/lib/ClassFileGeneratorHelper.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/ClassFileGeneratorHelper.test.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const ClassFileGeneratorHelper_1 = require("./ClassFileGeneratorHelper");
-const ClassModel_1 = require("./model/ClassModel");
-const Settings_1 = require("./Settings");
-test('that getSanitizedGroup returns the same string when there is nothing to sanitize', () => {
-    const testClass = new ClassModel_1.default();
-    testClass.setClassGroup('GroupName');
-    expect(ClassFileGeneratorHelper_1.default.getSanitizedGroup(testClass)).toBe('GroupName');
-});
-test('that getSanitizedGroup replaces spaces with dashes', () => {
-    const testClass = new ClassModel_1.default();
-    testClass.setClassGroup('Group Name');
-    expect(ClassFileGeneratorHelper_1.default.getSanitizedGroup(testClass)).toBe('Group-Name');
-});
-test('that getSanitizedGroup removes dots', () => {
-    const testClass = new ClassModel_1.default();
-    testClass.setClassGroup('Group Na.me');
-    expect(ClassFileGeneratorHelper_1.default.getSanitizedGroup(testClass)).toBe('Group-Name');
-});
-test('that getFileLink returns the correct string when grouping is off', () => {
-    Settings_1.default.getInstance().setShouldGroup(false);
-    const testClass = new ClassModel_1.default();
-    testClass.setClassName('MyTestClassName');
-    expect(ClassFileGeneratorHelper_1.default.getFileLink(testClass)).toBe('[MyTestClassName](/MyTestClassName.md)');
-});
-test('that getFileLink returns the correct string when grouping is on', () => {
-    Settings_1.default.getInstance().setShouldGroup(true);
-    const testClass = new ClassModel_1.default();
-    testClass.setClassName('MyTestClassName');
-    expect(ClassFileGeneratorHelper_1.default.getFileLink(testClass)).toBe(`[MyTestClassName](/${ClassFileGeneratorHelper_1.default.getSanitizedGroup(testClass)}/MyTestClassName.md)`);
-});

package/lib/Configuration.d.ts

@@ -1,34 +0,0 @@
-interface ConfigHome {
-    header?: string;
-}
-interface ConfigContent {
-    startingHeadingLevel?: number;
-    includeAuthor?: string;
-    includeDate?: string;
-    injections?: Injection;
-}
-interface Config {
-    root?: string;
-    defaultGroupName?: string;
-    sourceLanguage?: string;
-    home?: ConfigHome;
-    content?: ConfigContent;
-}
-interface Injection {
-    doc: DocInjection;
-}
-interface DocInjection {
-    onInit: string[];
-    onEnd: string[];
-    method: MethodInjection;
-}
-interface MethodInjection {
-    onInit: string[];
-    onEnd: string[];
-    onBeforeExample: string[];
-}
-export default class Configuration {
-    static getHeader(): string | undefined;
-    static getConfig(): Config | undefined;
-}
-export {};

package/lib/Configuration.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs = require("fs");
-const Settings_1 = require("./Settings");
-class Configuration {
-    static getHeader() {
-        var _a;
-        let config = this.getConfig();
-        if (!((_a = config === null || config === void 0 ? void 0 : config.home) === null || _a === void 0 ? void 0 : _a.header)) {
-            return undefined;
-        }
-        const headerFilePath = config.home.header;
-        try {
-            const rawHeader = fs.readFileSync(headerFilePath);
-            return rawHeader.toString();
-        }
-        catch (error) {
-            throw new Error('Error occurred while reading the header file ' + error.toString());
-        }
-    }
-    static getConfig() {
-        const configPath = Settings_1.default.getInstance().getConfigPath();
-        if (!configPath) {
-            return undefined;
-        }
-        let config;
-        try {
-            const rawFile = fs.readFileSync(configPath);
-            config = JSON.parse(rawFile.toString());
-        }
-        catch (error) {
-            throw new Error('Error occurred while reading the configuration file ' + error.toString());
-        }
-        return config;
-    }
-}
-exports.default = Configuration;

package/lib/DocsProcessor.d.ts

@@ -1,6 +0,0 @@
-import ClassModel from './model/ClassModel';
-export default abstract class DocsProcessor {
-    onBeforeProcess(classes: ClassModel[], outputDir: string): void;
-    abstract process(cModel: ClassModel, outputDir: string): void;
-    onAfterProcess(classes: ClassModel[], outputDir: string): void;
-}

package/lib/DocsProcessor.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class DocsProcessor {
-    // tslint:disable-next-line:no-empty
-    onBeforeProcess(classes, outputDir) { }
-    // tslint:disable-next-line:no-empty
-    onAfterProcess(classes, outputDir) { }
-}
-exports.default = DocsProcessor;

package/lib/DocsifyDocsProcessor.d.ts

@@ -1,4 +0,0 @@
-import MarkdownDocsProcessor from './MarkdownDocsProcessor';
-export default class DocsifyDocsProcessor extends MarkdownDocsProcessor {
-    getHomeFileName(): string;
-}

package/lib/DocsifyDocsProcessor.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const MarkdownDocsProcessor_1 = require("./MarkdownDocsProcessor");
-class DocsifyDocsProcessor extends MarkdownDocsProcessor_1.default {
-    getHomeFileName() {
-        return 'README.md';
-    }
-}
-exports.default = DocsifyDocsProcessor;

package/lib/DocsifyDocsProcessor.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/DocsifyDocsProcessor.test.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const DocsifyDocsProcessor_1 = require("./DocsifyDocsProcessor");
-test('that the home file name is README', () => {
-    const processor = new DocsifyDocsProcessor_1.default();
-    expect(processor.getHomeFileName()).toBe('README.md');
-});

package/lib/FileManager.d.ts

@@ -1,6 +0,0 @@
-import ClassModel from './model/ClassModel';
-export default class FileManager {
-    classModels: ClassModel[];
-    constructor(classModels: ClassModel[]);
-    generate(): void;
-}

package/lib/FileManager.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const Settings_1 = require("./Settings");
-class FileManager {
-    constructor(classModels) {
-        this.classModels = classModels;
-    }
-    // TODO: Make static
-    generate() {
-        const sortedClasses = this.classModels.sort((classA, classB) => {
-            if (classA.getClassName() < classB.getClassName())
-                return -1;
-            if (classA.getClassName() > classB.getClassName())
-                return 1;
-            return 0;
-        });
-        const docsProcessor = Settings_1.default.getInstance().getDocsProcessor();
-        if (!docsProcessor) {
-            return;
-        }
-        const outputDir = Settings_1.default.getInstance().getOutputDir();
-        docsProcessor.onBeforeProcess(sortedClasses, Settings_1.default.getInstance().getOutputDir());
-        sortedClasses.forEach(classModel => {
-            docsProcessor.process(classModel, outputDir);
-        });
-    }
-}
-exports.default = FileManager;

package/lib/JekyllDocsProcessor.d.ts

@@ -1,8 +0,0 @@
-import MarkdownDocsProcessor from './MarkdownDocsProcessor';
-import MarkdownHelper from './MarkdownHelper';
-export default class JekyllDocsProcessor extends MarkdownDocsProcessor {
-    getHomeFileName(): string;
-    onBeforeHomeFileCreated(generator: MarkdownHelper): void;
-    onBeforeClassFileCreated(generator: MarkdownHelper): void;
-    private addFrontMatterHeader;
-}

package/lib/JekyllDocsProcessor.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const MarkdownDocsProcessor_1 = require("./MarkdownDocsProcessor");
-class JekyllDocsProcessor extends MarkdownDocsProcessor_1.default {
-    getHomeFileName() {
-        return 'index.md';
-    }
-    onBeforeHomeFileCreated(generator) {
-        this.addFrontMatterHeader(generator);
-    }
-    onBeforeClassFileCreated(generator) {
-        this.addFrontMatterHeader(generator);
-    }
-    addFrontMatterHeader(generator) {
-        generator.addText('---');
-        generator.addText('layout: default');
-        generator.addText('---');
-    }
-}
-exports.default = JekyllDocsProcessor;

package/lib/JekyllDocsProcessor.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/JekyllDocsProcessor.test.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const JekyllDocsProcessor_1 = require("./JekyllDocsProcessor");
-test('that home file is index.md', () => {
-    const processor = new JekyllDocsProcessor_1.default();
-    expect(processor.getHomeFileName()).toBe('index.md');
-});
-test('that onBeforeHomeFileCreated adds front matter', () => {
-    const markdownHelper = jest.genMockFromModule('./MarkdownHelper');
-    markdownHelper.addText = jest.fn();
-    const processor = new JekyllDocsProcessor_1.default();
-    processor.onBeforeHomeFileCreated(markdownHelper);
-    expect(markdownHelper.addText).toHaveBeenCalledTimes(3);
-});
-test('that onBeforeClassFileCreated adds front matter', () => {
-    const markdownHelper = jest.genMockFromModule('./MarkdownHelper');
-    markdownHelper.addText = jest.fn();
-    const processor = new JekyllDocsProcessor_1.default();
-    processor.onBeforeClassFileCreated(markdownHelper);
-    expect(markdownHelper.addText).toHaveBeenCalledTimes(3);
-});

package/lib/JsHelper.d.ts

@@ -1,12 +0,0 @@
-export default class JsHelper {
-    contents: string;
-    addBlankLine(): void;
-    initializeBlock(): void;
-    finalizeBlock(): void;
-    declareType(className: string, docDescription: string): void;
-    declareProperty(propertyType: string, propertyName: string, docDescription: string): void;
-    sanitizeApexPropertyToJavascript(propertyType: string): string;
-    isListProperty(propertyType: string): true | undefined;
-    extractTypeFromList(propertyType: string): string;
-    replaceAll(sourceString: string, strReplace: string, strWith: string): string;
-}

package/lib/JsHelper.js

@@ -1,72 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class JsHelper {
-    constructor() {
-        this.contents = '';
-    }
-    addBlankLine() {
-        this.contents += '\n';
-    }
-    initializeBlock() {
-        this.contents += '/**';
-        this.addBlankLine();
-    }
-    finalizeBlock() {
-        this.contents += ' */';
-        this.addBlankLine();
-    }
-    declareType(className, docDescription) {
-        this.contents += ` * @typedef {Object} ${className} ${docDescription}`;
-        this.addBlankLine();
-    }
-    declareProperty(propertyType, propertyName, docDescription) {
-        let sanitizedType;
-        // First we check if we are dealing with a list
-        if (this.isListProperty(propertyType)) {
-            // If we are then we first extract the type from the list
-            sanitizedType = this.extractTypeFromList(propertyType);
-            // then sanitize it
-            sanitizedType = this.sanitizeApexPropertyToJavascript(sanitizedType);
-            // and then we add brackets ([])
-            sanitizedType = sanitizedType + '[]';
-        }
-        else {
-            sanitizedType = this.sanitizeApexPropertyToJavascript(propertyType);
-        }
-        this.contents += ` * @property {${sanitizedType}} ${propertyName} ${docDescription}`;
-        this.addBlankLine();
-    }
-    sanitizeApexPropertyToJavascript(propertyType) {
-        const lowerPropertyType = propertyType.toLowerCase();
-        if (lowerPropertyType === 'decimal' || lowerPropertyType === 'integer' || lowerPropertyType === 'double') {
-            return 'number';
-        }
-        if (lowerPropertyType === 'boolean' || lowerPropertyType === 'string') {
-            // If it is a built-in type then we return the lower-cased version.
-            return lowerPropertyType;
-        }
-        // Otherwise we respect casing
-        return propertyType;
-    }
-    isListProperty(propertyType) {
-        const lowerPropertyType = propertyType.toLowerCase();
-        if (lowerPropertyType.includes('<') && lowerPropertyType.includes('list')) {
-            return true;
-        }
-    }
-    extractTypeFromList(propertyType) {
-        const propertyWithoutList = this.replaceAll(propertyType, 'list', '');
-        return propertyWithoutList
-            .replace('list', '')
-            .replace('<', '')
-            .replace('>', '');
-    }
-    // Case insensitive replace
-    replaceAll(sourceString, strReplace, strWith) {
-        // See http://stackoverflow.com/a/3561711/556609
-        const esc = strReplace.replace(/[-\/\\^$*+?.()|[\]{}]/g, '\\$&');
-        const reg = new RegExp(esc, 'ig');
-        return sourceString.replace(reg, strWith);
-    }
-}
-exports.default = JsHelper;

package/lib/MarkdownDocsProcessor.d.ts

@@ -1,22 +0,0 @@
-import DocsProcessor from './DocsProcessor';
-import MarkdownHelper from './MarkdownHelper';
-import ClassModel from './model/ClassModel';
-export default abstract class MarkdownDocsProcessor extends DocsProcessor {
-    private classes;
-    abstract getHomeFileName(): string;
-    onBeforeHomeFileCreated(generator: MarkdownHelper): void;
-    onBeforeClassFileCreated(generator: MarkdownHelper): void;
-    onBeforeProcess(classes: ClassModel[], outputDir: string): void;
-    process(classModel: ClassModel, outputDir: string): void;
-    generateDocsForClass(generator: MarkdownHelper, classModel: ClassModel, level: number): void;
-    private group;
-    private addProperties;
-    private addConstructors;
-    private addEnums;
-    private addMethods;
-    private addInnerClasses;
-    private addParameters;
-    private addReturns;
-    private addThrowsBlock;
-    private addExample;
-}