diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..b75acc6 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,194 @@ +root = true + +#### Shared defaults #### + +[*] +charset = utf-8 +indent_style = space +insert_final_newline = true +trim_trailing_whitespace = true +# This repository's files are LF throughout; a .gitattributes is not present to +# normalise on checkout, so keep editors from rewriting every file they touch. +end_of_line = lf + +[*.{cs,vb}] +#### Naming styles #### + +# Naming rules + +dotnet_naming_rule.interface_should_be_begins_with_i.severity = suggestion +dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface +dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i + +dotnet_naming_rule.types_should_be_pascal_case.severity = suggestion +dotnet_naming_rule.types_should_be_pascal_case.symbols = types +dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case + +dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = suggestion +dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members +dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case + +dotnet_sort_system_directives_first = true + +# Enforce private fields to start with an underscore +dotnet_naming_rule.private_fields_with_underscore.severity = suggestion +dotnet_naming_rule.private_fields_with_underscore.symbols = private_fields +dotnet_naming_rule.private_fields_with_underscore.style = underscore_prefix + +dotnet_naming_symbols.private_fields.applicable_kinds = field +dotnet_naming_symbols.private_fields.applicable_accessibilities = private +dotnet_naming_symbols.private_fields.required_modifiers = instance + +dotnet_naming_style.underscore_prefix.required_prefix = _ +dotnet_naming_style.underscore_prefix.capitalization = camel_case + +# Symbol specifications + +dotnet_naming_symbols.interface.applicable_kinds = interface +dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected +dotnet_naming_symbols.interface.required_modifiers = + +dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum +dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected +dotnet_naming_symbols.types.required_modifiers = + +dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method +dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected +dotnet_naming_symbols.non_field_members.required_modifiers = + +# Naming styles + +dotnet_naming_style.begins_with_i.required_prefix = I +dotnet_naming_style.begins_with_i.required_suffix = +dotnet_naming_style.begins_with_i.word_separator = +dotnet_naming_style.begins_with_i.capitalization = pascal_case + +dotnet_naming_style.pascal_case.required_prefix = +dotnet_naming_style.pascal_case.required_suffix = +dotnet_naming_style.pascal_case.word_separator = +dotnet_naming_style.pascal_case.capitalization = pascal_case +dotnet_style_coalesce_expression = true:suggestion +dotnet_style_null_propagation = true:suggestion +dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion +dotnet_style_prefer_auto_properties = true:silent +dotnet_style_object_initializer = true:suggestion +dotnet_style_collection_initializer = true:suggestion +dotnet_style_prefer_simplified_boolean_expressions = true:suggestion +dotnet_style_prefer_conditional_expression_over_assignment = true:suggestion +dotnet_style_prefer_conditional_expression_over_return = true:suggestion +dotnet_style_explicit_tuple_names = true:suggestion +dotnet_style_prefer_inferred_tuple_names = true:suggestion +dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion +dotnet_style_prefer_compound_assignment = true:suggestion +dotnet_style_prefer_simplified_interpolation = true:suggestion +dotnet_style_prefer_collection_expression = when_types_loosely_match:suggestion +dotnet_style_namespace_match_folder = true:suggestion +dotnet_style_operator_placement_when_wrapping = beginning_of_line +tab_width = 4 +indent_size = 4 +max_line_length = 220 +dotnet_style_readonly_field = true:suggestion +dotnet_style_predefined_type_for_locals_parameters_members = true:silent +dotnet_style_predefined_type_for_member_access = true:silent +dotnet_style_require_accessibility_modifiers = for_non_interface_members:silent +dotnet_style_allow_statement_immediately_after_block_experimental = true:silent +dotnet_style_allow_multiple_blank_lines_experimental = true:silent +dotnet_style_namespace_declarations = file_scoped:suggestion +dotnet_code_quality_unused_parameters = all:warning +dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:silent +dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent +dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent +dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent +dotnet_style_qualification_for_field = false:warning +dotnet_style_qualification_for_property = false:suggestion +dotnet_style_qualification_for_method = false:warning +dotnet_style_qualification_for_event = false:warning + +[*.cs] +csharp_using_directive_placement = outside_namespace:silent +csharp_prefer_simple_using_statement = true:suggestion +csharp_prefer_braces = true:silent +# File-scoped, matching every .cs file in this repository. The C#-specific key wins +# over dotnet_style_namespace_declarations, so the two must agree or the setting +# silently flips for C#. +csharp_style_namespace_declarations = file_scoped:suggestion +csharp_style_prefer_method_group_conversion = true:silent +csharp_style_prefer_top_level_statements = true:silent +csharp_style_prefer_primary_constructors = false:warning +csharp_prefer_system_threading_lock = true:suggestion +csharp_style_expression_bodied_methods = false:silent +csharp_style_expression_bodied_constructors = false:silent +csharp_style_expression_bodied_operators = false:silent +csharp_style_expression_bodied_properties = true:silent +csharp_style_expression_bodied_indexers = true:silent +csharp_style_expression_bodied_accessors = true:silent +csharp_style_expression_bodied_lambdas = true:silent +csharp_style_expression_bodied_local_functions = false:silent +csharp_style_throw_expression = true:suggestion +csharp_style_prefer_null_check_over_type_check = true:suggestion +csharp_prefer_simple_default_expression = true:suggestion +csharp_style_prefer_local_over_anonymous_function = true:suggestion +csharp_style_prefer_index_operator = true:suggestion +csharp_style_prefer_range_operator = true:suggestion +csharp_style_implicit_object_creation_when_type_is_apparent = true:suggestion +csharp_style_prefer_tuple_swap = true:suggestion +csharp_indent_labels = one_less_than_current +csharp_space_around_binary_operators = before_and_after +csharp_style_prefer_unbound_generic_type_in_nameof = true:suggestion +csharp_style_prefer_utf8_string_literals = true:suggestion +csharp_style_inlined_variable_declaration = true:suggestion +csharp_style_deconstructed_variable_declaration = true:suggestion +csharp_style_unused_value_assignment_preference = discard_variable:suggestion +csharp_style_unused_value_expression_statement_preference = discard_variable:silent +csharp_prefer_static_local_function = true:suggestion +csharp_prefer_static_anonymous_function = true:suggestion +csharp_style_prefer_readonly_struct = true:suggestion +csharp_style_prefer_readonly_struct_member = true:suggestion +csharp_style_allow_embedded_statements_on_same_line_experimental = true:silent +csharp_style_allow_blank_lines_between_consecutive_braces_experimental = true:silent +csharp_style_allow_blank_line_after_colon_in_constructor_initializer_experimental = true:silent +csharp_style_allow_blank_line_after_token_in_conditional_expression_experimental = true:silent +csharp_style_allow_blank_line_after_token_in_arrow_expression_clause_experimental = true:silent +csharp_style_conditional_delegate_call = true:suggestion +csharp_style_prefer_switch_expression = true:suggestion +csharp_style_prefer_pattern_matching = true:silent +csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion +csharp_style_pattern_matching_over_as_with_null_check = true:suggestion +csharp_style_prefer_not_pattern = true:suggestion +csharp_style_prefer_extended_property_pattern = true:suggestion +csharp_style_var_for_built_in_types = false:silent +csharp_style_var_when_type_is_apparent = false:silent +csharp_style_var_elsewhere = false:silent +csharp_style_prefer_implicitly_typed_lambda_expression = true:suggestion +csharp_style_target_typed_new_expression = true:suggestion + +#### Front end #### +# The web client is Prettier-formatted: two-space indent, single quotes, no semicolons. + +[*.{ts,tsx,js,jsx,mjs,cjs}] +indent_size = 2 +tab_width = 2 +max_line_length = 100 +quote_type = single + +[*.{json,jsonc,yml,yaml}] +indent_size = 2 +tab_width = 2 + +[*.{css,html}] +indent_size = 2 +tab_width = 2 + +#### Everything else #### + +[*.md] +# Two trailing spaces are a hard line break in Markdown. +trim_trailing_whitespace = false +max_line_length = 100 + +[*.{csproj,props,targets,slnx}] +indent_size = 2 +tab_width = 2 + +[*.sln] +indent_style = tab diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..0213087 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,82 @@ +# CLAUDE.md + +Guidance for Claude Code (claude.ai/code) in this repo. + +## Project + +Novel Software: software for planning and writing a novel. ASP.NET Core 10, C#, TypeScript, React. Chapter outlines, character dossiers, prose drafting, an embedded Claude agent, and an MCP server over the same API. + +## Structure + +- `src/NovelSoftware.Domain/` — entities and enums, no dependencies +- `src/NovelSoftware.Application/` — services, DTOs, the agent tool-use loop +- `src/NovelSoftware.Infrastructure/` — EF Core + SQLite, Anthropic SDK client +- `src/NovelSoftware.Api/` — minimal API endpoints +- `src/NovelSoftware.Mcp/` — MCP stdio server +- `src/NovelSoftware.Web/` — React + Vite client +- `tests/` — test suite +- `docs/` — documentation + +## Best Practices + +- Use latest .NET + latest supported nuget packages for that version +- Set `langVersion` to latest in all csproj files; enable nullable +- Organize code by feature/area, not type +- New features need unit tests covering logic as much as possible +- Modified file: check missing test coverage, all tests pass + +## Architecture + +- The React client, the embedded agent, and the MCP server all go through the same REST API. One source of truth — never let a client reach past the API to the database. +- Agent tools and MCP tools call the same application services the endpoints do. New capability = new service method, then surface it in all three. +- Domain has no dependencies. Application depends on Domain. Infrastructure depends on Application. Nothing depends on Api. + +# Coding + +- Descriptive names all classes/methods. No generic: Provider, Manager, Helper +- Match formatting/style from `.editorconfig` +- Wrap lines at 220 chars, single line if fewer +- Interfaces implemented by single class → bottom of class file. Interface w/ multiple implementations → separate file. +- No tuples for return types. Prefer records or classes for multiple values +- Use `record` for data objects, `class` for objects with behavior. Avoid mutable state where possible. +- DTOs are records; entities are classes +- `PATCH` requests are partial: null field = leave alone, empty string = clear. Keep new update endpoints consistent with `Patch.Apply`. +- Enums cross the wire as names, never ordinals + +## Testing + +- Min 70% code coverage, target 90%. Unit tests focus end-user scenarios first. +- Don't write tests just for coverage. Call out missing coverage rather than cover stuff not valuable to end user. +- Code not cleanly unit-testable → mark `[ExcludeFromCodeCoverage]` or exclude namespace from coverage in .runsettings file +- BDD-style unit tests, end-to-end as possible. e.g. `Deleting_a_scene_leaves_its_beats_alone` +- xUnit + FluentAssertions +- Tests run against real in-memory SQLite via `TestDatabase`, not the EF InMemory provider — cascade deletes and query translation must be exercised, and the InMemory provider fakes both +- Model calls are faked at the `IAgentModelClient` seam (see `ScriptedModelClient`). Never hit the Anthropic API from a test. +- No "Mock" in mocked object names +- No Arrange/Act/Assert comments +- All tests pass before commit + +## Verifying + +Build and tests passing is not the same as working. For anything touching an endpoint, the agent loop, or the MCP server, run it: + +- API: `ASPNETCORE_URLS=http://localhost:5080 dotnet run --project src/NovelSoftware.Api`, then exercise the route with curl +- Web: `cd src/NovelSoftware.Web && npm run dev` — proxies `/api` to :5080 +- MCP: build it, then drive it over stdio JSON-RPC (`initialize` → `notifications/initialized` → `tools/list` → `tools/call`) + +Several real bugs here — SQLite refusing to ORDER BY a DateTimeOffset, the agent's model client throwing at construction and taking read-only endpoints down with it — passed the build and the test suite and only showed up when the app actually ran. + +## Claude + +- Plans = `.md` files in `docs/plans/`. Web → `docs/plans/web/`, API → `docs/plans/api/` +- Split large plans into discrete chunks — each buildable + committable independently +- Plan generated from `docs/plans/.md` → save as `docs/plans/_plan.md` +- Plan implemented from `docs/plans/.md` → save summary as `docs/plans/_output.md` + +## Stack + +`.gitignore` set for .NET/Visual Studio (C#, NuGet, MSBuild) plus Node. Update if stack change. + +- Anthropic model id lives in `appsettings.json` under `Agent:Model`. Don't hardcode it. +- API key comes from `ANTHROPIC_API_KEY` or `Agent:ApiKey` — never commit one. The app must stay fully usable without a key; only the agent endpoints require it. +- EF migrations: `dotnet ef migrations add -p src/NovelSoftware.Infrastructure -s src/NovelSoftware.Api -o Persistence/Migrations`. The API migrates on boot. diff --git a/src/NovelSoftware.Api/NovelSoftware.Api.csproj b/src/NovelSoftware.Api/NovelSoftware.Api.csproj index 0f65328..39aff4a 100644 --- a/src/NovelSoftware.Api/NovelSoftware.Api.csproj +++ b/src/NovelSoftware.Api/NovelSoftware.Api.csproj @@ -1,9 +1,9 @@ - - + + - - + + @@ -11,12 +11,13 @@ all - - - - net10.0 - enable - enable - - - + + + + net10.0 + enable + latest + enable + + + diff --git a/src/NovelSoftware.Application/Agent/JsonSchema.cs b/src/NovelSoftware.Application/Agent/JsonSchema.cs index 81ffe33..67020aa 100644 --- a/src/NovelSoftware.Application/Agent/JsonSchema.cs +++ b/src/NovelSoftware.Application/Agent/JsonSchema.cs @@ -7,7 +7,7 @@ namespace NovelSoftware.Application.Agent; /// Small builder for the JSON Schema objects tool definitions need. Hand-writing these /// as string literals is where tool definitions usually rot, so build them structurally. /// -public sealed class JsonSchemaBuilder +public class JsonSchemaBuilder { private readonly JsonObject _properties = []; private readonly JsonArray _required = []; diff --git a/src/NovelSoftware.Application/Agent/NovelAgentService.cs b/src/NovelSoftware.Application/Agent/NovelAgentService.cs index f23cb19..986f6e9 100644 --- a/src/NovelSoftware.Application/Agent/NovelAgentService.cs +++ b/src/NovelSoftware.Application/Agent/NovelAgentService.cs @@ -101,14 +101,14 @@ public class NovelAgentService( var results = new List(); foreach (var call in requestedTools) { - var (result, isError) = await toolset.ExecuteAsync(call.Name, projectId, call.Input, ct); + var outcome = await toolset.ExecuteAsync(call.Name, projectId, call.Input, ct); logger.LogInformation( "Agent tool {Tool} on project {ProjectId} {Outcome}", - call.Name, projectId, isError ? "failed" : "succeeded"); + call.Name, projectId, outcome.IsError ? "failed" : "succeeded"); - toolCalls.Add(new ToolCallDto(call.Name, call.Input.ToString(), result)); - results.Add(new AgentToolResultBlock(call.Id, result, isError)); + toolCalls.Add(new ToolCallDto(call.Name, call.Input.ToString(), outcome.Content)); + results.Add(new AgentToolResultBlock(call.Id, outcome.Content, outcome.IsError)); } transcript.Add(AgentChatMessage.User([.. results])); diff --git a/src/NovelSoftware.Application/Agent/NovelAgentToolset.cs b/src/NovelSoftware.Application/Agent/NovelAgentToolset.cs index 99d1261..3ee2f38 100644 --- a/src/NovelSoftware.Application/Agent/NovelAgentToolset.cs +++ b/src/NovelSoftware.Application/Agent/NovelAgentToolset.cs @@ -5,8 +5,11 @@ using NovelSoftware.Domain; namespace NovelSoftware.Application.Agent; +/// The outcome of running a tool: what to hand back to the model, and whether it failed. +public record AgentToolResult(string Content, bool IsError); + /// A tool the agent can call, bound to a handler that runs against the project's data. -public sealed record AgentTool( +public record AgentTool( string Name, string Description, JsonElement InputSchema, @@ -42,30 +45,30 @@ public class NovelAgentToolset( /// Runs a tool and serialises its result. Failures come back as text rather than /// exceptions so the model can read the message and correct itself. /// - public async Task<(string Result, bool IsError)> ExecuteAsync( + public async Task ExecuteAsync( string name, Guid projectId, JsonElement input, CancellationToken ct = default) { if (!ByName.TryGetValue(name, out var tool)) { - return ($"No such tool: '{name}'.", true); + return new AgentToolResult($"No such tool: '{name}'.", true); } try { var result = await tool.Handler(projectId, input, ct); - return (JsonSerializer.Serialize(result, SerializerOptions), false); + return new AgentToolResult(JsonSerializer.Serialize(result, SerializerOptions), false); } catch (NotFoundException ex) { - return (ex.Message, true); + return new AgentToolResult(ex.Message, true); } catch (ArgumentException ex) { - return (ex.Message, true); + return new AgentToolResult(ex.Message, true); } catch (InvalidOperationException ex) { - return (ex.Message, true); + return new AgentToolResult(ex.Message, true); } } diff --git a/src/NovelSoftware.Application/NovelSoftware.Application.csproj b/src/NovelSoftware.Application/NovelSoftware.Application.csproj index f614db7..6e8c81d 100644 --- a/src/NovelSoftware.Application/NovelSoftware.Application.csproj +++ b/src/NovelSoftware.Application/NovelSoftware.Application.csproj @@ -15,6 +15,7 @@ net10.0 enable enable + latest diff --git a/src/NovelSoftware.Domain/NovelSoftware.Domain.csproj b/src/NovelSoftware.Domain/NovelSoftware.Domain.csproj index b760144..5bdc6ca 100644 --- a/src/NovelSoftware.Domain/NovelSoftware.Domain.csproj +++ b/src/NovelSoftware.Domain/NovelSoftware.Domain.csproj @@ -4,6 +4,7 @@ net10.0 enable enable + latest diff --git a/src/NovelSoftware.Infrastructure/NovelSoftware.Infrastructure.csproj b/src/NovelSoftware.Infrastructure/NovelSoftware.Infrastructure.csproj index d3bc0df..376ba3f 100644 --- a/src/NovelSoftware.Infrastructure/NovelSoftware.Infrastructure.csproj +++ b/src/NovelSoftware.Infrastructure/NovelSoftware.Infrastructure.csproj @@ -19,6 +19,7 @@ net10.0 enable enable + latest diff --git a/src/NovelSoftware.Infrastructure/Persistence/NovelDbContext.cs b/src/NovelSoftware.Infrastructure/Persistence/NovelDbContext.cs index 7f1e5b8..c15611d 100644 --- a/src/NovelSoftware.Infrastructure/Persistence/NovelDbContext.cs +++ b/src/NovelSoftware.Infrastructure/Persistence/NovelDbContext.cs @@ -11,7 +11,7 @@ namespace NovelSoftware.Infrastructure.Persistence; /// first" listing depends on. The domain only ever writes UtcNow, so normalising to UTC /// loses nothing. /// -internal sealed class UtcTicksConverter() +internal class UtcTicksConverter() : ValueConverter( value => value.UtcTicks, ticks => new DateTimeOffset(ticks, TimeSpan.Zero)); diff --git a/src/NovelSoftware.Mcp/NovelSoftware.Mcp.csproj b/src/NovelSoftware.Mcp/NovelSoftware.Mcp.csproj index d3115be..dbb9fdd 100644 --- a/src/NovelSoftware.Mcp/NovelSoftware.Mcp.csproj +++ b/src/NovelSoftware.Mcp/NovelSoftware.Mcp.csproj @@ -5,6 +5,7 @@ net10.0 enable enable + latest diff --git a/tests/NovelSoftware.Tests/NovelAgentServiceTests.cs b/tests/NovelSoftware.Tests/NovelAgentServiceTests.cs index ea4976c..5135b96 100644 --- a/tests/NovelSoftware.Tests/NovelAgentServiceTests.cs +++ b/tests/NovelSoftware.Tests/NovelAgentServiceTests.cs @@ -200,7 +200,7 @@ public class NovelAgentServiceTests : IDisposable /// A model stand-in that returns a fixed script of turns and records every transcript it /// was sent, so tests can assert on what the loop actually put in front of the model. /// -internal sealed class ScriptedModelClient(IReadOnlyList> script) +internal class ScriptedModelClient(IReadOnlyList> script) : IAgentModelClient { private int _turn; diff --git a/tests/NovelSoftware.Tests/NovelSoftware.Tests.csproj b/tests/NovelSoftware.Tests/NovelSoftware.Tests.csproj index be86ca5..1fa50ad 100644 --- a/tests/NovelSoftware.Tests/NovelSoftware.Tests.csproj +++ b/tests/NovelSoftware.Tests/NovelSoftware.Tests.csproj @@ -4,6 +4,7 @@ net10.0 enable enable + latest false diff --git a/tests/NovelSoftware.Tests/TestDatabase.cs b/tests/NovelSoftware.Tests/TestDatabase.cs index be4b6a7..89e481b 100644 --- a/tests/NovelSoftware.Tests/TestDatabase.cs +++ b/tests/NovelSoftware.Tests/TestDatabase.cs @@ -9,7 +9,7 @@ namespace NovelSoftware.Tests; /// in-memory provider means the tests exercise the same relational behaviour the app /// ships with — cascade deletes, foreign keys and all. /// -public sealed class TestDatabase : IDisposable +public class TestDatabase : IDisposable { private readonly SqliteConnection _connection;