Skip to content

34 docs complete readme#39

Merged
OGR-67 merged 9 commits into
devfrom
34-docs-complete-readme
Mar 22, 2026
Merged

34 docs complete readme#39
OGR-67 merged 9 commits into
devfrom
34-docs-complete-readme

Conversation

@OGR-67

@OGR-67 OGR-67 commented Mar 22, 2026

Copy link
Copy Markdown
Owner

Description

Closes

closes #34

Copilot AI review requested due to automatic review settings March 22, 2026 10:17
@OGR-67 OGR-67 merged commit 8015c35 into dev Mar 22, 2026
3 of 4 checks passed
@OGR-67 OGR-67 deleted the 34-docs-complete-readme branch March 22, 2026 10:17

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Expands project documentation to make AL2DBML easier to install/configure and to document key architecture/parsing behavior, closing issue #34.

Changes:

  • Replaces the minimal README with installation steps, command usage, configuration, and pre-commit hook docs.
  • Extends docs/ARCHITECTURE.md with CLI-layer details (strategies, services, DI integration).
  • Adds docs/AL_PARSING.md describing supported AL object types and parsing rules/edge cases.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
README.md Adds end-user documentation (install/usage/config/hook).
docs/ARCHITECTURE.md Documents clean architecture layout + CLI internals and DI story.
docs/AL_PARSING.md New parsing reference for AL → DBML behavior and constraints.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Comment on lines +129 to +132
To remove the hook, run:

```bash
al2dbml remove-hook

Copilot AI Mar 22, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

al2dbml remove-hook is documented here, but the CLI currently only registers generate and init commands (no remove-hook). Either add a remove-hook command, or update the README to describe manual removal (delete the section between # [al2dbml-start] / # [al2dbml-end] in .git/hooks/pre-commit).

Suggested change
To remove the hook, run:
```bash
al2dbml remove-hook
To remove the hook, open `.git/hooks/pre-commit` in a text editor and delete the section between:
```sh
# [al2dbml-start]
...
# [al2dbml-end]

Copilot uses AI. Check for mistakes.
Comment thread docs/ARCHITECTURE.md

### DI integration

Spectre.Console.Cli is integrated with `Microsoft.Extensions.DependencyInjection` via a custom `TypeRegistrar`/`TypeResolver`. A new DI scope is created per command execution so scoped services (parser state, tracker) are properly isolated.

Copilot AI Mar 22, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This states a new DI scope is created per command execution, but TypeRegistrar.Build() creates a single scope once and reuses that scoped ServiceProvider for the app lifetime. Please align the documentation with the actual behavior, or adjust the DI integration to truly create/dispose a scope per command if isolation is required.

Suggested change
Spectre.Console.Cli is integrated with `Microsoft.Extensions.DependencyInjection` via a custom `TypeRegistrar`/`TypeResolver`. A new DI scope is created per command execution so scoped services (parser state, tracker) are properly isolated.
Spectre.Console.Cli is integrated with `Microsoft.Extensions.DependencyInjection` via a custom `TypeRegistrar`/`TypeResolver`. The DI container is built once and a single scope is reused for the application lifetime, so services registered as scoped (such as parser state and trackers) are shared across command executions rather than isolated per command.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants