hcordova 1.0.0

package/src/utils/VariableValidator.js

@@ -0,0 +1,369 @@
+/*
+ * Copyright (c) 2025 Huawei Device, Inc. Ltd. and <马弓手>.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+class VariableValidator {
+    constructor(api) {
+        this.api = api;
+        this.events = api.events;
+    }
+
+    /**
+     * 收集变量并验证必需变量
+     */
+    collectAndValidateVariables(pluginConfig, installOptions) {
+        const vars = Object.fromEntries(installOptions.cli_variables)
+        const variables = {
+            // 内置变量
+            PLUGIN_ID: pluginConfig.id,
+            PLUGIN_NAME: pluginConfig.name,
+            PLUGIN_VERSION: pluginConfig.package.version,
+            // 从安装选项继承的变量
+            ...vars
+        };
+
+        // 获取插件声明的所有变量要求（合并全局和平台特定）
+        const pluginVariables = this._getAllPluginVariables(pluginConfig);
+        
+        // 验证必需变量
+        const missingVariables = [];
+        const validatedVariables = { ...variables }; // 复制已有变量
+
+        for (const [varName, varInfo] of Object.entries(pluginVariables)) {
+            if (varInfo.required) {
+                // 检查必需变量
+                const currentValue = validatedVariables[varName];
+                if (currentValue === undefined || currentValue === null || currentValue === '') {
+                    missingVariables.push({
+                        name: varName,
+                        info: varInfo
+                    });
+                }
+            } else {
+                // 可选变量，使用默认值或提供的值
+                if (validatedVariables[varName] === undefined) {
+                    validatedVariables[varName] = varInfo.default || '';
+                }
+            }
+        }
+
+        // 如果有缺失的必需变量，抛出错误
+        if (missingVariables.length > 0) {
+            const errorMessage = this._formatMissingVariablesError(pluginConfig.id, missingVariables);
+            throw new Error(errorMessage);
+        }
+
+        // 记录验证结果
+        this._logVariableValidation(pluginConfig.id, validatedVariables, pluginVariables);
+
+        return validatedVariables;
+    }
+
+    /**
+     * 获取插件声明的所有变量（合并全局和平台特定）
+     */
+    _getAllPluginVariables(pluginConfig) {
+        const variables = {};
+
+        // 添加全局preference变量
+        if (pluginConfig.preferences) {
+            for (const [name, pref] of Object.entries(pluginConfig.preferences)) {
+                variables[name] = {
+                    name: name,
+                    default: pref.default,
+                    required: pref.required,
+                    description: `Global preference: ${name}`,
+                    source: 'global'
+                };
+            }
+        }
+
+        // 添加平台特定preference变量
+        if (pluginConfig.platform && pluginConfig.platform.preferences) {
+            for (const [name, pref] of Object.entries(pluginConfig.platform.preferences)) {
+                // 如果变量已存在，平台特定的优先级更高
+                variables[name] = {
+                    name: name,
+                    default: pref.default,
+                    required: pref.required,
+                    description: `Platform preference: ${name}`,
+                    source: 'platform',
+                    platformSpecific: true
+                };
+            }
+        }
+
+        // 从config-file中提取变量引用
+        const configFileVariables = this._extractVariablesFromConfigFiles(pluginConfig);
+        for (const [name, varInfo] of Object.entries(configFileVariables)) {
+            // 如果变量尚未声明，添加它
+            if (!variables[name]) {
+                variables[name] = {
+                    name: name,
+                    default: '',
+                    required: true, // config-file中引用的变量默认必需
+                    description: `Referenced in config-file: ${name}`,
+                    source: 'config-file'
+                };
+            }
+        }
+
+        return variables;
+    }
+
+    /**
+     * 从config-file内容中提取变量引用
+     */
+    _extractVariablesFromConfigFiles(pluginConfig) {
+        const variables = {};
+
+        if (pluginConfig.platform && pluginConfig.platform.configFiles) {
+            pluginConfig.platform.configFiles.forEach(configFile => {
+                // 查找 $VARIABLE 格式的变量引用
+                const variableMatches = configFile.content.match(/\$([A-Z_][A-Z0-9_]*)/g) || [];
+                variableMatches.forEach(match => {
+                    const varName = match.substring(1); // 去掉 $ 符号
+                    if (!variables[varName]) {
+                        variables[varName] = {
+                            name: varName,
+                            configFile: configFile.target
+                        };
+                    }
+                });
+
+                // 查找preference元素中的变量引用
+                const preferenceMatches = configFile.content.match(/<preference\s+name="([^"]+)"\s+value="([^"]+)"\s*\/>/g) || [];
+                preferenceMatches.forEach(match => {
+                    const nameMatch = match.match(/name="([^"]+)"/);
+                    const valueMatch = match.match(/value="([^"]+)"/);
+                    if (nameMatch && valueMatch) {
+                        const prefName = nameMatch[1];
+                        const prefValue = valueMatch[1];
+                        
+                        // 如果值以 $ 开头，说明这是一个变量引用
+                        if (prefValue.startsWith('$')) {
+                            const varName = prefValue.substring(1);
+                            if (!variables[varName]) {
+                                variables[varName] = {
+                                    name: varName,
+                                    configFile: configFile.target,
+                                    usedInPreference: prefName
+                                };
+                            }
+                        }
+                    }
+                });
+            });
+        }
+
+        return variables;
+    }
+
+    /**
+     * 格式化缺失变量的错误信息
+     */
+    _formatMissingVariablesError(pluginId, missingVariables) {
+        const lines = [
+            `Missing required variables for plugin "${pluginId}":`,
+            ''
+        ];
+
+        missingVariables.forEach(({ name, info }) => {
+            lines.push(`  Variable: ${name}`);
+            if (info.description) {
+                lines.push(`  Description: ${info.description}`);
+            }
+            if (info.source) {
+                lines.push(`  Source: ${info.source}`);
+            }
+            if (info.default) {
+                lines.push(`  Default: ${info.default}`);
+            }
+            if (info.configFile) {
+                lines.push(`  Used in: ${info.configFile}`);
+            }
+            if (info.usedInPreference) {
+                lines.push(`  Preference: ${info.usedInPreference}`);
+            }
+            lines.push('');
+        });
+
+        lines.push('Please provide these variables using:');
+        lines.push('');
+        
+        // 生成命令行示例
+        const varExamples = missingVariables.map(({ name }) => `--variable ${name}=VALUE`);
+        lines.push(`  cordova plugin add ${pluginId} ${varExamples.join(' ')}`);
+        lines.push('');
+        lines.push('Or set them in your config.xml:');
+        lines.push('');
+        lines.push('  <plugin name="' + pluginId + '">');
+        missingVariables.forEach(({ name }) => {
+            lines.push(`    <variable name="${name}" value="YOUR_VALUE" />`);
+        });
+        lines.push('  </plugin>');
+
+        return lines.join('\n');
+    }
+
+    /**
+     * 记录变量验证结果
+     */
+    _logVariableValidation(pluginId, validatedVariables, pluginVariables) {
+        const providedVars = Object.keys(validatedVariables).filter(name => 
+            pluginVariables[name] && validatedVariables[name] && validatedVariables[name] !== pluginVariables[name].default
+        );
+        const defaultVars = Object.keys(validatedVariables).filter(name =>
+            pluginVariables[name] && validatedVariables[name] === pluginVariables[name].default
+        );
+        const unusedVars = Object.keys(validatedVariables).filter(name =>
+            !pluginVariables[name] && 
+            !['PLUGIN_ID', 'PLUGIN_NAME', 'PLUGIN_VERSION'].includes(name)
+        );
+
+        if (providedVars.length > 0) {
+            this.events.emit('verbose', `Provided variables for ${pluginId}: ${providedVars.join(', ')}`);
+        }
+        if (defaultVars.length > 0) {
+            this.events.emit('verbose', `Using default values for ${pluginId}: ${defaultVars.join(', ')}`);
+        }
+        if (unusedVars.length > 0) {
+            this.events.emit('warn', `Unused variables provided for ${pluginId}: ${unusedVars.join(', ')}`);
+        }
+
+        // 记录所有验证通过的变量
+        const allVars = Object.keys(pluginVariables);
+        if (allVars.length > 0) {
+            this.events.emit('log', `Validated ${allVars.length} variables for plugin ${pluginId}`);
+        }
+    }
+
+    /**
+     * 验证单个变量值
+     */
+    validateVariableValue(variableName, value, variableDefinition) {
+        if (variableDefinition.required && (!value || value.trim() === '')) {
+            return {
+                valid: false,
+                error: `Variable ${variableName} is required but value is empty`
+            };
+        }
+
+        // 可以添加更多验证规则
+        if (variableDefinition.pattern && value) {
+            const regex = new RegExp(variableDefinition.pattern);
+            if (!regex.test(value)) {
+                return {
+                    valid: false,
+                    error: `Variable ${variableName} value "${value}" does not match pattern ${variableDefinition.pattern}`
+                };
+            }
+        }
+
+        if (variableDefinition.options && value) {
+            const validOptions = variableDefinition.options.split(',').map(opt => opt.trim());
+            if (!validOptions.includes(value)) {
+                return {
+                    valid: false,
+                    error: `Variable ${variableName} value "${value}" is not one of: ${validOptions.join(', ')}`
+                };
+            }
+        }
+
+        return { valid: true };
+    }
+
+    /**
+     * 获取插件的变量文档
+     */
+    getVariableDocumentation(pluginConfig) {
+        const pluginVariables = this._getAllPluginVariables(pluginConfig);
+        const documentation = {
+            pluginId: pluginConfig.id,
+            pluginName: pluginConfig.name,
+            variables: {}
+        };
+
+        for (const [varName, varInfo] of Object.entries(pluginVariables)) {
+            documentation.variables[varName] = {
+                required: varInfo.required,
+                default: varInfo.default || '(none)',
+                description: varInfo.description || 'No description provided',
+                source: varInfo.source,
+                ...(varInfo.configFile && { usedIn: varInfo.configFile }),
+                ...(varInfo.usedInPreference && { preference: varInfo.usedInPreference })
+            };
+        }
+
+        return documentation;
+    }
+
+    /**
+     * 生成变量使用报告
+     */
+    generateVariableReport(pluginConfig, validatedVariables) {
+        const pluginVariables = this._getAllPluginVariables(pluginConfig);
+        const report = {
+            plugin: {
+                id: pluginConfig.id,
+                name: pluginConfig.name
+            },
+            variables: [],
+            summary: {
+                total: Object.keys(pluginVariables).length,
+                required: Object.values(pluginVariables).filter(v => v.required).length,
+                provided: 0,
+                usingDefault: 0
+            }
+        };
+
+        for (const [varName, varInfo] of Object.entries(pluginVariables)) {
+            const value = validatedVariables[varName];
+            const isUsingDefault = value === varInfo.default;
+            const isProvided = value && value !== varInfo.default;
+
+            if (isProvided) report.summary.provided++;
+            if (isUsingDefault) report.summary.usingDefault++;
+
+            report.variables.push({
+                name: varName,
+                value: this._maskSensitiveValue(varName, value),
+                required: varInfo.required,
+                source: varInfo.source,
+                status: isProvided ? 'provided' : (isUsingDefault ? 'default' : 'missing'),
+                description: varInfo.description
+            });
+        }
+
+        return report;
+    }
+
+    /**
+     * 屏蔽敏感值（如密码、密钥等）
+     */
+    _maskSensitiveValue(variableName, value) {
+        const sensitiveKeywords = ['KEY', 'SECRET', 'PASSWORD', 'TOKEN', 'AUTH'];
+        const isSensitive = sensitiveKeywords.some(keyword => 
+            variableName.toUpperCase().includes(keyword)
+        );
+
+        if (isSensitive && value) {
+            return value.substring(0, 4) + '***' + value.substring(value.length - 4);
+        }
+        return value;
+    }
+}
+
+module.exports = VariableValidator;

