104 lines
5.1 KiB
Plaintext
104 lines
5.1 KiB
Plaintext
import { TextDocument } from 'vscode-languageserver-textdocument';
|
|
import { CompletionList, Position, Range } from 'vscode-languageserver-types';
|
|
import { URI } from 'vscode-uri';
|
|
import { FileService, FileStat, FileType } from './fileService';
|
|
import { ExtractOptions, MarkupAbbreviation, Options, StylesheetAbbreviation, SyntaxType, UserConfig } from 'emmet';
|
|
import { SnippetsMap } from './configCompat';
|
|
export { FileService, FileType, FileStat };
|
|
/**
|
|
* Emmet configuration as derived from the Emmet related VS Code settings
|
|
*/
|
|
export interface VSCodeEmmetConfig {
|
|
showExpandedAbbreviation?: string;
|
|
showAbbreviationSuggestions?: boolean;
|
|
syntaxProfiles?: object;
|
|
variables?: object;
|
|
preferences?: object;
|
|
excludeLanguages?: string[];
|
|
showSuggestionsAsSnippets?: boolean;
|
|
}
|
|
/**
|
|
* Returns all applicable emmet expansions for abbreviation at given position in a CompletionList
|
|
* @param document TextDocument in which completions are requested
|
|
* @param position Position in the document at which completions are requested
|
|
* @param syntax Emmet supported language
|
|
* @param emmetConfig Emmet Configurations as derived from VS Code
|
|
*/
|
|
export declare function doComplete(document: TextDocument, position: Position, syntax: string, emmetConfig: VSCodeEmmetConfig): CompletionList | undefined;
|
|
export declare const emmetSnippetField: (index: number, placeholder: string) => string;
|
|
/** Returns whether or not syntax is a supported stylesheet syntax, like CSS */
|
|
export declare function isStyleSheet(syntax: string): boolean;
|
|
/** Returns the syntax type, either markup (e.g. for HTML) or stylesheet (e.g. for CSS) */
|
|
export declare function getSyntaxType(syntax: string): SyntaxType;
|
|
/** Returns the default syntax (html or css) to use for the snippets registry */
|
|
export declare function getDefaultSyntax(syntax: string): string;
|
|
/** Returns the default snippets that Emmet suggests */
|
|
export declare function getDefaultSnippets(syntax: string): SnippetsMap;
|
|
/**
|
|
* Extracts abbreviation from the given position in the given document
|
|
* @param document The TextDocument from which abbreviation needs to be extracted
|
|
* @param position The Position in the given document from where abbreviation needs to be extracted
|
|
* @param options The options to pass to the @emmetio/extract-abbreviation module
|
|
*/
|
|
export declare function extractAbbreviation(document: TextDocument, position: Position, options?: Partial<ExtractOptions>): {
|
|
abbreviation: string;
|
|
abbreviationRange: Range;
|
|
filter: string | undefined;
|
|
} | undefined;
|
|
/**
|
|
* Extracts abbreviation from the given text
|
|
* @param text Text from which abbreviation needs to be extracted
|
|
* @param syntax Syntax used to extract the abbreviation from the given text
|
|
*/
|
|
export declare function extractAbbreviationFromText(text: string, syntax: string): {
|
|
abbreviation: string;
|
|
filter: string | undefined;
|
|
} | undefined;
|
|
/**
|
|
* Returns a boolean denoting validity of given abbreviation in the context of given syntax
|
|
* Not needed once https://github.com/emmetio/atom-plugin/issues/22 is fixed
|
|
* @param syntax string
|
|
* @param abbreviation string
|
|
*/
|
|
export declare function isAbbreviationValid(syntax: string, abbreviation: string): boolean;
|
|
declare type ExpandOptionsConfig = {
|
|
type: SyntaxType;
|
|
options: Partial<Options>;
|
|
variables: SnippetsMap;
|
|
snippets: SnippetsMap;
|
|
syntax: string;
|
|
text: string | string[] | undefined;
|
|
maxRepeat: number;
|
|
};
|
|
/**
|
|
* Returns options to be used by emmet
|
|
*/
|
|
export declare function getExpandOptions(syntax: string, emmetConfig?: VSCodeEmmetConfig, filter?: string): ExpandOptionsConfig;
|
|
/**
|
|
* Parses given abbreviation using given options and returns a tree
|
|
* @param abbreviation string
|
|
* @param options options used by the emmet module to parse given abbreviation
|
|
*/
|
|
export declare function parseAbbreviation(abbreviation: string, options: UserConfig): StylesheetAbbreviation | MarkupAbbreviation;
|
|
/**
|
|
* Expands given abbreviation using given options
|
|
* @param abbreviation string or parsed abbreviation
|
|
* @param config options used by the @emmetio/expand-abbreviation module to expand given abbreviation
|
|
*/
|
|
export declare function expandAbbreviation(abbreviation: string | MarkupAbbreviation | StylesheetAbbreviation, config: UserConfig): string;
|
|
/**
|
|
* Updates customizations from snippets.json and syntaxProfiles.json files in the directory configured in emmet.extensionsPath setting
|
|
* @param emmetExtensionsPathSetting setting passed from emmet.extensionsPath. Supports multiple paths
|
|
*/
|
|
export declare function updateExtensionsPath(emmetExtensionsPathSetting: string[], fs: FileService, workspaceFolderPaths?: URI[], homeDir?: URI): Promise<void>;
|
|
/**
|
|
* Get the corresponding emmet mode for given vscode language mode
|
|
* Eg: jsx for typescriptreact/javascriptreact or pug for jade
|
|
* If the language is not supported by emmet or has been exlcuded via `exlcudeLanguages` setting,
|
|
* then nothing is returned
|
|
*
|
|
* @param language
|
|
* @param exlcudedLanguages Array of language ids that user has chosen to exlcude for emmet
|
|
*/
|
|
export declare function getEmmetMode(language: string, excludedLanguages?: string[]): string | undefined;
|