feat: provide plugin config type definitions (#383)

closes #364 closes #359
sveltejs · Jul 17, 2023 · b07b7cf · b07b7cf
1 parent 5b70335
commit b07b7cf
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 39 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -0,0 +1,38 @@
+import { Config } from 'prettier';
+
+export interface PluginConfig {
+    svelteSortOrder?: SortOrder;
+    svelteStrictMode?: boolean;
+    svelteBracketNewLine?: boolean;
+    svelteAllowShorthand?: boolean;
+    svelteIndentScriptAndStyle?: boolean;
+}
+
+export type PrettierConfig = PluginConfig & Config;
+
+type SortOrder =
+    | 'options-scripts-markup-styles'
+    | 'options-scripts-styles-markup'
+    | 'options-markup-styles-scripts'
+    | 'options-markup-scripts-styles'
+    | 'options-styles-markup-scripts'
+    | 'options-styles-scripts-markup'
+    | 'scripts-options-markup-styles'
+    | 'scripts-options-styles-markup'
+    | 'markup-options-styles-scripts'
+    | 'markup-options-scripts-styles'
+    | 'styles-options-markup-scripts'
+    | 'styles-options-scripts-markup'
+    | 'scripts-markup-options-styles'
+    | 'scripts-styles-options-markup'
+    | 'markup-styles-options-scripts'
+    | 'markup-scripts-options-styles'
+    | 'styles-markup-options-scripts'
+    | 'styles-scripts-options-markup'
+    | 'scripts-markup-styles-options'
+    | 'scripts-styles-markup-options'
+    | 'markup-styles-scripts-options'
+    | 'markup-scripts-styles-options'
+    | 'styles-markup-scripts-options'
+    | 'styles-scripts-markup-options'
+    | 'none';
diff --git a/package.json b/package.json
@@ -5,8 +5,16 @@
     "main": "plugin.js",
     "files": [
         "plugin.js",
-        "plugin.js.map"
+        "plugin.js.map",
+        "index.d.ts"
     ],
+    "types": "./index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./index.d.ts",
+            "default": "./plugin.js"
+        }
+    },
     "scripts": {
         "build": "rollup -c",
         "test": "ava",

diff --git a/src/options.ts b/src/options.ts
@@ -1,20 +1,13 @@
 import { ParserOptions as PrettierParserOptions, SupportOption } from 'prettier';
+import { SortOrder, PluginConfig } from '..';
 
-export interface ParserOptions<T = any> extends PrettierParserOptions<T>, Partial<PluginOptions> {}
-
-export interface PluginOptions {
-    svelteSortOrder: SortOrder;
-    svelteStrictMode: boolean;
-    svelteBracketNewLine: boolean;
-    svelteAllowShorthand: boolean;
-    svelteIndentScriptAndStyle: boolean;
-}
+export interface ParserOptions<T = any> extends PrettierParserOptions<T>, Partial<PluginConfig> {}
 
 function makeChoice(choice: string) {
     return { value: choice, description: choice };
 }
 
-export const options: Record<keyof PluginOptions, SupportOption> = {
+export const options: Record<keyof PluginConfig, SupportOption> = {
     svelteSortOrder: {
         category: 'Svelte',
         type: 'choice',
@@ -76,33 +69,6 @@ export const options: Record<keyof PluginOptions, SupportOption> = {
     },
 };
 
-export type SortOrder =
-    | 'options-scripts-markup-styles'
-    | 'options-scripts-styles-markup'
-    | 'options-markup-styles-scripts'
-    | 'options-markup-scripts-styles'
-    | 'options-styles-markup-scripts'
-    | 'options-styles-scripts-markup'
-    | 'scripts-options-markup-styles'
-    | 'scripts-options-styles-markup'
-    | 'markup-options-styles-scripts'
-    | 'markup-options-scripts-styles'
-    | 'styles-options-markup-scripts'
-    | 'styles-options-scripts-markup'
-    | 'scripts-markup-options-styles'
-    | 'scripts-styles-options-markup'
-    | 'markup-styles-options-scripts'
-    | 'markup-scripts-options-styles'
-    | 'styles-markup-options-scripts'
-    | 'styles-scripts-options-markup'
-    | 'scripts-markup-styles-options'
-    | 'scripts-styles-markup-options'
-    | 'markup-styles-scripts-options'
-    | 'markup-scripts-styles-options'
-    | 'styles-markup-scripts-options'
-    | 'styles-scripts-markup-options'
-    | 'none';
-
 export type SortOrderPart = 'scripts' | 'markup' | 'styles' | 'options';
 
 const sortOrderSeparator = '-';

diff --git a/tsconfig.json b/tsconfig.json
@@ -5,5 +5,5 @@
         "strict": true,
         "esModuleInterop": true
     },
-    "include": ["src/**/*"]
+    "include": ["src/**/*", "index.d.ts"]
 }