Add prettier.config setting

CHANGELOG.md

@@ -6,6 +6,8 @@ All notable changes to the "prettier-vscode" extension will be documented in thi
 
 ## [Unreleased]
 
+-   New setting `config`. Specify path to prettier config file.
+
 ## [1.5.0]
 
 -   Revert notification popup: remove it.

README.md

@@ -112,6 +112,9 @@ Require a 'prettierconfig' to format
 Supply the path to an ignore file such as `.gitignore` or `.prettierignore`.
 Files which match will not be formatted. Set to `null` to not read ignore files. Restart required.
 
+#### prettier.config (default: setting is not used)
+Supply the path to a prettier config file such as `.prettierrc`. Restart required.
+
 #### prettier.disableLanguages (default: ["vue"])
 A list of languages IDs to disable this extension on. Restart required.
 *Note: Disabling a language enabled in a parent folder will prevent formatting instead of letting any other formatter to run*

package.json

@@ -72,6 +72,11 @@
           "description": "Path to a .prettierignore or similar file",
           "scope": "resource"
         },
+        "prettier.config": {
+          "type": "string",
+          "description": "Path to prettier config file",
+          "scope": "resource"
+        },
         "prettier.printWidth": {
           "type": "integer",
           "default": 80,

src/PrettierEditProvider.ts

@@ -9,7 +9,7 @@ import {
 } from 'vscode';
 
 import { safeExecution, addToOutput, setUsedModule } from './errorHandler';
-import { getGroup, getParsersFromLanguageId, getConfig } from './utils';
+import { getGroup, getParsersFromLanguageId, getConfig, getAbsolutePath } from './utils';
 import { requireLocalPkg } from './requirePkg';
 
 import {
@@ -30,8 +30,8 @@ const STYLE_PARSERS: ParserOption[] = ['postcss', 'css', 'less', 'scss'];
  * Check if a given file has an associated prettierconfig.
  * @param filePath file's path
  */
-async function hasPrettierConfig(filePath: string) {
-    const { config } = await resolveConfig(filePath);
+async function hasPrettierConfig(filePath: string, configPath?: string) {
+    const { config } = await resolveConfig(filePath, { config: configPath });
     return config !== null;
 }
 
@@ -44,7 +44,7 @@ type ResolveConfigResult = { config: PrettierConfig | null; error?: Error };
  */
 async function resolveConfig(
     filePath: string,
-    options?: { editorconfig?: boolean }
+    options?: { editorconfig?: boolean, config?: string }
 ): Promise<ResolveConfigResult> {
     try {
         const config = await bundledPrettier.resolveConfig(filePath, options);
@@ -128,14 +128,17 @@ async function format(
         lang.parsers.includes(parser)
     );
 
-    const hasConfig = await hasPrettierConfig(fileName);
+    const config = getAbsolutePath(uri, getConfig(uri).config);
+
+    const hasConfig = await hasPrettierConfig(fileName, config);
 
     if (!hasConfig && vscodeConfig.requireConfig) {
         return text;
     }
 
     const { config: fileOptions, error } = await resolveConfig(fileName, {
         editorconfig: true,
+        config,
     });
 
     if (error) {

src/configCacheHandler.ts

@@ -1,5 +1,7 @@
+import { basename } from 'path';
 import { workspace } from 'vscode';
 import { Prettier } from './types';
+import { getConfig } from './utils';
 
 const prettier = require('prettier') as Prettier;
 /**
@@ -15,6 +17,12 @@ const PRETTIER_CONFIG_FILES = [
     'prettier.config.js',
 ];
 
+const prettierConfigPath = getConfig().config;
+
+if (prettierConfigPath) {
+    PRETTIER_CONFIG_FILES.push(basename(prettierConfigPath));
+}
+
 /**
  * Create a file watcher. Clears prettier's configuration cache on
  * file change, create, delete.

src/ignoreFileHandler.ts

@@ -1,7 +1,7 @@
 import { readFileSync, existsSync } from 'fs';
 import * as path from 'path';
 import { workspace, Uri, Disposable } from 'vscode';
-import { getConfig } from './utils';
+import { getConfig, getAbsolutePath } from './utils';
 import { addToOutput } from './errorHandler';
 
 const ignore = require('ignore');
@@ -32,10 +32,8 @@ function ignoreFileHandler(disposables: Disposable[]) {
     function getIgnorerForFile(
         fsPath: string
     ): { ignorer: Ignorer; ignoreFilePath: string } {
-        const absolutePath = getIgnorePathForFile(
-            fsPath,
-            getConfig(Uri.file(fsPath)).ignorePath
-        );
+        const uri = Uri.file(fsPath);
+        const absolutePath = getAbsolutePath(uri, getConfig(uri).ignorePath);
 
         if (!absolutePath) {
             return { ignoreFilePath: '', ignorer: nullIgnorer };
@@ -86,24 +84,4 @@ function ignoreFileHandler(disposables: Disposable[]) {
     }
 }
 
-function getIgnorePathForFile(
-    filePath: string,
-    ignorePath: string
-): string | null {
-    // Configuration `prettier.ignorePath` is set to `null`
-    if (!ignorePath) {
-        return null;
-    }
-    if (workspace.workspaceFolders) {
-        const folder = workspace.getWorkspaceFolder(Uri.file(filePath));
-        return folder ? getPath(ignorePath, folder.uri.fsPath) : null;
-    }
-
-    return null;
-}
-
-function getPath(fsPath: string, relativeTo: string) {
-    return path.isAbsolute(fsPath) ? fsPath : path.join(relativeTo, fsPath);
-}
-
 export default ignoreFileHandler;

src/types.d.ts

@@ -68,6 +68,10 @@ interface ExtensionConfig {
      * Path to '.prettierignore' or similar.
      */
     ignorePath: string;
+    /**
+     * Path to prettier config file.
+     */
+    config: string;
     /**
      * If true will skip formatting if a prettierconfig isn't found.
      */
@@ -95,6 +99,10 @@ export interface Prettier {
              * read editorconfig, defaults to false.
              */
             editorconfig?: boolean;
+            /**
+             * Path to the config file to use, optional.
+             */
+            config?: string;
         }
     ) => Promise<PrettierConfig>;
     clearConfigCache: () => void;

src/utils.ts

@@ -1,3 +1,4 @@
+import { isAbsolute, join } from 'path';
 import { workspace, Uri } from 'vscode';
 import { basename } from 'path';
 import {
@@ -54,3 +55,21 @@ export function getGroup(group: string): PrettierSupportInfo['languages'] {
 function getSupportLanguages(version?: string) {
     return (require('prettier') as Prettier).getSupportInfo(version).languages;
 }
+
+/**
+ * Get absolute path for relative or absolute filePath.
+ * Relative to uri's workspace folder in relative case.
+ */
+export function getAbsolutePath(uri: Uri, filePath: string): string | undefined {
+    if (!filePath) {
+        return undefined;
+    }
+    if (isAbsolute(filePath)) {
+        return filePath;
+    }
+    if (workspace.workspaceFolders) {
+        const folder = workspace.getWorkspaceFolder(uri);
+        return folder && join(folder.uri.fsPath, filePath);
+    }
+    return undefined;
+}

testProject/config/.foo

@@ -0,0 +1,3 @@
+{
+  "semi": false
+}

testProject/config/.prettierrc

@@ -0,0 +1,3 @@
+{
+  "semi": false
+}

testProject/config/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "prettier.config": ".foo"
+}

testProject/config/test.js

@@ -0,0 +1,5 @@
+const x = 1
+
+const f = () => {
+  return 1
+}