package/src/utils/args-processor.js

@@ -0,0 +1,79 @@
+/*
+ * Copyright (c) 2025 Huawei Device, Inc. Ltd. and <马弓手>.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+class ArgsProcessor {
+  constructor() {
+    this.harmonyAliases = ['harmonyos', 'harmony', 'hongmeng', 'ohos'];
+  }
+
+  preprocess(args) {
+    return args.map(arg => {
+      // 将鸿蒙别名统一为 harmonyos
+      if (this.harmonyAliases.includes(arg.toLowerCase())) {
+        return 'harmonyos';
+      }
+      return arg;
+    });
+  }
+
+  isHarmonyCommand(args) {
+    return args.some(arg => 
+      this.harmonyAliases.includes(arg.toLowerCase()) || 
+      arg === 'harmonyos'
+    );
+  }
+
+  getCommand(args) {
+    return args[0] || '';
+  }
+
+  getSubCommand(args) {
+    return args[1] || '';
+  }
+
+  getTargets(args) {
+    return args.slice(2);
+  }
+
+  extractOptions(args) {
+    const options = {};
+    const nonOptionArgs = [];
+    
+    for (let i = 0; i < args.length; i++) {
+      const arg = args[i];
+      if (arg.startsWith('--')) {
+        const key = arg.slice(2);
+        const nextArg = args[i + 1];
+        if (nextArg && !nextArg.startsWith('-')) {
+          options[key] = nextArg;
+          i++; // Skip next arg
+        } else {
+          options[key] = true;
+        }
+      } else if (arg.startsWith('-')) {
+        // Handle short options
+        const key = arg.slice(1);
+        options[key] = true;
+      } else {
+        nonOptionArgs.push(arg);
+      }
+    }
+    
+    return { options, nonOptionArgs };
+  }
+}
+
+module.exports = ArgsProcessor;

package/templates/project/AppScope/app.json5

@@ -0,0 +1,10 @@
+{
+  "app": {
+    "bundleName": "{{PACKAGE_NAME}}",
+    "vendor": "example",
+    "versionCode": 1000000,
+    "versionName": "1.0.0",
+    "icon": "$media:layered_image",
+    "label": "$string:app_name"
+  }
+}

package/templates/project/AppScope/resources/base/element/string.json

@@ -0,0 +1,8 @@
+{
+  "string": [
+    {
+      "name": "app_name",
+      "value": "{{PROJECT_NAME}}"
+    }
+  ]
+}

package/templates/project/AppScope/resources/base/media/layered_image.json

@@ -0,0 +1,7 @@
+{
+  "layered-image":
+  {
+    "background" : "$media:background",
+    "foreground" : "$media:foreground"
+  }
+}

package/templates/project/build-profile.json5

@@ -0,0 +1,46 @@
+{
+  "app": {
+    "signingConfigs": [],
+    "products": [
+      {
+        "name": "default",
+        "signingConfig": "default",
+        "targetSdkVersion": "5.0.5(17)",
+        "compatibleSdkVersion": "5.0.0(12)",
+        "runtimeOS": "HarmonyOS",
+        "buildOption": {
+          "strictMode": {
+            "caseSensitiveCheck": true,
+            "useNormalizedOHMUrl": true
+          }
+        }
+      }
+    ],
+    "buildModeSet": [
+      {
+        "name": "debug",
+      },
+      {
+        "name": "release"
+      }
+    ]
+  },
+  "modules": [
+    {
+      "name": "entry",
+      "srcPath": "./entry",
+      "targets": [
+        {
+          "name": "default",
+          "applyToProducts": [
+            "default"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "cordova",
+      "srcPath": "./cordova"
+    }
+  ]
+}

package/templates/project/code-linter.json5

@@ -0,0 +1,32 @@
+{
+  "files": [
+    "**/*.ets"
+  ],
+  "ignore": [
+    "**/src/ohosTest/**/*",
+    "**/src/test/**/*",
+    "**/src/mock/**/*",
+    "**/node_modules/**/*",
+    "**/oh_modules/**/*",
+    "**/build/**/*",
+    "**/.preview/**/*"
+  ],
+  "ruleSet": [
+    "plugin:@performance/recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "rules": {
+    "@security/no-unsafe-aes": "error",
+    "@security/no-unsafe-hash": "error",
+    "@security/no-unsafe-mac": "warn",
+    "@security/no-unsafe-dh": "error",
+    "@security/no-unsafe-dsa": "error",
+    "@security/no-unsafe-ecdsa": "error",
+    "@security/no-unsafe-rsa-encrypt": "error",
+    "@security/no-unsafe-rsa-sign": "error",
+    "@security/no-unsafe-rsa-key": "error",
+    "@security/no-unsafe-dsa-key": "error",
+    "@security/no-unsafe-dh-key": "error",
+    "@security/no-unsafe-3des": "error"
+  }
+}

