Skip to content

Commit f444c76

Browse files
Add project configuration and documentation updates
- Create .gitignore to exclude cache files - Add project.yml for Serena project configuration - Update CLAUDE.md to correct code block syntax - Enhance DESCRIPTION.md with detailed library features - Revise README.md for improved clarity and feature descriptions - Introduce TAGS.md for relevant keywords
1 parent c7a235e commit f444c76

6 files changed

Lines changed: 244 additions & 99 deletions

File tree

.serena/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/cache

.serena/project.yml

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
# the name by which the project can be referenced within Serena
2+
project_name: "AppDataStorage"
3+
4+
5+
# list of languages for which language servers are started; choose from:
6+
# al bash clojure cpp csharp
7+
# csharp_omnisharp dart elixir elm erlang
8+
# fortran fsharp go groovy haskell
9+
# java julia kotlin lua markdown
10+
# matlab nix pascal perl php
11+
# php_phpactor powershell python python_jedi r
12+
# rego ruby ruby_solargraph rust scala
13+
# swift terraform toml typescript typescript_vts
14+
# vue yaml zig
15+
# (This list may be outdated. For the current list, see values of Language enum here:
16+
# https://github.com/oraios/serena/blob/main/src/solidlsp/ls_config.py
17+
# For some languages, there are alternative language servers, e.g. csharp_omnisharp, ruby_solargraph.)
18+
# Note:
19+
# - For C, use cpp
20+
# - For JavaScript, use typescript
21+
# - For Free Pascal/Lazarus, use pascal
22+
# Special requirements:
23+
# Some languages require additional setup/installations.
24+
# See here for details: https://oraios.github.io/serena/01-about/020_programming-languages.html#language-servers
25+
# When using multiple languages, the first language server that supports a given file will be used for that file.
26+
# The first language is the default language and the respective language server will be used as a fallback.
27+
# Note that when using the JetBrains backend, language servers are not used and this list is correspondingly ignored.
28+
languages:
29+
- csharp
30+
31+
# the encoding used by text files in the project
32+
# For a list of possible encodings, see https://docs.python.org/3.11/library/codecs.html#standard-encodings
33+
encoding: "utf-8"
34+
35+
# whether to use project's .gitignore files to ignore files
36+
ignore_all_files_in_gitignore: true
37+
38+
# list of additional paths to ignore in this project.
39+
# Same syntax as gitignore, so you can use * and **.
40+
# Note: global ignored_paths from serena_config.yml are also applied additively.
41+
ignored_paths: []
42+
43+
# whether the project is in read-only mode
44+
# If set to true, all editing tools will be disabled and attempts to use them will result in an error
45+
# Added on 2025-04-18
46+
read_only: false
47+
48+
# list of tool names to exclude. We recommend not excluding any tools, see the readme for more details.
49+
# Below is the complete list of tools for convenience.
50+
# To make sure you have the latest list of tools, and to view their descriptions,
51+
# execute `uv run scripts/print_tool_overview.py`.
52+
#
53+
# * `activate_project`: Activates a project by name.
54+
# * `check_onboarding_performed`: Checks whether project onboarding was already performed.
55+
# * `create_text_file`: Creates/overwrites a file in the project directory.
56+
# * `delete_lines`: Deletes a range of lines within a file.
57+
# * `delete_memory`: Deletes a memory from Serena's project-specific memory store.
58+
# * `execute_shell_command`: Executes a shell command.
59+
# * `find_referencing_code_snippets`: Finds code snippets in which the symbol at the given location is referenced.
60+
# * `find_referencing_symbols`: Finds symbols that reference the symbol at the given location (optionally filtered by type).
61+
# * `find_symbol`: Performs a global (or local) search for symbols with/containing a given name/substring (optionally filtered by type).
62+
# * `get_current_config`: Prints the current configuration of the agent, including the active and available projects, tools, contexts, and modes.
63+
# * `get_symbols_overview`: Gets an overview of the top-level symbols defined in a given file.
64+
# * `initial_instructions`: Gets the initial instructions for the current project.
65+
# Should only be used in settings where the system prompt cannot be set,
66+
# e.g. in clients you have no control over, like Claude Desktop.
67+
# * `insert_after_symbol`: Inserts content after the end of the definition of a given symbol.
68+
# * `insert_at_line`: Inserts content at a given line in a file.
69+
# * `insert_before_symbol`: Inserts content before the beginning of the definition of a given symbol.
70+
# * `list_dir`: Lists files and directories in the given directory (optionally with recursion).
71+
# * `list_memories`: Lists memories in Serena's project-specific memory store.
72+
# * `onboarding`: Performs onboarding (identifying the project structure and essential tasks, e.g. for testing or building).
73+
# * `prepare_for_new_conversation`: Provides instructions for preparing for a new conversation (in order to continue with the necessary context).
74+
# * `read_file`: Reads a file within the project directory.
75+
# * `read_memory`: Reads the memory with the given name from Serena's project-specific memory store.
76+
# * `remove_project`: Removes a project from the Serena configuration.
77+
# * `replace_lines`: Replaces a range of lines within a file with new content.
78+
# * `replace_symbol_body`: Replaces the full definition of a symbol.
79+
# * `restart_language_server`: Restarts the language server, may be necessary when edits not through Serena happen.
80+
# * `search_for_pattern`: Performs a search for a pattern in the project.
81+
# * `summarize_changes`: Provides instructions for summarizing the changes made to the codebase.
82+
# * `switch_modes`: Activates modes by providing a list of their names
83+
# * `think_about_collected_information`: Thinking tool for pondering the completeness of collected information.
84+
# * `think_about_task_adherence`: Thinking tool for determining whether the agent is still on track with the current task.
85+
# * `think_about_whether_you_are_done`: Thinking tool for determining whether the task is truly completed.
86+
# * `write_memory`: Writes a named memory (for future reference) to Serena's project-specific memory store.
87+
excluded_tools: []
88+
89+
# list of tools to include that would otherwise be disabled (particularly optional tools that are disabled by default)
90+
included_optional_tools: []
91+
92+
# fixed set of tools to use as the base tool set (if non-empty), replacing Serena's default set of tools.
93+
# This cannot be combined with non-empty excluded_tools or included_optional_tools.
94+
fixed_tools: []
95+
96+
# list of mode names to that are always to be included in the set of active modes
97+
# The full set of modes to be activated is base_modes + default_modes.
98+
# If the setting is undefined, the base_modes from the global configuration (serena_config.yml) apply.
99+
# Otherwise, this setting overrides the global configuration.
100+
# Set this to [] to disable base modes for this project.
101+
# Set this to a list of mode names to always include the respective modes for this project.
102+
base_modes:
103+
104+
# list of mode names that are to be activated by default.
105+
# The full set of modes to be activated is base_modes + default_modes.
106+
# If the setting is undefined, the default_modes from the global configuration (serena_config.yml) apply.
107+
# Otherwise, this overrides the setting from the global configuration (serena_config.yml).
108+
# This setting can, in turn, be overridden by CLI parameters (--mode).
109+
default_modes:
110+
111+
# initial prompt for the project. It will always be given to the LLM upon activating the project
112+
# (contrary to the memories, which are loaded on demand).
113+
initial_prompt: ""

