@@ -0,0 +1,2 @@
|
||||
/cache
|
||||
/project.local.yml
|
||||
@@ -0,0 +1,9 @@
|
||||
# 项目概览
|
||||
- 项目名称:timi-config
|
||||
- 作用:提供基于 SnakeYAML 的 Java YAML 配置加载、映射、序列化能力
|
||||
- 技术栈:Java 21、Maven、SnakeYAML 2.6、JUnit Jupiter、Lombok、timi-io
|
||||
- 代码结构:
|
||||
- `src/main/java/com/imyeyu/config`:核心配置加载与转换逻辑
|
||||
- `src/test/java/test`:面向 `ConfigLoader` 的测试与示例配置对象
|
||||
- 根目录 `test.yaml`、`test_converter.yaml`:测试资源
|
||||
- 主要入口:`ConfigLoader<T>`,负责加载、对象映射、导出 YAML、自定义转换器注册
|
||||
@@ -0,0 +1,7 @@
|
||||
# 风格与约束
|
||||
- 文本编码使用 UTF-8
|
||||
- 中文沟通,代码注释和文档优先使用中文
|
||||
- 缩进使用 tab
|
||||
- 倾向简单直接的实现,避免过度设计
|
||||
- 优先使用 Serena 的符号级工具理解和修改 Java 代码
|
||||
- 当前库对 YAML 导出做了定制:枚举导出为字符串,普通对象按 Map 结构导出,尽量减少类型标签
|
||||
@@ -0,0 +1,11 @@
|
||||
# 常用命令
|
||||
- 列出文件:`rg --files`
|
||||
- 搜索内容:`rg "关键字" src`
|
||||
- 运行单个测试:`mvn -q "-Dmaven.test.skip=false" "-Dtest=test.TestConfig#testLoadAndDump" test`
|
||||
- 编译跳过测试:`mvn -q -DskipTests compile`
|
||||
- 查看 Git 状态:`git status --short`
|
||||
|
||||
# Windows 环境
|
||||
- Shell 为 PowerShell
|
||||
- 读取文件可用 `Get-Content`
|
||||
- 列目录可用 `Get-ChildItem`
|
||||
@@ -0,0 +1,5 @@
|
||||
# 完成任务后建议
|
||||
- 优先跑与改动直接相关的最小测试,不默认跑全量构建
|
||||
- 若涉及 YAML 映射或序列化,至少补跑对应 `ConfigLoader` 测试
|
||||
- 若只改文档或注释,可不跑 Maven
|
||||
- 提交信息使用英语,符合 Git 规范
|
||||
@@ -0,0 +1,154 @@
|
||||
# the name by which the project can be referenced within Serena
|
||||
project_name: "timi-config"
|
||||
|
||||
|
||||
# list of languages for which language servers are started; choose from:
|
||||
# al bash clojure cpp csharp
|
||||
# csharp_omnisharp dart elixir elm erlang
|
||||
# fortran fsharp go groovy haskell
|
||||
# haxe java julia kotlin lua
|
||||
# markdown
|
||||
# matlab nix pascal perl php
|
||||
# php_phpactor powershell python python_jedi r
|
||||
# rego ruby ruby_solargraph rust scala
|
||||
# swift terraform toml typescript typescript_vts
|
||||
# vue yaml zig
|
||||
# (This list may be outdated. For the current list, see values of Language enum here:
|
||||
# https://github.com/oraios/serena/blob/main/src/solidlsp/ls_config.py
|
||||
# For some languages, there are alternative language servers, e.g. csharp_omnisharp, ruby_solargraph.)
|
||||
# Note:
|
||||
# - For C, use cpp
|
||||
# - For JavaScript, use typescript
|
||||
# - For Free Pascal/Lazarus, use pascal
|
||||
# Special requirements:
|
||||
# Some languages require additional setup/installations.
|
||||
# See here for details: https://oraios.github.io/serena/01-about/020_programming-languages.html#language-servers
|
||||
# When using multiple languages, the first language server that supports a given file will be used for that file.
|
||||
# The first language is the default language and the respective language server will be used as a fallback.
|
||||
# Note that when using the JetBrains backend, language servers are not used and this list is correspondingly ignored.
|
||||
languages:
|
||||
- java
|
||||
|
||||
# the encoding used by text files in the project
|
||||
# For a list of possible encodings, see https://docs.python.org/3.11/library/codecs.html#standard-encodings
|
||||
encoding: "utf-8"
|
||||
|
||||
# line ending convention to use when writing source files.
|
||||
# Possible values: unset (use global setting), "lf", "crlf", or "native" (platform default)
|
||||
# This does not affect Serena's own files (e.g. memories and configuration files), which always use native line endings.
|
||||
line_ending:
|
||||
|
||||
# The language backend to use for this project.
|
||||
# If not set, the global setting from serena_config.yml is used.
|
||||
# Valid values: LSP, JetBrains
|
||||
# Note: the backend is fixed at startup. If a project with a different backend
|
||||
# is activated post-init, an error will be returned.
|
||||
language_backend:
|
||||
|
||||
# whether to use project's .gitignore files to ignore files
|
||||
ignore_all_files_in_gitignore: true
|
||||
|
||||
# advanced configuration option allowing to configure language server-specific options.
|
||||
# Maps the language key to the options.
|
||||
# Have a look at the docstring of the constructors of the LS implementations within solidlsp (e.g., for C# or PHP) to see which options are available.
|
||||
# No documentation on options means no options are available.
|
||||
ls_specific_settings: {}
|
||||
|
||||
# list of additional paths to ignore in this project.
|
||||
# Same syntax as gitignore, so you can use * and **.
|
||||
# Note: global ignored_paths from serena_config.yml are also applied additively.
|
||||
ignored_paths: []
|
||||
|
||||
# whether the project is in read-only mode
|
||||
# If set to true, all editing tools will be disabled and attempts to use them will result in an error
|
||||
# Added on 2025-04-18
|
||||
read_only: false
|
||||
|
||||
# list of tool names to exclude.
|
||||
# This extends the existing exclusions (e.g. from the global configuration)
|
||||
#
|
||||
# Below is the complete list of tools for convenience.
|
||||
# To make sure you have the latest list of tools, and to view their descriptions,
|
||||
# execute `uv run scripts/print_tool_overview.py`.
|
||||
#
|
||||
# * `activate_project`: Activates a project based on the project name or path.
|
||||
# * `check_onboarding_performed`: Checks whether project onboarding was already performed.
|
||||
# * `create_text_file`: Creates/overwrites a file in the project directory.
|
||||
# * `delete_memory`: Delete a memory file. Should only happen if a user asks for it explicitly,
|
||||
# for example by saying that the information retrieved from a memory file is no longer correct
|
||||
# or no longer relevant for the project.
|
||||
# * `edit_memory`: Replaces content matching a regular expression in a memory.
|
||||
# * `execute_shell_command`: Executes a shell command.
|
||||
# * `find_file`: Finds files in the given relative paths
|
||||
# * `find_referencing_symbols`: Finds symbols that reference the given symbol using the language server backend
|
||||
# * `find_symbol`: Performs a global (or local) search using the language server backend.
|
||||
# * `get_current_config`: Prints the current configuration of the agent, including the active and available projects, tools, contexts, and modes.
|
||||
# * `get_symbols_overview`: Gets an overview of the top-level symbols defined in a given file.
|
||||
# * `initial_instructions`: Provides instructions Serena usage (i.e. the 'Serena Instructions Manual')
|
||||
# for clients that do not read the initial instructions when the MCP server is connected.
|
||||
# * `insert_after_symbol`: Inserts content after the end of the definition of a given symbol.
|
||||
# * `insert_before_symbol`: Inserts content before the beginning of the definition of a given symbol.
|
||||
# * `list_dir`: Lists files and directories in the given directory (optionally with recursion).
|
||||
# * `list_memories`: List available memories. Any memory can be read using the `read_memory` tool.
|
||||
# * `onboarding`: Performs onboarding (identifying the project structure and essential tasks, e.g. for testing or building).
|
||||
# * `read_file`: Reads a file within the project directory.
|
||||
# * `read_memory`: Read the content of a memory file. This tool should only be used if the information
|
||||
# is relevant to the current task. You can infer whether the information
|
||||
# is relevant from the memory file name.
|
||||
# You should not read the same memory file multiple times in the same conversation.
|
||||
# * `rename_memory`: Renames or moves a memory. Moving between project and global scope is supported
|
||||
# (e.g., renaming "global/foo" to "bar" moves it from global to project scope).
|
||||
# * `rename_symbol`: Renames a symbol throughout the codebase using language server refactoring capabilities.
|
||||
# For JB, we use a separate tool.
|
||||
# * `replace_content`: Replaces content in a file (optionally using regular expressions).
|
||||
# * `replace_symbol_body`: Replaces the full definition of a symbol using the language server backend.
|
||||
# * `safe_delete_symbol`:
|
||||
# * `search_for_pattern`: Performs a search for a pattern in the project.
|
||||
# * `write_memory`: Write some information (utf-8-encoded) about this project that can be useful for future tasks to a memory in md format.
|
||||
# The memory name should be meaningful.
|
||||
excluded_tools: []
|
||||
|
||||
# list of tools to include that would otherwise be disabled (particularly optional tools that are disabled by default).
|
||||
# This extends the existing inclusions (e.g. from the global configuration).
|
||||
included_optional_tools: []
|
||||
|
||||
# fixed set of tools to use as the base tool set (if non-empty), replacing Serena's default set of tools.
|
||||
# This cannot be combined with non-empty excluded_tools or included_optional_tools.
|
||||
fixed_tools: []
|
||||
|
||||
# list of mode names to that are always to be included in the set of active modes
|
||||
# The full set of modes to be activated is base_modes + default_modes.
|
||||
# If the setting is undefined, the base_modes from the global configuration (serena_config.yml) apply.
|
||||
# Otherwise, this setting overrides the global configuration.
|
||||
# Set this to [] to disable base modes for this project.
|
||||
# Set this to a list of mode names to always include the respective modes for this project.
|
||||
base_modes:
|
||||
|
||||
# list of mode names that are to be activated by default.
|
||||
# The full set of modes to be activated is base_modes + default_modes.
|
||||
# If the setting is undefined, the default_modes from the global configuration (serena_config.yml) apply.
|
||||
# Otherwise, this overrides the setting from the global configuration (serena_config.yml).
|
||||
# This setting can, in turn, be overridden by CLI parameters (--mode).
|
||||
default_modes:
|
||||
|
||||
# initial prompt for the project. It will always be given to the LLM upon activating the project
|
||||
# (contrary to the memories, which are loaded on demand).
|
||||
initial_prompt: ""
|
||||
|
||||
# time budget (seconds) per tool call for the retrieval of additional symbol information
|
||||
# such as docstrings or parameter information.
|
||||
# This overrides the corresponding setting in the global configuration; see the documentation there.
|
||||
# If null or missing, use the setting from the global configuration.
|
||||
symbol_info_budget:
|
||||
|
||||
# list of regex patterns which, when matched, mark a memory entry as read‑only.
|
||||
# Extends the list from the global configuration, merging the two lists.
|
||||
read_only_memory_patterns: []
|
||||
|
||||
# list of regex patterns for memories to completely ignore.
|
||||
# Matching memories will not appear in list_memories or activate_project output
|
||||
# and cannot be accessed via read_memory or write_memory.
|
||||
# To access ignored memory files, use the read_file tool on the raw file path.
|
||||
# Extends the list from the global configuration, merging the two lists.
|
||||
# Example: ["_archive/.*", "_episodes/.*"]
|
||||
ignored_memory_patterns: []
|
||||
@@ -6,7 +6,7 @@
|
||||
|
||||
<groupId>com.imyeyu.config</groupId>
|
||||
<artifactId>timi-config</artifactId>
|
||||
<version>0.0.3</version>
|
||||
<version>0.1.0</version>
|
||||
|
||||
<properties>
|
||||
<maven.test.skip>true</maven.test.skip>
|
||||
@@ -96,7 +96,7 @@
|
||||
<dependency>
|
||||
<groupId>com.imyeyu.io</groupId>
|
||||
<artifactId>timi-io</artifactId>
|
||||
<version>0.0.5</version>
|
||||
<version>0.1.0</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.junit.jupiter</groupId>
|
||||
|
||||
@@ -2,8 +2,8 @@ package com.imyeyu.config;
|
||||
|
||||
import com.imyeyu.io.IO;
|
||||
import com.imyeyu.io.IOSize;
|
||||
import com.imyeyu.java.bean.timi.TimiCode;
|
||||
import com.imyeyu.java.bean.timi.TimiException;
|
||||
import com.imyeyu.java.bean.ActionException;
|
||||
import com.imyeyu.java.bean.ResultCode;
|
||||
import org.yaml.snakeyaml.DumperOptions;
|
||||
import org.yaml.snakeyaml.LoaderOptions;
|
||||
import org.yaml.snakeyaml.Yaml;
|
||||
@@ -13,11 +13,15 @@ import org.yaml.snakeyaml.representer.Representer;
|
||||
import java.io.File;
|
||||
import java.lang.reflect.Array;
|
||||
import java.lang.reflect.Field;
|
||||
import java.lang.reflect.ParameterizedType;
|
||||
import java.lang.reflect.Type;
|
||||
import java.util.ArrayList;
|
||||
import java.util.HashMap;
|
||||
import java.util.LinkedHashMap;
|
||||
import java.util.LinkedHashSet;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.Set;
|
||||
|
||||
/**
|
||||
* 配置加载器 - SnakeYAML 封装
|
||||
@@ -68,7 +72,7 @@ public class ConfigLoader<T> {
|
||||
try {
|
||||
IO.resourceToDisk(getClass(), srcPath, distPath);
|
||||
} catch (Exception e) {
|
||||
throw new TimiException(TimiCode.ERROR, "load default config error", e);
|
||||
throw new ActionException(ResultCode.ERROR, "load default config error", e);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -119,7 +123,7 @@ public class ConfigLoader<T> {
|
||||
value = (T) raw;
|
||||
return value;
|
||||
} catch (Exception e) {
|
||||
throw new TimiException(TimiCode.ERROR, "load config error: " + file.getAbsolutePath(), e);
|
||||
throw new ActionException(ResultCode.ERROR, "load config error: " + file.getAbsolutePath(), e);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -133,7 +137,7 @@ public class ConfigLoader<T> {
|
||||
|
||||
IO.toFile(file, yamlContent);
|
||||
} catch (Exception e) {
|
||||
throw new TimiException(TimiCode.ERROR, "dump config error: " + file.getAbsolutePath(), e);
|
||||
throw new ActionException(ResultCode.ERROR, "dump config error: " + file.getAbsolutePath(), e);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -155,7 +159,7 @@ public class ConfigLoader<T> {
|
||||
applyMapToObject(map, instance);
|
||||
return instance;
|
||||
} catch (Exception e) {
|
||||
throw new TimiException(TimiCode.ERROR, "map to bean error: " + targetClass.getName(), e);
|
||||
throw new ActionException(ResultCode.ERROR, "map to bean error: " + targetClass.getName(), e);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -187,30 +191,81 @@ public class ConfigLoader<T> {
|
||||
}
|
||||
|
||||
private Object convertFieldValue(Field field, Object rawValue) {
|
||||
Object preparedRawValue = convertTypeValue(field.getGenericType(), rawValue);
|
||||
BaseConverter<?, ?> converter = converters.get(field.getType());
|
||||
if (converter != null) {
|
||||
return converter.deserialize0(field, rawValue);
|
||||
return converter.deserialize0(field, preparedRawValue);
|
||||
}
|
||||
if (rawValue == null) {
|
||||
if (preparedRawValue == null) {
|
||||
return null;
|
||||
}
|
||||
Class<?> fieldType = field.getType();
|
||||
if (fieldType.isEnum()) {
|
||||
return toEnumValue(fieldType, rawValue.toString());
|
||||
if (fieldType.isInstance(preparedRawValue)) {
|
||||
return preparedRawValue;
|
||||
}
|
||||
if (fieldType.isArray() && rawValue instanceof Iterable<?> rawIterable) {
|
||||
if (fieldType.isEnum()) {
|
||||
return toEnumValue(fieldType, preparedRawValue.toString());
|
||||
}
|
||||
if (fieldType.isArray() && preparedRawValue instanceof Iterable<?> rawIterable) {
|
||||
return toArrayValue(fieldType.getComponentType(), rawIterable);
|
||||
}
|
||||
if (rawValue instanceof Map<?, ?> rawMap && shouldMapToBean(fieldType)) {
|
||||
if (preparedRawValue instanceof Map<?, ?> rawMap && shouldMapToBean(fieldType)) {
|
||||
return mapToBean(rawMap, fieldType);
|
||||
}
|
||||
return convertScalarValue(fieldType, rawValue);
|
||||
return convertScalarValue(fieldType, preparedRawValue);
|
||||
}
|
||||
|
||||
private Object convertTypeValue(Type targetType, Object rawValue) {
|
||||
if (rawValue == null) {
|
||||
return null;
|
||||
}
|
||||
if (targetType instanceof ParameterizedType pt) {
|
||||
return convertParameterizedValue(pt, rawValue);
|
||||
}
|
||||
if (targetType instanceof Class<?> targetClass) {
|
||||
return convertClassValue(targetClass, rawValue);
|
||||
}
|
||||
return rawValue;
|
||||
}
|
||||
|
||||
private Object convertParameterizedValue(ParameterizedType targetType, Object rawValue) {
|
||||
Type rawType = targetType.getRawType();
|
||||
if (!(rawType instanceof Class<?> rawClass)) {
|
||||
return rawValue;
|
||||
}
|
||||
if (Iterable.class.isAssignableFrom(rawClass) && rawValue instanceof Iterable<?> rawIterable) {
|
||||
return toCollectionValue(rawClass, targetType.getActualTypeArguments()[0], rawIterable);
|
||||
}
|
||||
if (Map.class.isAssignableFrom(rawClass) && rawValue instanceof Map<?, ?> rawMap) {
|
||||
Type[] actualTypeArguments = targetType.getActualTypeArguments();
|
||||
return toMapValue(actualTypeArguments[0], actualTypeArguments[1], rawMap);
|
||||
}
|
||||
return convertClassValue(rawClass, rawValue);
|
||||
}
|
||||
|
||||
private Object convertClassValue(Class<?> targetClass, Object rawValue) {
|
||||
if (rawValue == null) {
|
||||
return null;
|
||||
}
|
||||
if (targetClass.isInstance(rawValue)) {
|
||||
return rawValue;
|
||||
}
|
||||
if (targetClass.isEnum()) {
|
||||
return toEnumValue(targetClass, rawValue.toString());
|
||||
}
|
||||
if (targetClass.isArray() && rawValue instanceof Iterable<?> rawIterable) {
|
||||
return toArrayValue(targetClass.getComponentType(), rawIterable);
|
||||
}
|
||||
if (rawValue instanceof Map<?, ?> rawMap && shouldMapToBean(targetClass)) {
|
||||
return mapToBean(rawMap, targetClass);
|
||||
}
|
||||
return convertScalarValue(targetClass, rawValue);
|
||||
}
|
||||
|
||||
private Object toArrayValue(Class<?> componentType, Iterable<?> rawIterable) {
|
||||
List<Object> values = new ArrayList<>();
|
||||
for (Object rawElement : rawIterable) {
|
||||
values.add(convertArrayElement(componentType, rawElement));
|
||||
values.add(convertTypeValue(componentType, rawElement));
|
||||
}
|
||||
Object array = Array.newInstance(componentType, values.size());
|
||||
for (int i = 0; i < values.size(); i++) {
|
||||
@@ -219,17 +274,29 @@ public class ConfigLoader<T> {
|
||||
return array;
|
||||
}
|
||||
|
||||
private Object convertArrayElement(Class<?> componentType, Object rawElement) {
|
||||
if (rawElement == null) {
|
||||
return null;
|
||||
private Object toCollectionValue(Class<?> collectionType, Type elementType, Iterable<?> rawIterable) {
|
||||
if (Set.class.isAssignableFrom(collectionType)) {
|
||||
Set<Object> values = new LinkedHashSet<>();
|
||||
for (Object rawElement : rawIterable) {
|
||||
values.add(convertTypeValue(elementType, rawElement));
|
||||
}
|
||||
return values;
|
||||
}
|
||||
if (componentType.isEnum()) {
|
||||
return toEnumValue(componentType, rawElement.toString());
|
||||
List<Object> values = new ArrayList<>();
|
||||
for (Object rawElement : rawIterable) {
|
||||
values.add(convertTypeValue(elementType, rawElement));
|
||||
}
|
||||
if (rawElement instanceof Map<?, ?> rawMap && shouldMapToBean(componentType)) {
|
||||
return mapToBean(rawMap, componentType);
|
||||
return values;
|
||||
}
|
||||
|
||||
private Map<Object, Object> toMapValue(Type keyType, Type valueType, Map<?, ?> rawMap) {
|
||||
Map<Object, Object> result = new LinkedHashMap<>();
|
||||
for (Map.Entry<?, ?> entry : rawMap.entrySet()) {
|
||||
Object key = convertTypeValue(keyType, entry.getKey());
|
||||
Object value = convertTypeValue(valueType, entry.getValue());
|
||||
result.put(key, value);
|
||||
}
|
||||
return convertScalarValue(componentType, rawElement);
|
||||
return result;
|
||||
}
|
||||
|
||||
private boolean shouldMapToBean(Class<?> fieldType) {
|
||||
@@ -297,10 +364,13 @@ public class ConfigLoader<T> {
|
||||
if (field != null) {
|
||||
BaseConverter<?, ?> converter = converters.get(field.getType());
|
||||
if (converter != null) {
|
||||
return converter.serialize0(field, value);
|
||||
return toYamlValue(null, converter.serialize0(field, value));
|
||||
}
|
||||
}
|
||||
if (value == null) {
|
||||
if (field != null && field.getType() == String.class) {
|
||||
return "";
|
||||
}
|
||||
return null;
|
||||
}
|
||||
Class<?> valueType = value.getClass();
|
||||
@@ -350,7 +420,7 @@ public class ConfigLoader<T> {
|
||||
}
|
||||
return result;
|
||||
} catch (Exception e) {
|
||||
throw new TimiException(TimiCode.ERROR, "converter error on dump", e);
|
||||
throw new ActionException(ResultCode.ERROR, "converter error on dump", e);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -6,6 +6,8 @@ import org.yaml.snakeyaml.nodes.NodeTuple;
|
||||
import org.yaml.snakeyaml.nodes.Tag;
|
||||
import org.yaml.snakeyaml.representer.Representer;
|
||||
|
||||
import java.util.Set;
|
||||
|
||||
/**
|
||||
* 自定义 Representer - SnakeYAML 序列化增强
|
||||
* <ul>
|
||||
@@ -40,7 +42,7 @@ public class ConfigRepresenter extends Representer {
|
||||
}
|
||||
|
||||
@Override
|
||||
protected org.yaml.snakeyaml.nodes.MappingNode representJavaBean(java.util.Set<Property> properties, Object javaBean) {
|
||||
protected org.yaml.snakeyaml.nodes.MappingNode representJavaBean(Set<Property> properties, Object javaBean) {
|
||||
Class<?> clazz = javaBean.getClass();
|
||||
// 对于非 Java 标准库的类,使用 MAP 标签而不是类名标签
|
||||
if (!clazz.getName().startsWith("java.") && !clazz.getName().startsWith("javax.")) {
|
||||
|
||||
Reference in New Issue
Block a user