Skip to content

chore(): add adr for the mapping DSL (Domain Specific Language)#47

Merged
brandPittCode merged 14 commits intomainfrom
chore/adr-for-mapping-dsl
May 4, 2026
Merged

chore(): add adr for the mapping DSL (Domain Specific Language)#47
brandPittCode merged 14 commits intomainfrom
chore/adr-for-mapping-dsl

Conversation

@brandPittCode
Copy link
Copy Markdown
Collaborator

@brandPittCode brandPittCode commented Apr 28, 2026

PR Description

What this PR Provides

This pull request adds a new Architecture Decision Record (ADR) documenting the selection of JSLT as the dynamic mapping DSL for the project. The ADR provides a thorough analysis of the options considered and the rationale for the decision.

Key additions in the ADR:

Dynamic Mapping DSL Decision:

  • Introduces ADR 0004, which formalizes the decision to use JSLT (JSON Standard Transformation Language) as the project's dynamic mapping DSL, including context, decision drivers, and detailed pros and cons of both JSLT and Jackson-JQ.
  • Outlines the positive and negative consequences of selecting JSLT, such as improved modularity, maintainability, and extensibility, as well as challenges like verbosity, a steeper learning curve, and the need for custom helper functions.
  • Provides example transformation scripts for both JSLT and JQ to illustrate syntax and capabilities.
  • Highlights the impact of this decision on user experience, extensibility, performance, and community support.
  • Includes references to official documentation for further information.

Fixes

Review

The reviewer must double-check these points:

  • The documentation has been updated

How to test

  • N/A

Breaking changes (if any)

  • N/A

Context of the Breaking Change

  • N/A

Result of the Breaking Change

  • N/A

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a new Architecture Decision Record (ADR) documenting the project’s decision to use JSLT as the dynamic mapping DSL for IDP-Core, including rationale, tradeoffs, and comparisons to JQ-based alternatives.

Changes:

  • Adds ADR 0004 detailing the decision, decision drivers, consequences, and option analysis.
  • Updates the Vale IDP vocabulary accept list to accommodate newly introduced terms.

Reviewed changes

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

File Description
docs/src/contributing/adrs/0004-dynamic-mapping-dsl.md New ADR documenting the dynamic mapping DSL decision (JSLT vs JQ), including examples and pros/cons.
.vale/styles/config/vocabularies/IDP/accept.txt Adds vocabulary entries to satisfy Vale linting for new documentation terms.

Comment thread docs/src/contributing/adrs/0004-dynamic-mapping-dsl.md Outdated
Comment thread docs/src/contributing/adrs/0004-dynamic-mapping-dsl.md Outdated
Comment thread .vale/styles/config/vocabularies/IDP/accept.txt Outdated
Comment thread docs/src/contributing/adrs/0004-dynamic-mapping-dsl.md Outdated
Comment thread docs/src/contributing/adrs/0004-dynamic-mapping-dsl.md Outdated
Comment thread docs/src/contributing/adrs/0004-dynamic-mapping-dsl.md Outdated
Comment thread docs/src/contributing/adrs/0004-dynamic-mapping-dsl.md Outdated
Comment thread docs/src/contributing/adrs/0004-dynamic-mapping-dsl.md Outdated
Copy link
Copy Markdown
Collaborator

@etiennej70 etiennej70 left a comment

Choose a reason for hiding this comment

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

✅ OK with the decision outcome, see few comments more about the formulation.
Great job.

Comment thread .vale/styles/config/vocabularies/IDP/accept.txt Outdated
Comment thread docs/src/contributing/adrs/0004-dynamic-mapping-dsl.md Outdated
Comment thread docs/src/contributing/adrs/0004-dynamic-mapping-dsl.md Outdated
Comment thread docs/src/contributing/adrs/0004-dynamic-mapping-dsl.md Outdated
Comment thread docs/src/contributing/adrs/0004-dynamic-mapping-dsl.md Outdated
brandPittCode and others added 6 commits April 30, 2026 14:10
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Etienne JACQUOT <2057151+etiennej70@users.noreply.github.com>
Signed-off-by: Andrés Brand <andresbrand@gmail.com>
Co-authored-by: Etienne JACQUOT <2057151+etiennej70@users.noreply.github.com>
Signed-off-by: Andrés Brand <andresbrand@gmail.com>
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented May 4, 2026

@brandPittCode brandPittCode requested a review from evebrnd May 4, 2026 14:12
@brandPittCode brandPittCode merged commit da27303 into main May 4, 2026
18 checks passed
@brandPittCode brandPittCode deleted the chore/adr-for-mapping-dsl branch May 4, 2026 14:51
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.

4 participants