Skip to content

Commit d11321b

Browse files
lishaducklishaduck
committed
feat: prefer satisfies operator
It gives better types and error messages.
1 parent 73e421e commit d11321b

File tree

7 files changed

+43
-43
lines changed

7 files changed

+43
-43
lines changed

‎apps/docs-website/docs/configuration.mdx

+32-32
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ import { defineFlatConfig } from "eslint-define-config";
5858

5959
// highlight-start
6060
// Sheriff configuration object
61-
const sheriffOptions: SheriffSettings = {
61+
const sheriffOptions = {
6262
react: false,
6363
next: false,
6464
astro: false,
@@ -67,7 +67,7 @@ const sheriffOptions: SheriffSettings = {
6767
playwright: false,
6868
jest: false,
6969
vitest: false,
70-
};
70+
} satisfies SheriffSettings;
7171
// highlight-end
7272

7373
export default defineFlatConfig([...sheriff(sheriffOptions)]);
@@ -98,7 +98,7 @@ const sheriffOptions = {
9898
playwright: false,
9999
jest: false,
100100
vitest: false,
101-
};
101+
} satisfies SheriffSettings;
102102

103103
export default defineFlatConfig([
104104
...sheriff(sheriffOptions),
@@ -118,7 +118,7 @@ export default defineFlatConfig([
118118
import sheriff, { type SheriffSettings } from "eslint-config-sheriff";
119119
import { defineFlatConfig } from "eslint-define-config";
120120

121-
const sheriffOptions: SheriffSettings = {
121+
const sheriffOptions = {
122122
react: false,
123123
next: false,
124124
astro: false,
@@ -127,7 +127,7 @@ const sheriffOptions: SheriffSettings = {
127127
playwright: false,
128128
jest: false,
129129
vitest: false,
130-
};
130+
} satisfies SheriffSettings;
131131

132132
export default defineFlatConfig([
133133
...sheriff(sheriffOptions),
@@ -161,7 +161,7 @@ const sheriffOptions = {
161161
playwright: false,
162162
jest: false,
163163
vitest: false,
164-
};
164+
} satisfies SheriffSettings;
165165

166166
export default defineFlatConfig([
167167
...sheriff(sheriffOptions),
@@ -181,7 +181,7 @@ export default defineFlatConfig([
181181
import sheriff, { type SheriffSettings } from "eslint-config-sheriff";
182182
import { defineFlatConfig } from "eslint-define-config";
183183

184-
const sheriffOptions: SheriffSettings = {
184+
const sheriffOptions = {
185185
react: false,
186186
next: false,
187187
astro: false,
@@ -190,7 +190,7 @@ const sheriffOptions: SheriffSettings = {
190190
playwright: false,
191191
jest: false,
192192
vitest: false,
193-
};
193+
} satisfies SheriffSettings;
194194

195195
export default defineFlatConfig([
196196
...sheriff(sheriffOptions),
@@ -263,7 +263,7 @@ const sheriffOptions = {
263263
recommended: true, // true by default. False to disable.
264264
},
265265
// highlight-end
266-
};
266+
} satisfies SheriffSettings;
267267

268268
export default defineFlatConfig([...sheriff(sheriffOptions)]);
269269
```
@@ -275,7 +275,7 @@ export default defineFlatConfig([...sheriff(sheriffOptions)]);
275275
import sheriff, { type SheriffSettings } from "eslint-config-sheriff";
276276
import { defineFlatConfig } from "eslint-define-config";
277277

278-
const sheriffOptions: SheriffSettings = {
278+
const sheriffOptions = {
279279
react: false,
280280
next: false,
281281
astro: false,
@@ -289,7 +289,7 @@ const sheriffOptions: SheriffSettings = {
289289
recommended: true, // true by default. False to disable.
290290
},
291291
// highlight-end
292-
};
292+
} satisfies SheriffSettings;
293293

294294
export default defineFlatConfig([...sheriff(sheriffOptions)]);
295295
```
@@ -324,7 +324,7 @@ const sheriffOptions = {
324324
inheritedFromGitignore: true, // true by default. False to disable.
325325
},
326326
// highlight-end
327-
};
327+
} satisfies SheriffSettings;
328328

329329
export default defineFlatConfig([...sheriff(sheriffOptions)]);
330330
```
@@ -336,7 +336,7 @@ export default defineFlatConfig([...sheriff(sheriffOptions)]);
336336
import sheriff, { type SheriffSettings } from "eslint-config-sheriff";
337337
import { defineFlatConfig } from "eslint-define-config";
338338

339-
const sheriffOptions: SheriffSettings = {
339+
const sheriffOptions = {
340340
react: false,
341341
next: false,
342342
astro: false,
@@ -350,7 +350,7 @@ const sheriffOptions: SheriffSettings = {
350350
inheritedFromGitignore: true, // true by default. False to disable.
351351
},
352352
// highlight-end
353-
};
353+
} satisfies SheriffSettings;
354354

355355
export default defineFlatConfig([...sheriff(sheriffOptions)]);
356356
```
@@ -405,7 +405,7 @@ const sheriffOptions = {
405405
// highlight-next-line
406406
tsconfigLocation: "./tsconfig.eslint.json",
407407
},
408-
};
408+
} satisfies SheriffSettings;
409409

410410
export default defineFlatConfig([...sheriff(sheriffOptions)]);
411411
```
@@ -417,7 +417,7 @@ export default defineFlatConfig([...sheriff(sheriffOptions)]);
417417
import sheriff, { type SheriffSettings } from "eslint-config-sheriff";
418418
import { defineFlatConfig } from "eslint-define-config";
419419

420-
const sheriffOptions: SheriffSettings = {
420+
const sheriffOptions = {
421421
react: false,
422422
next: false,
423423
astro: false,
@@ -430,7 +430,7 @@ const sheriffOptions: SheriffSettings = {
430430
// highlight-next-line
431431
tsconfigLocation: "./tsconfig.eslint.json",
432432
},
433-
};
433+
} satisfies SheriffSettings;
434434

435435
export default defineFlatConfig([...sheriff(sheriffOptions)]);
436436
```
@@ -477,7 +477,7 @@ const sheriffOptions = {
477477
],
478478
// highlight-end
479479
},
480-
};
480+
} satisfies SheriffSettings;
481481

482482
export default defineFlatConfig([...sheriff(sheriffOptions)]);
483483
```
@@ -489,7 +489,7 @@ export default defineFlatConfig([...sheriff(sheriffOptions)]);
489489
import sheriff, { type SheriffSettings } from "eslint-config-sheriff";
490490
import { defineFlatConfig } from "eslint-define-config";
491491

492-
const sheriffOptions: SheriffSettings = {
492+
const sheriffOptions = {
493493
react: false,
494494
next: false,
495495
astro: false,
@@ -507,7 +507,7 @@ const sheriffOptions: SheriffSettings = {
507507
],
508508
// highlight-end
509509
},
510-
};
510+
} satisfies SheriffSettings;
511511

512512
export default defineFlatConfig([...sheriff(sheriffOptions)]);
513513
```
@@ -554,7 +554,7 @@ const sheriffOptions = {
554554
],
555555
// highlight-end
556556
},
557-
};
557+
} satisfies SheriffSettings;
558558

559559
export default defineFlatConfig([...sheriff(sheriffOptions)]);
560560
```
@@ -566,7 +566,7 @@ export default defineFlatConfig([...sheriff(sheriffOptions)]);
566566
import sheriff, { type SheriffSettings } from "eslint-config-sheriff";
567567
import { defineFlatConfig } from "eslint-define-config";
568568

569-
const sheriffOptions: SheriffSettings = {
569+
const sheriffOptions = {
570570
react: false,
571571
next: false,
572572
astro: false,
@@ -584,7 +584,7 @@ const sheriffOptions: SheriffSettings = {
584584
],
585585
// highlight-end
586586
},
587-
};
587+
} satisfies SheriffSettings;
588588

589589
export default defineFlatConfig([...sheriff(sheriffOptions)]);
590590
```
@@ -623,7 +623,7 @@ const sheriffOptions = {
623623
playwright: false,
624624
jest: false,
625625
vitest: false,
626-
};
626+
} satisfies SheriffSettings;
627627

