feat(vite-plus): add oxfmt and oxlint config types (#328)

Author: Brooooooklyn

.oxfmtrc.json

@@ -7,4 +7,6 @@ extend-exclude = [
   "**/snap-tests/**/snap.txt",
   "crates/fspy_detours_sys/detours",
   "crates/fspy_detours_sys/src/generated_bindings.rs",
+  "packages/cli/src/oxfmt-config.ts",
+  "packages/cli/src/oxlint-config.ts",
 ]

.typos.toml

@@ -36,7 +36,7 @@
     ],
     "*.@(js|ts|tsx)": [
       "oxlint -- --fix",
-      "oxfmt"
+      "vite fmt"
     ],
     "*.rs": [
       "cargo fmt --"

package.json

@@ -18,28 +18,16 @@ use vite_task::{
 };
 
 use crate::commands::{
-    add::AddCommand,
-    dedupe::DedupeCommand,
-    doc::doc as doc_cmd,
-    fmt::{FmtConfig, fmt},
-    install::InstallCommand,
-    lib_cmd::lib,
-    link::LinkCommand,
-    lint::{LintConfig, lint},
-    outdated::OutdatedCommand,
-    pm::PmCommand,
-    remove::RemoveCommand,
-    test::test,
-    unlink::UnlinkCommand,
-    update::UpdateCommand,
-    vite::vite as vite_cmd,
-    why::WhyCommand,
+    add::AddCommand, dedupe::DedupeCommand, doc::doc as doc_cmd, fmt::fmt, install::InstallCommand,
+    lib_cmd::lib, link::LinkCommand, lint::lint, outdated::OutdatedCommand, pm::PmCommand,
+    remove::RemoveCommand, test::test, unlink::UnlinkCommand, update::UpdateCommand,
+    vite::vite as vite_cmd, why::WhyCommand,
 };
 
 #[derive(Debug, Clone, Serialize, Deserialize)]
 pub struct ResolvedUniversalViteConfig {
-    pub lint: Option<LintConfig>,
-    pub fmt: Option<FmtConfig>,
+    pub lint: Option<serde_json::Value>,
+    pub fmt: Option<serde_json::Value>,
 }
 
 #[derive(Parser, Debug)]
@@ -993,9 +981,29 @@ pub async fn main<
         }
         Commands::Fmt { args } => {
             let workspace = Workspace::partial_load(cwd)?;
+            let vite_config = read_vite_config_from_workspace_root(
+                workspace.root_dir(),
+                options.as_ref().map(|o| &o.resolve_universal_vite_config),
+            )
+            .await?;
             let fmt_fn =
                 options.map(|o| o.fmt).expect("fmt command requires CliOptions to be provided");
-
+            let resolved_vite_config: Option<ResolvedUniversalViteConfig> = vite_config
+                .map(|vite_config| {
+                    serde_json::from_str(&vite_config).inspect_err(|_| {
+                        tracing::error!("Failed to parse vite config: {vite_config}");
+                    })
+                })
+                .transpose()?;
+            let fmt_config = resolved_vite_config.and_then(|c| c.fmt);
+            if let Some(fmt_config) = fmt_config {
+                let oxfmt_config_path = workspace.cache_path().join(".oxfmtrc.json");
+                write(&oxfmt_config_path, serde_json::to_string(&fmt_config)?).await?;
+                args.extend_from_slice(&[
+                    "--config".to_string(),
+                    oxfmt_config_path.as_path().to_string_lossy().into_owned(),
+                ]);
+            }
             let summary = fmt(fmt_fn, &workspace, args).await?;
             workspace.unload().await?;
             summary

packages/cli/binding/src/cli.rs

@@ -1,18 +1,11 @@
-use std::{collections::HashMap, future::Future, iter::once};
+use std::{future::Future, iter::once};
 
 use petgraph::stable_graph::StableGraph;
-use serde::{Deserialize, Serialize};
-use serde_json::Value;
 use vite_error::Error as ViteError;
 use vite_task::{
     Error, ExecutionPlan, ExecutionSummary, ResolveCommandResult, ResolvedTask, Workspace,
 };
 
-#[derive(Debug, Clone, Serialize, Deserialize)]
-pub struct FmtConfig {
-    pub rules: HashMap<String, Value>,
-}
-
 #[tracing::instrument(skip(resolve_fmt_command, workspace))]
 pub async fn fmt<
     Fmt: Future<Output = Result<ResolveCommandResult, ViteError>>,

packages/cli/binding/src/commands/fmt.rs

@@ -1,17 +1,11 @@
-use std::{collections::HashMap, future::Future, iter::once};
+use std::{future::Future, iter::once};
 
 use petgraph::stable_graph::StableGraph;
-use serde::{Deserialize, Serialize};
 use vite_error::Error as ViteError;
 use vite_task::{
     Error, ExecutionPlan, ExecutionSummary, ResolveCommandResult, ResolvedTask, Workspace,
 };
 
-#[derive(Debug, Clone, Serialize, Deserialize)]
-pub struct LintConfig {
-    pub rules: HashMap<String, String>,
-}
-
 #[tracing::instrument(skip(resolve_lint_command, workspace))]
 pub async fn lint<
     Lint: Future<Output = Result<ResolveCommandResult, ViteError>>,

packages/cli/binding/src/commands/lint.rs

@@ -1,3 +1,4 @@
+import { existsSync, mkdirSync, writeFileSync } from 'node:fs';
 import { dirname, join } from 'node:path';
 import { fileURLToPath } from 'node:url';
 
@@ -32,8 +33,18 @@ async function buildNapiBinding() {
   });
 
   const outputs = await task;
