@liferay/generator-js/generators/utils/ProjectAnalyzer.d.ts

Yeoman generators for Liferay DXP and Portal CE JavaScript projects.

/**
 * SPDX-FileCopyrightText: © 2017 Liferay, Inc. <https://liferay.com>
 * SPDX-License-Identifier: LGPL-3.0-or-later
 */
import { PkgJson } from '@liferay/js-toolkit-core';
/**
 * A class to be able to analyze what the project does and doesn't.
 */
export default class ProjectAnalyzer {
    /**
     * @param {Generator} generator a Yeoman generator
     */
    constructor(generator: any);
    /**
     * Get project name.
     * @return {string}
     */
    get name(): string;
    /**
     * Get project description.
     * @return {string}
     */
    get description(): string;
    /**
     * Get project display name (description if present, otherwise the name).
     * @return {string}
     */
    get displayName(): string;
    /**
     * Test if the project has localization enabled.
     * @return {boolean}
     */
    get hasLocalization(): boolean;
    /**
     * Test if the project has configuration.
     * @return {boolean}
     */
    get hasConfiguration(): boolean;
    /**
     * Get the basename of the localization file (without the .properties
     * extension)
     * @return {string}
     */
    get localizationBundleName(): string;
    /**
     * Get the path to localization properties file.
     * @return {string}
     */
    get localizationFilePath(): string;
    /**
     * Get the path to the configuration file.
     * @return {string}
     */
    get configurationFilePath(): string;
    /**
     * Get the parsed '.npmbundlerrc' file
     * @return {object}
     */
    get _npmbundlerrc(): object;
    /**
     * Get the parsed 'package.json' file
     * @return {object}
     */
    get _packageJson(): PkgJson;
    private _generator;
}