628628
export default defineFlatConfig([
629629
...sheriff(sheriffOptions),
@@ -647,7 +647,7 @@ export default defineFlatConfig([
647647
import sheriff, { type SheriffSettings } from "eslint-config-sheriff";
648648
import { defineFlatConfig } from "eslint-define-config";
649649

650-
const sheriffOptions: SheriffSettings = {
650+
const sheriffOptions = {
651651
react: false,
652652
next: false,
653653
astro: false,
@@ -656,7 +656,7 @@ const sheriffOptions: SheriffSettings = {
656656
playwright: false,
657657
jest: false,
658658
vitest: false,
659-
};
659+
} satisfies SheriffSettings;
660660

661661
export default defineFlatConfig([
662662
...sheriff(sheriffOptions),
@@ -699,7 +699,7 @@ const sheriffOptions = {
699699
playwright: false,
700700
jest: false,
701701
vitest: false
702-
};
702+
} satisfies SheriffSettings;
703703

704704
export default defineFlatConfig([
705705
...sheriff(sheriffOptions),
@@ -724,7 +724,7 @@ export default defineFlatConfig([
724724
import sheriff, { baseNoRestrictedSyntaxRules, type SheriffSettings } from "eslint-config-sheriff";
725725
import { defineFlatConfig } from "eslint-define-config";
726726

727-
const sheriffOptions: SheriffSettings = {
727+
const sheriffOptions = {
728728
react: false,
729729
next: false,
730730
astro: false,
@@ -733,7 +733,7 @@ const sheriffOptions: SheriffSettings = {
733733
playwright: false,
734734
jest: false,
735735
vitest: false
736-
};
736+
} satisfies SheriffSettings;
737737

738738
export default defineFlatConfig([
739739
...sheriff(sheriffOptions),
@@ -781,7 +781,7 @@ const sheriffOptions = {
781781
playwright: false,
782782
jest: false,
783783
vitest: false
784-
};
784+
} satisfies SheriffSettings;
785785

786786
export default defineFlatConfig([
787787
...sheriff(sheriffOptions),
@@ -805,7 +805,7 @@ export default defineFlatConfig([
805805
import sheriff, { type SheriffSettings } from "eslint-config-sheriff";
806806
import { defineFlatConfig } from "eslint-define-config";
807807

808-
const sheriffOptions: SheriffSettings = {
808+
const sheriffOptions = {
809809
react: false,
810810
next: false,
811811
astro: false,
@@ -814,7 +814,7 @@ const sheriffOptions: SheriffSettings = {
814814
playwright: false,
815815
jest: false,
816816
vitest: false
817-
};
817+
} satisfies SheriffSettings;
818818

819819
export default defineFlatConfig([
820820
...sheriff(sheriffOptions),

‎apps/docs-website/docs/migration-guide.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ export default defineFlatConfig([...sheriff(sheriffOptions)]);
5858
import sheriff, { type SheriffSettings } from "eslint-config-sheriff";
5959
import { defineFlatConfig } from "eslint-define-config";
6060

61-
const sheriffOptions: SheriffSettings = {
61+
const sheriffOptions = {
6262
// highlight-next-line
6363
files: ["./src/**/*"], // Only the files in the src directory will be linted.
6464
react: false,
@@ -69,7 +69,7 @@ const sheriffOptions: SheriffSettings = {
6969
playwright: false,
7070
jest: false,
7171
vitest: false,
72-
};
72+
} satisfies SheriffSettings;
7373

7474
export default defineFlatConfig([...sheriff(sheriffOptions)]);
7575
```

‎apps/docs-website/docs/performance-considerations.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ import process from 'node:process';
8383
import sheriff, { type SheriffSettings } from "eslint-config-sheriff";
8484
import { defineFlatConfig } from "eslint-define-config";
8585

86-
const sheriffOptions: SheriffSettings = {
86+
const sheriffOptions = {
8787
react: false,
8888
next: false,
8989
astro: false,
@@ -92,7 +92,7 @@ const sheriffOptions: SheriffSettings = {
9292
playwright: false,
9393
jest: false,
9494
vitest: false,
95-
};
95+
} satisfies SheriffSettings;
9696

9797
export default defineFlatConfig([
9898
...sheriff(sheriffOptions),

‎apps/docs-website/docs/setup/manual-setup.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Follow these steps:
7878
import sheriff, { type SheriffSettings } from "eslint-config-sheriff";
7979
import { defineFlatConfig } from "eslint-define-config";
8080

81-
const sheriffOptions: SheriffSettings = {
81+
const sheriffOptions = {
8282
react: false,
8383
next: false,
8484
astro: false,
@@ -87,7 +87,7 @@ Follow these steps:
8787
playwright: false,
8888
jest: false,
8989
vitest: false,
90-
};
90+
} satisfies SheriffSettings;
9191

9292
export default defineFlatConfig([...sheriff(sheriffOptions)]);
9393
```

‎packages/sheriff-cli/src/utils/getEslintConfigRawText.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ export const getEslintConfigRawText = async (
2121
ts: `import sheriff, { type SheriffSettings } from 'eslint-config-sheriff';
2222
import { defineFlatConfig } from 'eslint-define-config';
2323
24-
const sheriffOptions: SheriffSettings = ${JSON.stringify(
24+
const sheriffOptions = ${JSON.stringify(
2525
sheriffConfig,
2626
null,
2727
2,
28-
)};
28+
)} satisfies SheriffSettings;
2929
3030
export default defineFlatConfig([...sheriff(sheriffOptions)]);`,
3131

‎packages/sheriff-constants/src/index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ export const ignores = [
4545
'**/build/**',
4646
'**/artifacts/**',
4747
'**/coverage/**',
48-
'eslint.config.{js,mjs,cjs}', // we currently cannot lint the eslint.config.js itself. It is currently only provided as a .js file and this config currently only supports .ts files. Therefore, eslint.config.js can only be re-enabled once this config support pure .js files too, or the ESLint team support the eslint.config.ts file.
48+
'eslint.config.{js,mjs,cjs}', // We currently cannot lint the `eslint.config.js` itself. Sheriff currently only supports `.ts` files. Therefore, `eslint.config.js` can only be re-enabled once this config supports pure `.js` files too.
4949
] as const;
5050

5151
export const baseNoRestrictedSyntaxRules = [

‎packages/sheriff-create-config/src/utils/getEslintConfigRawText.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ export const getEslintConfigRawText = async (
2121
ts: `import sheriff, { type SheriffSettings } from 'eslint-config-sheriff';
2222
import { defineFlatConfig } from 'eslint-define-config';
2323
24-
const sheriffOptions: SheriffSettings = ${JSON.stringify(
24+
const sheriffOptions = ${JSON.stringify(
2525
sheriffConfig,
2626
null,
2727
2,
28-
)};
28+
)} satisfies SheriffSettings;
2929
3030
export default defineFlatConfig([...sheriff(sheriffOptions)]);`,
3131

0 commit comments

Comments
 (0)