-
Notifications
You must be signed in to change notification settings - Fork 213
FIX: typography of public-api article #871
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
2d4aacc
FIX: typography of public-api article
Fpsska f7305be
Update i18n/ru/docusaurus-plugin-content-docs/current/reference/publi…
Fpsska 0cf21de
Update i18n/ru/docusaurus-plugin-content-docs/current/reference/publi…
Fpsska 43016f7
Update i18n/ru/docusaurus-plugin-content-docs/current/reference/publi…
Fpsska File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -31,11 +31,11 @@ export * from "./ui/Comment"; // 👎 не пытайтесь повторит | |
| export * from "./model/comments"; // 💩 это плохая практика | ||
| ``` | ||
|
|
||
| Это ухудшает понимаемость слайса беглым взглядом, потому что вы не можете легко определить, каков интерфейс этого слайса. Не зная интерфейс, вам придется глубоко погружаться в код слайса, чтобы понять, как его интегрировать. Еще одна проблема заключается в том, что вы можете случайно раскрыть внутренние модули, что усложнит рефакторинг, если кто-то начнет от них зависеть. | ||
| Это приводит к трудностям определения роли конкретного слайса (его интерфейса). Не зная интерфейс, вам придется глубоко погружаться в код слайса, чтобы понять, как его интегрировать. Еще одна проблема заключается в том, что вы можете случайно раскрыть внутренние модули, что усложнит рефакторинг, если кто-то начнет от них зависеть. | ||
|
|
||
| ## Публичный API для кросс-импортов {#public-api-for-cross-imports} | ||
|
|
||
| Кросс-импорты — это ситуация, когда один слайс импортирует из другого слайса на том же слое. Обычно это запрещено [правилом импорта для слоёв][import-rule-on-layers], но часто есть реальные причины, чтоб сделать кросс-импорт. Например, в реальном мире бизнес-сущности часто ссылаются друг на друга, и лучше отразить эти отношения в коде, а не пытаться избавиться от них. | ||
| Кросс-импорты — это ситуация, когда один слайс импортирует из другого слайса на том же слое. Обычно это запрещено [правилом импорта для слоёв][import-rule-on-layers], но часто есть реальные причины, чтобы сделать кросс-импорт. Например, в реальном мире бизнес-сущности часто ссылаются друг на друга, и лучше отразить эти отношения в коде, а не пытаться избавиться от них. | ||
|
|
||
| Для этой цели существует особый вид публичного API, также известный как `@x`-нотация. Если у вас есть сущности A и B, и сущность B должна импортировать из сущности A, то сущность A может объявить отдельный публичный API только для сущности B. | ||
|
|
||
|
|
@@ -45,7 +45,7 @@ export * from "./model/comments"; // 💩 это плохая практика | |
| - `📄 B.ts` — специальный публичный API только для кода внутри `entities/B/` | ||
| - `📄 index.ts` — обычный публичный API | ||
|
|
||
| Затем код внутри `entities/B/` может импортировать из `entities/A/@x/B`: | ||
| Затем код внутри `entities/B/` может быть импортирован из `entities/A/@x/B`: | ||
|
||
|
|
||
| ```ts | ||
| import type { EntityA } from "entities/A/@x/B"; | ||
|
|
@@ -141,11 +141,11 @@ import { TextField } from '@/shared/ui/text-field'; | |
|
|
||
| Есть несколько вещей, которые вы можете сделать, чтобы справиться с этой проблемой: | ||
|
|
||
| 1. То же самое, что и в разделе "Большие бандлы и неработающий tree-shaking в Shared" — создайте отдельные индексные файлы для каждого компонента/библиотеки в shared/ui и shared/lib вместо одного большого | ||
| 1. То же самое, что и в разделе "Большие бандлы и неработающий tree-shaking в Shared" — создайте отдельные индексные файлы для каждого компонента/библиотеки в `shared/ui` и `shared/lib` вместо одного большого | ||
| 2. Избегайте наличия индексных файлов в сегментах на слоях, которые имеют слайсы. | ||
| Например, если у вас есть индекс для фичи "comments", `📄 features/comments/index.js`, нет смысла иметь еще один индекс для `ui` сегмента этой фичи, `📄 features/comments/ui/index.js`. | ||
| 3. Если у вас очень большой проект, есть большая вероятность, что ваше приложение можно разделить на несколько больших кусков. | ||
| Например, у Google Docs очень разные обязанности для редактора документов и для файлового браузера. Вы можете создать монорепозиторий, где каждый пакет является отдельным корнем FSD со своим набором слоев. Некоторые пакеты могут иметь только слои Shared и Entities, другие могут иметь только Pages и App, а некоторые могут включать свой небольшой Shared, но при этом использовать большой Shared из другого пакета. | ||
| Например, у Google Docs зона ответственности для редактора документов и для файлового браузера сильно отличаются. Вы можете создать монорепозиторий, где каждый пакет является отдельным корнем FSD со своим набором слоев. Некоторые пакеты могут иметь только слои Shared и Entities, другие могут иметь только Pages и App, а некоторые могут включать свой небольшой Shared, но при этом использовать большой Shared из другого пакета. | ||
Fpsska marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| <!-- TODO: add a link to a page that explains this in more detail (when one will exist) --> | ||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.