fix: support eslint-plugin-perfectionist@3 (#1596)

## PR Checklist

- [x] Addresses an existing open issue: fixes #1588
- [x] That issue was marked as [`status: accepting
prs`](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- [x] Steps in
[CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/CONTRIBUTING.md)
were taken

## Overview

Bumps to `eslint-plugin-perfection@3` and runs `pnpm lint --fix` for all
its behavior differences.

💖

Author: JoshuaKGoldberg

eslint.config.js

@@ -15,7 +15,7 @@ import jsonc from "eslint-plugin-jsonc";
 import markdown from "eslint-plugin-markdown";
 import n from "eslint-plugin-n";
 import packageJson from "eslint-plugin-package-json/configs/recommended";
-import perfectionistNatural from "eslint-plugin-perfectionist/configs/recommended-natural";
+import perfectionist from "eslint-plugin-perfectionist";
 import * as regexp from "eslint-plugin-regexp";
 import vitest from "eslint-plugin-vitest";
 import yml from "eslint-plugin-yml";
@@ -45,7 +45,7 @@ export default tseslint.config(
 	jsdoc.configs["flat/recommended-typescript-error"],
 	n.configs["flat/recommended"],
 	packageJson,
-	perfectionistNatural,
+	perfectionist.configs["recommended-natural"],
 	regexp.configs["flat/recommended"],
 	...tseslint.config({
 		extends: [
@@ -99,7 +99,7 @@ export default tseslint.config(
 				"error",
 				{
 					order: "asc",
-					"partition-by-comment": true,
+					partitionByComment: true,
 					type: "natural",
 				},
 			],

package.json

@@ -81,7 +81,7 @@
 		"eslint-plugin-markdown": "^5.0.0",
 		"eslint-plugin-n": "^17.3.1",
 		"eslint-plugin-package-json": "^0.15.0",
-		"eslint-plugin-perfectionist": "^2.9.0",
+		"eslint-plugin-perfectionist": "^3.1.2",
 		"eslint-plugin-regexp": "^2.5.0",
 		"eslint-plugin-vitest": "^0.5.3",
 		"eslint-plugin-yml": "^1.14.0",

pnpm-lock.yaml

@@ -1,5 +1,5 @@
 import chalk from "chalk";
-import { MockInstance, beforeEach, describe, expect, it, vi } from "vitest";
+import { beforeEach, describe, expect, it, MockInstance, vi } from "vitest";
 
 import { logHelpText } from "./help.js";
 

src/bin/help.test.ts

@@ -1,5 +1,5 @@
 import chalk from "chalk";
-import { MockInstance, beforeEach, describe, expect, it, vi } from "vitest";
+import { beforeEach, describe, expect, it, MockInstance, vi } from "vitest";
 
 import { outro } from "./outro.js";
 

src/shared/cli/outro.test.ts

@@ -1,5 +1,5 @@
 import { Octokit } from "octokit";
-import { MockInstance, describe, expect, it, vi } from "vitest";
+import { describe, expect, it, MockInstance, vi } from "vitest";
 
 import { doesRepositoryExist } from "./doesRepositoryExist.js";
 

src/shared/doesRepositoryExist.test.ts

@@ -1,5 +1,5 @@
 import chalk from "chalk";
-import { MockInstance, beforeEach, describe, expect, it, vi } from "vitest";
+import { beforeEach, describe, expect, it, MockInstance, vi } from "vitest";
 
 import { getGitHubUserAsAllContributor } from "./getGitHubUserAsAllContributor.js";
 

src/shared/getGitHubUserAsAllContributor.test.ts

@@ -4,8 +4,8 @@ import chalk from "chalk";
 import { filterPromptCancel } from "../prompts.js";
 import { Options, OptionsBase } from "../types.js";
 import {
-	ExclusionKey,
 	exclusionDescriptions,
+	ExclusionKey,
 	exclusionKeys,
 	getExclusions,
 } from "./exclusionKeys.js";

src/shared/options/augmentOptionsWithExcludes.ts

@@ -11,7 +11,7 @@ import { createOptionDefaults } from "./createOptionDefaults/index.js";
 import { detectEmailRedundancy } from "./detectEmailRedundancy.js";
 import { ensureRepositoryExists } from "./ensureRepositoryExists.js";
 import { getBase } from "./getBase.js";
-import { GitHub, getGitHub } from "./getGitHub.js";
+import { getGitHub, GitHub } from "./getGitHub.js";
 import { getPrefillOrPromptedOption } from "./getPrefillOrPromptedOption.js";
 import { logInferredOptions } from "./logInferredOptions.js";
 import { optionsSchema } from "./optionsSchema.js";

src/shared/options/readOptions.ts

@@ -1,5 +1,5 @@
 import * as prompts from "@clack/prompts";
 
-export function filterPromptCancel<Value>(value: Value | symbol) {
+export function filterPromptCancel<Value>(value: symbol | Value) {
 	return prompts.isCancel(value) ? undefined : value;
 }

src/shared/prompts.ts

@@ -1,6 +1,6 @@
 import * as fs from "node:fs/promises";
 
-export async function readFileSafe(filePath: URL | string, fallback: string) {
+export async function readFileSafe(filePath: string | URL, fallback: string) {
 	try {
 		return (await fs.readFile(filePath)).toString();
 	} catch {

src/shared/readFileSafe.ts

@@ -1,5 +1,5 @@
 import { readFileSafe } from "./readFileSafe.js";
 
-export async function readFileSafeAsJson(filePath: URL | string) {
+export async function readFileSafeAsJson(filePath: string | URL) {
 	return JSON.parse(await readFileSafe(filePath, "null")) as unknown;
 }

src/shared/readFileSafeAsJson.ts

@@ -1,5 +1,5 @@
 import { Octokit } from "octokit";
-import { MockInstance, describe, expect, it, vi } from "vitest";
+import { describe, expect, it, MockInstance, vi } from "vitest";
 
 import { Options } from "../shared/types.js";
 import { initializeBranchProtectionSettings } from "./initializeGitHubRepository/initializeBranchProtectionSettings.js";

src/steps/initializeBranchProtectionSettings.test.ts

@@ -1,8 +1,8 @@
 import { $ } from "execa";
 
 import {
-	GhLabelData,
 	getExistingEquivalentLabels,
+	GhLabelData,
 } from "./getExistingEquivalentLabels.js";
 import { outcomeLabels } from "./outcomeLabels.js";
 

src/steps/initializeGitHubRepository/labels/initializeRepositoryLabels.ts

@@ -115,7 +115,7 @@ describe("createESLintConfig", () => {
 				import markdown from "eslint-plugin-markdown";
 				import n from "eslint-plugin-n";
 				import packageJson from "eslint-plugin-package-json/configs/recommended";
-				import perfectionistNatural from "eslint-plugin-perfectionist/configs/recommended-natural";
+				import perfectionist from "eslint-plugin-perfectionist";
 				import * as regexp from "eslint-plugin-regexp";
 				import vitest from "eslint-plugin-vitest";
 				import yml from "eslint-plugin-yml";
@@ -145,7 +145,7 @@ describe("createESLintConfig", () => {
 				  jsdoc.configs["flat/recommended-typescript-error"],
 				  n.configs["flat/recommended"],
 				  packageJson,
-				  perfectionistNatural,
+				  perfectionist.configs["recommended-natural"],
 				  regexp.configs["flat/recommended"],
 				  ...tseslint.config({
 				    extends: [
@@ -185,7 +185,7 @@ describe("createESLintConfig", () => {
 				        "error",
 				        {
 				          order: "asc",
-				          "partition-by-comment": true,
+				          partitionByComment: true,
 				          type: "natural",
 				        },
 				      ],

src/steps/writing/creation/createESLintConfig.test.ts

@@ -15,7 +15,7 @@ export async function createESLintConfig(options: Options) {
 		!options.excludeLintPackageJson &&
 			`import packageJson from "eslint-plugin-package-json/configs/recommended";`,
 		!options.excludeLintPerfectionist &&
-			`import perfectionistNatural from "eslint-plugin-perfectionist/configs/recommended-natural";`,
+			`import perfectionist from "eslint-plugin-perfectionist";`,
 		!options.excludeLintRegex &&
 			`import * as regexp from "eslint-plugin-regexp";`,
 		!options.excludeTests && `import vitest from "eslint-plugin-vitest";`,
@@ -35,7 +35,8 @@ export async function createESLintConfig(options: Options) {
 			`	jsdoc.configs["flat/recommended-typescript-error"],`,
 		`	n.configs["flat/recommended"],`,
 		!options.excludeLintPackageJson && `	packageJson,`,
-		!options.excludeLintPerfectionist && `	perfectionistNatural,`,
+		!options.excludeLintPerfectionist &&
+			`	perfectionist.configs["recommended-natural"],`,
 		!options.excludeLintRegex && `	regexp.configs["flat/recommended"],`,
 	].filter(Boolean);
 
@@ -122,7 +123,7 @@ export default tseslint.config(
 				"error",
 				{
 					order: "asc",
-					"partition-by-comment": true,
+					partitionByComment: true,
 					type: "natural",
 				},
 			],`

src/steps/writing/creation/createESLintConfig.ts

@@ -56,7 +56,7 @@ interface WorkflowFileOptionsBase {
 }
 
 interface WorkflowFileOptionsRuns extends WorkflowFileOptionsBase {
-	runs: (WorkflowFileStep | string)[];
+	runs: (string | WorkflowFileStep)[];
 }
 
 interface WorkflowFileOptionsSteps extends WorkflowFileOptionsBase {