@schemastore/tslint 0.0.12 → 0.0.13

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.
Files changed (3) hide show
  1. package/README.md +22 -6
  2. package/index.d.ts +57 -19
  3. package/package.json +4 -4
package/README.md CHANGED
@@ -1,12 +1,28 @@
1
- # Installation
2
- > `npm install --save @schemastore/tslint`
1
+ # Type definitions for tslint
2
+
3
+ ## Installation
4
+
5
+ ```
6
+ npm i @schemastore/tslint
7
+ yarn add @schemastore/tslint
8
+ ```
9
+
10
+ ## Summary
3
11
 
4
- # Summary
5
12
  This package contains type definitions for tslint.
6
13
 
7
- ## Details
8
- Files were exported from https://github.com/ffflorian/schemastore-updater/tree/main/schemas/tslint.
14
+ ## Usage
15
+
16
+ ```ts
17
+ import * as tslint from '@schemastore/tslint';
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
- * Last updated: Fri, Feb 24, 2023, 11:23:41 GMT
25
+
26
+ * [Schema source](https://github.com/SchemaStore/schemastore/tree/master/src/schemas/json/tslint)
27
+ * Last updated: Fri, Jun 30, 2023, 21:04:05 GMT
12
28
  * Dependencies: none
package/index.d.ts CHANGED
@@ -13,7 +13,7 @@ export type Rule = {
13
13
  * Severity level. Level "error" will cause exit code 2.
14
14
  */
15
15
  severity?: "default" | "error" | "warning" | "warn" | "off" | "none";
16
- [k: string]: unknown;
16
+ [k: string]: unknown | undefined;
17
17
  } & Rule1;
18
18
  export type Rule1 =
19
19
  | boolean
@@ -22,7 +22,7 @@ export type Rule1 =
22
22
  * Severity level. Level "error" will cause exit code 2.
23
23
  */
24
24
  severity?: "default" | "error" | "warning" | "warn" | "off" | "none";
25
- [k: string]: unknown;
25
+ [k: string]: unknown | undefined;
26
26
  }
27
27
  | [unknown, ...unknown[]];
28
28
  /**
@@ -3450,15 +3450,19 @@ export interface JSONSchemaForTheTSLintConfigurationFiles {
3450
3450
  * An array of globs. Any file matching these globs will not be linted. All exclude patterns are relative to the configuration file they were specified in.
3451
3451
  */
3452
3452
  exclude?: string[];
3453
- [k: string]: unknown;
3453
+ [k: string]: unknown | undefined;
3454
3454
  };
3455
- [k: string]: unknown;
3455
+ [k: string]: unknown | undefined;
3456
3456
  }
3457
3457
  export interface TsRules {
3458
3458
  /**
3459
3459
  * Enforces function overloads to be consecutive.
3460
3460
  */
3461
3461
  "adjacent-overload-signatures"?: (Rule & []) | [boolean];
3462
+ /**
3463
+ * Bans "// @ts-ignore" comments from being used.
3464
+ */
3465
+ "ban-ts-ignore"?: (Rule1 & []) | [boolean];
3462
3466
  /**
3463
3467
  * Requires using either 'T[]' or 'Array<T>' for arrays.
3464
3468
  */
@@ -3508,7 +3512,7 @@ export interface TsRules {
3508
3512
  boolean,
3509
3513
  {
3510
3514
  "ignore-rest-args"?: boolean;
3511
- [k: string]: unknown;
3515
+ [k: string]: unknown | undefined;
3512
3516
  }
3513
3517
  ];
3514
3518
  /**
@@ -3606,7 +3610,7 @@ export interface TsRules {
3606
3610
  */
3607
3611
  "no-var-requires"?: (Rule1 & []) | [boolean];
3608
3612
  /**
3609
- * Requires that private variables are marked as `readonly` if theyre never modified outside of the constructor.
3613
+ * Requires that private variables are marked as `readonly` if they're never modified outside of the constructor.
3610
3614
  */
3611
3615
  "prefer-readonly"?: (Rule1 & []) | [boolean, ..."only-inline-lambdas"[]];
3612
3616
  /**
@@ -3705,7 +3709,7 @@ export interface TsRules {
3705
3709
  boolean,
3706
3710
  {
3707
3711
  singleLine?: "always" | "never";
3708
- [k: string]: unknown;
3712
+ [k: string]: unknown | undefined;
3709
3713
  }
3710
3714
  ];
3711
3715
  /**
@@ -3716,7 +3720,11 @@ export interface TsRules {
3716
3720
  * Warns if an explicitly specified type argument is the default for that type parameter.
3717
3721
  */
3718
3722
  "use-default-type-parameter"?: (Rule1 & []) | [boolean];
3719
- [k: string]: unknown;
3723
+ /**
3724
+ * Prevents using the built-in Function constructor.
3725
+ */
3726
+ "function-constructor"?: (Rule1 & []) | [boolean];
3727
+ [k: string]: unknown | undefined;
3720
3728
  }
3721
3729
  export interface Rules {
3722
3730
  /**
@@ -3774,7 +3782,7 @@ export interface Rules {
3774
3782
  | {
3775
3783
  "ignore-words"?: string[];
3776
3784
  "ignore-pattern"?: string;
3777
- [k: string]: unknown;
3785
+ [k: string]: unknown | undefined;
3778
3786
  }
3779
3787
  )[]
3780
3788
  ];
@@ -3831,7 +3839,7 @@ export interface Rules {
3831
3839
  variables?: {
3832
3840
  visibilities?: "all" | "exported" | "internal";
3833
3841
  };
3834
- [k: string]: unknown;
3842
+ [k: string]: unknown | undefined;
3835
3843
  }
3836
3844
  )[]
3837
3845
  ];
@@ -3891,7 +3899,7 @@ export interface Rules {
3891
3899
  /**
3892
3900
  * @minItems 1
3893
3901
  */
3894
- [k: string]: [string, ...string[]];
3902
+ [k: string]: [string, ...string[]] | undefined;
3895
3903
  }
3896
3904
  | string[]
3897
3905
  )[]
@@ -4017,12 +4025,17 @@ export interface Rules {
4017
4025
  * Disallows `eval` function invocations.
4018
4026
  */
4019
4027
  "no-eval"?: (Rule1 & []) | [boolean];
4028
+ /**
4029
+ * Forbid for…in statements
4030
+ * https://palantir.github.io/tslint/rules/no-for-in/
4031
+ */
4032
+ "no-for-in"?: (Rule1 & []) | [boolean];
4020
4033
  /**
4021
4034
  * Disallows iterating over an array with a for-in loop.
4022
4035
  */
4023
4036
  "no-for-in-array"?: (Rule1 & []) | [boolean];
4024
4037
  /**
4025
- * Disallows importing modules that are not listed as dependency in the projects package.json.
4038
+ * Disallows importing modules that are not listed as dependency in the project's package.json.
4026
4039
  */
4027
4040
  "no-implicit-dependencies"?:
4028
4041
  | (Rule1 & [])
@@ -4048,6 +4061,11 @@ export interface Rules {
4048
4061
  * When no list of allowed values is specified, -1, 0 and 1 are allowed by default.
4049
4062
  */
4050
4063
  "no-magic-numbers"?: (Rule1 & []) | [boolean, ...number[]];
4064
+ /**
4065
+ * Forbid explicitly declared or implicitly returned union types with both null and undefined as members
4066
+ * https://palantir.github.io/tslint/rules/no-null-undefined-union/
4067
+ */
4068
+ "no-null-undefined-union"?: (Rule1 & []) | [boolean];
4051
4069
  /**
4052
4070
  * Disallows use of the `null` keyword literal.
4053
4071
  */
@@ -4215,6 +4233,11 @@ export interface Rules {
4215
4233
  * Prefer while loops instead of for loops without an initializer and incrementor.
4216
4234
  */
4217
4235
  "prefer-while"?: (Rule1 & []) | [boolean];
4236
+ /**
4237
+ * Force functions marked async contain an await or return statement
4238
+ * https://palantir.github.io/tslint/rules/no-async-without-await/
4239
+ */
4240
+ "no-async-without-await"?: (Rule1 & []) | [boolean];
4218
4241
  /**
4219
4242
  * Requires any function or method that returns a promise to be marked async.
4220
4243
  */
@@ -4315,7 +4338,7 @@ export interface Rules {
4315
4338
  | "check-postbrace"
4316
4339
  )[]
4317
4340
  ];
4318
- [k: string]: unknown;
4341
+ [k: string]: unknown | undefined;
4319
4342
  }
4320
4343
  export interface Items1 {
4321
4344
  order?:
@@ -8461,7 +8484,7 @@ export interface Items5 {
8461
8484
  name?: string;
8462
8485
  match: string;
8463
8486
  order: number;
8464
- [k: string]: unknown;
8487
+ [k: string]: unknown | undefined;
8465
8488
  }
8466
8489
  )[];
8467
8490
  "import-sources-order"?:
@@ -8571,7 +8594,7 @@ export interface Rules1 {
8571
8594
  | {
8572
8595
  "ignore-words"?: string[];
8573
8596
  "ignore-pattern"?: string;
8574
- [k: string]: unknown;
8597
+ [k: string]: unknown | undefined;
8575
8598
  }
8576
8599
  )[]
8577
8600
  ];
@@ -8628,7 +8651,7 @@ export interface Rules1 {
8628
8651
  variables?: {
8629
8652
  visibilities?: "all" | "exported" | "internal";
8630
8653
  };
8631
- [k: string]: unknown;
8654
+ [k: string]: unknown | undefined;
8632
8655
  }
8633
8656
  )[]
8634
8657
  ];
@@ -8688,7 +8711,7 @@ export interface Rules1 {
8688
8711
  /**
8689
8712
  * @minItems 1
8690
8713
  */
8691
- [k: string]: [string, ...string[]];
8714
+ [k: string]: [string, ...string[]] | undefined;
8692
8715
  }
8693
8716
  | string[]
8694
8717
  )[]
@@ -8814,12 +8837,17 @@ export interface Rules1 {
8814
8837
  * Disallows `eval` function invocations.
8815
8838
  */
8816
8839
  "no-eval"?: (Rule1 & []) | [boolean];
8840
+ /**
8841
+ * Forbid for…in statements
8842
+ * https://palantir.github.io/tslint/rules/no-for-in/
8843
+ */
8844
+ "no-for-in"?: (Rule1 & []) | [boolean];
8817
8845
  /**
8818
8846
  * Disallows iterating over an array with a for-in loop.
8819
8847
  */
8820
8848
  "no-for-in-array"?: (Rule1 & []) | [boolean];
8821
8849
  /**
8822
- * Disallows importing modules that are not listed as dependency in the projects package.json.
8850
+ * Disallows importing modules that are not listed as dependency in the project's package.json.
8823
8851
  */
8824
8852
  "no-implicit-dependencies"?:
8825
8853
  | (Rule1 & [])
@@ -8845,6 +8873,11 @@ export interface Rules1 {
8845
8873
  * When no list of allowed values is specified, -1, 0 and 1 are allowed by default.
8846
8874
  */
8847
8875
  "no-magic-numbers"?: (Rule1 & []) | [boolean, ...number[]];
8876
+ /**
8877
+ * Forbid explicitly declared or implicitly returned union types with both null and undefined as members
8878
+ * https://palantir.github.io/tslint/rules/no-null-undefined-union/
8879
+ */
8880
+ "no-null-undefined-union"?: (Rule1 & []) | [boolean];
8848
8881
  /**
8849
8882
  * Disallows use of the `null` keyword literal.
8850
8883
  */
@@ -9012,6 +9045,11 @@ export interface Rules1 {
9012
9045
  * Prefer while loops instead of for loops without an initializer and incrementor.
9013
9046
  */
9014
9047
  "prefer-while"?: (Rule1 & []) | [boolean];
9048
+ /**
9049
+ * Force functions marked async contain an await or return statement
9050
+ * https://palantir.github.io/tslint/rules/no-async-without-await/
9051
+ */
9052
+ "no-async-without-await"?: (Rule1 & []) | [boolean];
9015
9053
  /**
9016
9054
  * Requires any function or method that returns a promise to be marked async.
9017
9055
  */
@@ -9112,5 +9150,5 @@ export interface Rules1 {
9112
9150
  | "check-postbrace"
9113
9151
  )[]
9114
9152
  ];
9115
- [k: string]: unknown;
9153
+ [k: string]: unknown | undefined;
9116
9154
  }
package/package.json CHANGED
@@ -7,8 +7,8 @@
7
7
  "name": "@schemastore/tslint",
8
8
  "repository": "https://github.com/ffflorian/schemastore-updater/tree/main/schemas/tslint",
9
9
  "scripts": {},
10
- "typesPublisherContentHash": "9f5e19563c372ca4001cd1e492872074e08c121da2bdc3059a2d0119a22aed4b",
10
+ "typeScriptVersion": "2.2",
11
11
  "types": "index.d.ts",
12
- "version": "0.0.12",
13
- "typeScriptVersion": "2.2"
14
- }
12
+ "typesPublisherContentHash": "32e81635dd49340f06f0531b262e89d2bf73b91a11921f5d835d601cc269c382",
13
+ "version": "0.0.13"
14
+ }