@cparra/apexdocs 1.13.4 → 2.0.0-alpha.14

package/lib/MarkdownDocsProcessor.js

@@ -1,358 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs = require("fs");
-const path = require("path");
-const DocsProcessor_1 = require("./DocsProcessor");
-const MarkdownHelper_1 = require("./MarkdownHelper");
-const Settings_1 = require("./Settings");
-const Configuration_1 = require("./Configuration");
-const ClassFileGeneratorHelper_1 = require("./ClassFileGeneratorHelper");
-class MarkdownDocsProcessor extends DocsProcessor_1.default {
-    constructor() {
-        super(...arguments);
-        this.classes = [];
-    }
-    // tslint:disable-next-line:no-empty
-    onBeforeHomeFileCreated(generator) { }
-    // tslint:disable-next-line:no-empty
-    onBeforeClassFileCreated(generator) { }
-    onBeforeProcess(classes, outputDir) {
-        this.classes = classes;
-        const headerContent = Configuration_1.default.getHeader();
-        // Generate home page listing all classes.
-        const generator = new MarkdownHelper_1.default(classes);
-        this.onBeforeHomeFileCreated(generator);
-        if (headerContent) {
-            generator.addText(headerContent);
-        }
-        generator.addTitle('Classes');
-        if (!Settings_1.default.getInstance().getShouldGroup()) {
-            classes.forEach(classModel => {
-                generator.addBlankLine();
-                generator.addTitle(ClassFileGeneratorHelper_1.default.getFileLink(classModel), 2);
-                generator.addBlankLine();
-                generator.addBlankLine();
-                generator.addText(classModel.getDescription());
-                generator.addBlankLine();
-                generator.addBlankLine();
-            });
-        }
-        else {
-            const groupedClasses = this.group(classes);
-            groupedClasses.forEach((value, key) => {
-                generator.addTitle(key, 2);
-                value.forEach(classModel => {
-                    generator.addBlankLine();
-                    generator.addTitle(ClassFileGeneratorHelper_1.default.getFileLink(classModel), 3);
-                    generator.addBlankLine();
-                    generator.addBlankLine();
-                    generator.addText(classModel.getDescription());
-                    generator.addBlankLine();
-                    generator.addBlankLine();
-                });
-            });
-        }
-        if (!fs.existsSync(outputDir)) {
-            fs.mkdirSync(outputDir);
-        }
-        const filePath = path.join(outputDir, this.getHomeFileName());
-        fs.writeFile(filePath, generator.contents, 'utf8', () => {
-            // tslint:disable-next-line:no-console
-            console.log('Home page generated.');
-        });
-    }
-    process(classModel, outputDir) {
-        var _a, _b;
-        const generator = new MarkdownHelper_1.default(this.classes);
-        this.onBeforeClassFileCreated(generator);
-        const startingHeadingLevel = ((_b = (_a = Configuration_1.default.getConfig()) === null || _a === void 0 ? void 0 : _a.content) === null || _b === void 0 ? void 0 : _b.startingHeadingLevel) || 1;
-        this.generateDocsForClass(generator, classModel, startingHeadingLevel);
-        if (!fs.existsSync(outputDir)) {
-            fs.mkdirSync(outputDir);
-        }
-        let filePath;
-        if (!Settings_1.default.getInstance().getShouldGroup()) {
-            filePath = path.join(outputDir, `${classModel.getClassName()}.md`);
-        }
-        else {
-            const classGroupPath = path.join(outputDir, ClassFileGeneratorHelper_1.default.getSanitizedGroup(classModel));
-            if (!fs.existsSync(classGroupPath)) {
-                fs.mkdirSync(classGroupPath);
-            }
-            filePath = path.join(classGroupPath, `${classModel.getClassName()}.md`);
-        }
-        fs.writeFile(filePath, generator.contents, 'utf8', () => {
-            // tslint:disable-next-line:no-console
-            console.log(`${classModel.getClassName()} processed.`);
-        });
-    }
-    generateDocsForClass(generator, classModel, level) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
-        (_e = (_d = (_c = (_b = (_a = Configuration_1.default.getConfig()) === null || _a === void 0 ? void 0 : _a.content) === null || _b === void 0 ? void 0 : _b.injections) === null || _c === void 0 ? void 0 : _c.doc) === null || _d === void 0 ? void 0 : _d.onInit) === null || _e === void 0 ? void 0 : _e.forEach(injection => {
-            generator.addText(injection);
-        });
-        const suffix = classModel.getIsInterface() ? 'interface' : classModel.getIsEnum() ? 'enum' : 'class';
-        generator.addTitle(`${classModel.getClassName()} ${suffix}`, level);
-        if (classModel.getIsNamespaceAccessible()) {
-            generator.addBlankLine();
-            generator.addText('`NamespaceAccessible`');
-        }
-        if (classModel.getDescription()) {
-            generator.addBlankLine();
-            generator.addText(classModel.getDescription());
-            generator.addBlankLine();
-        }
-        if (((_g = (_f = Configuration_1.default.getConfig()) === null || _f === void 0 ? void 0 : _f.content) === null || _g === void 0 ? void 0 : _g.includeAuthor) && classModel.getAuthor()) {
-            generator.addBlankLine();
-            generator.addText(`**Author:** ${classModel.getAuthor()}`);
-        }
-        if (((_j = (_h = Configuration_1.default.getConfig()) === null || _h === void 0 ? void 0 : _h.content) === null || _j === void 0 ? void 0 : _j.includeDate) && classModel.getDate()) {
-            generator.addBlankLine();
-            generator.addText(`**Date:** ${classModel.getDate()}`);
-        }
-        if (classModel.getSeeList().length !== 0) {
-            generator.addTitle('Related', level + 1);
-            classModel.getSeeList().forEach(relatedClassName => {
-                const relatedClass = this.classes.find(currentClassModel => currentClassModel.getClassName() === relatedClassName);
-                generator.addBlankLine();
-                if (relatedClass) {
-                    generator.addText(ClassFileGeneratorHelper_1.default.getFileLink(relatedClass));
-                }
-                else {
-                    generator.addText(relatedClassName);
-                }
-                generator.addBlankLine();
-            });
-        }
-        generator.addHorizontalRule();
-        this.addConstructors(generator, level, classModel);
-        this.addEnums(generator, level, classModel);
-        this.addProperties(generator, level, classModel);
-        this.addMethods(generator, level, classModel);
-        this.addInnerClasses(classModel, generator, level);
-        (_p = (_o = (_m = (_l = (_k = Configuration_1.default.getConfig()) === null || _k === void 0 ? void 0 : _k.content) === null || _l === void 0 ? void 0 : _l.injections) === null || _m === void 0 ? void 0 : _m.doc) === null || _o === void 0 ? void 0 : _o.onEnd) === null || _p === void 0 ? void 0 : _p.forEach(injection => {
-            generator.addText(injection);
-        });
-    }
-    group(classes) {
-        return classes.reduce((groups, currentClass) => {
-            const key = currentClass.getClassGroup();
-            const group = groups.get(key) || [];
-            group.push(currentClass);
-            groups.set(key, group);
-            return groups;
-        }, new Map());
-    }
-    addProperties(generator, level, classModel) {
-        if (classModel.getProperties().length === 0) {
-            return;
-        }
-        generator.addTitle('Properties', level + 1);
-        generator.addBlankLine();
-        classModel
-            .getProperties()
-            .sort((propA, propB) => {
-            if (propA.getPropertyName() < propB.getPropertyName())
-                return -1;
-            if (propA.getPropertyName() > propB.getPropertyName())
-                return 1;
-            return 0;
-        })
-            .forEach(propertyModel => {
-            generator.addTitle(`\`${propertyModel.getPropertyName()}\` → \`${propertyModel.getReturnType()}\``, level + 2);
-            if (classModel.getIsNamespaceAccessible()) {
-                generator.addBlankLine();
-                generator.addText('`NamespaceAccessible`');
-            }
-            if (propertyModel.getDescription()) {
-                generator.addBlankLine();
-                generator.addText(propertyModel.getDescription());
-            }
-            generator.addBlankLine();
-        });
-        generator.addHorizontalRule();
-    }
-    addConstructors(generator, level, classModel) {
-        if (classModel.getMethods().filter(method => method.getIsConstructor()).length === 0) {
-            return;
-        }
-        generator.addTitle('Constructors', level + 1);
-        classModel
-            .getMethods()
-            .filter(method => method.getIsConstructor())
-            .forEach(methodModel => {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t;
-            (_f = (_e = (_d = (_c = (_b = (_a = Configuration_1.default.getConfig()) === null || _a === void 0 ? void 0 : _a.content) === null || _b === void 0 ? void 0 : _b.injections) === null || _c === void 0 ? void 0 : _c.doc) === null || _d === void 0 ? void 0 : _d.method) === null || _e === void 0 ? void 0 : _e.onInit) === null || _f === void 0 ? void 0 : _f.forEach(injection => {
-                generator.addText(injection);
-            });
-            generator.addTitle(`\`${methodModel.getSignature()}\``, level + 2);
-            if (classModel.getIsNamespaceAccessible()) {
-                generator.addBlankLine();
-                generator.addText('`NamespaceAccessible`');
-            }
-            if (methodModel.getDescription()) {
-                generator.addBlankLine();
-                generator.addText(methodModel.getDescription());
-            }
-            if (methodModel.getParams().length) {
-                this.addParameters(generator, level, methodModel);
-            }
-            if (methodModel.getThrownExceptions().length) {
-                this.addThrowsBlock(generator, level, methodModel);
-            }
-            if (methodModel.getExample() !== '') {
-                (_m = (_l = (_k = (_j = (_h = (_g = Configuration_1.default.getConfig()) === null || _g === void 0 ? void 0 : _g.content) === null || _h === void 0 ? void 0 : _h.injections) === null || _j === void 0 ? void 0 : _j.doc) === null || _k === void 0 ? void 0 : _k.method) === null || _l === void 0 ? void 0 : _l.onBeforeExample) === null || _m === void 0 ? void 0 : _m.forEach(injection => {
-                    generator.addText(injection);
-                });
-                this.addExample(generator, methodModel, level);
-            }
-            (_t = (_s = (_r = (_q = (_p = (_o = Configuration_1.default.getConfig()) === null || _o === void 0 ? void 0 : _o.content) === null || _p === void 0 ? void 0 : _p.injections) === null || _q === void 0 ? void 0 : _q.doc) === null || _r === void 0 ? void 0 : _r.method) === null || _s === void 0 ? void 0 : _s.onEnd) === null || _t === void 0 ? void 0 : _t.forEach(injection => {
-                generator.addText(injection);
-            });
-        });
-        generator.addHorizontalRule();
-    }
-    addEnums(generator, level, classModel) {
-        if (classModel.getChildEnums().length === 0) {
-            return;
-        }
-        generator.addTitle('Enums', level + 1);
-        classModel
-            .getChildEnums()
-            .sort((enumA, enumB) => {
-            if (enumA.getClassName() < enumB.getClassName())
-                return -1;
-            if (enumA.getClassName() > enumB.getClassName())
-                return 1;
-            return 0;
-        })
-            .forEach(enumModel => {
-            generator.addTitle(enumModel.getClassName(), level + 2);
-            generator.addBlankLine();
-            if (classModel.getIsNamespaceAccessible()) {
-                generator.addBlankLine();
-                generator.addText('`NamespaceAccessible`');
-            }
-            if (enumModel.getDescription()) {
-                generator.addBlankLine();
-                generator.addText(enumModel.getDescription());
-                generator.addBlankLine();
-            }
-        });
-        generator.addHorizontalRule();
-    }
-    addMethods(generator, level, classModel) {
-        if (classModel.getMethods().filter(method => !method.getIsConstructor()).length === 0) {
-            return;
-        }
-        generator.addTitle('Methods', level + 1);
-        classModel
-            .getMethods()
-            .sort((methodA, methodB) => {
-            if (methodA.getMethodName() < methodB.getMethodName())
-                return -1;
-            if (methodA.getMethodName() > methodB.getMethodName())
-                return 1;
-            return 0;
-        })
-            .filter(method => !method.getIsConstructor())
-            .forEach(methodModel => {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t;
-            (_f = (_e = (_d = (_c = (_b = (_a = Configuration_1.default.getConfig()) === null || _a === void 0 ? void 0 : _a.content) === null || _b === void 0 ? void 0 : _b.injections) === null || _c === void 0 ? void 0 : _c.doc) === null || _d === void 0 ? void 0 : _d.method) === null || _e === void 0 ? void 0 : _e.onInit) === null || _f === void 0 ? void 0 : _f.forEach(injection => {
-                generator.addText(injection);
-            });
-            generator.addTitle(`\`${methodModel.getSignature()}\` → \`${methodModel.getReturnType()}\``, level + 2);
-            if (classModel.getIsNamespaceAccessible()) {
-                generator.addBlankLine();
-                generator.addText('`NamespaceAccessible`');
-            }
-            if (methodModel.getDescription()) {
-                generator.addBlankLine();
-                generator.addText(methodModel.getDescription());
-                generator.addBlankLine();
-            }
-            if (methodModel.getParams().length) {
-                this.addParameters(generator, level, methodModel);
-            }
-            if (methodModel.getReturns().length) {
-                this.addReturns(generator, level, methodModel);
-            }
-            if (methodModel.getThrownExceptions().length) {
-                this.addThrowsBlock(generator, level, methodModel);
-            }
-            if (methodModel.getExample() !== '') {
-                (_m = (_l = (_k = (_j = (_h = (_g = Configuration_1.default.getConfig()) === null || _g === void 0 ? void 0 : _g.content) === null || _h === void 0 ? void 0 : _h.injections) === null || _j === void 0 ? void 0 : _j.doc) === null || _k === void 0 ? void 0 : _k.method) === null || _l === void 0 ? void 0 : _l.onBeforeExample) === null || _m === void 0 ? void 0 : _m.forEach(injection => {
-                    generator.addText(injection);
-                });
-                this.addExample(generator, methodModel, level);
-            }
-            (_t = (_s = (_r = (_q = (_p = (_o = Configuration_1.default.getConfig()) === null || _o === void 0 ? void 0 : _o.content) === null || _p === void 0 ? void 0 : _p.injections) === null || _q === void 0 ? void 0 : _q.doc) === null || _r === void 0 ? void 0 : _r.method) === null || _s === void 0 ? void 0 : _s.onEnd) === null || _t === void 0 ? void 0 : _t.forEach(injection => {
-                generator.addText(injection);
-            });
-        });
-        generator.addHorizontalRule();
-    }
-    addInnerClasses(classModel, generator, level) {
-        if (classModel.getChildClasses().length > 0) {
-            generator.addTitle('Inner Classes', ++level);
-            level++;
-            generator.addBlankLine();
-            classModel
-                .getChildClasses()
-                .sort((classA, classB) => {
-                if (classA.getClassName() < classB.getClassName())
-                    return -1;
-                if (classA.getClassName() > classB.getClassName())
-                    return 1;
-                return 0;
-            })
-                .forEach(innerClass => {
-                this.generateDocsForClass(generator, innerClass, level);
-            });
-        }
-    }
-    addParameters(generator, level, methodModel) {
-        generator.addTitle('Parameters', level + 3);
-        // Building a table to display the parameters
-        generator.addText('|Param|Description|');
-        generator.addText('|-----|-----------|');
-        methodModel.getParams().forEach(param => {
-            const paramName = param.substr(0, param.indexOf(' '));
-            const paramDescription = param.substr(param.indexOf(' '));
-            generator.addText(`|\`${paramName}\` | ${paramDescription} |`);
-        });
-        generator.addBlankLine();
-    }
-    addReturns(generator, level, methodModel) {
-        generator.addTitle('Return', level + 3);
-        generator.addBlankLine();
-        generator.addText('**Type**');
-        generator.addBlankLine();
-        generator.addText(methodModel.getReturnType());
-        generator.addBlankLine();
-        generator.addText('**Description**');
-        generator.addBlankLine();
-        generator.addText(methodModel.getReturns());
-        generator.addBlankLine();
-    }
-    addThrowsBlock(generator, level, methodModel) {
-        generator.addTitle('Throws', level + 3);
-        // Building a table to display the exceptions
-        generator.addText('|Exception|Description|');
-        generator.addText('|---------|-----------|');
-        methodModel.getThrownExceptions().forEach(param => {
-            const exceptionName = param.substr(0, param.indexOf(' '));
-            const exceptionDescription = param.substr(param.indexOf(' '));
-            generator.addText(`|\`${exceptionName}\` | ${exceptionDescription} |`);
-        });
-        generator.addBlankLine();
-    }
-    addExample(generator, methodModel, level) {
-        generator.addTitle('Example', level + 3);
-        generator.startCodeBlock();
-        generator.addText(methodModel.getExample(), false);
-        generator.endCodeBlock();
-        generator.addBlankLine();
-    }
-}
-exports.default = MarkdownDocsProcessor;

