prettier-plugin-sort 1.0.0 → 1.1.0

package/dist/options.d.ts

@@ -1,4 +1,4 @@
-import { type ParserOptions, type SupportOptions } from 'prettier';
+import { type ParserOptions } from 'prettier';
 /** import 声明分组。 */
 export type ImportGroup = 'builtin' | 'external' | 'internal' | 'parent' | 'sibling' | 'index';
 /** type import 的声明形式与成员顺序。 */
@@ -12,12 +12,76 @@ export interface SortOptions {
     esmImportMerge?: boolean;
     esmExportSpecifierSort?: boolean;
     packageSort?: boolean;
+    tsconfigSort?: boolean;
+    tsconfigSeparation?: boolean;
 }
+export type ResolvedEsmOptions = Required<Pick<SortOptions, 'esmExportSpecifierSort' | 'esmImportGroups' | 'esmImportMerge' | 'esmImportSeparation' | 'esmImportSort' | 'esmImportTypeStyle'>>;
+export type ResolvedTsconfigOptions = Required<Pick<SortOptions, 'tsconfigSeparation' | 'tsconfigSort'>>;
 type SortPluginParserOptions = ParserOptions & SortOptions;
-/**
- * 从 Prettier 选项中提取插件配置，缺失或非法的参数会回退为默认值。
- */
-export declare function resolveSortOptions(prettierOptions: SortPluginParserOptions): Required<SortOptions>;
-/** Prettier 插件选项。 */
-export declare const options: SupportOptions;
+export declare function resolveEsmOptions(prettierOptions: SortPluginParserOptions): ResolvedEsmOptions;
+export declare function isPackageSortEnabled(prettierOptions: SortPluginParserOptions): boolean;
+export declare function resolveTsconfigOptions(prettierOptions: SortPluginParserOptions): ResolvedTsconfigOptions;
+export declare const options: {
+    esmImportSort: {
+        type: "boolean";
+        default: boolean;
+        category: string;
+        description: string;
+    };
+    esmImportGroups: {
+        type: "string";
+        array: true;
+        default: {
+            value: ImportGroup[];
+        }[];
+        category: string;
+        description: string;
+    };
+    esmImportSeparation: {
+        type: "boolean";
+        default: boolean;
+        category: string;
+        description: string;
+    };
+    esmImportTypeStyle: {
+        type: "choice";
+        default: TypeImportStyle;
+        category: string;
+        description: string;
+        choices: {
+            value: string;
+            description: string;
+        }[];
+    };
+    esmImportMerge: {
+        type: "boolean";
+        default: boolean;
+        category: string;
+        description: string;
+    };
+    esmExportSpecifierSort: {
+        type: "boolean";
+        default: boolean;
+        category: string;
+        description: string;
+    };
+    packageSort: {
+        type: "boolean";
+        default: boolean;
+        category: string;
+        description: string;
+    };
+    tsconfigSort: {
+        type: "boolean";
+        default: boolean;
+        category: string;
+        description: string;
+    };
+    tsconfigSeparation: {
+        type: "boolean";
+        default: boolean;
+        category: string;
+        description: string;
+    };
+};
 export {};

package/dist/parser-ast.d.ts

@@ -1,4 +1,4 @@
-import { type SourceTextRange } from './utils/source-text';
+import { type SourceTextRange } from '#/utils/source-text';
 /**
  * 已注册 Prettier parser 的源码偏移字段。
  *
@@ -22,6 +22,7 @@ interface ParserAstLocation extends Record<string, unknown> {
  * - `declaration`、`specifiers`、`source`、`imported`、`local`、`exported` 来自 ESTree ES2015 module 节点
  * - `program`、`comments` 来自 Babel `File` 包装节点及 Prettier 的顶层注释约定
  * - `importKind`、`phase` 来自 Babel/typescript-estree 的 import 扩展
+ * - `argument`、`elements`、`key`、`node`、`operator`、`properties` 来自 Babel JSON AST
  *
  * 不同 parser 的字段结构存在差异，因此属性均为可选，并在使用处收窄类型。
  *
@@ -36,9 +37,15 @@ export interface ParserAstNode extends ParserAstLocation {
     readonly type: string;
     readonly name?: unknown;
     readonly value?: unknown;
+    readonly argument?: ParserAstNode;
     readonly body?: ParserAstNode[];
     readonly comments?: ParserAstComment[];
+    readonly elements?: (ParserAstNode | null)[];
+    readonly key?: ParserAstNode;
+    readonly node?: ParserAstNode;
+    readonly operator?: unknown;
     readonly program?: ParserAstNode;
+    readonly properties?: ParserAstNode[];
     readonly declaration?: ParserAstNode | null;
     readonly specifiers?: ParserAstNode[];
     readonly source?: ParserAstNode | null;
@@ -62,11 +69,12 @@ export interface ParserAstCommentWithTextRange {
     readonly comment: ParserAstComment;
     readonly textRange: SourceTextRange;
 }
-export declare function getAstNodeTextRange(node: ParserAstNode | ParserAstComment | undefined | null): SourceTextRange | null;
+export declare function isParserAstNode(value: unknown): value is ParserAstNode;
+export declare function getAstNodeTextRange(node?: ParserAstNode | ParserAstComment | null): SourceTextRange | null;
 export declare function getSortedAstCommentsWithTextRanges(comments: readonly ParserAstComment[]): ParserAstCommentWithTextRange[];
 /** 使用二分查找定位指定源码位置之后的第一条注释。 */
 export declare function findCommentIndexAtOrAfter(sortedComments: readonly ParserAstCommentWithTextRange[], sourceIndex: number): number;
