@vuedx/vue-virtual-textdocument
Advanced tools
A virtual filesystem to access blocks in SFC as files
An implementation of virtual filesystem for accessing blocks in a .vue file as independent files.
npm add @vuedx/vue-virtual-textdocument
Signature:
declare class AsyncDocumentStore<T> extends DocumentStore<T> {
constructor(resolve: (uri: string) => T | Promise<T | null> | null, normalize?: (uri: string) => string);
get(uri: string): T | null;
get(uri: string): Promise<T | null>;
}
Members:
Signature:
get(uri: string): T | null;
| Parameter | Type | Description |
|---|---|---|
| uri | string | - |
Signature:
get(uri: string): Promise<T | null>;
| Parameter | Type | Description |
|---|---|---|
| uri | string | - |
Signature:
declare class DocumentStore<T> {
constructor(resolve: (uri: string) => T | null, normalize?: (uri: string) => string);
all(): string[];
delete(uri: string): boolean;
dispose(): void;
get(uri: string): T | null;
protected getNormalizedUri(uri: string): string;
has(uri: string): boolean;
protected map: Map<string, T>;
normalize: (uri: string) => string;
protected resolve: (uri: string) => T | null;
protected reverseUriMap: Map<string, string>;
set(uri: string, document: T): void;
}
Members:
Signature:
all(): string[];
Signature:
delete(uri: string): boolean;
| Parameter | Type | Description |
|---|---|---|
| uri | string | - |
Signature:
dispose(): void;
Signature:
get(uri: string): T | null;
| Parameter | Type | Description |
|---|---|---|
| uri | string | - |
Signature:
protected getNormalizedUri(uri: string): string;
| Parameter | Type | Description |
|---|---|---|
| uri | string | - |
Signature:
has(uri: string): boolean;
| Parameter | Type | Description |
|---|---|---|
| uri | string | - |
Signature:
set(uri: string, document: T): void;
| Parameter | Type | Description |
|---|---|---|
| uri | string | - |
| document | T | - |
Signature:
declare class RenderFunctionTextDocument extends TransformedBlockTextDocument {
constructor(container: VueTextDocument, selector: Selector, transformed: TextDocument, source: TextDocument);
get ast(): CodegenResult['ast'] | undefined;
get contextCompletionsTriggerOffset(): number;
static create(options: CreateVirtualTextDocumentOptions): RenderFunctionTextDocument;
findExpression(offset: number, length: number): undefined | {
offset: number;
length: number;
};
protected generate(): string;
getAllGeneratedOffsetsAt(offset: number): undefined | Array<{
length: number;
offset: number;
}>;
getGeneratedOffsetAt(offset: number): undefined | {
length: number;
offset: number;
};
protected getKnownComponents(): Record<string, ComponentImport>;
getOriginalOffsetAt(offset: number): undefined | {
offset: number;
length: number;
};
isInGeneratedRange(offset: number): boolean;
isInTemplateIdentifierRange(offset: number): boolean;
get parserErrors(): CodegenResult['errors'];
get tagCompletionsTriggerOffset(): number;
toDisplayMappings(): string;
protected tryGenerate(): string;
}
Members:
Signature:
static create(options: CreateVirtualTextDocumentOptions): RenderFunctionTextDocument;
| Parameter | Type | Description |
|---|---|---|
| options | CreateVirtualTextDocumentOptions | - |
Signature:
findExpression(offset: number, length: number): undefined | {
offset: number;
length: number;
};
| Parameter | Type | Description |
|---|---|---|
| offset | number | - |
| length | number | - |
Signature:
protected generate(): string;
Signature:
getAllGeneratedOffsetsAt(offset: number): undefined | Array<{
length: number;
offset: number;
}>;
| Parameter | Type | Description |
|---|---|---|
| offset | number | - |
Signature:
getGeneratedOffsetAt(offset: number): undefined | {
length: number;
offset: number;
};
| Parameter | Type | Description |
|---|---|---|
| offset | number | - |
Signature:
protected getKnownComponents(): Record<string, ComponentImport>;
Signature:
getOriginalOffsetAt(offset: number): undefined | {
offset: number;
length: number;
};
| Parameter | Type | Description |
|---|---|---|
| offset | number | - |
Signature:
isInGeneratedRange(offset: number): boolean;
| Parameter | Type | Description |
|---|---|---|
| offset | number | - |
Signature:
isInTemplateIdentifierRange(offset: number): boolean;
| Parameter | Type | Description |
|---|---|---|
| offset | number | - |
Signature:
toDisplayMappings(): string;
Signature:
protected tryGenerate(): string;
Signature:
declare class TransformedBlockTextDocument extends VirtualTextDocument {
protected constructor(container: VueTextDocument, selector: Selector, transformed: TextDocument, source: TextDocument | VirtualTextDocument, _transform: (document: TransformedBlockTextDocument) => BlockTransformResult);
static create(options: CreateTransformedBlockTextDocumentOptions): TransformedBlockTextDocument;
protected refresh(): void;
transform(): BlockTransformResult;
tryGetGeneratedOffset(offset: number): number | undefined;
tryGetSourceOffset(offset: number): number | undefined;
}
Members:
Signature:
static create(options: CreateTransformedBlockTextDocumentOptions): TransformedBlockTextDocument;
| Parameter | Type | Description |
|---|---|---|
| options | CreateTransformedBlockTextDocumentOptions | - |
Signature:
protected refresh(): void;
Signature:
transform(): BlockTransformResult;
Signature:
tryGetGeneratedOffset(offset: number): number | undefined;
| Parameter | Type | Description |
|---|---|---|
| offset | number | - |
Signature:
tryGetSourceOffset(offset: number): number | undefined;
| Parameter | Type | Description |
|---|---|---|
| offset | number | - |
Signature:
declare class VirtualTextDocument extends ProxyTextDocument {
protected constructor(container: VueTextDocument, selector: Selector, doc: TextDocument);
readonly container: VueTextDocument;
static create(options: CreateVirtualTextDocumentOptions): VirtualTextDocument;
protected isDirty: boolean;
markDirty(): void;
protected refresh(): void;
readonly selector: Selector;
}
Members:
Signature:
static create(options: CreateVirtualTextDocumentOptions): VirtualTextDocument;
| Parameter | Type | Description |
|---|---|---|
| options | CreateVirtualTextDocumentOptions | - |
Signature:
markDirty(): void;
Signature:
protected refresh(): void;
Signature:
declare class VueTextDocument extends ProxyTextDocument {
constructor(doc: TextDocument, options?: VueTextDocumentOptions, parseOptions?: SFCParseOptions);
all(): VirtualTextDocument[];
blockAt(position: Position | number): SFCBlock | null | undefined;
static create(uri: string, languageId: string, version: number, content: string, options?: VueTextDocumentOptions, parseOptions?: SFCParseOptions): VueTextDocument;
protected createBlockDocument(selector: BlockSelector): VirtualTextDocument | undefined;
protected createInternalModuleDocument(): TransformedBlockTextDocument;
protected createModuleDocument(): TransformedBlockTextDocument;
protected createRenderDocument(): RenderFunctionTextDocument;
protected createTemplateASTDocument(): TransformedBlockTextDocument;
get descriptor(): SFCDescriptor;
documentAt(position: Position | number): VirtualTextDocument | undefined;
getBlock(selector: BlockSelector): SFCBlock | null | undefined;
getBlockSelector(block: SFCBlock): BlockSelector | undefined;
getDocument(selector: typeof RENDER_SELECTOR): RenderFunctionTextDocument;
getDocument(selector: SelectorLike): VirtualTextDocument;
getDocument(selector: string): VirtualTextDocument | undefined;
getDocumentFileName(selectorLike: SelectorLike): string;
protected getDocumentId(selector: Selector): string;
protected getDocumentLanguage(selector: Selector): string;
markDirty(): void;
readonly options: VueTextDocumentOptions;
protected parse(): void;
static update(document: VueTextDocument, changes: TextDocumentContentChangeEvent[], version: number): VueTextDocument;
}
Members:
Signature:
all(): VirtualTextDocument[];
Signature:
blockAt(position: Position | number): SFCBlock | null | undefined;
| Parameter | Type | Description |
|---|---|---|
| position | Position | number | - |
Signature:
static create(uri: string, languageId: string, version: number, content: string, options?: VueTextDocumentOptions, parseOptions?: SFCParseOptions): VueTextDocument;
| Parameter | Type | Description |
|---|---|---|
| uri | string | - |
| languageId | string | - |
| version | number | - |
| content | string | - |
| options | VueTextDocumentOptions | - |
| parseOptions | SFCParseOptions | - |
Signature:
protected createBlockDocument(selector: BlockSelector): VirtualTextDocument | undefined;
| Parameter | Type | Description |
|---|---|---|
| selector | BlockSelector | - |
Signature:
protected createInternalModuleDocument(): TransformedBlockTextDocument;
Signature:
protected createModuleDocument(): TransformedBlockTextDocument;
Signature:
protected createRenderDocument(): RenderFunctionTextDocument;
Signature:
protected createTemplateASTDocument(): TransformedBlockTextDocument;
Signature:
documentAt(position: Position | number): VirtualTextDocument | undefined;
| Parameter | Type | Description |
|---|---|---|
| position | Position | number | - |
Signature:
getBlock(selector: BlockSelector): SFCBlock | null | undefined;
| Parameter | Type | Description |
|---|---|---|
| selector | BlockSelector | - |
Signature:
getBlockSelector(block: SFCBlock): BlockSelector | undefined;
| Parameter | Type | Description |
|---|---|---|
| block | SFCBlock | - |
Signature:
getDocument(selector: typeof RENDER_SELECTOR): RenderFunctionTextDocument;
| Parameter | Type | Description |
|---|---|---|
| selector | typeof RENDER_SELECTOR | - |
Signature:
getDocument(selector: SelectorLike): VirtualTextDocument;
| Parameter | Type | Description |
|---|---|---|
| selector | SelectorLike | - |
Signature:
getDocument(selector: string): VirtualTextDocument | undefined;
| Parameter | Type | Description |
|---|---|---|
| selector | string | - |
Signature:
getDocumentFileName(selectorLike: SelectorLike): string;
| Parameter | Type | Description |
|---|---|---|
| selectorLike | SelectorLike | - |
Signature:
protected getDocumentId(selector: Selector): string;
| Parameter | Type | Description |
|---|---|---|
| selector | Selector | - |
Signature:
protected getDocumentLanguage(selector: Selector): string;
| Parameter | Type | Description |
|---|---|---|
| selector | Selector | - |
Signature:
markDirty(): void;
Signature:
protected parse(): void;
Signature:
static update(document: VueTextDocument, changes: TextDocumentContentChangeEvent[], version: number): VueTextDocument;
| Parameter | Type | Description |
|---|---|---|
| document | VueTextDocument | - |
| changes | TextDocumentContentChangeEvent[] | - |
| version | number | - |
Signature:
declare function asFsPath(uri: string): string;
| Parameter | Type | Description |
|---|---|---|
| uri | string | - |
Signature:
declare function asFsUri(fileName: string): string;
| Parameter | Type | Description |
|---|---|---|
| fileName | string | - |
Signature:
declare function asUri(fileNameOrUri: string): string;
| Parameter | Type | Description |
|---|---|---|
| fileNameOrUri | string | - |
Signature:
declare function basename(fileName: string): string;
| Parameter | Type | Description |
|---|---|---|
| fileName | string | - |
Signature:
declare function binarySearch<T>(array: T[], isMatch: (a: T) => number, returnMin?: boolean): T | undefined;
| Parameter | Type | Description |
|---|---|---|
| array | T[] | - |
| isMatch | (a: T) => number | - |
| returnMin | boolean | - |
Signature:
declare function getBlockLanguage(block?: SFCBlock | null): string;
| Parameter | Type | Description |
|---|---|---|
| block | SFCBlock | null | - |
Signature:
declare function getContainingFile(fileName: string): string;
| Parameter | Type | Description |
|---|---|---|
| fileName | string | - |
Signature:
declare function getLanguageExtension(lang: string): string;
| Parameter | Type | Description |
|---|---|---|
| lang | string | - |
Signature:
declare function getLanguageIdFromExtension(ext: string): string;
| Parameter | Type | Description |
|---|---|---|
| ext | string | - |
Signature:
declare function isOffsetInBlock(offset: number, block?: SFCBlock | null): boolean;
| Parameter | Type | Description |
|---|---|---|
| offset | number | - |
| block | SFCBlock | null | - |
Signature:
declare function isVirtualFile(fileName: string): boolean;
| Parameter | Type | Description |
|---|---|---|
| fileName | string | - |
Signature:
declare function isVirtualFileOfType(fileName: string, type: '_render' | '_module' | '_internal' | 'script' | 'scriptSetup'): boolean;
| Parameter | Type | Description |
|---|---|---|
| fileName | string | - |
| type | '_render' | '_module' | '_internal' | 'script' | 'scriptSetup' | - |
Signature:
declare function isVueFile(fileName: string): boolean;
| Parameter | Type | Description |
|---|---|---|
| fileName | string | - |
Signature:
declare function parseVirtualFileName(fileName: string): {
uri: string;
selector: Selector;
} | null;
| Parameter | Type | Description |
|---|---|---|
| fileName | string | - |
Signature:
declare function relativeVirtualImportPath(fileName: string): string;
| Parameter | Type | Description |
|---|---|---|
| fileName | string | - |
Signature:
declare function replaceSlashes(fileName: string): string;
| Parameter | Type | Description |
|---|---|---|
| fileName | string | - |
This package is part of VueDX project, maintained by Rahul Kadyan. You can 💖 sponsor him for continued development of this package and other VueDX tools.
FAQs
A virtual filesystem to access blocks in SFC as files
The npm package @vuedx/vue-virtual-textdocument receives a total of 2,631 weekly downloads. As such, @vuedx/vue-virtual-textdocument popularity was classified as popular.
We found that @vuedx/vue-virtual-textdocument demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.