Merge remote-tracking branch 'origin/main' into chenjiahan/perf-minify-fmt-worker

# Conflicts:
#	packages/rstack/rslib.config.ts

Author: chenjiahan

packages/rstack/THIRD_PARTY_NOTICES.md

@@ -29,10 +29,13 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
-## @prettier/plugin-yuku
+## Prettier yuku parser adapter
 
-This package includes bundled code from
-[@prettier/plugin-yuku](https://github.com/prettier/prettier/tree/main/packages/plugin-yuku).
+The local Yuku parser adapter includes portions derived from
+[@prettier/plugin-yuku](https://github.com/prettier/prettier/tree/main/packages/plugin-yuku)
+and Prettier's JavaScript parser postprocessing. The adapter reuses the public
+ESTree printer, formatter options, and parser utilities from the installed
+`prettier` package.
 
 License: MIT
 
@@ -56,38 +59,6 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
-The bundled plugin also contains MIT-licensed code from:
-
-- emoji-regex 10.6.0, copyright Mathias Bynens
-- escape-string-regexp 5.0.0, copyright Sindre Sorhus
-- get-east-asian-width 1.6.0, copyright Sindre Sorhus
-- index-to-position 1.2.0, copyright Sindre Sorhus
-- is-es5-identifier-name 1.0.1, copyright fisker Cheung
-- jest-docblock 30.4.0, copyright Meta Platforms, Inc. and Jest contributors
-- narrow-emojis 0.0.3, copyright fisker Cheung
-- Prettier 3.10.0-dev, copyright James Long and contributors
-- to-fast-properties 4.0.0, copyright Petka Antonov, Benjamin Gruenbaum,
-  John-David Dalton, and Sindre Sorhus
-- trim-newlines 5.0.0, copyright Sindre Sorhus
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
-of the Software, and to permit persons to whom the Software is furnished to do
-so, subject to the following conditions:
-
-The above copyright notices and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
 ## fast-ignore
 
 This package includes bundled code from [fast-ignore](https://github.com/fabiospampinato/fast-ignore).

packages/rstack/package.json

@@ -62,7 +62,6 @@
     "yuku-parser": "catalog:"
   },
   "devDependencies": {
-    "@prettier/plugin-yuku": "catalog:",
     "@rspress/core": "catalog:",
     "@rstackjs/load-config": "catalog:",
     "@rstackjs/test-utils": "catalog:",

packages/rstack/rslib.config.ts

@@ -1,7 +1,7 @@
 import { defineConfig } from '@rslib/core';
 import pkgJson from './package.json' with { type: 'json' };
 
-const fullyMinifiedChunks = /(?:fmtWorker|lintStaged)\.js$/;
+const fullyMinifiedChunks = /(?:fmtWorker|staged)\.js$/;
 
 export default defineConfig({
   lib: [{ syntax: 'es2023', dts: true }],
@@ -32,7 +32,7 @@ export default defineConfig({
       css: false,
       jsOptions: [
         {
-          // Fully minify large bundles to reduce package size.
+          // Fully minify the formatter worker and staged chunk to reduce package size.
           include: fullyMinifiedChunks,
         },
         {

packages/rstack/src/cli/commands.ts

@@ -1,8 +1,6 @@
 import { join } from 'node:path';
 import { color } from 'rslog';
 import { getConfigState } from '../config.ts';
-import { runSetupCLI } from '../setup/index.ts';
-import { runStagedCLI } from '../staged.ts';
 import { insertConfigArg, parseCliArgs } from './args.ts';
 
 declare global {
@@ -154,11 +152,19 @@ export async function setupCommands(): Promise<void> {
   }
 
   if (command === 'staged') {
+    const { runStagedCLI } = await import(
+      /* rspackChunkName: 'staged' */
+      '../staged.ts'
+    );
     await runStagedCLI(args.slice(1));
     return;
   }
 
   if (command === 'setup') {
+    const { runSetupCLI } = await import(
+      /* rspackChunkName: 'setup' */
+      '../setup/index.ts'
+    );
     runSetupCLI(args.slice(1));
     return;
   }

packages/rstack/src/fmt/cli.ts

@@ -6,13 +6,16 @@ import { loadRstackConfig } from '../config.ts';
 import { resolveFmtConfig } from './config.ts';
 import { discoverFmtFiles } from './discovery.ts';
 import { runFmtFiles } from './runner.ts';
-import type { FmtMode, FmtRunResult } from './types.ts';
+import { runFmtStdin } from './stdin.ts';
+import type { FmtMode, FmtRunResult, ResolvedFmtConfig } from './types.ts';
 
 interface ParsedFmtCLIArgs {
   mode: FmtMode;
   patterns: string[];
   maxWorkers?: number;
   help: boolean;
+  /** Path the stdin content is formatted as; it need not exist on disk. */
+  stdinFilepath?: string;
 }
 
 const fmtHelpMessage: string = `Rstack v${RSTACK_VERSION}
@@ -27,6 +30,7 @@ ${color.cyan('Options')}:
   --check             Check whether files are formatted
   --list-different    Print paths of unformatted files
   --parallel-workers <count>  Number of parallel workers
+  --stdin-filepath <path>  Format stdin as if it were saved at <path>
   -h, --help          Display this help message`;
 
 const parseMaxWorkers = (
@@ -56,6 +60,8 @@ const parseFmtCLIArgs = (args: string[]): ParsedFmtCLIArgs => {
       listDifferent: { type: 'boolean' },
       'parallel-workers': { type: 'string' },
       parallelWorkers: { type: 'string' },
+      'stdin-filepath': { type: 'string' },
+      stdinFilepath: { type: 'string' },
       help: { type: 'boolean', short: 'h' },
     },
     allowPositionals: true,
@@ -70,12 +76,26 @@ const parseFmtCLIArgs = (args: string[]): ParsedFmtCLIArgs => {
 
   const mode = values.check ? 'check' : listDifferent ? 'list-different' : 'write';
   const maxWorkers = parseMaxWorkers(values['parallel-workers'], values.parallelWorkers);
+  const stdinFilepath = values['stdin-filepath'] ?? values.stdinFilepath;
+
+  if (stdinFilepath !== undefined) {
+    if (modes.length > 0) {
+      throw new Error(
+        'The --stdin-filepath option cannot be used with --write, --check, or --list-different.',
+      );
+    }
+
+    if (positionals.length > 0) {
+      throw new Error('The --stdin-filepath option cannot be used with file arguments.');
+    }
+  }
 
   return {
     mode,
     patterns: positionals,
     maxWorkers,
     help: values.help ?? false,
+    stdinFilepath,
   };
 };
 
@@ -174,23 +194,35 @@ const logFmtResult = (
   }
 };
 
-const runFmtCLI = async (args: string[]): Promise<void> => {
-  const { help, maxWorkers, mode, patterns } = parseFmtCLIArgs(args);
-  if (help) {
-    logger.log(fmtHelpMessage);
-    return;
-  }
+const loadFmtConfig = async (cwd: string): Promise<ResolvedFmtConfig> => {
+  const { configs, filePath } = await loadRstackConfig();
 
+  return resolveFmtConfig({
+    definition: configs.fmt,
+    configFilePath: filePath,
+    cwd,
+  });
+};
+
+const runFmtCLI = async (args: string[]): Promise<void> => {
   const cwd = process.cwd();
   const startTime = performance.now();
 
+  // Argument errors are reported like every other failure so that a single
+  // exit code identifies "rs fmt refused to run".
   try {
-    const { configs, filePath } = await loadRstackConfig();
-    const config = await resolveFmtConfig({
-      definition: configs.fmt,
-      configFilePath: filePath,
-      cwd,
-    });
+    const { help, maxWorkers, mode, patterns, stdinFilepath } = parseFmtCLIArgs(args);
+    if (help) {
+      logger.log(fmtHelpMessage);
+      return;
+    }
+
+    if (stdinFilepath !== undefined) {
+      await runFmtStdin({ filepath: stdinFilepath, cwd, loadConfig: () => loadFmtConfig(cwd) });
+      return;
+    }
+
+    const config = await loadFmtConfig(cwd);
     const files = await discoverFmtFiles({ cwd, patterns, config });
 
     if (files.length === 0) {

packages/rstack/src/fmt/discoverPaths.ts

@@ -164,6 +164,15 @@ class GitIgnoreMatcher {
   }
 
   #matches(relativePath: string, isDirectory: boolean): boolean {
+    // Most repositories only use a root `.gitignore`. Avoid checking every path
+    // segment when no nested matcher can override its result.
+    const rootMatcher = this.#matchers.size === 1 ? this.#matchers.get(this.#rootPath) : undefined;
+    if (rootMatcher) {
+      // `ignore` expects POSIX separators and uses a trailing slash to distinguish directories.
+      const pathFromMatcher = toPosixPath(relativePath);
+      return rootMatcher.test(isDirectory ? `${pathFromMatcher}/` : pathFromMatcher).ignored;
+    }
+
     const segments = relativePath.split(path.sep);
     let directoryPath = this.#rootPath;
     let pathFromMatcher = segments.join('/');

packages/rstack/src/fmt/discovery.ts

@@ -1,16 +1,11 @@
 import { resolveFmtOptions } from './config.ts';
 import { discoverFmtPaths } from './discoverPaths.ts';
 import { createFmtIgnoreMatcher } from './ignore.ts';
-import { createFmtPluginResolver, type FmtPluginResolver } from './plugins.ts';
 import type { DiscoverFmtFilesOptions, FmtFileRequest, ResolvedFmtConfig } from './types.ts';
 
-const createFileRequest = (
-  filePath: string,
-  config: ResolvedFmtConfig,
-  resolvePlugins: FmtPluginResolver,
-): FmtFileRequest => ({
+const createFileRequest = (filePath: string, config: ResolvedFmtConfig): FmtFileRequest => ({
   path: filePath,
-  options: resolvePlugins(resolveFmtOptions(filePath, config)),
+  options: resolveFmtOptions(filePath, config),
 });
 
 /** Discovers worker-ready files without reading Prettier config files or `.prettierignore`. */
@@ -26,9 +21,18 @@ const discoverFmtFiles = async ({
 
   const isFmtIgnored = createFmtIgnoreMatcher(config);
   const filePaths = candidates.filter((filePath) => !isFmtIgnored(filePath));
+  const files = filePaths.map((filePath) => createFileRequest(filePath, config));
+  if (!files.some((file) => file.options.plugins?.length)) {
+    return files;
+  }
+
+  const { createFmtPluginResolver } = await import(
+    /* rspackChunkName: 'fmtPlugins' */
+    './plugins.ts'
+  );
   const resolvePlugins = createFmtPluginResolver(config.rootPath);
 
-  return filePaths.map((filePath) => createFileRequest(filePath, config, resolvePlugins));
+  return files.map((file) => ({ ...file, options: resolvePlugins(file.options) }));
 };
 
-export { discoverFmtFiles };
+export { createFileRequest, discoverFmtFiles };

packages/rstack/src/fmt/format.ts

@@ -0,0 +1,59 @@
+// Derived from @prettier/cli, see THIRD_PARTY_NOTICES.md
+
+import {
+  format,
+  getFileInfo,
+  type FileInfoOptions,
+  type Options as PrettierOptions,
+} from 'prettier';
+import { getPrettierPlugins } from './prettierPlugins.ts';
+import type { FmtFileRequest } from './types.ts';
+
+type PrettierPlugins = NonNullable<PrettierOptions['plugins']>;
+
+type FormatFmtSourceResult =
+  { status: 'unsupported' } | { status: 'formatted'; source: string; formatted: string };
+
+const fileInfoOptions = {
+  ignorePath: [],
+  resolveConfig: false,
+  withNodeModules: true,
+} satisfies FileInfoOptions;
+
+/** Uses the configured parser or infers one without loading Prettier config. */
+const resolveFmtParser = async (
+  filePath: string,
+  options: PrettierOptions,
+  plugins: PrettierPlugins,
+): Promise<PrettierOptions['parser'] | null> =>
+  options.parser ??
+  (
+    await getFileInfo(filePath, {
+      ...fileInfoOptions,
+      plugins,
+    })
+  ).inferredParser;
+
+/** Formats file contents, requesting the source only once a parser is known. */
+const formatFmtSource = async (
+  { path, options }: FmtFileRequest,
+  readSource: () => string,
+): Promise<FormatFmtSourceResult> => {
+  const plugins = await getPrettierPlugins(options, path);
+  const parser = await resolveFmtParser(path, options, plugins);
+  if (!parser) {
+    return { status: 'unsupported' };
+  }
+
+  const source = readSource();
+  const formatted = await format(source, {
+    ...options,
+    filepath: path,
+    parser,
+    plugins,
+  });
+
+  return { status: 'formatted', source, formatted };
+};
+
+export { formatFmtSource };

packages/rstack/src/fmt/prettierPlugins.ts

@@ -1,6 +1,6 @@
-import * as yukuPlugin from '@prettier/plugin-yuku';
 import type { Options as PrettierOptions, Plugin } from 'prettier';
 import type { ResolvedFmtOptions } from './types.ts';
+import { yukuPlugin } from './yukuPlugin.ts';
 
 type PrettierPlugins = NonNullable<PrettierOptions['plugins']>;