CLAUDE.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
44

55
## Build Commands
66

7-
```powershell
7+
```bash
88
# Restore, build, and test (standard workflow)
99
dotnet restore
1010
dotnet build
@@ -64,17 +64,28 @@ data.Save();
6464
- Debounced saves via `QueueSave()` / `SaveIfRequired()` (3-second debounce)
6565
- Automatic backup files (`.bk` suffix) with timestamped collision handling
6666
- Safe write pattern: write to `.tmp`, backup existing, move `.tmp` to final
67+
- Lazy singleton access via `Get()` backed by `Lazy<T>`
68+
- `LoadOrCreate()` overloads support custom subdirectories and file names
69+
- Corrupt file recovery: falls back to `.bk` backup, then creates a fresh instance
70+
- Process exit handler ensures queued saves are flushed via `IDisposable`
6771

6872
### Testing
6973

70-
Tests use `MockFileSystem` from `System.IO.Abstractions.TestingHelpers`:
74+
Tests use `MockFileSystem` from `System.IO.Abstractions.TestingHelpers` with thread-local isolation:
7175

7276
```csharp
77+
// In ClassInitialize - set up factory (each thread gets its own MockFileSystem)
7378
AppData.ConfigureForTesting(() => new MockFileSystem());
74-
// ... run tests ...
75-
AppData.ResetFileSystem(); // Cleanup
79+
80+
// In TestInitialize - clear cached instance for test isolation
81+
AppData.ClearCachedFileSystem();
82+
83+
// In cleanup
84+
AppData.ResetFileSystem();
7685
```
7786

87+
Tests run with `[Parallelize(Scope = ExecutionScope.MethodLevel)]` for parallel execution. Tests using the shared singleton (`Get()`) must be marked `[DoNotParallelize]`.
88+
7889
## CI/CD
7990

8091
Uses `scripts/PSBuild.psm1` PowerShell module for CI pipeline. Version increments are controlled by commit message tags: `[major]`, `[minor]`, `[patch]`, `[pre]`.

DESCRIPTION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Application data management library using JSON serialization to save and load data in the user's app data folder.
1+
A .NET library for persistent application data storage using JSON serialization. Provides a simple inherit-and-use pattern with automatic file management, thread-safe operations, debounced saves, backup recovery, and singleton access. Stores data in the user's app data folder with support for custom subdirectories and file names.

0 commit comments

Comments
 (0)