package/templates/project/entry/build-profile.json5

@@ -0,0 +1,28 @@
+{
+  "apiType": "stageMode",
+  "buildOption": {
+  },
+  "buildOptionSet": [
+    {
+      "name": "release",
+      "arkOptions": {
+        "obfuscation": {
+          "ruleOptions": {
+            "enable": false,
+            "files": [
+              "./obfuscation-rules.txt"
+            ]
+          }
+        }
+      }
+    },
+  ],
+  "targets": [
+    {
+      "name": "default"
+    },
+    {
+      "name": "ohosTest",
+    }
+  ]
+}

package/templates/project/entry/hvigorfile.ts

@@ -0,0 +1,6 @@
+import { hapTasks } from '@ohos/hvigor-ohos-plugin';
+
+export default {
+    system: hapTasks,  /* Built-in plugin of Hvigor. It cannot be modified. */
+    plugins:[]         /* Custom plugin to extend the functionality of Hvigor. */
+}

package/templates/project/entry/obfuscation-rules.txt

@@ -0,0 +1,23 @@
+# Define project specific obfuscation rules here.
+# You can include the obfuscation configuration files in the current module's build-profile.json5.
+#
+# For more details, see
+#   https://developer.huawei.com/consumer/cn/doc/harmonyos-guides-V5/source-obfuscation-V5
+
+# Obfuscation options:
+# -disable-obfuscation: disable all obfuscations
+# -enable-property-obfuscation: obfuscate the property names
+# -enable-toplevel-obfuscation: obfuscate the names in the global scope
+# -compact: remove unnecessary blank spaces and all line feeds
+# -remove-log: remove all console.* statements
+# -print-namecache: print the name cache that contains the mapping from the old names to new names
+# -apply-namecache: reuse the given cache file
+
+# Keep options:
+# -keep-property-name: specifies property names that you want to keep
+# -keep-global-name: specifies names that you want to keep in the global scope
+
+-enable-property-obfuscation
+-enable-toplevel-obfuscation
+-enable-filename-obfuscation
+-enable-export-obfuscation

package/templates/project/entry/oh-package.json5

@@ -0,0 +1,12 @@
+{
+  "name": "entry",
+  "version": "1.0.0",
+  "description": "Please describe the basic information.",
+  "main": "",
+  "author": "",
+  "license": "",
+  "dependencies": {
+    "@magongshou/harmony-cordova": "file:../cordova"
+  }
+}
+