Merge branch 'main' into stdin-filepath-test-fixes

Author: pralkarz

package.json

@@ -3,7 +3,7 @@
   "repository": "github:prettier/prettier-cli",
   "description": "A faster CLI for Prettier.",
   "license": "MIT",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "type": "module",
   "main": "dist/index.js",
   "types": "./dist/index.d.ts",

src/bin.ts

@@ -3,9 +3,9 @@
 import { toKebabCase } from "kasi";
 import { bin, color, exit, parseArgv } from "specialist";
 import { PRETTIER_VERSION, DEFAULT_PARSERS } from "./constants.js";
-import { getPlugin, isBoolean, isNumber, isIntegerInRange, isString } from "./utils.js";
+import { getPluginOrExit, isBoolean, isNumber, isIntegerInRange, isString } from "./utils.js";
 import { normalizeOptions, normalizeFormatOptions, normalizePluginOptions } from "./utils.js";
-import type { Bin, PluginsOptions } from "./types.js";
+import type { Bin, PluginsOptions, PrettierPlugin } from "./types.js";
 
 const makeBin = (): Bin => {
   return (
@@ -53,6 +53,10 @@ const makeBin = (): Bin => {
         section: "Format",
         enum: ["lf", "crlf", "cr", "auto"],
       })
+      .option("--experimental-operator-position <start|end>", 'Where to print operators when binary expressions wrap lines\nDefaults to "end"', {
+        section: "Format",
+        enum: ["start", "end"],
+      })
       .option("--experimental-ternaries", 'Use curious ternaries, with the question mark after the condition\nDefaults to "false"', {
         section: "Format",
       })
@@ -63,6 +67,10 @@ const makeBin = (): Bin => {
       .option("--jsx-single-quote", 'Use single quotes in JSX\nDefaults to "false"', {
         section: "Format",
       })
+      .option("--object-wrap <preserve|collapse>", 'How to wrap object literals\nDefaults to "preserve"', {
+        section: "Format",
+        enum: ["preserve", "collapse"],
+      })
       .option(`--parser <${DEFAULT_PARSERS.join('|')}>`, "Which parser to use", {
         section: "Format",
         enum: DEFAULT_PARSERS,
@@ -208,7 +216,7 @@ const makePluggableBin = async (): Promise<Bin> => {
 
   for (let i = 0, l = pluginsNames.length; i < l; i++) {
     const pluginName = pluginsNames[i];
-    const plugin = await getPlugin(pluginName);
+    const plugin = await getPluginOrExit(pluginName);
 
     for (const option in plugin.options) {
       optionsNames.push(option);

src/prettier_plugins_builtin.ts

@@ -106,6 +106,22 @@ const options = {
     description: "Print semicolons.",
     oppositeDescription: "Do not print semicolons, except at the beginning of lines which may need them.",
   },
+  experimentalOperatorPosition: {
+    category: "JavaScript",
+    type: "choice",
+    default: "end",
+    description: "Where to print operators when binary expressions wrap lines.",
+    choices: [
+      {
+        value: "start",
+        description: "Print operators at the start of new lines.",
+      },
+      {
+        value: "end",
+        description: "Print operators at the end of previous lines.",
+      },
+    ],
+  },
   experimentalTernaries: {
     category: "JavaScript",
     type: "boolean",
@@ -170,6 +186,22 @@ const options = {
       { value: "preserve", description: "Wrap prose as-is." },
     ],
   },
+  objectWrap: {
+    category: "Common",
+    type: "choice",
+    default: "preserve",
+    description: "How to wrap object literals.",
+    choices: [
+      {
+        value: "preserve",
+        description: "Keep as multi-line, if there is a newline between the opening brace and first property.",
+      },
+      {
+        value: "collapse",
+        description: "Fit to a single line when possible.",
+      },
+    ],
+  },
 };
 
 const languages = [

src/prettier_serial.ts

@@ -1,7 +1,7 @@
 import { readFile, writeFile } from "atomically";
 import process from "node:process";
 import prettier from "prettier/standalone";
-import { getPlugins, getPluginsBuiltin, resolve } from "./utils.js";
+import { getPluginsOrExit, getPluginsBuiltin, resolve } from "./utils.js";
 import type { ContextOptions, LazyFormatOptions, PluginsOptions } from "./types.js";
 
 async function check(
@@ -37,7 +37,7 @@ async function format(
 ): Promise<string> {
   formatOptions = await resolve(formatOptions);
   const pluginsBuiltin = await getPluginsBuiltin();
-  const plugins = await getPlugins(formatOptions.plugins || []);
+  const plugins = await getPluginsOrExit(formatOptions.plugins || []);
   const pluginsOverride = contextOptions.configPrecedence !== "file-override";
 
   const options = {

src/types.ts

@@ -9,6 +9,7 @@ type ContextOptions = {
 
 type FormatOptions = {
   [pluginOption: string]: unknown;
+  experimentalOperatorPosition?: "start" | "end";
   experimentalTernaries?: boolean;
   arrowParens?: "avoid" | "always";
   bracketSameLine?: boolean;
@@ -18,6 +19,7 @@ type FormatOptions = {
   htmlWhitespaceSensitivity?: "css" | "strict" | "ignore";
   insertPragma?: boolean;
   jsxSingleQuote?: boolean;
+  objectWrap?: "preserve" | "collapse";
   parser?: "flow" | "babel" | "babel-flow" | "babel-ts" | "typescript" | "acorn" | "espree" | "meriyah" | "css" | "less" | "scss" | "json" | "json5" | "json-stringify" | "graphql" | "markdown" | "mdx" | "vue" | "yaml" | "glimmer" | "html" | "angular" | "lwc"; // prettier-ignore
   plugins?: string[];
   printWidth?: number;

src/utils.ts

@@ -129,6 +129,14 @@ const getPlugin = memoize((name: string): Promise<PrettierPlugin> => {
   return plugin;
 });
 
+async function getPluginOrExit(name: string): Promise<PrettierPlugin> {
+  try {
+    return await getPlugin(name);
+  } catch {
+    exit(`The plugin "${name}" could not be loaded`);
+  }
+}
+
 function getPluginPath(name: string): string {
   const rootPath = path.join(process.cwd(), "index.js");
   const pluginPath = getModulePath(name, rootPath);
@@ -146,9 +154,14 @@ function getPluginVersion(name: string): string | null {
   }
 }
 
-function getPlugins(names: string[]): PromiseMaybe<PrettierPlugin[]> {
+async function getPlugins(names: string[]): Promise<PrettierPlugin[]> {
+  if (!names.length) return [];
+  return await Promise.all(names.map((name) => getPlugin(name)));
+}
+
+async function getPluginsOrExit(names: string[]): Promise<PrettierPlugin[]> {
   if (!names.length) return [];
-  return Promise.all(names.map(getPlugin));
+  return await Promise.all(names.map((name) => getPluginOrExit(name)));
 }
 
 const getPluginsBuiltin = once(async (): Promise<PrettierPlugin[]> => {
@@ -431,6 +444,13 @@ function normalizeFormatOptions(options: unknown): FormatOptions {
 
   const formatOptions: FormatOptions = {};
 
+  if ("experimentalOperatorPosition" in options) {
+    const value = options.experimentalOperatorPosition;
+    if (value === "start" || value === "end") {
+      formatOptions.experimentalOperatorPosition = value;
+    }
+  }
+
   if ("experimentalTernaries" in options) {
     const value = options.experimentalTernaries;
     if (isBoolean(value)) {
@@ -494,11 +514,18 @@ function normalizeFormatOptions(options: unknown): FormatOptions {
     }
   }
 
+  if ("objectWrap" in options) {
+    const value = options.objectWrap;
+    if (value === "preserve" || value === "collapse") {
+      formatOptions.objectWrap = value;
+    }
+  }
+
   if ("parser" in options) {
     const value = options.parser;
-    // prettier-ignore
-    if (value === "flow" || value === "babel" || value === "babel-flow" || value === "babel-ts" || value === "typescript" || value === "acorn" || value === "espree" || value === "meriyah" || value === "css" || value === "less" || value === "scss" || value === "json" || value === "json5" || value === "json-stringify" || value === "graphql" || value === "markdown" || value === "mdx" || value === "vue" || value === "yaml" || value === "glimmer" || value === "html" || value === "angular" || value === "lwc") {
-      formatOptions.parser = value;
+    if (isString(value)) {
+      // New parsers that we don't about can be added by plugins
+      formatOptions.parser = value as FormatOptions["parser"];
     }
   }
 
@@ -722,10 +749,12 @@ export {
   getModule,
   getModulePath,
   getPlugin,
+  getPluginOrExit,
   getPluginPath,
   getPluginVersion,
   getPlugins,
   getPluginsBuiltin,
+  getPluginsOrExit,
   getPluginsPaths,
   getPluginsVersions,
   getProjectPath,

test/__fixtures__/plugin-options-string/config.json

@@ -0,0 +1,4 @@
+{
+    "plugins": ["./plugin.cjs"],
+    "fooString": "baz"
+}

test/__fixtures__/plugin-options-string/plugin.cjs

@@ -0,0 +1,31 @@
+"use strict";
+
+module.exports = {
+  languages: [
+    {
+      name: "foo",
+      parsers: ["foo-parser"],
+      extensions: [".foo"],
+      since: "1.0.0",
+    },
+  ],
+  options: {
+    fooString: {
+      type: "string",
+      default: "bar",
+      description: "foo description",
+    },
+  },
+  parsers: {
+    "foo-parser": {
+      parse: (text) => ({ text }),
+      astFormat: "foo-ast",
+    },
+  },
+  printers: {
+    "foo-ast": {
+      print: (path, options) =>
+        options.fooString ? `foo:${options.fooString}` : path.getValue().text,
+    },
+  },
+};

test/__fixtures__/with-parser-inference/javascript.js

@@ -0,0 +1,2 @@
+/* JavaScript */
+"use strict";

test/__fixtures__/with-parser-inference/stylesheet.css

@@ -0,0 +1,4 @@
+/* Stylesheet */
+* {
+  outline: none;
+}