package/lib/MarkdownHelper.d.ts

@@ -1,13 +0,0 @@
-import ClassModel from './model/ClassModel';
-export default class MarkdownHelper {
-    contents: string;
-    classes: ClassModel[];
-    constructor(classes: ClassModel[]);
-    addBlankLine(): void;
-    addTitle(text: string, level?: number): void;
-    addText(text: string, encodeHtml?: boolean): void;
-    addHorizontalRule(): void;
-    addLink(title: string, url: string): void;
-    startCodeBlock(): void;
-    endCodeBlock(): void;
-}

package/lib/MarkdownHelper.js

@@ -1,78 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const html_entities_1 = require("html-entities");
-const ClassFileGeneratorHelper_1 = require("./ClassFileGeneratorHelper");
-const Configuration_1 = require("./Configuration");
-class MarkdownHelper {
-    constructor(classes) {
-        this.contents = '';
-        this.classes = classes;
-    }
-    addBlankLine() {
-        this.contents += '\n';
-    }
-    addTitle(text, level = 1) {
-        let title = '';
-        for (let i = 0; i < level; i++) {
-            title += '#';
-        }
-        title += ' ';
-        title += text;
-        this.contents += title;
-        this.addBlankLine();
-    }
-    addText(text, encodeHtml = true) {
-        // Parsing text to extract possible linking classes.
-        const possibleLinks = text.match(/<<.*?>>/g);
-        possibleLinks === null || possibleLinks === void 0 ? void 0 : possibleLinks.forEach(currentMatch => {
-            const classNameForMatch = currentMatch.replace('<<', '').replace('>>', '');
-            this.classes.forEach(classModel => {
-                if (classModel.getClassName() === classNameForMatch) {
-                    text = text.replace(currentMatch, ClassFileGeneratorHelper_1.default.getFileLink(classModel));
-                }
-            });
-        });
-        // Parsing links using {@link ClassName} format
-        const linkFormatRegEx = '{@link (.*?)}';
-        const expression = new RegExp(linkFormatRegEx, 'gi');
-        let match;
-        const matches = [];
-        do {
-            match = expression.exec(text);
-            if (match) {
-                matches.push(match);
-            }
-        } while (match);
-        for (const currentMatch of matches) {
-            this.classes.forEach(classModel => {
-                if (classModel.getClassName() === currentMatch[1]) {
-                    text = text.replace(currentMatch[0], ClassFileGeneratorHelper_1.default.getFileLink(classModel));
-                }
-            });
-        }
-        const textToAdd = encodeHtml ? html_entities_1.encode(text) : text;
-        this.contents += textToAdd;
-        this.addBlankLine();
-    }
-    addHorizontalRule() {
-        this.contents += '---';
-        this.addBlankLine();
-    }
-    addLink(title, url) {
-        this.contents += `[${title}](${url})`;
-    }
-    startCodeBlock() {
-        var _a;
-        this.contents += '```';
-        const sourceLanguage = (_a = Configuration_1.default.getConfig()) === null || _a === void 0 ? void 0 : _a.sourceLanguage;
-        if (sourceLanguage) {
-            this.contents += sourceLanguage;
-        }
-        this.addBlankLine();
-    }
-    endCodeBlock() {
-        this.contents += '```';
-        this.addBlankLine();
-    }
-}
-exports.default = MarkdownHelper;

