Skip to content

Update v0.0.60 migration doc - #14

Merged
yilmaztayfun merged 1 commit into
mainfrom
f/revision-architecture
Jun 14, 2026
Merged

Update v0.0.60 migration doc#14
yilmaztayfun merged 1 commit into
mainfrom
f/revision-architecture

Conversation

@yilmaztayfun

@yilmaztayfun yilmaztayfun commented Jun 14, 2026

Copy link
Copy Markdown
Contributor

Özet

Etkilenen Bölüm

  • Technical (docs/)
  • Architecture (architecture/)
  • Business (business/)
  • Product (product/)
  • Blog (blog/)
  • Tooling / CI / Config

Dil

  • TR yazıldı
  • EN çevirisi eklendi
  • EN sonradan eklenecek (priority değil)

Local Doğrulama

  • npm run build başarılı
  • npm run start ile gözle kontrol edildi
  • Internal linkler kırık değil

İlgili Phase / Issue

Summary by Sourcery

Document mappings support in domain projects for the v0.0.60 migration, including configuration, tooling updates, and example references.

Documentation:

  • Expand the v0.0.60 migration guide with detailed instructions for adding the Mappings directory and updating vnext.config.json in domain projects.
  • Document required changes to domain tooling scripts (build, validate, setup, index, test) to support discovery and validation of mappings.
  • Extend the migration steps with validation guidance and add links to vnext-example as a working reference for mappings configuration and usage.

Summary by CodeRabbit

  • Documentation
    • Added comprehensive migration guide for v0.0.60, including detailed domain project configuration instructions.
    • Expanded migration steps with clearer step-by-step guidance and best practices.
    • Included reference examples and links for easier implementation of required configuration changes.

@yilmaztayfun yilmaztayfun self-assigned this Jun 14, 2026
@yilmaztayfun
yilmaztayfun requested a review from a team June 14, 2026 19:02
@sourcery-ai

sourcery-ai Bot commented Jun 14, 2026

Copy link
Copy Markdown

Reviewer's Guide

Refines the v0.0.60 migration documentation for the new sys-mappings component by expanding the domain configuration section, detailing required tooling script updates, and adding concrete migration steps and reference links to the vnext-example repo.

File-Level Changes

Change Details Files
Expand and restructure the domain configuration section to clarify how mappings are organized and configured in a domain project.
  • Rename and reposition the section about vnext.config.json under a broader domain configuration heading.
  • Add a detailed explanation and directory layout example for the new Mappings/ folder including example mapping and helper files.
  • Clarify how vnext.config.json paths and exports should include mappings with a concrete JSON example using a core domain.
blog-migration/2026-06-13-v0-0-60-migration.md
Document required updates to domain tooling scripts so they discover and validate mappings correctly.
  • Describe adding mappings to the default paths configuration in setup.js, index.js, build.js, and validate.js via getPathsConfig.
  • Introduce new getMappings helper and update getAvailableTypes in index.js to include mappings.
  • Explain additions needed in build.js, validate.js, and test.js to handle mappings directories, exports, getters, and schema type associations.
blog-migration/2026-06-13-v0-0-60-migration.md
Refine migration steps and add a reference section pointing to a working vnext-example implementation.
  • Update the ordered migration steps to include creating the Mappings folder, updating tooling scripts, using sys-mappings with scripts.helpers and REF encoding, configuring allowedAssemblies, and running validation/build commands.
  • Add a dedicated reference section with direct links into the vnext-example repository for vnext.config.json, example mappings, workflows, and tooling scripts.
  • Tighten cross-links to other mapping and sandbox documentation for further details.
blog-migration/2026-06-13-v0-0-60-migration.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@yilmaztayfun
yilmaztayfun merged commit 1141a4d into main Jun 14, 2026
3 of 4 checks passed
@coderabbitai

coderabbitai Bot commented Jun 14, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 7920e53d-ed9b-47e2-807d-b8cc79ec8461

📥 Commits

Reviewing files that changed from the base of the PR and between 921ed79 and 44b682d.

📒 Files selected for processing (1)
  • blog-migration/2026-06-13-v0-0-60-migration.md

📝 Walkthrough

Walkthrough

