feat: 项目配置的验证支持使用远程配置文件

Author: luckyadam

Cargo.toml

@@ -12,6 +12,7 @@ crate-type = ["cdylib"]
 napi = { version = "2", default-features = false, features = [
   "napi4",
   "serde-json",
+  "async"
 ] }
 napi-derive = { version = "2", default-features = false }
 
@@ -20,6 +21,8 @@ jsonschema = "0.17"
 emojis = "0.6.0"
 console = "0.15.7"
 regex = "1.8.3"
+reqwest = "0.11.18"
+tokio = "1.28.2"
 
 [build-dependencies]
 napi-build = "2.0.1"

assets/config_schema.json

@@ -142,14 +142,14 @@
       "oneOf": [
         {
           "type": "string",
-          "enum": ["webpack4", "webpack5"]
+          "enum": ["webpack4", "webpack5", "vite"]
         },
         {
           "type": "object",
           "properties": {
             "type": {
               "type": "string",
-              "enum": ["webpack4", "webpack5"]
+              "enum": ["webpack4", "webpack5", "vite"]
             },
             "prebundle": {
               "type": "object",

index.js

@@ -20,7 +20,7 @@ exports.default = (ctx) => {
         fn() {
             return __awaiter(this, void 0, void 0, function* () {
                 const { appPath, nodeModulesPath, configPath } = ctx.paths;
-                const { fs, chalk, PROJECT_CONFIG } = ctx.helper;
+                const { fs, chalk, getUserHomeDir, TARO_CONFIG_FOLDER, TARO_BASE_CONFIG, PROJECT_CONFIG } = ctx.helper;
                 if (!configPath || !fs.existsSync(configPath)) {
                     console.log(chalk.red(`找不到项目配置文件${PROJECT_CONFIG}，请确定当前目录是 Taro 项目根目录!`));
                     process.exit(1);
@@ -31,8 +31,24 @@ exports.default = (ctx) => {
                     }
                     return v;
                 });
+                let remoteConfigSchemaUrl = 'https://raw.githubusercontent.com/NervJS/taro-doctor/main/assets/config_schema.json';
+                let useRemoteConfigSchema = true;
+                const homedir = getUserHomeDir();
+                if (homedir) {
+                    const taroConfigPath = path.join(homedir, TARO_CONFIG_FOLDER);
+                    const taroConfig = path.join(taroConfigPath, TARO_BASE_CONFIG);
+                    if (fs.existsSync(taroConfig)) {
+                        const config = yield fs.readJSON(taroConfig);
+                        remoteConfigSchemaUrl = config && config.remoteConfigSchemaUrl ? config.remoteConfigSchemaUrl : remoteConfigSchemaUrl;
+                        useRemoteConfigSchema = config && config.useRemoteConfigSchema ? config.useRemoteConfigSchema : useRemoteConfigSchema;
+                    }
+                    else {
+                        yield fs.createFile(taroConfig);
+                        yield fs.writeJSON(taroConfig, { remoteConfigSchemaUrl, useRemoteConfigSchema });
+                    }
+                }
                 (0, js_binding_1.validateEnvPrint)();
-                (0, js_binding_1.validateConfigPrint)(configStr);
+                yield (0, js_binding_1.validateConfigPrint)(configStr, remoteConfigSchemaUrl, useRemoteConfigSchema);
                 (0, js_binding_1.validatePackagePrint)(appPath, nodeModulesPath);
                 (0, js_binding_1.validateRecommendPrint)(appPath);
                 yield validateEslintPrint(ctx.initialConfig, chalk);

index.ts

@@ -17,7 +17,7 @@ export default (ctx) => {
     name: 'doctor',
     async fn() {
       const { appPath, nodeModulesPath, configPath } = ctx.paths
-      const { fs, chalk, PROJECT_CONFIG } = ctx.helper
+      const { fs, chalk, getUserHomeDir, TARO_CONFIG_FOLDER, TARO_BASE_CONFIG, PROJECT_CONFIG } = ctx.helper
 
       if (!configPath || !fs.existsSync(configPath)) {
         console.log(chalk.red(`找不到项目配置文件${PROJECT_CONFIG}，请确定当前目录是 Taro 项目根目录!`))
@@ -29,8 +29,23 @@ export default (ctx) => {
         }
         return v
       })
+      let remoteConfigSchemaUrl = 'https://raw.githubusercontent.com/NervJS/taro-doctor/main/assets/config_schema.json'
+      let useRemoteConfigSchema = true
+      const homedir = getUserHomeDir()
+      if (homedir) {
+        const taroConfigPath = path.join(homedir, TARO_CONFIG_FOLDER)
+        const taroConfig = path.join(taroConfigPath, TARO_BASE_CONFIG)
+        if (fs.existsSync(taroConfig)) {
+          const config = await fs.readJSON(taroConfig)
+          remoteConfigSchemaUrl = config && config.remoteConfigSchemaUrl ? config.remoteConfigSchemaUrl : remoteConfigSchemaUrl
+          useRemoteConfigSchema = config && config.useRemoteConfigSchema ? config.useRemoteConfigSchema : useRemoteConfigSchema
+        } else {
+          await fs.createFile(taroConfig)
+          await fs.writeJSON(taroConfig, { remoteConfigSchemaUrl, useRemoteConfigSchema })
+        }
+      }
       validateEnvPrint()
-      validateConfigPrint(configStr)
+      await validateConfigPrint(configStr, remoteConfigSchemaUrl, useRemoteConfigSchema)
       validatePackagePrint(appPath, nodeModulesPath)
       validateRecommendPrint(appPath)
       await validateEslintPrint(ctx.initialConfig, chalk)

js-binding.d.ts

@@ -19,8 +19,8 @@ export interface ValidateResult {
   isValid: boolean
   messages: Array<Message>
 }
-export function validateConfig(configStr: string): ValidateResult
-export function validateConfigPrint(configStr: string): boolean
+export function validateConfig(configStr: string, remoteSchemaUrl: string, useRemoteSchema: boolean): Promise<ValidateResult>
+export function validateConfigPrint(configStr: string, remoteSchemaUrl: string, useRemoteSchema: boolean): Promise<boolean>
 export function validatePackage(appPath: string, nodeModulesPath: string): ValidateResult
 export function validatePackagePrint(appPath: string, nodeModulesPath: string): boolean
 export function validateEnv(): ValidateResult

src/lib.rs

@@ -1,10 +1,9 @@
 #![deny(clippy::all)]
 
 mod validators;
-
 use std::{error::Error, fs, path::PathBuf};
 
-use validators::{env::EnvValidator, message::ValidateResult, recommend::RecommendValidator};
+use validators::{env::EnvValidator, message::ValidateResult, recommend::RecommendValidator, common::fetch_data_text};
 
 use crate::validators::{
   common::Validator,
@@ -17,8 +16,8 @@ use crate::validators::{
 extern crate napi_derive;
 
 #[napi]
-pub fn validate_config(config_str: String) -> ValidateResult {
-  let result = validate_config_core(config_str);
+pub async fn validate_config(config_str: String, remote_schema_url: String, use_remote_schema: bool) -> ValidateResult {
+  let result = validate_config_core(config_str, remote_schema_url, use_remote_schema).await;
   let messages = match result {
     Ok(messages) => messages,
     Err(e) => {
@@ -42,8 +41,8 @@ pub fn validate_config(config_str: String) -> ValidateResult {
 }
 
 #[napi]
-pub fn validate_config_print(config_str: String) -> bool {
-  let result = validate_config_core(config_str);
+pub async fn validate_config_print(config_str: String, remote_schema_url: String, use_remote_schema: bool) -> bool {
+  let result = validate_config_core(config_str, remote_schema_url, use_remote_schema).await;
   let messages = match result {
     Ok(messages) => messages,
     Err(e) => {
@@ -220,14 +219,35 @@ pub fn validate_recommend_print(app_path: String) -> bool {
   is_valid
 }
 
-fn validate_config_core(config_str: String) -> Result<Vec<Message>, Box<dyn Error>> {
-  let tip = Message {
+async fn validate_config_core(config_str: String, remote_schema_url: String, use_remote_schema: bool) -> Result<Vec<Message>, Box<dyn Error>> {
+  let mut tip = vec![Message {
     kind: MessageKind::Info,
     content: String::from("验证项目配置 (/config/index.js) ！"),
     solution: None,
+  }];
+  let schema_str = if use_remote_schema {
+    match fetch_data_text(&remote_schema_url).await {
+      Ok(schema_str) => {
+        tip.push(Message {
+          kind: MessageKind::Success,
+          content: String::from(format!("成功获取远程配置验证文件：{}", remote_schema_url)),
+          solution: None,
+        });
+        schema_str
+      },
+      Err(_) => {
+        tip.push(Message {
+          kind: MessageKind::Warning,
+          content: String::from("无法获取远程配置验证文件，将使用本地配置验证文件！"),
+          solution: None,
+        });
+        include_str!("../assets/config_schema.json").to_string()
+      }
+    }
+  } else {
+    include_str!("../assets/config_schema.json").to_string()
   };
-  let schema_str = include_str!("../assets/config_schema.json");
-  let config_validator_result = ConfigValidator::build(String::from(schema_str), config_str);
+  let config_validator_result = ConfigValidator::build(schema_str, config_str);
   let mut messages = match config_validator_result {
     Ok(config_validator) => config_validator.validate(),
     Err(e) => vec![Message {
@@ -243,7 +263,7 @@ fn validate_config_core(config_str: String) -> Result<Vec<Message>, Box<dyn Erro
       solution: None,
     })
   }
-  messages.insert(0, tip);
+  messages.splice(0..0, tip);
   Ok(messages)
 }
 

src/validators/common.rs

@@ -1,4 +1,4 @@
-use std::{cmp::Ordering, error::Error, fs, path::PathBuf};
+use std::{cmp::Ordering, error::Error, fs, path::PathBuf, time::Duration};
 
 use serde_json::{from_str, Value};
 
@@ -14,6 +14,14 @@ pub struct PackageInfo {
   pub json: Value,
 }
 
+/**
+ * @description: 获取 package.json 信息
+ * @param {&str} node_modules_path
+ * @param {&str} name
+ * @return {Result<PackageInfo, Box<dyn Error>>}
+ * @example:
+ * get_package_info("./node_modules", "react")
+ */
 pub fn get_package_info(
   node_modules_path: &str,
   name: &str,
@@ -51,6 +59,12 @@ pub fn get_package_info(
   }
 }
 
+/**
+ * @description: 比较版本号
+ * @param {&str} a
+ * @param {&str} b
+ * @return {Option<Ordering>}
+ */
 pub fn compare_versions(a: &str, b: &str) -> Option<Ordering> {
   let parts1: Vec<u64> = a.split('.').filter_map(|s| s.parse().ok()).collect();
   let parts2: Vec<u64> = b.split('.').filter_map(|s| s.parse().ok()).collect();
@@ -68,3 +82,22 @@ pub fn compare_versions(a: &str, b: &str) -> Option<Ordering> {
     Ordering::Equal => Some(Ordering::Equal),
   }
 }
+
+/**
+ * @description: 获取远程数据
+ * @param {&str} url
+ * @return {Result<String, reqwest::Error>}
+ */
+pub async fn fetch_data_text(url: &str) -> Result<String, reqwest::Error> {
+  let client = reqwest::Client::builder()
+    .timeout(Duration::from_secs(1))
+    .build()?;
+  let response = client.get(url).send().await?;
+  if response.status().is_success() {
+    let text = response.text().await?;
+    Ok(text)
+  } else {
+    let error = response.error_for_status();
+    Err(error.unwrap_err())
+  }
+}