@vuedx/vue-virtual-textdocument
A virtual filesystem to access blocks in SFC as files
$ cnpm install @vuedx/vue-virtual-textdocument
SYNC missed versions from
official npm registry.
Vue Virtual TextDocument
An implementation of virtual filesystem for accessing blocks in a .vue file as independent files.
npm add @vuedx/vue-virtual-textdocument
API
VueSFCDocument
<summary>More info</summary>
Signature:
export declare class VueSFCDocument implements TextDocument {
get blocks(): SFCBlock[];
static create(fileName: string, content: string, options?: Omit<CompileOptions, 'cache' | 'fileName'>, version?: number): VueSFCDocument;
get descriptor(): SFCDescriptor;
get errors(): Array<CompilerError | SyntaxError>;
get fileName(): string;
findGeneratedTextSpan(spanInOriginalText: TextSpan): TextSpan | null;
findMapping(positionType: 'original' | 'generated', position: Position, searchBias?: SourceMapBiasType): Mapping | null;
findOriginalTextSpan(spanInGeneratedText: TextSpan): TextSpan | null;
get generated(): TextDocument;
readonly generatedFileName: string;
generatedOffsetAt(offset: number): number | null;
generatedPositionFor(position: Position): Position | null;
getBlockAt(offset: number): SFCBlock | null;
getLineAndCharacterOfPosition(position: number): Position;
getSourceFile(fileName?: string): {
fileName: string;
readonly text: string;
lineMap: unknown;
getLineAndCharacterOfPosition: (position: number) => Position;
};
getText(range?: Range): string;
get languageId(): string;
get lineCount(): number;
lineMap: unknown | undefined;
get map(): string;
offsetAt(position: Position): number;
readonly options: Required<CompileOptions>;
get original(): TextDocument;
readonly originalFileName: string;
originalOffsetAt(offset: number): number | null;
originalPositionFor(position: Position): Position | null;
positionAt(offset: number): Position;
get snapshot(): VueToTsxSnapshot;
get templateAST(): RootNode | undefined;
get text(): string;
update(changes: TextDocumentContentChangeEvent[], version: number): void;
get uri(): string;
get version(): number;
}
Members:
create
Signature:
static create(fileName: string, content: string, options?: Omit<CompileOptions, 'cache' | 'fileName'>, version?: number): VueSFCDocument;
| Parameter | Type | Description |
|---|---|---|
| fileName | string |
- |
| content | string |
- |
| options | Omit<CompileOptions, 'cache' | 'fileName'> |
- |
| version | number |
- |
findGeneratedTextSpan
Signature:
findGeneratedTextSpan(spanInOriginalText: TextSpan): TextSpan | null;
| Parameter | Type | Description |
|---|---|---|
| spanInOriginalText | TextSpan |
- |
findMapping
Signature:
findMapping(positionType: 'original' | 'generated', position: Position, searchBias?: SourceMapBiasType): Mapping | null;
| Parameter | Type | Description |
|---|---|---|
| positionType | 'original' | 'generated' |
- |
| position | Position |
- |
| searchBias | SourceMapBiasType |
- |
findOriginalTextSpan
Signature:
findOriginalTextSpan(spanInGeneratedText: TextSpan): TextSpan | null;
| Parameter | Type | Description |
|---|---|---|
| spanInGeneratedText | TextSpan |
- |
generatedOffsetAt
Signature:
generatedOffsetAt(offset: number): number | null;
| Parameter | Type | Description |
|---|---|---|
| offset | number |
- |
generatedPositionFor
Signature:
generatedPositionFor(position: Position): Position | null;
| Parameter | Type | Description |
|---|---|---|
| position | Position |
- |
getBlockAt
Signature:
getBlockAt(offset: number): SFCBlock | null;
| Parameter | Type | Description |
|---|---|---|
| offset | number |
- |
getLineAndCharacterOfPosition
Signature:
getLineAndCharacterOfPosition(position: number): Position;
| Parameter | Type | Description |
|---|---|---|
| position | number |
- |
getSourceFile
Signature:
getSourceFile(fileName?: string): {
fileName: string;
readonly text: string;
lineMap: unknown;
getLineAndCharacterOfPosition: (position: number) => Position;
};
| Parameter | Type | Description |
|---|---|---|
| fileName | string |
- |
getText
Signature:
getText(range?: Range): string;
| Parameter | Type | Description |
|---|---|---|
| range | Range |
- |
offsetAt
Signature:
offsetAt(position: Position): number;
| Parameter | Type | Description |
|---|---|---|
| position | Position |
- |
originalOffsetAt
Signature:
originalOffsetAt(offset: number): number | null;
| Parameter | Type | Description |
|---|---|---|
| offset | number |
- |
originalPositionFor
Signature:
originalPositionFor(position: Position): Position | null;
| Parameter | Type | Description |
|---|---|---|
| position | Position |
- |
positionAt
Signature:
positionAt(offset: number): Position;
| Parameter | Type | Description |
|---|---|---|
| offset | number |
- |
update
Signature:
update(changes: TextDocumentContentChangeEvent[], version: number): void;
| Parameter | Type | Description |
|---|---|---|
| changes | TextDocumentContentChangeEvent[] |
- |
| version | number |
- |
Types
TextSpan
export interface TextSpan {
length: number;
start: number;
}
Support
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.
Current Tags
- 0.7.5-insiders-1630604709.0 ... insiders (5 years ago)
- 0.7.6 ... latest (3 years ago)
- 0.7.7-next-1667939290.0 ... next (3 years ago)
- 0.2.3 ... pnpm-temp (6 years ago)
155 Versions
- 0.7.7-next-1667939290.0 ... 3 years ago
- 0.7.7-next-1667938774.0 ... 3 years ago
- 0.7.7-next-1667925330.0 ... 3 years ago
- 0.7.7-next-1667576550.0 ... 3 years ago
- 0.7.7-next-1667540051.0 ... 3 years ago
- 0.7.6 ... 3 years ago
- 0.7.7-next-1667345594.0 ... 3 years ago
- 0.7.6-next-1667345249.0 ... 3 years ago
- 0.7.6-next-1667343481.0 ... 3 years ago
- 0.7.6-next-1667343140.0 ... 3 years ago
- 0.7.6-next-1666251997.0 ... 3 years ago
- 0.7.6-next-1666207395.0 ... 3 years ago
- 0.7.6-next-1666119500.0 ... 3 years ago
- 0.7.6-next-1665995999.0 ... 3 years ago
- 0.7.6-next-1665979403.0 ... 3 years ago
- 0.7.6-next-1665904926.0 ... 3 years ago
- 0.7.6-next-1665816659.0 ... 3 years ago
- 0.7.6-next-1664852417.0 ... 4 years ago
- 0.7.6-next-1664775821.0 ... 4 years ago
- 0.7.6-next-1664761915.0 ... 4 years ago
- 0.7.6-next-1663918844.0 ... 4 years ago
- 0.7.6-next-1663917928.0 ... 4 years ago
- 0.7.6-next-1651055813.0 ... 4 years ago
- 0.7.6-next-1651050089.0 ... 4 years ago
- 0.7.6-next-1651048177.0 ... 4 years ago
- 0.7.5 ... 4 years ago
- 0.7.5-next-1650753481.0 ... 4 years ago
- 0.7.5-next-1649663515.0 ... 4 years ago
- 0.7.5-next-1649655181.0 ... 4 years ago
- 0.7.5-next-1649654649.0 ... 4 years ago
- 0.7.5-next-1649653313.0 ... 4 years ago
- 0.7.5-next-1649614433.0 ... 4 years ago
- 0.7.5-next-1649585554.0 ... 4 years ago
- 0.7.5-next-1649583602.0 ... 4 years ago
- 0.7.5-next-1649578076.0 ... 4 years ago
- 0.7.5-next-1649577134.0 ... 4 years ago
- 0.7.5-next-1649493814.0 ... 4 years ago
- 0.7.5-next-1649398416.0 ... 4 years ago
- 0.7.5-next-1649388850.0 ... 4 years ago
- 0.7.5-next-1649381954.0 ... 4 years ago
- 0.7.5-next-1649315434.0 ... 4 years ago
- 0.7.5-next-1649228283.0 ... 4 years ago
- 0.7.5-next-1649225489.0 ... 4 years ago
- 0.7.5-next-1649087720.0 ... 4 years ago
- 0.7.5-next-1648824950.0 ... 4 years ago
- 0.7.5-next-1648822539.0 ... 4 years ago
- 0.7.5-next-1648440991.0 ... 4 years ago
- 0.7.5-next-1648411566.0 ... 4 years ago
- 0.7.5-next-1648409815.0 ... 4 years ago
- 0.7.5-next-1648400394.0 ... 4 years ago
- 0.7.5-next-1647933433.0 ... 4 years ago
- 0.7.5-next-1647768616.0 ... 4 years ago
- 0.7.5-next-1647674505.0 ... 4 years ago
- 0.7.5-next-1647442110.0 ... 4 years ago
- 0.7.5-next-1647274818.0 ... 4 years ago
- 0.7.5-next-1646814663.0 ... 4 years ago
- 0.7.5-next-1646032139.0 ... 4 years ago
- 0.7.5-insiders-1630604709.0 ... 5 years ago
- 0.7.5-insiders-1630601239.0 ... 5 years ago
- 0.7.5-insiders-1630600136.0 ... 5 years ago
- 0.7.5-insiders-1623402835.0 ... 5 years ago
- 0.7.5-insiders-1623394946.0 ... 5 years ago
- 0.7.4 ... 5 years ago
- 0.7.5-insiders-1623390917.0 ... 5 years ago
- 0.7.4-insiders-1623387961.0 ... 5 years ago
- 0.7.3 ... 5 years ago
- 0.7.3-insiders-1623384696.0 ... 5 years ago
- 0.7.3-insiders-1623383952.0 ... 5 years ago
- 0.7.3-insiders-1623383290.0 ... 5 years ago
- 0.7.3-insiders-1623262375.0 ... 5 years ago
- 0.7.2 ... 5 years ago
- 0.7.2-insiders-1623224804.0 ... 5 years ago
- 0.7.1 ... 5 years ago
- 0.7.0 ... 5 years ago
- 0.7.1-insiders-1623221784.0 ... 5 years ago
- 0.6.4-insiders-1611829384.0 ... 5 years ago
- 0.6.3 ... 5 years ago
- 0.6.2-insiders-1611564162.0 ... 5 years ago
- 0.6.1-insiders-1611498830.0 ... 5 years ago
- 0.6.1-insiders-1611324083.0 ... 5 years ago
- 0.6.1-insiders-1610911987.0 ... 5 years ago
- 0.6.1-insiders-1610891537.0 ... 5 years ago
- 0.6.0 ... 5 years ago
- 0.6.1-insiders-1610883378.0 ... 5 years ago
- 0.5.1-insiders-1610828338.0 ... 5 years ago
- 0.5.1-insiders-1610735282.0 ... 5 years ago
- 0.5.1-insiders-1610688008.0 ... 5 years ago
- 0.5.0 ... 5 years ago
- 0.5.1-insiders-1610450632.0 ... 5 years ago
- 0.4.2-insiders-1610448877.0 ... 5 years ago
- 0.4.2-insiders-1610169628.0 ... 5 years ago
- 0.4.2-insiders-1609960000.0 ... 5 years ago
- 0.4.2-insiders-1609479032.0 ... 5 years ago
- 0.4.2-insiders-1609436485.0 ... 5 years ago
- 0.4.2-insiders-1609385764.0 ... 5 years ago
- 0.4.2-insiders-1609376781.0 ... 5 years ago
- 0.4.2-insiders-1609376449.0 ... 5 years ago
- 0.4.1 ... 5 years ago
- 0.4.1-insiders-1609336775.0 ... 5 years ago
- 0.4.0 ... 5 years ago
- 0.4.1-insiders-1609180156.0 ... 5 years ago
- 0.3.1-insiders-1609155664.0 ... 5 years ago
- 0.3.1-insiders-1609034385.0 ... 5 years ago
- 0.3.1-insiders-1609032938.0 ... 5 years ago
- 0.3.1-insiders-1608682132.0 ... 5 years ago
- 0.3.1-insiders-1608679989.0 ... 5 years ago
- 0.3.1-insiders-1608679071.0 ... 5 years ago
- 0.3.1-insiders-1608642006.0 ... 5 years ago
- 0.3.1-insiders-1608632613.0 ... 5 years ago
- 0.3.1-insiders-1608294809.0 ... 5 years ago
- 0.3.1-insiders-1608285835.0 ... 5 years ago
- 0.3.1-insiders-1608281809.0 ... 5 years ago
- 0.3.1-insiders-1608185511.0 ... 5 years ago
- 0.3.1-insiders-1607632537.0 ... 5 years ago
- 0.3.1-insiders-1607631204.0 ... 5 years ago
- 0.3.1-insiders-1607577772.0 ... 5 years ago
- 0.3.1-insiders-1607576746.0 ... 5 years ago
- 0.3.1-insiders-1607576406.0 ... 5 years ago
- 0.3.1-insiders-1607543873.0 ... 5 years ago
- 0.3.1-insiders-1607121235.0 ... 5 years ago
- 0.3.1-insiders-1606884529.0 ... 5 years ago
- 0.3.1-insiders-1606467106.0 ... 5 years ago
- 0.3.1-insiders-1606311019.0 ... 5 years ago
- 0.3.1-insiders-1606300525.0 ... 5 years ago
- 0.3.1-insiders-1606101276.0 ... 5 years ago
- 0.3.1-insiders-1606047354.0 ... 5 years ago
- 0.3.1-insiders-1605961078.0 ... 5 years ago
- 0.3.1-insiders-1605496438.0 ... 5 years ago
- 0.3.1-insiders-1604891675.0 ... 5 years ago
- 0.3.1-insiders-1604576237.0 ... 5 years ago
- 0.3.1-insiders-1604106530.0 ... 5 years ago
- 0.2.4-0 ... 6 years ago
- 0.2.3 ... 6 years ago
- 0.2.2 ... 6 years ago
- 0.2.1 ... 6 years ago
- 0.2.0 ... 6 years ago
- 0.1.5 ... 6 years ago
- 0.1.4 ... 6 years ago
- 0.1.3 ... 6 years ago
- 0.1.2 ... 6 years ago
- 0.1.1 ... 6 years ago
- 0.1.0-alpha.13 ... 6 years ago
- 0.1.0-alpha.12 ... 6 years ago
- 0.1.0-alpha.11 ... 6 years ago
- 0.1.0-alpha.10 ... 6 years ago
- 0.1.0-alpha.9 ... 6 years ago
- 0.1.0-alpha.8 ... 6 years ago
- 0.1.0-alpha.7 ... 6 years ago
- 0.1.0-alpha.5 ... 6 years ago
- 0.1.0-alpha.4 ... 6 years ago
- 0.1.0-alpha.3 ... 6 years ago
- 0.1.0-alpha.2 ... 6 years ago
- 0.1.0-alpha.1 ... 6 years ago
- 0.1.0-alpha.0 ... 6 years ago
- 0.1.0 ... 6 years ago
Maintainers (1)
Downloads
Today
0
This Week
0
This Month
89
Last Day
0
Last Week
92
Last Month
45
Dependencies (8)
- @vuedx/compiler-sfc 0.7.2
- @vuedx/compiler-tsx 0.8.1
- @vuedx/shared 0.7.5
- @vuedx/template-ast-types 0.7.4
- @vuedx/transforms 0.7.6
- sourcemap-codec ^1.4.8
- vscode-languageserver-textdocument ^1.0.1
- vscode-uri ^2.1.2
Dev Dependencies (1)
- typescript ^4.6.3
Dependents (2)