vusion-api/src/fs/Library.ts

Vusion Node.js API

import * as fs from 'fs-extra';
import * as path from 'path';
import * as semver from 'semver';
import VueFile from './VueFile';
import JSFile from './JSFile';
import FSEntry from './FSEntry';
import { listAllFiles } from './';
import { config, Directory } from '..';
import { VusionConfig, MaterialInfo } from '../config/getDefaults';
import PackageJSON from '../types/PackageJSON';


export enum LibraryType {
    internal = 'internal',
    external = 'external',
    other = 'other',
}

/**
 * Library
 * libraryPath 指向包含多种类型的文件夹，比如`./src`，用于快速索引目录
 */
export default class Library {
    libraryType: LibraryType;
    fullPath: string;
    libraryPath: string;
    fileName: string;
    baseName: string;
    extName: string;
    title: string;

    superLibrary: Library;
    superLibraries: Array<Library>;
    otherComponents: Array<VueFile>;

    package: PackageJSON;
    config: VusionConfig;
    components: Array<VueFile>;
    componentsDirectory: Directory;
    componentsIndexFile: JSFile;
    docsComponentsInfoMap: Map<string, MaterialInfo>;
    blocks: Array<VueFile>;
    directives: Array<FSEntry>;
    filters: Array<FSEntry>;
    formatters: Array<FSEntry>;
    validators: Array<FSEntry>;
    rules: Array<FSEntry>;
    utils: Array<FSEntry>;
    assets: Array<FSEntry>;

    isOpen: boolean;

    constructor(fullPath: string, libraryType: LibraryType) {
        this.fullPath = fullPath;
        this.libraryType = libraryType;
        this.fileName = path.basename(fullPath);
        this.extName = path.extname(this.fileName);
        this.baseName = path.basename(this.fileName, this.extName);
        this.title = this.baseName;

        this.isOpen = false;
    }

    async open() {
        if (this.isOpen)
            return;
        return this.forceOpen();
    }

    async forceOpen() {
        await this.load();
        this.isOpen = true;
    }

    protected async load() {
        if (!fs.existsSync(this.fullPath))
            throw new Error(`Cannot find: ${this.fullPath}!`);

        const packageJSONPath = path.resolve(this.fullPath, 'package.json');
        if (!fs.existsSync(packageJSONPath))
            return;

        this.package = JSON.parse(await fs.readFile(packageJSONPath, 'utf8'));
        this.config = config.resolve(this.fullPath);
        this.libraryPath = path.resolve(this.fullPath, this.config.libraryPath);
        if (typeof this.config.docs === 'object' && this.config.docs.components) {
            this.docsComponentsInfoMap = new Map<string, MaterialInfo>();
            this.config.docs.components.forEach((componentInfo) => {
                this.docsComponentsInfoMap.set(componentInfo.name, componentInfo);
            });
        }

        /* 在 package.json 中查找 .vusion 或 .vue 的依赖项 */
        const vusionDeps: Array<string> = [];
        const vueDeps: Array<string> = [];

        Object.keys(this.package.dependencies).forEach((dep) => {
            if (dep.endsWith('.vusion'))
                vusionDeps.push(dep);
            else if (dep.endsWith('.vue'))
                vueDeps.push(dep);
        });

        // @TODO: 我们就这么几个库，先写死
        let superLibraryName = vusionDeps[0];
        if (vusionDeps.includes('vusion-ui.vusion'))
            superLibraryName = 'vusion-ui.vusion';
        else if (vusionDeps.includes('cloud-ui.vusion'))
            superLibraryName = 'cloud-ui.vusion';

        this.superLibraries = vusionDeps.map((dep) => new Library(path.resolve(this.fullPath, 'node_modules', dep), LibraryType.external));
        this.superLibrary = this.superLibraries.find((library) => library.fileName === superLibraryName);

        this.otherComponents = vueDeps.map((dep) => new VueFile(path.resolve(this.fullPath, 'node_modules', dep)));

        if (this.libraryType === LibraryType.internal) {
            this.componentsDirectory = Directory.fetch(path.resolve(this.libraryPath, 'components'));

            const componentsIndexPath = path.resolve(this.componentsDirectory.fullPath, 'index.js');
            if (fs.existsSync(componentsIndexPath))
                this.componentsIndexFile = JSFile.fetch(componentsIndexPath);
        } else if (this.libraryType === LibraryType.external) {
            if (semver.lt(this.package.version, '0.4.0-alpha'))
                this.componentsDirectory = new Directory(path.resolve(this.libraryPath));
            else
                this.componentsDirectory = new Directory(path.resolve(this.libraryPath, 'components'));

            const componentsIndexPath = path.resolve(this.componentsDirectory.fullPath, 'index.js');
            if (fs.existsSync(componentsIndexPath))
                this.componentsIndexFile = new JSFile(componentsIndexPath);
        }

        if (this.componentsDirectory) {
            this.components = listAllFiles(this.componentsDirectory.fullPath, {
                dot: false,
                patterns: ['!**/node_modules', '!**/.git'],
                includes: /\.vue$/,
                excludes: /\.vue[\\/]/,
            }).map((fullPath) => new VueFile(fullPath));
        }
    }

    async forceOpenOthers() {
        if (!fs.existsSync(this.fullPath))
            throw new Error(`Cannot find: ${this.fullPath}!`);

        const packageJSONPath = path.resolve(this.fullPath, 'package.json');
        if (!fs.existsSync(packageJSONPath))
            return;

        this.package = JSON.parse(await fs.readFile(packageJSONPath, 'utf8'));

        /* 在 package.json 中查找 .vusion 或 .vue 的依赖项 */
        const vueDeps: Array<string> = [];
        Object.keys(this.package.dependencies).forEach((dep) => {
            if (dep.endsWith('.vue'))
                vueDeps.push(dep);
        });

        this.otherComponents = vueDeps.map((dep) => new VueFile(path.resolve(this.fullPath, 'node_modules', dep)));
    }
}