+  const fmtConfigPath = join(projectDir, '../../node_modules/.vite/task-cache/.oxfmtrc.json');
+  if (!existsSync(fmtConfigPath)) {
+    const viteConfig = await import('../../vite.config');
+    mkdirSync(dirname(fmtConfigPath), { recursive: true });
+    writeFileSync(fmtConfigPath, JSON.stringify(viteConfig.default.fmt, null, 2));
+  }
   await format(
-    outputs.filter((o) => o.kind !== 'node').map((o) => o.path),
+    [
+      '-c',
+      '../../node_modules/.vite/task-cache/.oxfmtrc.json',
+      ...outputs.filter((o) => o.kind !== 'node').map((o) => o.path),
+    ],
     formatEmbeddedCode,
   );
 }

packages/cli/build.ts

@@ -52,7 +52,7 @@ Options:
 
 
 > vite fmt -h # fmt help message
-Usage: [--check | --list-different] [-c=PATH] [--ignore-path=PATH]... [PATH]...
+Usage: [-c=PATH] [PATH]...
 
 Output Options
         --check              Check mode - check if files are formatted, also show statistics
@@ -67,15 +67,15 @@ Ignore Options
                              used.
         --with-node-modules  Format code in node_modules directory (skipped by default)
 
-Miscellaneous
+Misc Options
         --lsp                Start language server protocol (LSP) server
         --no-error-on-unmatched-pattern  Do not exit with error when pattern is unmatched
         --threads=INT        Number of threads to use. Set to 1 for using only 1 CPU core.
 
 Available positional items:
     PATH                     Single file, single path or list of paths. If not provided, current
                              working directory is used. Glob is supported only for exclude patterns
-                             like `'!**/fixtures/*.js'.
+                             like `'!**/fixtures/*.js'`.
 
 Available options:
     -h, --help               Prints help information

packages/cli/snap-tests/command-helper/snap.txt

@@ -1,26 +1,16 @@
 import { defineConfig } from '@voidzero-dev/vite-plus-test/config';
 
-// replace it with the real oxlint config in the future
-export type LintConfig = {
-  rules: {
-    [key: string]: string;
-  };
-};
-
-export type FmtConfig = {
-  rules: {
-    [key: string]: string;
-  };
-};
+import type { OxfmtConfig } from './oxfmt-config';
+import type { OxlintConfig } from './oxlint-config';
 
 declare module '@voidzero-dev/vite-plus-core' {
   interface UserConfig {
     /**
      * Options for oxlint
      */
-    lint?: LintConfig;
+    lint?: OxlintConfig;
 
-    fmt?: FmtConfig;
+    fmt?: OxfmtConfig;
   }
 }