Merge pull request #17 from taiga-family/compatibility

fix(backticks): add compatibility with @trivago/prettier-plugin-sort-imports

README-ru.md

@@ -53,3 +53,7 @@ npx prettier --write .
 # или
 yarn prettier --write .
 ```
+
+## Совместимые плагины
+
+* `@trivago/prettier-plugin-sort-imports`

README.md

@@ -52,3 +52,7 @@ npx prettier --write .
 # or
 yarn prettier --write .
 ```
+
+## Compatible plugins
+
+* `@trivago/prettier-plugin-sort-imports`

package.json

@@ -3,7 +3,7 @@
   "version": "1.0.3",
   "description": "",
   "scripts": {
-    "test": "tsc --noEmit && node --import tsx --test test/fixtures.spec.ts",
+    "test": "tsc --noEmit && node --import tsx --test test/*.spec.ts",
     "lint": "eslint .",
     "build": "tsc",
     "prepare": "husky",
@@ -14,6 +14,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@taiga-ui/eslint-plugin-experience": "^0.67.10",
+    "@trivago/prettier-plugin-sort-imports": "^4.3.0",
     "@types/node": "^20.11.29",
     "eslint": "^8.57.0",
     "husky": "^9.0.11",

src/constants/plugin-key.ts

@@ -0,0 +1 @@
+export default Symbol('PrettierPluginBackticks');

src/index.ts

@@ -2,12 +2,29 @@ import type { Plugin } from 'prettier';
 import babelParsers from 'prettier/parser-babel';
 import typescriptParsers from 'prettier/parser-typescript';
 
+import pluginKey from './constants/plugin-key.js';
 import printers from './printers.js';
+import getParentParser from './utils/get-parent-parser.js';
 
 export default {
     parsers: {
-        babel: babelParsers.parsers.babel,
-        typescript: typescriptParsers.parsers.typescript,
+        babel: {
+            ...babelParsers.parsers.babel,
+            preprocess: (text, options) => {
+                const parentParser = getParentParser(options);
+
+                return parentParser?.preprocess(text, options) ?? text;
+            },
+        },
+        typescript: {
+            ...typescriptParsers.parsers.typescript,
+            preprocess: (text, options) => {
+                const parentParser = getParentParser(options);
+
+                return parentParser?.preprocess?.(text, options) ?? text;
+            },
+        },
     },
     printers,
+    [pluginKey]: true,
 } satisfies Plugin;

src/utils/assert-plugins.ts

@@ -0,0 +1,9 @@
+import type { ParserOptions, Plugin } from 'prettier';
+
+export function assertPlugins(
+    plugins: ParserOptions['plugins'],
+): asserts plugins is Plugin[] {
+    if (plugins.some((plugin) => typeof plugin === 'string')) {
+        throw new Error('Assertion error: plugin must not be a string');
+    }
+}

src/utils/get-current-plugin-index.ts

@@ -0,0 +1,15 @@
+import type { Plugin } from 'prettier';
+
+import isCurrentPlugin from './is-current-plugin.js';
+
+export default function (plugins: Plugin[]): number {
+    const currentPlugins = plugins.filter(isCurrentPlugin);
+
+    if (currentPlugins.length > 1) {
+        throw new Error(
+            'prettier-plugin-backticks initialized multiple times.',
+        );
+    }
+
+    return plugins.indexOf(currentPlugins[0]);
+}

src/utils/get-parent-parser.ts

@@ -0,0 +1,18 @@
+import type { Parser, ParserOptions } from 'prettier';
+
+import { assertPlugins } from './assert-plugins.js';
+import getCurrentPluginIndex from './get-current-plugin-index.js';
+
+export default function ({ parser, plugins }: ParserOptions): Parser {
+    assertPlugins(plugins);
+
+    const currentPluginIndex = getCurrentPluginIndex(plugins);
+
+    for (let i = currentPluginIndex - 1; i > 0; i--) {
+        const parentParser = plugins[i].parsers?.[parser as string];
+
+        if (parentParser) {
+            return parentParser;
+        }
+    }
+}

src/utils/is-current-plugin.ts

@@ -0,0 +1,7 @@
+import type { Plugin } from 'prettier';
+
+import pluginKey from '../constants/plugin-key.js';
+
+export default function (plugin: Plugin): boolean {
+    return pluginKey in plugin;
+}

test/compatibility.spec.ts

@@ -0,0 +1,36 @@
+import { equal } from 'node:assert';
+import { it } from 'node:test';
+
+import { format } from 'prettier';
+
+import Plugin from '../src/index.js';
+
+await it('compatibility with @trivago/prettier-plugin-sort-imports', async () => {
+    const originCode = `import { B, A } from './b';
+
+import { D, C } from './a';
+
+const a = 'test';
+`;
+    const expectedCode = `import { D, C } from "./a";
+import { B, A } from "./b";
+
+const a = \`test\`;
+`;
+
+    equal(
+        await format(originCode, {
+            filepath: 'test.ts',
+            plugins: ['@trivago/prettier-plugin-sort-imports', Plugin],
+        }),
+        expectedCode,
+    );
+
+    equal(
+        await format(originCode, {
+            filepath: 'test.ts',
+            plugins: [Plugin, '@trivago/prettier-plugin-sort-imports'],
+        }),
+        expectedCode,
+    );
+});

tsconfig.json

@@ -6,7 +6,8 @@
     "rootDir": ".",
     "moduleResolution": "NodeNext",
     "esModuleInterop": true,
-    "declaration": true
+    "declaration": true,
+    "lib": ["ES2023"]
   },
   "files": [
     "src/index.ts"