package/lib/Settings.d.ts

@@ -1,22 +0,0 @@
-import DocsProcessor from './DocsProcessor';
-export default class Settings {
-    private static instance;
-    private desiredScope;
-    private outputDir;
-    private configPath;
-    private shouldGroup;
-    private processor;
-    private constructor();
-    static getInstance(): Settings;
-    setScope(desiredScope: string[]): void;
-    getScope(): string[];
-    setOutputDir(outputDir: string): void;
-    getOutputDir(): string;
-    setDocsProcessor(processor: DocsProcessor): void;
-    getDocsProcessor(): DocsProcessor | null;
-    setConfigPath(configPath: string): void;
-    getConfigPath(): string | null;
-    setShouldGroup(shouldGroup: boolean): void;
-    getShouldGroup(): boolean | null;
-    includeNamespaceAccessible(): boolean;
-}

package/lib/Settings.js

@@ -1,51 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class Settings {
-    constructor() {
-        this.desiredScope = ['global', 'public', 'namespaceaccessible'];
-        this.outputDir = 'docs';
-        this.configPath = null;
-        this.shouldGroup = true;
-        this.processor = null;
-    }
-    static getInstance() {
-        if (!Settings.instance) {
-            Settings.instance = new Settings();
-        }
-        return Settings.instance;
-    }
-    setScope(desiredScope) {
-        this.desiredScope = desiredScope;
-    }
-    getScope() {
-        return this.desiredScope;
-    }
-    setOutputDir(outputDir) {
-        this.outputDir = outputDir;
-    }
-    getOutputDir() {
-        return this.outputDir;
-    }
-    setDocsProcessor(processor) {
-        this.processor = processor;
-    }
-    getDocsProcessor() {
-        return this.processor;
-    }
-    setConfigPath(configPath) {
-        this.configPath = configPath;
-    }
-    getConfigPath() {
-        return this.configPath;
-    }
-    setShouldGroup(shouldGroup) {
-        this.shouldGroup = shouldGroup;
-    }
-    getShouldGroup() {
-        return this.shouldGroup;
-    }
-    includeNamespaceAccessible() {
-        return this.getScope().includes('namespaceaccessible');
-    }
-}
-exports.default = Settings;

