@schemastore/tsconfig 0.0.10 → 0.0.11
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/README.md +22 -6
- package/index.d.ts +66 -41
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,12 +1,28 @@
|
|
|
1
|
-
#
|
|
2
|
-
|
|
1
|
+
# Type definitions for tsconfig
|
|
2
|
+
|
|
3
|
+
## Installation
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
npm i @schemastore/tsconfig
|
|
7
|
+
yarn add @schemastore/tsconfig
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
## Summary
|
|
3
11
|
|
|
4
|
-
# Summary
|
|
5
12
|
This package contains type definitions for tsconfig.
|
|
6
13
|
|
|
7
|
-
##
|
|
8
|
-
|
|
14
|
+
## Usage
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
import * as tsconfig from '@schemastore/tsconfig';
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Note
|
|
21
|
+
|
|
22
|
+
The definitions were auto-generated by [schemastore-updater](https://github.com/ffflorian/schemastore-updater) using [`json-schema-to-typescript`](https://www.npmjs.com/package/json-schema-to-typescript).
|
|
9
23
|
|
|
10
24
|
## Additional Details
|
|
11
|
-
|
|
25
|
+
|
|
26
|
+
* [Schema source](https://github.com/SchemaStore/schemastore/tree/master/src/schemas/json/tsconfig)
|
|
27
|
+
* Last updated: Fri, Jun 30, 2023, 21:04:05 GMT
|
|
12
28
|
* Dependencies: none
|
package/index.d.ts
CHANGED
|
@@ -16,12 +16,20 @@ export type JSONSchemaForTheTypeScriptCompilerSConfigurationFile = CompilerOptio
|
|
|
16
16
|
|
|
17
17
|
export interface CompilerOptionsDefinition {
|
|
18
18
|
compilerOptions?: CompilerOptions;
|
|
19
|
-
[k: string]: unknown;
|
|
19
|
+
[k: string]: unknown | undefined;
|
|
20
20
|
}
|
|
21
21
|
/**
|
|
22
22
|
* Instructs the TypeScript compiler how to compile .ts files.
|
|
23
23
|
*/
|
|
24
24
|
export interface CompilerOptions {
|
|
25
|
+
/**
|
|
26
|
+
* Enable importing files with any extension, provided a declaration file is present.
|
|
27
|
+
*/
|
|
28
|
+
allowArbitraryExtensions?: boolean;
|
|
29
|
+
/**
|
|
30
|
+
* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set.
|
|
31
|
+
*/
|
|
32
|
+
allowImportingTsExtensions?: boolean;
|
|
25
33
|
/**
|
|
26
34
|
* No longer supported. In early versions, manually set the text encoding for reading files.
|
|
27
35
|
*/
|
|
@@ -30,6 +38,10 @@ export interface CompilerOptions {
|
|
|
30
38
|
* Enable constraints that allow a TypeScript project to be used with project references.
|
|
31
39
|
*/
|
|
32
40
|
composite?: boolean;
|
|
41
|
+
/**
|
|
42
|
+
* Conditions to set in addition to the resolver-specific defaults when resolving imports.
|
|
43
|
+
*/
|
|
44
|
+
customConditions?: string[];
|
|
33
45
|
/**
|
|
34
46
|
* Generate .d.ts files from TypeScript and JavaScript files in your project.
|
|
35
47
|
*/
|
|
@@ -125,7 +137,7 @@ export interface CompilerOptions {
|
|
|
125
137
|
| "NodeNext"
|
|
126
138
|
)
|
|
127
139
|
| {
|
|
128
|
-
[k: string]: unknown;
|
|
140
|
+
[k: string]: unknown | undefined;
|
|
129
141
|
}
|
|
130
142
|
) &
|
|
131
143
|
string;
|
|
@@ -133,9 +145,9 @@ export interface CompilerOptions {
|
|
|
133
145
|
* Specify how TypeScript looks up a file from a given module specifier.
|
|
134
146
|
*/
|
|
135
147
|
moduleResolution?: (
|
|
136
|
-
| ("
|
|
148
|
+
| ("classic" | "node" | "node16" | "nodenext" | "bundler")
|
|
137
149
|
| {
|
|
138
|
-
[k: string]: unknown;
|
|
150
|
+
[k: string]: unknown | undefined;
|
|
139
151
|
}
|
|
140
152
|
) &
|
|
141
153
|
string;
|
|
@@ -145,7 +157,7 @@ export interface CompilerOptions {
|
|
|
145
157
|
newLine?: (
|
|
146
158
|
| ("crlf" | "lf")
|
|
147
159
|
| {
|
|
148
|
-
[k: string]: unknown;
|
|
160
|
+
[k: string]: unknown | undefined;
|
|
149
161
|
}
|
|
150
162
|
) &
|
|
151
163
|
string;
|
|
@@ -273,10 +285,11 @@ export interface CompilerOptions {
|
|
|
273
285
|
| "ES2020"
|
|
274
286
|
| "ES2021"
|
|
275
287
|
| "ES2022"
|
|
288
|
+
| "ES2023"
|
|
276
289
|
| "ESNext"
|
|
277
290
|
)
|
|
278
291
|
| {
|
|
279
|
-
[k: string]: unknown;
|
|
292
|
+
[k: string]: unknown | undefined;
|
|
280
293
|
}
|
|
281
294
|
) &
|
|
282
295
|
string;
|
|
@@ -361,7 +374,7 @@ export interface CompilerOptions {
|
|
|
361
374
|
* Specify a set of entries that re-map imports to additional lookup locations.
|
|
362
375
|
*/
|
|
363
376
|
paths?: {
|
|
364
|
-
[k: string]: string[];
|
|
377
|
+
[k: string]: string[] | undefined;
|
|
365
378
|
};
|
|
366
379
|
/**
|
|
367
380
|
* Specify a list of language service plugins to include.
|
|
@@ -371,7 +384,7 @@ export interface CompilerOptions {
|
|
|
371
384
|
* Plugin name.
|
|
372
385
|
*/
|
|
373
386
|
name?: string;
|
|
374
|
-
[k: string]: unknown;
|
|
387
|
+
[k: string]: unknown | undefined;
|
|
375
388
|
}[];
|
|
376
389
|
/**
|
|
377
390
|
* Allow multiple folders to be treated as one when resolving modules.
|
|
@@ -486,43 +499,43 @@ export interface CompilerOptions {
|
|
|
486
499
|
| "ES2022.String"
|
|
487
500
|
)
|
|
488
501
|
| {
|
|
489
|
-
[k: string]: unknown;
|
|
502
|
+
[k: string]: unknown | undefined;
|
|
490
503
|
}
|
|
491
504
|
| {
|
|
492
|
-
[k: string]: unknown;
|
|
505
|
+
[k: string]: unknown | undefined;
|
|
493
506
|
}
|
|
494
507
|
| {
|
|
495
|
-
[k: string]: unknown;
|
|
508
|
+
[k: string]: unknown | undefined;
|
|
496
509
|
}
|
|
497
510
|
| {
|
|
498
|
-
[k: string]: unknown;
|
|
511
|
+
[k: string]: unknown | undefined;
|
|
499
512
|
}
|
|
500
513
|
| {
|
|
501
|
-
[k: string]: unknown;
|
|
514
|
+
[k: string]: unknown | undefined;
|
|
502
515
|
}
|
|
503
516
|
| {
|
|
504
|
-
[k: string]: unknown;
|
|
517
|
+
[k: string]: unknown | undefined;
|
|
505
518
|
}
|
|
506
519
|
| {
|
|
507
|
-
[k: string]: unknown;
|
|
520
|
+
[k: string]: unknown | undefined;
|
|
508
521
|
}
|
|
509
522
|
| {
|
|
510
|
-
[k: string]: unknown;
|
|
523
|
+
[k: string]: unknown | undefined;
|
|
511
524
|
}
|
|
512
525
|
| {
|
|
513
|
-
[k: string]: unknown;
|
|
526
|
+
[k: string]: unknown | undefined;
|
|
514
527
|
}
|
|
515
528
|
| {
|
|
516
|
-
[k: string]: unknown;
|
|
529
|
+
[k: string]: unknown | undefined;
|
|
517
530
|
}
|
|
518
531
|
| {
|
|
519
|
-
[k: string]: unknown;
|
|
532
|
+
[k: string]: unknown | undefined;
|
|
520
533
|
}
|
|
521
534
|
| {
|
|
522
|
-
[k: string]: unknown;
|
|
535
|
+
[k: string]: unknown | undefined;
|
|
523
536
|
}
|
|
524
537
|
| {
|
|
525
|
-
[k: string]: unknown;
|
|
538
|
+
[k: string]: unknown | undefined;
|
|
526
539
|
}
|
|
527
540
|
) &
|
|
528
541
|
string)[];
|
|
@@ -598,6 +611,14 @@ export interface CompilerOptions {
|
|
|
598
611
|
* Enable importing .json files
|
|
599
612
|
*/
|
|
600
613
|
resolveJsonModule?: boolean;
|
|
614
|
+
/**
|
|
615
|
+
* Use the package.json 'exports' field when resolving package imports.
|
|
616
|
+
*/
|
|
617
|
+
resolvePackageJsonExports?: boolean;
|
|
618
|
+
/**
|
|
619
|
+
* Use the package.json 'imports' field when resolving imports.
|
|
620
|
+
*/
|
|
621
|
+
resolvePackageJsonImports?: boolean;
|
|
601
622
|
/**
|
|
602
623
|
* Have recompiles in '--incremental' and '--watch' assume that changes within a file will only affect files directly depending on it. Requires TypeScript version 3.8 or later.
|
|
603
624
|
*/
|
|
@@ -618,14 +639,18 @@ export interface CompilerOptions {
|
|
|
618
639
|
* Opt a project out of multi-project reference checking when editing.
|
|
619
640
|
*/
|
|
620
641
|
disableSolutionSearching?: boolean;
|
|
621
|
-
|
|
642
|
+
/**
|
|
643
|
+
* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting.
|
|
644
|
+
*/
|
|
645
|
+
verbatimModuleSyntax?: boolean;
|
|
646
|
+
[k: string]: unknown | undefined;
|
|
622
647
|
}
|
|
623
648
|
export interface CompileOnSaveDefinition {
|
|
624
649
|
/**
|
|
625
650
|
* Enable Compile-on-Save for this project.
|
|
626
651
|
*/
|
|
627
652
|
compileOnSave?: boolean;
|
|
628
|
-
[k: string]: unknown;
|
|
653
|
+
[k: string]: unknown | undefined;
|
|
629
654
|
}
|
|
630
655
|
export interface TypeAcquisitionDefinition {
|
|
631
656
|
/**
|
|
@@ -644,16 +669,16 @@ export interface TypeAcquisitionDefinition {
|
|
|
644
669
|
* Specifies a list of type declarations to be excluded from auto type acquisition. Ex. ["jquery", "lodash"]
|
|
645
670
|
*/
|
|
646
671
|
exclude?: string[];
|
|
647
|
-
[k: string]: unknown;
|
|
672
|
+
[k: string]: unknown | undefined;
|
|
648
673
|
};
|
|
649
|
-
[k: string]: unknown;
|
|
674
|
+
[k: string]: unknown | undefined;
|
|
650
675
|
}
|
|
651
676
|
export interface ExtendsDefinition {
|
|
652
677
|
/**
|
|
653
|
-
* Path to base configuration file to inherit from
|
|
678
|
+
* Path to base configuration file to inherit from (requires TypeScript version 2.1 or later), or array of base files, with the rightmost files having the greater priority (requires TypeScript version 5.0 or later).
|
|
654
679
|
*/
|
|
655
|
-
extends?: string;
|
|
656
|
-
[k: string]: unknown;
|
|
680
|
+
extends?: string | string[];
|
|
681
|
+
[k: string]: unknown | undefined;
|
|
657
682
|
}
|
|
658
683
|
export interface WatchOptionsDefinition {
|
|
659
684
|
/**
|
|
@@ -688,9 +713,9 @@ export interface WatchOptionsDefinition {
|
|
|
688
713
|
* Remove a list of directories from the watch process.
|
|
689
714
|
*/
|
|
690
715
|
excludeDirectories?: string[];
|
|
691
|
-
[k: string]: unknown;
|
|
716
|
+
[k: string]: unknown | undefined;
|
|
692
717
|
};
|
|
693
|
-
[k: string]: unknown;
|
|
718
|
+
[k: string]: unknown | undefined;
|
|
694
719
|
}
|
|
695
720
|
export interface BuildOptionsDefinition {
|
|
696
721
|
buildOptions?: {
|
|
@@ -718,9 +743,9 @@ export interface BuildOptionsDefinition {
|
|
|
718
743
|
* Log paths used during the `moduleResolution` process.
|
|
719
744
|
*/
|
|
720
745
|
traceResolution?: boolean;
|
|
721
|
-
[k: string]: unknown;
|
|
746
|
+
[k: string]: unknown | undefined;
|
|
722
747
|
};
|
|
723
|
-
[k: string]: unknown;
|
|
748
|
+
[k: string]: unknown | undefined;
|
|
724
749
|
}
|
|
725
750
|
export interface TsNodeDefinition {
|
|
726
751
|
/**
|
|
@@ -848,7 +873,7 @@ export interface TsNodeDefinition {
|
|
|
848
873
|
| [
|
|
849
874
|
string,
|
|
850
875
|
{
|
|
851
|
-
[k: string]: unknown;
|
|
876
|
+
[k: string]: unknown | undefined;
|
|
852
877
|
}
|
|
853
878
|
]
|
|
854
879
|
| string;
|
|
@@ -856,9 +881,9 @@ export interface TsNodeDefinition {
|
|
|
856
881
|
* **DEPRECATED** Specify type-check is enabled (e.g. `transpileOnly == false`).
|
|
857
882
|
*/
|
|
858
883
|
typeCheck?: boolean;
|
|
859
|
-
[k: string]: unknown;
|
|
884
|
+
[k: string]: unknown | undefined;
|
|
860
885
|
};
|
|
861
|
-
[k: string]: unknown;
|
|
886
|
+
[k: string]: unknown | undefined;
|
|
862
887
|
}
|
|
863
888
|
/**
|
|
864
889
|
* Override certain paths to be compiled and executed as CommonJS or ECMAScript modules.
|
|
@@ -876,28 +901,28 @@ export interface TsNodeDefinition {
|
|
|
876
901
|
* tsconfig.json "module" options.
|
|
877
902
|
*/
|
|
878
903
|
export interface TsNodeModuleTypes {
|
|
879
|
-
[k: string]: unknown;
|
|
904
|
+
[k: string]: unknown | undefined;
|
|
880
905
|
}
|
|
881
906
|
export interface FilesDefinition {
|
|
882
907
|
/**
|
|
883
908
|
* If no 'files' or 'include' property is present in a tsconfig.json, the compiler defaults to including all files in the containing directory and subdirectories except those specified by 'exclude'. When a 'files' property is specified, only those files and those specified by 'include' are included.
|
|
884
909
|
*/
|
|
885
910
|
files?: string[];
|
|
886
|
-
[k: string]: unknown;
|
|
911
|
+
[k: string]: unknown | undefined;
|
|
887
912
|
}
|
|
888
913
|
export interface ExcludeDefinition {
|
|
889
914
|
/**
|
|
890
915
|
* Specifies a list of files to be excluded from compilation. The 'exclude' property only affects the files included via the 'include' property and not the 'files' property. Glob patterns require TypeScript version 2.0 or later.
|
|
891
916
|
*/
|
|
892
917
|
exclude?: string[];
|
|
893
|
-
[k: string]: unknown;
|
|
918
|
+
[k: string]: unknown | undefined;
|
|
894
919
|
}
|
|
895
920
|
export interface IncludeDefinition {
|
|
896
921
|
/**
|
|
897
922
|
* Specifies a list of glob patterns that match files to be included in compilation. If no 'files' or 'include' property is present in a tsconfig.json, the compiler defaults to including all files in the containing directory and subdirectories except those specified by 'exclude'. Requires TypeScript version 2.0 or later.
|
|
898
923
|
*/
|
|
899
924
|
include?: string[];
|
|
900
|
-
[k: string]: unknown;
|
|
925
|
+
[k: string]: unknown | undefined;
|
|
901
926
|
}
|
|
902
927
|
export interface ReferencesDefinition {
|
|
903
928
|
/**
|
|
@@ -908,7 +933,7 @@ export interface ReferencesDefinition {
|
|
|
908
933
|
* Path to referenced tsconfig or to folder containing tsconfig.
|
|
909
934
|
*/
|
|
910
935
|
path?: string;
|
|
911
|
-
[k: string]: unknown;
|
|
936
|
+
[k: string]: unknown | undefined;
|
|
912
937
|
}[];
|
|
913
|
-
[k: string]: unknown;
|
|
938
|
+
[k: string]: unknown | undefined;
|
|
914
939
|
}
|
package/package.json
CHANGED
|
@@ -7,8 +7,8 @@
|
|
|
7
7
|
"name": "@schemastore/tsconfig",
|
|
8
8
|
"repository": "https://github.com/ffflorian/schemastore-updater/tree/main/schemas/tsconfig",
|
|
9
9
|
"scripts": {},
|
|
10
|
-
"
|
|
10
|
+
"typeScriptVersion": "2.2",
|
|
11
11
|
"types": "index.d.ts",
|
|
12
|
-
"
|
|
13
|
-
"
|
|
14
|
-
}
|
|
12
|
+
"typesPublisherContentHash": "179a48b9d118e9d4b5e8db9b93833fcd46cb784d3cf68f2509e0f3b2ce6a82eb",
|
|
13
|
+
"version": "0.0.11"
|
|
14
|
+
}
|