// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
// See LICENSE in the project root for license information.

import * as path from 'path';
import { JsonSchema, JsonFile, NewlineKind } from '@rushstack/node-core-library';
import { IConfigFile } from './IConfigFile';
import { DocGenMode } from './DocGenMode';
import { MarkdownHeadingLevel } from '../markdown/MarkdownHeadingLevel';

/**
 * Helper for loading the api-documenter.json file format.  Later when the schema is more mature,
 * this class will be used to represent the validated and normalized configuration, whereas `IConfigFile`
 * represents the raw JSON file structure.
 */
export class DocumenterConfig {
    public readonly configFilePath: string;
    public readonly configFile: IConfigFile;

    /**
     * Specifies what type of newlines API Documenter should use when writing output files.  By default, the output files
     * will be written with Windows-style newlines.
     */
    public readonly newlineKind: NewlineKind;

    /**
     * Specifies a custom URI root in case the documentation links should be customized.
     */
    public uriRoot?: string;

    /**
     * Specifies how packages must start to be included, so non matching package names are excluded.
     */
    public onlyPackagesStartingWith?: string | string[];

    /**
     * Specifies the log level to output.
     */
    public logLevel?: string;

    /**
     * Adds a fixed suffix to the output filenames.
     */
    public readonly outputFileNameSuffix?: string;

    /**
     * {@inheritDoc IConfigFile.mode}
     */
    public readonly rootHeadingLevel?: MarkdownHeadingLevel;

    /**
     * {@inheritDoc IConfigFile.mode}
     */
    public readonly mode?: DocGenMode;

    /**
     * The JSON Schema for API Extractor config file (api-extractor.schema.json).
     */
    public static readonly jsonSchema: JsonSchema = JsonSchema.fromFile(
        path.join(__dirname, '..', 'schemas', 'api-documenter.schema.json')
    );

    /**
     * The config file name "api-extractor.json".
     */
    public static readonly FILENAME: string = 'api-documenter.json';

    private constructor(filePath: string, configFile: IConfigFile) {
        this.configFilePath = filePath;
        this.configFile = configFile;

        switch (configFile.newlineKind) {
            case 'lf':
                this.newlineKind = NewlineKind.Lf;
                break;
            case 'os':
                this.newlineKind = NewlineKind.OsDefault;
                break;
            default:
                this.newlineKind = NewlineKind.CrLf;
                break;
        }

        this.uriRoot = configFile.uriRoot;
        this.onlyPackagesStartingWith = configFile.onlyPackagesStartingWith;
        this.outputFileNameSuffix = configFile.outputFileNameSuffix;
        this.logLevel = configFile.logLevel;
        this.mode = configFile.mode;
    }

    /**
     * Load and validate an api-documenter.json file.
     */
    public static loadFile(configFilePath: string): DocumenterConfig {
        const configFile: IConfigFile = JsonFile.loadAndValidate(configFilePath, DocumenterConfig.jsonSchema);

        return new DocumenterConfig(path.resolve(configFilePath), configFile);
    }
}