Skip to content

Commit 4dc4ba8

Browse files
committed
chore: project structure with mermaid
1 parent 5112bb2 commit 4dc4ba8

File tree

1 file changed

+32
-3
lines changed

1 file changed

+32
-3
lines changed

.github/CONTRIBUTING.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ A high level overview of tools used:
6060

6161
- [TypeScript](https://www.typescriptlang.org/) as the development language
6262
- [Rollup](https://rollupjs.org) for bundling
63-
- [Jest](https://jestjs.io/) for unit testing
64-
- [Puppeteer](https://pptr.dev/) for e2e testing
63+
- [Vitest](https://vitest.dev/) for unit testing
64+
- [Playwright](https://playwright.dev/) for e2e testing
6565
- [ESLint](https://eslint.org/) for code linting
6666
- [Prettier](https://prettier.io/) for code formatting
6767

@@ -174,13 +174,42 @@ $ pnpm test -- fileName -t 'test name'
174174

175175
This repository employs a [monorepo](https://en.wikipedia.org/wiki/Monorepo) setup which hosts a number of associated packages under the `packages` directory:
176176

177+
```mermaid
178+
flowchart TD
179+
shared["@intlify/shared"]
180+
message-compiler["@intlify/message-compiler"]
181+
core-base["@intlify/core-base"]
182+
core["@intlify/core"]
183+
vue-i18n-core["@intlify/vue-i18n-core"]
184+
petite-vue-i18n["petite-vue-i18n"]
185+
vue-i18n["vue-i18n"]
186+
187+
subgraph Framework Agnostice Packages
188+
message-compiler --> shared
189+
core-base --> shared
190+
core-base --> message-compiler
191+
core --> shared
192+
core --> core-base
193+
end
194+
195+
subgraph Vue Layer Packages
196+
vue-i18n-core --> shared
197+
vue-i18n-core --> core-base
198+
vue-i18n --> shared
199+
vue-i18n --> core-base
200+
vue-i18n --> vue-i18n-core
201+
petite-vue-i18n --> shared
202+
petite-vue-i18n --> core-base
203+
petite-vue-i18n --> vue-i18n-core
204+
end
205+
```
206+
177207
- `shared`: Internal utilities shared across multiple packages.
178208
- `message-compiler`: The intlify message format compiler.
179209
- `core-base`: The inlitfy core base.
180210
- `core`: The intlify core "full build" which includes both the runtime AND the compiler.
181211
- `vue-i18n-core`: The vue-i18n core implementation package.
182212
- `vue-i18n`: The vue-i18n "full build" which includes both the runtime AND the compiler.
183-
- `vue-i18n-bridge`: The birdge package for migrating from [email protected] or later.
184213
- `petite-vue-i18n`: The vue-i18n "small build" which includes both the runtime AND the compiler.
185214

186215
### Importing Packages

0 commit comments

Comments
 (0)