package/lib/Settings.test.d.ts

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

package/lib/Settings.test.js

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const Settings_1 = require("./Settings");
-test('has global, public and namespaceaccessbile as default scope', () => {
-    expect(Settings_1.default.getInstance().getScope()).toHaveLength(3);
-    expect(Settings_1.default.getInstance().getScope()).toContain('global');
-    expect(Settings_1.default.getInstance().getScope()).toContain('public');
-    expect(Settings_1.default.getInstance().getScope()).toContain('namespaceaccessible');
-});
-test('can set scope', () => {
-    const expectedScope = ['private'];
-    Settings_1.default.getInstance().setScope(expectedScope);
-    expect(Settings_1.default.getInstance().getScope()).toHaveLength(1);
-    expect(Settings_1.default.getInstance().getScope()).toContain('private');
-});
-test('has "docs" as the default output directory', () => {
-    expect(Settings_1.default.getInstance().getOutputDir()).toBe('docs');
-});
-test('can set output directory', () => {
-    const directory = 'cutomdir';
-    Settings_1.default.getInstance().setOutputDir(directory);
-    expect(Settings_1.default.getInstance().getOutputDir()).toBe(directory);
-});
-test('that the processor can be set', () => {
-    const docsProcessor = jest.genMockFromModule('./DocsProcessor');
-    Settings_1.default.getInstance().setDocsProcessor(docsProcessor);
-    expect(Settings_1.default.getInstance().getDocsProcessor()).toBe(docsProcessor);
-});
-test('that the config path can be set', () => {
-    const configPath = './config.json';
-    Settings_1.default.getInstance().setConfigPath(configPath);
-    expect(Settings_1.default.getInstance().getConfigPath()).toBe(configPath);
-});
-test('that shouldGroup can be set', () => {
-    const shouldGroup = false;
-    Settings_1.default.getInstance().setShouldGroup(shouldGroup);
-    expect(Settings_1.default.getInstance().getShouldGroup()).toBe(shouldGroup);
-});

