@coderline/alphatab-language-server 1.8.1 → 1.8.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/server.d.ts CHANGED
@@ -1,24 +1,14 @@
1
- import type * as alphaTab from '@coderline/alphatab';
1
+ import type { AlphaTexExample } from './../../alphatex/src/types';
2
2
  import { BrowserMessageReader } from 'vscode-languageserver/lib/browser/main.js';
3
+ import type { MetadataTagDefinition } from './../../alphatex/src/types';
4
+ import type { ParameterDefinition } from './../../alphatex/src/types';
5
+ import type { ParameterValueDefinition } from './../../alphatex/src/types';
6
+ import type { PropertyDefinition as PropertyDefinition_2 } from './../../alphatex/src/types';
7
+ import type { SignatureDefinition } from './../../alphatex/src/types';
8
+ import type { WithDescription } from './../../alphatex/src/types';
9
+ import type { WithSignatures } from './../../alphatex/src/types';
3
10
 
4
- /**
5
- * An alphaTex example demonstrating the usage of elements.
6
- */
7
- export declare type AlphaTexExample = string | {
8
- /**
9
- * The options to apply when rendering the example
10
- */
11
- options?: alphaTab.json.SettingsJson;
12
- /**
13
- * The plain alphaTex code.
14
- */
15
- tex: string;
16
- /**
17
- * An alternative MDX code to use for extended documentation, mainly used for the
18
- * alphaTab website when advanced examples are needed.
19
- */
20
- websiteMdx?: string;
21
- };
11
+ export { AlphaTexExample }
22
12
 
23
13
  export declare const documentation: {
24
14
  structuralMetaData: Map<string, MetadataTagDefinition>;
@@ -35,111 +25,17 @@ export declare const documentation: {
35
25
  */
36
26
  export declare const languageConfiguration: any;
37
27
 
38
- /**
39
- * A definition for an alphaTex metadata tag
40
- */
41
- export declare interface MetadataTagDefinition extends WithSignatures {
42
- /**
43
- * The metadata tag (including the backslash)
44
- */
45
- tag: string;
46
- /**
47
- * A lookup containing the properties available for this metadata.
48
- * The key is the lowercase identifier of the property.
49
- */
50
- properties?: Map<string, PropertyDefinition_2>;
51
- }
28
+ export { MetadataTagDefinition }
52
29
 
53
- /**
54
- * Defines the details of a single parameter for a {@link SignatureDefinition}
55
- */
56
- export declare interface ParameterDefinition extends WithDescription {
57
- /**
58
- * The name of the parameter
59
- */
60
- name: string;
61
- /**
62
- * The mode used to parse this parameter.
63
- */
64
- parseMode: alphaTab.importer.alphaTex.ArgumentListParseTypesMode;
65
- /**
66
- * The node type for this parameter.
67
- */
68
- type: alphaTab.importer.alphaTex.AlphaTexNodeType | alphaTab.importer.alphaTex.AlphaTexNodeType[];
69
- /**
70
- * Whether to allow strings in place of identifiers and vice versa.
71
- */
72
- allowAllStringTypes?: boolean;
73
- /**
74
- * The default value of this parameter if not provided.
75
- */
76
- defaultValue?: unknown;
77
- /**
78
- * Whether the values list should only be used for providing completion items.
79
- * If set to true the parser will parse tokens of any value into the AST and
80
- * separately semantic errors have to be created.
81
- */
82
- valuesOnlyForCompletion?: true;
83
- /**
84
- * A list of possible values
85
- */
86
- values?: ParameterValueDefinition[];
87
- /**
88
- * A list of identifiers which are reserved and cannot be used for this parameter.
89
- */
90
- reservedIdentifiers?: string[];
91
- }
30
+ export { ParameterDefinition }
92
31
 
93
- /**
94
- * Describes an individual value for a specific parameter.
95
- */
96
- export declare interface ParameterValueDefinition extends WithDescription {
97
- /**
98
- * The name of the item
99
- */
100
- name: string;
101
- /**
102
- * The snippet to insert
103
- */
104
- snippet: string;
105
- /**
106
- * Whether this value has no code completion and mapping but for completeness on enum mappings
107
- */
108
- skip?: true;
109
- }
32
+ export { ParameterValueDefinition }
110
33
 
111
34
  declare type Port = ConstructorParameters<typeof BrowserMessageReader>[0];
112
35
 
113
- /**
114
- * The documentation for a property.
115
- */
116
- declare interface PropertyDefinition_2 extends WithSignatures {
117
- /**
118
- * The name of the property.
119
- */
120
- property: string;
121
- }
122
36
  export { PropertyDefinition_2 as PropertyDefinition }
123
37
 
124
- /**
125
- * Defines a signature for values which can be passed into the containing element
126
- * (e.g. metadata or properties)
127
- */
128
- export declare interface SignatureDefinition {
129
- /**
130
- * An additional description specific for this signature.
131
- */
132
- description?: string;
133
- /**
134
- * Whether parsing should be strict, meaning: single values can be without parenthesis
135
- * multiple values need parenthesis.
136
- */
137
- strict?: boolean;
138
- /**
139
- * The parameters which can be passed into this signature.
140
- */
141
- parameters: ParameterDefinition[];
142
- }
38
+ export { SignatureDefinition }
143
39
 
144
40
  /**
145
41
  * Starts a new language server communicating from a Node.js process with a parent Node.js.
@@ -159,50 +55,8 @@ export declare function startWebWorkerLanguageServer(readerPort: Port, writerPor
159
55
  */
160
56
  export declare const textMateGrammar: any;
161
57
 
162
- /**
163
- * Common props for elements with descriptions.
164
- */
165
- export declare interface WithDescription {
166
- /**
167
- * An optional long description, typically shown in the extended doc popup
168
- * shown on hovers and code completions.
169
- */
170
- longDescription?: string;
171
- /**
172
- * A short description, typically shown in the code completion box.
173
- */
174
- shortDescription: string;
175
- /**
176
- * If defined, the element is deprecated.
177
- */
178
- deprecated?: string;
179
- /**
180
- * Additional remarks relevant for this item.
181
- */
182
- remarks?: string;
183
- }
58
+ export { WithDescription }
184
59
 
185
- /**
186
- * Common props for documented elements.
187
- */
188
- export declare interface WithSignatures extends WithDescription {
189
- /**
190
- * A list of signatures defining all overloads which can be called for this element.
191
- */
192
- signatures: SignatureDefinition[];
193
- /**
194
- * The snippet to insert on autocompleting this item.
195
- */
196
- snippet: string;
197
- /**
198
- * One or more examples demonstrating the usage of this element.
199
- */
200
- examples: AlphaTexExample | AlphaTexExample[];
201
- /**
202
- * Whether this item is hidden from auto completes and the docs
203
- * (e.g. because of outdated mechanisms or aliases)
204
- */
205
- hidden?: true;
206
- }
60
+ export { WithSignatures }
207
61
 
208
62
  export { }