Skip to content

Commit

Permalink
add clarity to global css example; fix formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
willmartian committed Dec 15, 2023
1 parent 8ce7a11 commit dc3a137
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/architecture/clients/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ and a single [Git repository](https://github.com/bitwarden/clients).

The mono-repository root directory contains three main folders.

- `apps` - Our different application specific code, consists of `web`, `browser`, `desktop` and
- `apps`: Our different application specific code, consists of `web`, `browser`, `desktop` and
`cli`.
- `bitwarden_license` - Bitwarden Licensed version of the web vault.
- `libs` - Shared code between the different applications.
- `bitwarden_license`: Bitwarden Licensed version of the web vault.
- `libs`: Shared code between the different applications.

## Libs

Expand Down Expand Up @@ -51,8 +51,8 @@ concerned with bootstrapping the application and consuming and configuring code

Any code in the `apps/` that doesn't have a tight coupling with the client can be moved into a lib:
if an exported member is wholly dependent on other libs but not `apps/`, it can likely be moved to a
lib itself. (More concretely, this bars components that rely on global client-specific CSS, but not
components built with Tailwind and the CL.)
lib itself. (More concretely, this bars components that rely on global client-specific CSS but not
components built with Tailwind and the CL — from being included in a lib)

> Having a dedicated library project is a much stronger boundary compared to just separating code
> into folders, though. Each library has a so-called "public API", represented by an index.ts barrel
Expand All @@ -64,7 +64,7 @@ An existing example of this pattern is `@bitwarden/components`:

- It is consumed by multiple apps and other libs
- It manages a clear public and private API boundary through its barrel file
- Code ownership is clear--the CL team only owns the files within `libs/components`
- Code ownership is clearthe CL team only owns the files within `libs/components`
- The CL team can make independent decisions around internal folder structure and code style

As part of this process, we are also investigating utilizing additional tooling (such as Nx) to make
Expand Down

0 comments on commit dc3a137

Please sign in to comment.