-export declare function getAstNodeName(node: ParserAstNode | undefined | null): string | null;
+export declare function getAstNodeName(node?: ParserAstNode | null): string | null;
 export declare function getAstCommentText(comment: ParserAstComment): string | null;
 export declare function getProgramStatements(parserAst: ParserAstNode): readonly ParserAstNode[];
 export declare function getProgramComments(parserAst: ParserAstNode): readonly ParserAstComment[];

package/dist/sort-exports.d.ts

@@ -1,5 +1,5 @@
-import { type ParserAstCommentWithTextRange, type ParserAstNode } from './parser-ast';
-import { type SourceTextEdit } from './utils/source-text';
+import { type ParserAstCommentWithTextRange, type ParserAstNode } from '#/parser-ast';
+import { type SourceTextEdit } from '#/utils/source-text';
 /**
  * 为无注释的 `export { ... }` 生成 specifier 排序编辑。
  *

package/dist/sort-imports.d.ts

@@ -1,8 +1,8 @@
-import { type SortOptions } from './options';
-import { type ParserAstCommentWithTextRange, type ParserAstNode } from './parser-ast';
-import { type SourceTextEdit } from './utils/source-text';
+import { type ResolvedEsmOptions } from '#/options';
+import { type ParserAstCommentWithTextRange, type ParserAstNode } from '#/parser-ast';
+import { type SourceTextEdit } from '#/utils/source-text';
 /**
  * 将顶层 import 划分为可独立排序的片段，并生成基于原文范围的编辑。
  * 被忽略的声明、独立注释和位置敏感指令不会进入编辑范围。
  */
-export declare function buildImportSortingEdits(sourceText: string, programStatements: readonly ParserAstNode[], sortedComments: readonly ParserAstCommentWithTextRange[], sortOptions: Required<SortOptions>, isPrettierFilePragmaPresent: boolean): SourceTextEdit[];
+export declare function buildImportSortingEdits(sourceText: string, programStatements: readonly ParserAstNode[], sortedComments: readonly ParserAstCommentWithTextRange[], sortOptions: ResolvedEsmOptions, pathPatterns: readonly string[], isPrettierFilePragmaPresent: boolean): SourceTextEdit[];

package/dist/sort-tsconfig.d.ts

@@ -0,0 +1,6 @@
+import { type Parser, type ParserOptions } from 'prettier';
+/**
+ * 只处理 tsconfig.json 和 tsconfig.*.json。
+ * AST、字段或注释归属无法安全处理时返回原文。
+ */
+export declare function preprocessTsconfig(sourceText: string, prettierOptions: ParserOptions, parser: Parser): Promise<string>;

package/dist/utils/package-rules.d.ts

@@ -1,5 +1,6 @@
 /**
  * 基于 `sort-package-json` 4.0.0 默认规则的 `package.json` 顶层字段顺序。
+ * `$schema` 按 JSON Schema 惯例补充在最前。
  *
  * @see {@link https://github.com/keithamus/sort-package-json/blob/v4.0.0/defaultRules.md | sort-package-json 4.0.0 默认规则}
  */

