@dev-build-deploy/comment-it
Version:
Source File Comment Management Library
24 lines (23 loc) • 870 B
TypeScript
import { Language } from "./types";
/**
* Retrieve the language configuration for the provided file.
* NOTE: Filename matches have precedence over extension matches.
* @param file The file to retrieve the language for
* @returns The language configuration
*/
export declare function getLanguage(file: string): Language;
/**
* Extends the list of supported languages with the provided language.
* NOTES:
* - Adding any new language including overlapping filenames or extensions,
* will override any previously existing language (incl. defaults).
*
* @param language The language to add
*/
export declare function addLanguage(language: Language): void;
/**
* Determines if the provided file is supported by comment-it
* @param file The file to check
* @returns Whether the file is supported
*/
export declare function isSupported(file: string): boolean;