package/lib/command/Generate.d.ts

@@ -1,2 +0,0 @@
-import ClassModel from '../model/ClassModel';
-export declare function generate(sourceDirectory: string, recursive?: boolean, scope?: string[], outputDir?: string, targetGenerator?: string, configPath?: string, group?: boolean): ClassModel[];

package/lib/command/Generate.js

@@ -1,54 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs = require("fs");
-const path = require("path");
-const Settings_1 = require("../Settings");
-const FileParser_1 = require("../parser/FileParser");
-const DocsifyDocsProcessor_1 = require("../DocsifyDocsProcessor");
-const JekyllDocsProcessor_1 = require("../JekyllDocsProcessor");
-const AsJsDocsProcessor_1 = require("../AsJsDocsProcessor");
-function generate(sourceDirectory, recursive = true, scope = ['global', 'public', 'namespaceaccessible'], outputDir = 'docs', targetGenerator = 'jekyll', configPath, group) {
-    Settings_1.default.getInstance().setScope(scope);
-    Settings_1.default.getInstance().setOutputDir(outputDir);
-    if (targetGenerator === 'jekyll') {
-        Settings_1.default.getInstance().setDocsProcessor(new JekyllDocsProcessor_1.default());
-    }
-    else if (targetGenerator === 'docsify') {
-        Settings_1.default.getInstance().setDocsProcessor(new DocsifyDocsProcessor_1.default());
-    }
-    else {
-        Settings_1.default.getInstance().setDocsProcessor(new AsJsDocsProcessor_1.default());
-    }
-    if (group !== undefined) {
-        Settings_1.default.getInstance().setShouldGroup(group);
-    }
-    if (configPath) {
-        Settings_1.default.getInstance().setConfigPath(configPath);
-    }
-    // TODO: Assert data validation to avoid exposing 'fs' and 'path' errors to callers.
-    const classes = getClassesFromDirectory(sourceDirectory, recursive);
-    // tslint:disable-next-line:no-console
-    console.log(`Processed ${classes.length} files`);
-    return classes;
-}
-exports.generate = generate;
-function getClassesFromDirectory(sourceDirectory, recursive) {
-    let classes = [];
-    const directoryContents = fs.readdirSync(sourceDirectory);
-    directoryContents.forEach(currentFile => {
-        const currentPath = path.join(sourceDirectory, currentFile);
-        if (recursive && fs.statSync(currentPath).isDirectory()) {
-            classes = classes.concat(getClassesFromDirectory(currentPath, recursive));
-        }
-        if (!currentFile.endsWith('.cls')) {
-            return;
-        }
-        const rawFile = fs.readFileSync(currentPath);
-        const response = new FileParser_1.default().parseFileContents(rawFile.toString());
-        if (!response) {
-            return;
-        }
-        classes.push(response);
-    });
-    return classes;
-}

