@schemastore/clang-format 0.0.5 → 0.0.6
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 +21 -21
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,12 +1,28 @@
|
|
|
1
|
-
#
|
|
2
|
-
|
|
1
|
+
# Type definitions for clang-format
|
|
2
|
+
|
|
3
|
+
## Installation
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
npm i @schemastore/clang-format
|
|
7
|
+
yarn add @schemastore/clang-format
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
## Summary
|
|
3
11
|
|
|
4
|
-
# Summary
|
|
5
12
|
This package contains type definitions for clang-format.
|
|
6
13
|
|
|
7
|
-
##
|
|
8
|
-
|
|
14
|
+
## Usage
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
import * as clang_format from '@schemastore/clang-format';
|
|
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/clang-format)
|
|
27
|
+
* Last updated: Fri, Jun 30, 2023, 21:03:58 GMT
|
|
12
28
|
* Dependencies: none
|
package/index.d.ts
CHANGED
|
@@ -114,7 +114,7 @@ export interface ClangFormatConfig {
|
|
|
114
114
|
/**
|
|
115
115
|
* clang-format 9
|
|
116
116
|
|
|
117
|
-
If a function call or braced initializer list doesn
|
|
117
|
+
If a function call or braced initializer list doesn't fit on a line, allow putting all arguments onto the next line, even if BinPackArguments is false.
|
|
118
118
|
*/
|
|
119
119
|
AllowAllArgumentsOnNextLine?: boolean;
|
|
120
120
|
/**
|
|
@@ -122,13 +122,13 @@ export interface ClangFormatConfig {
|
|
|
122
122
|
|
|
123
123
|
This option is deprecated in clang-format 15. See NextLine of PackConstructorInitializers.
|
|
124
124
|
|
|
125
|
-
If a constructor definition with a member initializer list doesn
|
|
125
|
+
If a constructor definition with a member initializer list doesn't fit on a single line, allow putting all member initializers onto the next line, if `ConstructorInitializerAllOnOneLineOrOnePerLine` is true. Note that this parameter has no effect if `ConstructorInitializerAllOnOneLineOrOnePerLine` is false.
|
|
126
126
|
*/
|
|
127
127
|
AllowAllConstructorInitializersOnNextLine?: boolean;
|
|
128
128
|
/**
|
|
129
129
|
* clang-format 3.3
|
|
130
130
|
|
|
131
|
-
If the function declaration doesn
|
|
131
|
+
If the function declaration doesn't fit on a line, allow putting all parameters of a function declaration onto the next line even if BinPackParameters is false.
|
|
132
132
|
*/
|
|
133
133
|
AllowAllParametersOfDeclarationOnNextLine?: boolean;
|
|
134
134
|
/**
|
|
@@ -208,13 +208,13 @@ export interface ClangFormatConfig {
|
|
|
208
208
|
/**
|
|
209
209
|
* clang-format 3.7
|
|
210
210
|
|
|
211
|
-
If false, a function call
|
|
211
|
+
If false, a function call's arguments will either be all on the same line or will have one line each.
|
|
212
212
|
*/
|
|
213
213
|
BinPackArguments?: boolean;
|
|
214
214
|
/**
|
|
215
215
|
* clang-format 3.7
|
|
216
216
|
|
|
217
|
-
If false, a function declaration
|
|
217
|
+
If false, a function declaration's or function definition's parameters will either all be on the same line or will have one line each.
|
|
218
218
|
*/
|
|
219
219
|
BinPackParameters?: boolean;
|
|
220
220
|
/**
|
|
@@ -301,7 +301,7 @@ export interface ClangFormatConfig {
|
|
|
301
301
|
* bool SplitEmptyNamespace If false, empty namespace body can be put on a single line. This option is used only if the opening brace of the namespace has already been wrapped, i.e. the AfterNamespace brace wrapping mode is set.
|
|
302
302
|
*/
|
|
303
303
|
SplitEmptyNamespace?: boolean;
|
|
304
|
-
[k: string]: unknown;
|
|
304
|
+
[k: string]: unknown | undefined;
|
|
305
305
|
};
|
|
306
306
|
/**
|
|
307
307
|
* clang-format 3.8
|
|
@@ -450,7 +450,7 @@ export interface ClangFormatConfig {
|
|
|
450
450
|
/**
|
|
451
451
|
* clang-format 5
|
|
452
452
|
|
|
453
|
-
If true, clang-format adds missing namespace end comments for short namespaces and fixes invalid existing ones. Short ones are controlled by
|
|
453
|
+
If true, clang-format adds missing namespace end comments for short namespaces and fixes invalid existing ones. Short ones are controlled by "ShortNamespaceLines".
|
|
454
454
|
*/
|
|
455
455
|
FixNamespaceComments?: boolean;
|
|
456
456
|
/**
|
|
@@ -482,22 +482,22 @@ export interface ClangFormatConfig {
|
|
|
482
482
|
Priority: number;
|
|
483
483
|
SortPriority?: number;
|
|
484
484
|
CaseSensitive?: boolean;
|
|
485
|
-
[k: string]: unknown;
|
|
485
|
+
[k: string]: unknown | undefined;
|
|
486
486
|
}[];
|
|
487
487
|
/**
|
|
488
488
|
* clang-format 7
|
|
489
489
|
|
|
490
490
|
Specify a regular expression of suffixes that are allowed in the file-to-main-include mapping.
|
|
491
|
-
When guessing whether a #include is the
|
|
492
|
-
For example, if configured to
|
|
491
|
+
When guessing whether a #include is the "main" include (to assign category 0, see above), use this regex of allowed suffixes to the header stem. A partial match is done, so that: - "" means "arbitrary suffix" - "$" means "no suffix"
|
|
492
|
+
For example, if configured to "(_test)?$", then a header a.h would be seen as the "main" include in both a.cc and a_test.cc.
|
|
493
493
|
*/
|
|
494
494
|
IncludeIsMainRegex?: string;
|
|
495
495
|
/**
|
|
496
496
|
* clang-format 7
|
|
497
497
|
|
|
498
|
-
Specify a regular expression for files being formatted that are allowed to be considered
|
|
499
|
-
By default, clang-format considers files as
|
|
500
|
-
By default, clang-format considers files as
|
|
498
|
+
Specify a regular expression for files being formatted that are allowed to be considered "main" in the file-to-main-include mapping.
|
|
499
|
+
By default, clang-format considers files as "main" only when they end with: .c, .cc, .cpp, .c++, .cxx, .m or .mm extensions. For these files a guessing of "main" include takes place (to assign category 0, see above). This config option allows for additional suffixes and extensions for files to be considered as "main".
|
|
500
|
+
By default, clang-format considers files as "main" only when they end with: .c, .cc, .cpp, .c++, .cxx, .m or .mm extensions. For these files a guessing of "main" include takes place (to assign category 0, see above). This config option allows for additional suffixes and extensions for files to be considered as "main".
|
|
501
501
|
*/
|
|
502
502
|
IncludeIsMainSourceRegex?: string;
|
|
503
503
|
/**
|
|
@@ -568,7 +568,7 @@ When false, goto labels are flushed left.
|
|
|
568
568
|
* clang-fomrat 15
|
|
569
569
|
Insert braces after control statements (if, else, for, do, and while) in C++ unless the control statements are inside macro definitions or the braces would enclose preprocessor directives.
|
|
570
570
|
|
|
571
|
-
Warning: Setting this option to true could lead to incorrect code formatting due to clang-format
|
|
571
|
+
Warning: Setting this option to true could lead to incorrect code formatting due to clang-format's lack of complete semantic information. As such, extra care should be taken to review code changes made by this option.
|
|
572
572
|
*/
|
|
573
573
|
InsertBraces?: boolean;
|
|
574
574
|
/**
|
|
@@ -768,7 +768,7 @@ If Never, lays out Objective-C protocol conformance list items onto individual l
|
|
|
768
768
|
|
|
769
769
|
The order in which the qualifiers appear. Order is an array that can contain any of the following.
|
|
770
770
|
|
|
771
|
-
Note: it MUST contain
|
|
771
|
+
Note: it MUST contain 'type'. Items to the left of 'type' will be placed to the left of the type and aligned in the order supplied. Items to the right of 'type' will be placed to the right of the type and aligned in the order supplied.
|
|
772
772
|
*/
|
|
773
773
|
QualifierOrder?: ("const" | "inline" | "static" | "constexpr" | "volatile" | "restrict" | "type")[];
|
|
774
774
|
/**
|
|
@@ -806,7 +806,7 @@ If Never, lays out Objective-C protocol conformance list items onto individual l
|
|
|
806
806
|
| "gnu"
|
|
807
807
|
| "inheritparentconfig";
|
|
808
808
|
EnclosingFunctions?: string[];
|
|
809
|
-
[k: string]: unknown;
|
|
809
|
+
[k: string]: unknown | undefined;
|
|
810
810
|
}[];
|
|
811
811
|
/**
|
|
812
812
|
* clang-format 13
|
|
@@ -827,7 +827,7 @@ If Never, lays out Objective-C protocol conformance list items onto individual l
|
|
|
827
827
|
|
|
828
828
|
WarningThis option will be renamed and expanded to support other styles.
|
|
829
829
|
|
|
830
|
-
Setting this option to true could lead to incorrect code formatting due to clang-format
|
|
830
|
+
Setting this option to true could lead to incorrect code formatting due to clang-format's lack of complete semantic information. As such, extra care should be taken to review code changes made by this option.
|
|
831
831
|
*/
|
|
832
832
|
RemoveBracesLLVM?: boolean;
|
|
833
833
|
/**
|
|
@@ -881,7 +881,7 @@ If Never, lays out Objective-C protocol conformance list items onto individual l
|
|
|
881
881
|
/**
|
|
882
882
|
* clang-format 4
|
|
883
883
|
|
|
884
|
-
If true, a space will be inserted after the
|
|
884
|
+
If true, a space will be inserted after the 'template' keyword.
|
|
885
885
|
*/
|
|
886
886
|
SpaceAfterTemplateKeyword?: boolean;
|
|
887
887
|
/**
|
|
@@ -976,7 +976,7 @@ If Never, lays out Objective-C protocol conformance list items onto individual l
|
|
|
976
976
|
* bool BeforeNonEmptyParentheses If true, put a space before opening parentheses only if the parentheses are not empty.
|
|
977
977
|
*/
|
|
978
978
|
BeforeNonEmptyParentheses?: boolean;
|
|
979
|
-
[k: string]: unknown;
|
|
979
|
+
[k: string]: unknown | undefined;
|
|
980
980
|
};
|
|
981
981
|
/**
|
|
982
982
|
* clang-format 7
|
|
@@ -1042,7 +1042,7 @@ This does not affect trailing block comments (/* - comments) as those commonly h
|
|
|
1042
1042
|
SpacesInLineCommentPrefix?: {
|
|
1043
1043
|
Minimum?: number;
|
|
1044
1044
|
Maximum?: number;
|
|
1045
|
-
[k: string]: unknown;
|
|
1045
|
+
[k: string]: unknown | undefined;
|
|
1046
1046
|
};
|
|
1047
1047
|
/**
|
|
1048
1048
|
* clang-format 3.7
|
|
@@ -1112,5 +1112,5 @@ For example: OpenSSL STACK_OF, BSD LIST_ENTRY.
|
|
|
1112
1112
|
For example: BOOST_PP_STRINGIZE
|
|
1113
1113
|
*/
|
|
1114
1114
|
WhitespaceSensitiveMacros?: string[];
|
|
1115
|
-
[k: string]: unknown;
|
|
1115
|
+
[k: string]: unknown | undefined;
|
|
1116
1116
|
}
|
package/package.json
CHANGED
|
@@ -7,8 +7,8 @@
|
|
|
7
7
|
"name": "@schemastore/clang-format",
|
|
8
8
|
"repository": "https://github.com/ffflorian/schemastore-updater/tree/main/schemas/clang-format",
|
|
9
9
|
"scripts": {},
|
|
10
|
-
"
|
|
10
|
+
"typeScriptVersion": "2.2",
|
|
11
11
|
"types": "index.d.ts",
|
|
12
|
-
"
|
|
13
|
-
"
|
|
14
|
-
}
|
|
12
|
+
"typesPublisherContentHash": "fcf217ef83867d4fc6575ced08f7368c2250e27f68746305df7bcb2085c8bbad",
|
|
13
|
+
"version": "0.0.6"
|
|
14
|
+
}
|