Resolve Prettier options from packageFolder option (#81)

Author: lorisleiva

.changeset/wild-years-visit.md

@@ -0,0 +1,5 @@
+---
+'@codama/renderers-js': patch
+---
+
+Resolve Prettier options from packageFolder option

src/utils/formatCode.ts

@@ -0,0 +1,47 @@
+import { mapRenderMapContentAsync, RenderMap } from '@codama/renderers-core';
+import { format, Plugin, resolveConfig } from 'prettier';
+import * as estreePlugin from 'prettier/plugins/estree';
+import * as typeScriptPlugin from 'prettier/plugins/typescript';
+
+import { Fragment } from './fragment';
+import { RenderOptions } from './options';
+
+export type PrettierOptions = Parameters<typeof format>[1];
+
+const DEFAULT_PRETTIER_OPTIONS: PrettierOptions = {
+    arrowParens: 'always',
+    parser: 'typescript',
+    plugins: [estreePlugin as Plugin<unknown>, typeScriptPlugin],
+    printWidth: 80,
+    semi: true,
+    singleQuote: true,
+    tabWidth: 2,
+    trailingComma: 'es5',
+    useTabs: false,
+};
+
+export async function formatCode(
+    renderMap: RenderMap<Fragment>,
+    options: Pick<RenderOptions, 'formatCode' | 'packageFolder' | 'prettierOptions'>,
+): Promise<RenderMap<Fragment>> {
+    const shouldFormatCode = options.formatCode ?? true;
+    if (!shouldFormatCode) return renderMap;
+
+    const prettierOptions: PrettierOptions = {
+        ...DEFAULT_PRETTIER_OPTIONS,
+        ...(await resolvePrettierOptions(options.packageFolder)),
+        ...options.prettierOptions,
+    };
+
+    return await mapRenderMapContentAsync(renderMap, code => format(code, prettierOptions));
+}
+
+async function resolvePrettierOptions(packageFolder: string | undefined): Promise<PrettierOptions | null> {
+    if (!__NODEJS__) {
+        // In a non-NodeJS environment, we cannot load config files.
+        return null;
+    }
+
+    if (!packageFolder) return null;
+    return await resolveConfig(packageFolder);
+}

src/utils/index.ts

@@ -1,6 +1,7 @@
 export * from './async';
 export * from './codecs';
 export * from './customData';
+export * from './formatCode';
 export * from './fragment';
 export * from './importMap';
 export * from './linkOverrides';

src/utils/options.ts

@@ -1,14 +1,12 @@
 import type { CamelCaseString } from '@codama/nodes';
 import type { LinkableDictionary } from '@codama/visitors-core';
-import type { format } from 'prettier/standalone';
 
 import type { TypeManifestVisitor } from '../visitors';
 import type { CustomDataOptions, ParsedCustomDataOptions } from './customData';
+import { PrettierOptions } from './formatCode';
 import type { GetImportFromFunction, LinkOverrides } from './linkOverrides';
 import type { NameApi, NameTransformers } from './nameTransformers';
 
-type PrettierOptions = Parameters<typeof format>[1];
-
 export type RenderOptions = GetRenderMapOptions & {
     deleteFolderBeforeRendering?: boolean;
     formatCode?: boolean;

src/visitors/renderVisitor.ts

@@ -1,27 +1,9 @@
-import { deleteDirectory, mapRenderMapContentAsync, writeRenderMap } from '@codama/renderers-core';
+import { deleteDirectory, writeRenderMap } from '@codama/renderers-core';
 import { rootNodeVisitor, visit } from '@codama/visitors-core';
-import { Plugin } from 'prettier';
-import * as estreePlugin from 'prettier/plugins/estree';
-import * as typeScriptPlugin from 'prettier/plugins/typescript';
-import { format } from 'prettier/standalone';
 
-import { RenderOptions, syncPackageJson } from '../utils';
+import { formatCode, RenderOptions, syncPackageJson } from '../utils';
 import { getRenderMapVisitor } from './getRenderMapVisitor';
 
-type PrettierOptions = Parameters<typeof format>[1];
-
-const DEFAULT_PRETTIER_OPTIONS: PrettierOptions = {
-    arrowParens: 'always',
-    parser: 'typescript',
-    plugins: [estreePlugin as Plugin<unknown>, typeScriptPlugin],
-    printWidth: 80,
-    semi: true,
-    singleQuote: true,
-    tabWidth: 2,
-    trailingComma: 'es5',
-    useTabs: false,
-};
-
 export function renderVisitor(path: string, options: RenderOptions = {}) {
     return rootNodeVisitor(async root => {
         // Delete existing generated folder.
@@ -32,15 +14,13 @@ export function renderVisitor(path: string, options: RenderOptions = {}) {
         // Render the new files.
         let renderMap = visit(root, getRenderMapVisitor(options));
 
-        // Format the code.
-        if (options.formatCode ?? true) {
-            const prettierOptions = { ...DEFAULT_PRETTIER_OPTIONS, ...options.prettierOptions };
-            renderMap = await mapRenderMapContentAsync(renderMap, code => format(code, prettierOptions));
-        }
+        // Format the code, if requested.
+        renderMap = await formatCode(renderMap, options);
 
         // Create or update package.json dependencies, if requested.
         syncPackageJson(renderMap, options);
 
+        // Write the rendered files to the output directory.
         writeRenderMap(renderMap, path);
     });
 }

test/e2e/anchor/.prettierrc.json

@@ -10,6 +10,9 @@
     "lint": "eslint --ext js,ts,tsx src && prettier --check src test",
     "lint:fix": "eslint --fix --ext js,ts,tsx src && prettier --write src test"
   },
+  "dependencies": {
+    "@solana/kit": "^5.0.0"
+  },
   "license": "MIT",
   "ava": {
     "typescript": {
@@ -18,6 +21,5 @@
         "test/": "dist/test/"
       }
     }
-  },
-  "packageManager": "pnpm@9.1.0"
+  }
 }