package/lib/command/__test__/Generte.test.d.ts

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

package/lib/command/__test__/Generte.test.js

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs = require("fs");
-const Generate_1 = require("../Generate");
-const FileParser_1 = require("../../parser/FileParser");
-jest.mock('fs');
-jest.mock('../../parser/FileParser');
-beforeEach(() => {
-    FileParser_1.default.mockClear();
-});
-it('returns an empty list when there are no files', () => {
-    fs.readdirSync.mockReturnValue([]);
-    const classes = Generate_1.generate('src');
-    expect(classes.length).toBe(0);
-});
-it('returns an empty list when there are no files ending in .cls', () => {
-    fs.readdirSync.mockReturnValue(['file.xml', 'README.md']);
-    const classes = Generate_1.generate('src', false);
-    expect(classes.length).toBe(0);
-});
-it('returns parsed files when there are .cls files', () => {
-    fs.readdirSync.mockReturnValue(['TestClass.cls', 'README.md']);
-    fs.readFileSync.mockReturnValue('Raw class data');
-    Generate_1.generate('src', false);
-    expect(FileParser_1.default).toHaveBeenCalledTimes(1);
-    const mockFileParserInstance = FileParser_1.default.mock.instances[0];
-    const mockParseFileContents = mockFileParserInstance.parseFileContents;
-    expect(mockParseFileContents).toHaveBeenCalledTimes(1);
-    expect(mockParseFileContents).toHaveBeenCalledWith('Raw class data');
-});