package/dist/utils/tsconfig-rules.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 顶层只固定广泛采用的元信息、继承声明和输入文件字段。
+ * 其余字段保持原有相对顺序，不从示例推导完整规则。
+ *
+ * @see {@link https://www.typescriptlang.org/docs/handbook/tsconfig-json#tsconfig-bases | TypeScript TSConfig Bases}
+ * @see {@link https://www.typescriptlang.org/docs/handbook/tsconfig-json#examples | TypeScript TSConfig Examples}
+ */
+export declare const TSCONFIG_ROOT_FIRST_FIELDS: readonly ["$schema", "extends"];
+export declare const TSCONFIG_ROOT_LAST_FIELDS: readonly ["files", "include", "exclude"];
+/**
+ * TypeScript 5.8.3 `tsc --init` 使用的 compiler option 分类和声明顺序。
+ * 默认模板隐藏的分类仍按生成器遍历 `optionDeclarations` 时的顺序接在后面。
+ *
+ * @see {@link https://github.com/microsoft/TypeScript/blob/v5.8.3/src/compiler/commandLineParser.ts | TypeScript 5.8.3 tsconfig 生成器}
+ */
+export declare const COMPILER_OPTION_FIELD_GROUPS: readonly [readonly ["incremental", "composite", "tsBuildInfoFile", "disableSourceOfProjectReferenceRedirect", "disableSolutionSearching", "disableReferencedProjectLoad"], readonly ["target", "lib", "jsx", "libReplacement", "experimentalDecorators", "emitDecoratorMetadata", "jsxFactory", "jsxFragmentFactory", "jsxImportSource", "reactNamespace", "noLib", "useDefineForClassFields", "moduleDetection"], readonly ["module", "rootDir", "moduleResolution", "baseUrl", "paths", "rootDirs", "typeRoots", "types", "allowUmdGlobalAccess", "moduleSuffixes", "allowImportingTsExtensions", "rewriteRelativeImportExtensions", "resolvePackageJsonExports", "resolvePackageJsonImports", "customConditions", "noUncheckedSideEffectImports", "resolveJsonModule", "allowArbitraryExtensions", "noResolve"], readonly ["allowJs", "checkJs", "maxNodeModuleJsDepth"], readonly ["declaration", "declarationMap", "emitDeclarationOnly", "sourceMap", "inlineSourceMap", "noEmit", "outFile", "outDir", "removeComments", "importHelpers", "downlevelIteration", "sourceRoot", "mapRoot", "inlineSources", "emitBOM", "newLine", "stripInternal", "noEmitHelpers", "noEmitOnError", "preserveConstEnums", "declarationDir"], readonly ["isolatedModules", "verbatimModuleSyntax", "isolatedDeclarations", "erasableSyntaxOnly", "allowSyntheticDefaultImports", "esModuleInterop", "preserveSymlinks", "forceConsistentCasingInFileNames"], readonly ["strict", "noImplicitAny", "strictNullChecks", "strictFunctionTypes", "strictBindCallApply", "strictPropertyInitialization", "strictBuiltinIteratorReturn", "noImplicitThis", "useUnknownInCatchVariables", "alwaysStrict", "noUnusedLocals", "noUnusedParameters", "exactOptionalPropertyTypes", "noImplicitReturns", "noFallthroughCasesInSwitch", "noUncheckedIndexedAccess", "noImplicitOverride", "noPropertyAccessFromIndexSignature", "allowUnusedLabels", "allowUnreachableCode"], readonly ["skipDefaultLibCheck", "skipLibCheck"], readonly ["preserveWatchOutput", "pretty", "noErrorTruncation"], readonly ["listFiles", "explainFiles", "listEmittedFiles", "traceResolution", "diagnostics", "extendedDiagnostics", "generateCpuProfile", "generateTrace", "noCheck"], readonly ["assumeChangesOnlyAffectDirectDependencies"], readonly ["importsNotUsedAsValues", "out", "charset", "noImplicitUseStrict", "suppressExcessPropertyErrors", "suppressImplicitAnyIndexErrors", "noStrictGenericChecks", "preserveValueImports", "keyofStringsOnly"], readonly ["disableSizeLimit", "plugins"]];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "prettier-plugin-sort",
-  "version": "1.0.0",
-  "description": "A Prettier plugin for sorting ES module imports, export specifiers, and package.json keys.",
+  "version": "1.1.0",
+  "description": "A Prettier plugin for sorting ES module imports, export specifiers, and fields in package.json and tsconfig.json.",
   "keywords": [
     "imports",
     "order",
@@ -10,7 +10,8 @@
     "plugin",
     "prettier",
     "prettier-plugin",
-    "sort"
+    "sort",
+    "tsconfig"
   ],
   "homepage": "https://github.com/xueelf/prettier-plugin-sort",
   "bugs": {
@@ -23,27 +24,32 @@
   "license": "MIT",
   "author": "Yuki <admin@yuki.sh>",
   "type": "module",
+  "imports": {
+    "#/*": {
+      "types": "./dist/*.d.ts"
+    }
+  },
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     }
   },
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
   "files": [
     "dist"
   ],
   "scripts": {
     "build": "bun run scripts/build.ts",
-    "format": "prettier **/*.{json,ts,md} --write --experimental-cli",
-    "lint": "eslint src/ --cache",
-    "lint:fix": "eslint src/ --fix --cache",
+    "format": "prettier \"**/*.{json,md,ts,yaml,yml}\" --write --experimental-cli",
+    "format:check": "prettier \"**/*.{json,md,ts,yaml,yml}\" --check --experimental-cli",
+    "lint": "eslint --cache",
+    "lint:fix": "eslint --fix --cache",
     "prepare": "husky",
-    "test": "bun test tests/",
+    "test": "bun test",
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
+    "get-tsconfig": "^4.14.0",
     "semver": "^7.8.5"
   },
   "devDependencies": {
@@ -53,7 +59,7 @@
     "@eslint/js": "^10.0.1",
     "@types/bun": "^1.3.14",
     "@types/semver": "^7.7.1",
-    "annal": "^0.0.2",
+    "annal": "^0.2.0",
     "eslint": "^10.4.0",
     "husky": "^9.1.7",
     "typescript": "^6.0.3",