@lmc-eu/spirit-analytics/index.d.ts

Analytic tools for Spirit Design System

import { I as Instance, R as RunnerConfig, S as ScannerType, a as SpiritAdoptionProcessorOptions } from './spiritAdoptionProcessor-D223Z-9N.js';
export { s as spiritAdoptionProcessor, t as types } from './spiritAdoptionProcessor-D223Z-9N.js';

declare function cli(args: string[]): Promise<void>;

declare const OUTPUT_FILENAME_PREFIX = "spirit-analytics";
declare const OUTPUT_DIR = ".scanner";
declare const ROOT_PATH = ".";
declare const REACT_OUTPUT_FILE_NAME = "adoption-data-react";
declare const TWIG_OUTPUT_FILE_NAME = "./.scanner/adoption-data-twig";
declare const TWIG_CORE_COMPONENTS_PATH = "./vendor/lmc/spirit-web-twig-bundle/src/Resources/twig-components";
declare const TWIG_CONFIG_FILE = "./config/spirit-web-twig.yml";

declare const constants_OUTPUT_DIR: typeof OUTPUT_DIR;
declare const constants_OUTPUT_FILENAME_PREFIX: typeof OUTPUT_FILENAME_PREFIX;
declare const constants_REACT_OUTPUT_FILE_NAME: typeof REACT_OUTPUT_FILE_NAME;
declare const constants_ROOT_PATH: typeof ROOT_PATH;
declare const constants_TWIG_CONFIG_FILE: typeof TWIG_CONFIG_FILE;
declare const constants_TWIG_CORE_COMPONENTS_PATH: typeof TWIG_CORE_COMPONENTS_PATH;
declare const constants_TWIG_OUTPUT_FILE_NAME: typeof TWIG_OUTPUT_FILE_NAME;
declare namespace constants {
  export { constants_OUTPUT_DIR as OUTPUT_DIR, constants_OUTPUT_FILENAME_PREFIX as OUTPUT_FILENAME_PREFIX, constants_REACT_OUTPUT_FILE_NAME as REACT_OUTPUT_FILE_NAME, constants_ROOT_PATH as ROOT_PATH, constants_TWIG_CONFIG_FILE as TWIG_CONFIG_FILE, constants_TWIG_CORE_COMPONENTS_PATH as TWIG_CORE_COMPONENTS_PATH, constants_TWIG_OUTPUT_FILE_NAME as TWIG_OUTPUT_FILE_NAME };
}

declare const timestamp: () => string;

declare const errorMessage: (message: string) => void;
declare const infoMessage: (message: string) => void;

declare const getModuleName: (instance: Instance, componentName: string) => string | null;

declare const _dirname: string;
declare const getOutputPath: (outputPath: string, name: string) => string;

declare const getVersions: (pathToFolder: string) => Promise<string>;

declare const index__dirname: typeof _dirname;
declare const index_errorMessage: typeof errorMessage;
declare const index_getModuleName: typeof getModuleName;
declare const index_getOutputPath: typeof getOutputPath;
declare const index_getVersions: typeof getVersions;
declare const index_infoMessage: typeof infoMessage;
declare const index_timestamp: typeof timestamp;
declare namespace index {
  export { index__dirname as _dirname, index_errorMessage as errorMessage, index_getModuleName as getModuleName, index_getOutputPath as getOutputPath, index_getVersions as getVersions, index_infoMessage as infoMessage, index_timestamp as timestamp };
}

interface BaseArgs {
    outputPath: string;
    config: RunnerConfig;
    folder?: string;
}
interface Args extends BaseArgs {
    source: string;
    type: ScannerType;
}
declare function scanner({ source, outputPath, config, type }: Args): Promise<void>;

declare const _default: {
    crawlFrom: string;
    includeSubComponents: boolean;
    exclude: string[];
    processors: (({ forEachComponent, sortObjectKeysByValue, output, }: SpiritAdoptionProcessorOptions) => unknown)[];
};

export { cli, constants, index as helpers, _default as reactScannerConfig, scanner };