eslint-plugin-jsdoc 60.8.3 → 61.0.1
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/index-cjs.cjs +4 -4
- package/dist/index-cjs.cjs.map +1 -1
- package/dist/index.cjs +4 -4
- package/dist/index.cjs.map +1 -1
- package/dist/rules/typeFormatting.cjs +339 -7
- package/dist/rules/typeFormatting.cjs.map +1 -1
- package/dist/rules.d.ts +65 -1
- package/package.json +4 -4
- package/src/index-cjs.js +4 -4
- package/src/index.js +4 -4
- package/src/rules/typeFormatting.js +349 -7
- package/src/rules.d.ts +65 -1
package/src/rules.d.ts
CHANGED
|
@@ -2947,14 +2947,66 @@ export interface Rules {
|
|
|
2947
2947
|
* Determines how array generics are represented. Set to `angle` for the style `Array<type>` or `square` for the style `type[]`. Defaults to "square".
|
|
2948
2948
|
*/
|
|
2949
2949
|
arrayBrackets?: "angle" | "square";
|
|
2950
|
+
/**
|
|
2951
|
+
* The space character (if any) to use after return markers (`=>`). Defaults to " ".
|
|
2952
|
+
*/
|
|
2953
|
+
arrowFunctionPostReturnMarkerSpacing?: string;
|
|
2954
|
+
/**
|
|
2955
|
+
* The space character (if any) to use before return markers (`=>`). Defaults to " ".
|
|
2956
|
+
*/
|
|
2957
|
+
arrowFunctionPreReturnMarkerSpacing?: string;
|
|
2950
2958
|
/**
|
|
2951
2959
|
* Whether to enable the fixer. Defaults to `true`.
|
|
2952
2960
|
*/
|
|
2953
2961
|
enableFixer?: boolean;
|
|
2962
|
+
/**
|
|
2963
|
+
* The space character (if any) to use between function or class parameters. Defaults to " ".
|
|
2964
|
+
*/
|
|
2965
|
+
functionOrClassParameterSpacing?: string;
|
|
2966
|
+
/**
|
|
2967
|
+
* The space character (if any) to use after a generic expression in a function or class. Defaults to "".
|
|
2968
|
+
*/
|
|
2969
|
+
functionOrClassPostGenericSpacing?: string;
|
|
2970
|
+
/**
|
|
2971
|
+
* The space character (if any) to use after return markers (`:`). Defaults to "".
|
|
2972
|
+
*/
|
|
2973
|
+
functionOrClassPostReturnMarkerSpacing?: string;
|
|
2974
|
+
/**
|
|
2975
|
+
* The space character (if any) to use before return markers (`:`). Defaults to "".
|
|
2976
|
+
*/
|
|
2977
|
+
functionOrClassPreReturnMarkerSpacing?: string;
|
|
2978
|
+
/**
|
|
2979
|
+
* The space character (if any) to use between type parameters in a function or class. Defaults to " ".
|
|
2980
|
+
*/
|
|
2981
|
+
functionOrClassTypeParameterSpacing?: string;
|
|
2982
|
+
/**
|
|
2983
|
+
* The space character (if any) to use between elements in generics and tuples. Defaults to " ".
|
|
2984
|
+
*/
|
|
2985
|
+
genericAndTupleElementSpacing?: string;
|
|
2954
2986
|
/**
|
|
2955
2987
|
* Boolean value of whether to use a dot before the angled brackets of a generic (e.g., `SomeType.<AnotherType>`). Defaults to `false`.
|
|
2956
2988
|
*/
|
|
2957
2989
|
genericDot?: boolean;
|
|
2990
|
+
/**
|
|
2991
|
+
* The amount of spacing (if any) after the colon of a key-value or object-field pair. Defaults to " ".
|
|
2992
|
+
*/
|
|
2993
|
+
keyValuePostColonSpacing?: string;
|
|
2994
|
+
/**
|
|
2995
|
+
* The amount of spacing (if any) immediately after keys in a key-value or object-field pair. Defaults to "".
|
|
2996
|
+
*/
|
|
2997
|
+
keyValuePostKeySpacing?: string;
|
|
2998
|
+
/**
|
|
2999
|
+
* The amount of spacing (if any) after the optional operator (`?`) in a key-value or object-field pair. Defaults to "".
|
|
3000
|
+
*/
|
|
3001
|
+
keyValuePostOptionalSpacing?: string;
|
|
3002
|
+
/**
|
|
3003
|
+
* The amount of spacing (if any) after a variadic operator (`...`) in a key-value pair. Defaults to "".
|
|
3004
|
+
*/
|
|
3005
|
+
keyValuePostVariadicSpacing?: string;
|
|
3006
|
+
/**
|
|
3007
|
+
* The style of quotation mark for surrounding method names when quoted. Defaults to `double`
|
|
3008
|
+
*/
|
|
3009
|
+
methodQuotes?: "double" | "single";
|
|
2958
3010
|
/**
|
|
2959
3011
|
* A string indicating the whitespace to be added on each line preceding an
|
|
2960
3012
|
* object property-value field. Defaults to the empty string.
|
|
@@ -2990,6 +3042,18 @@ export interface Rules {
|
|
|
2990
3042
|
* Defaults to `false`.
|
|
2991
3043
|
*/
|
|
2992
3044
|
objectFieldSeparatorTrailingPunctuation?: boolean;
|
|
3045
|
+
/**
|
|
3046
|
+
* The space character (if any) to use between the equal signs of a default value. Defaults to " ".
|
|
3047
|
+
*/
|
|
3048
|
+
parameterDefaultValueSpacing?: string;
|
|
3049
|
+
/**
|
|
3050
|
+
* The space character (if any) to add after a method name. Defaults to "".
|
|
3051
|
+
*/
|
|
3052
|
+
postMethodNameSpacing?: string;
|
|
3053
|
+
/**
|
|
3054
|
+
* The space character (if any) to add after "new" in a constructor. Defaults to " ".
|
|
3055
|
+
*/
|
|
3056
|
+
postNewSpacing?: string;
|
|
2993
3057
|
/**
|
|
2994
3058
|
* Whether to apply the `objectFieldSeparator` (e.g., a semicolon) when there
|
|
2995
3059
|
* is only one property-value object field present. Defaults to `false`.
|
|
@@ -2997,7 +3061,7 @@ export interface Rules {
|
|
|
2997
3061
|
separatorForSingleObjectField?: boolean;
|
|
2998
3062
|
/**
|
|
2999
3063
|
* How string literals should be quoted (e.g., `"abc"`). Set to `single`
|
|
3000
|
-
* or `double`. Defaults to '
|
|
3064
|
+
* or `double`. Defaults to 'double'.
|
|
3001
3065
|
*/
|
|
3002
3066
|
stringQuotes?: "double" | "single";
|
|
3003
3067
|
/**
|