The v0.0.60 migration guide is expanded with a new "Domain projesi yapılandırması" subsection for sys-mappings, detailing Mappings/ directory setup, vnext.config.json configuration, and tooling script changes. The migration steps list grows from 3 to 5 items, adding allowedAssemblies and encoding: REF guidance, plus reference links to vnext-example.

Changes

v0.0.60 Migration Guide — sys-mappings Documentation

Layer / File(s) Summary
sys-mappings domain project configuration
blog-migration/2026-06-13-v0-0-60-migration.md
Adds domain project configuration subsection: Mappings/ directory tree, paths.mappings and exports.mappings in vnext.config.json, and tooling script integration (setup/index/build/validate/test) with getMappings, getAvailableTypes, and validate/build mapping expansions.
Expanded migration steps and reference links
blog-migration/2026-06-13-v0-0-60-migration.md
Migration steps section converted from a 3-item to a 5-item numbered list adding allowedAssemblies sandbox permissions and encoding: REF referencing; "Referans (vnext-example)" section added with links to config, mapping/helper files, workflow example, and tooling scripts.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • burgan-tech/vnext-docs#13: Modifies the same migration document (blog-migration/2026-06-13-v0-0-60-migration.md) with overlapping coverage of sys-mappings and domain tooling script updates.

Poem

🐇 Hop hop, the mappings are found,
In Mappings/ dirs, safe and sound.
Five steps now guide the migration trail,
With REF encoding — details that don't fail!
The rabbit documents, leaves no stone unturned. ✨

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch f/revision-architecture

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@sourcery-ai sourcery-ai Bot 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.

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@gemini-code-assist gemini-code-assist Bot 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.

Code Review

This pull request updates the migration documentation for v0.0.60, detailing how to configure domain projects and tooling scripts for the new mappings directory. The review feedback suggests improving Turkish grammar consistency in the introduction and resolving a potential ReferenceError in the validate.js documentation snippet by using a literal string instead of a configuration variable.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

### Domain projesi yapılandırması

Domain bileşen ağacına `Mappings/` dizini eklendi:
Bu bölümdeki adımlar mevcut bir domain projesini v0.0.60'a taşırken atılır. Çalışan bir referans için [`vnext-example`](https://github.com/burgan-tech/vnext-example) reposuna bakın — aşağıdaki yapılandırmanın tamamı orada hazırdır.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

Dil bilgisi ve anlatım uyumunu artırmak adına bu cümle daha doğal bir Türkçe ile yeniden yazılabilir. Etken fiil olan "taşırken" ile edilgen fiil olan "atılır" kullanımı anlatım bozukluğuna yol açmaktadır. Bunun yerine "taşınırken uygulanır" veya "taşınırken atılır" şeklinde edilgen uyumu sağlanabilir.

Öneri:
Bu bölümdeki adımlar mevcut bir domain projesi v0.0.60'a taşınırken uygulanır. Çalışan bir referans için [vnext-example](https://github.com/burgan-tech/vnext-example) reposuna bakın — aşağıdaki yapılandırmanın tamamı orada hazırdır.

Comment on lines +126 to +135
**`validate.js`** — dört noktada genişletilir:

```js
// requiredExports ve componentGetters dizilerine:
'getMappings',
// vnextDirs ve expectedDirs dizilerine:
pathsConfig.mappings,
// directoryToSchemaType eşlemesine (mapping → 'mapping' şeması):
[pathsConfig.mappings]: 'mapping',
```

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

Potansiyel Hata / İyileştirme Fırsatı:
validate.js dosyasında vnextDirs ve expectedDirs gibi diziler genellikle modül seviyesinde (global) tanımlanır. Eğer pathsConfig değişkeni bu dizilerin tanımlandığı kapsamda (scope) henüz yüklenmemiş veya tanımlanmamışsa, pathsConfig.mappings kullanımı ReferenceError hatasına yol açabilir.

test.js dosyasındaki örnekte olduğu gibi doğrudan 'Mappings' string değerini kullanmak veya pathsConfig'in ilgili kapsamda tanımlı olduğundan emin olmak daha güvenli bir yaklaşım olacaktır.

Örnek alternatif kullanım:

// vnextDirs ve expectedDirs dizilerine:
'Mappings',

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.

1 participant