https://github.com/dhi/arsenal
Shared components & guides monorepo. See the page below for demos.
https://github.com/dhi/arsenal
Last synced: about 2 months ago
JSON representation
Shared components & guides monorepo. See the page below for demos.
- Host: GitHub
- URL: https://github.com/dhi/arsenal
- Owner: DHI
- License: mit
- Created: 2020-07-02T10:11:05.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-15T03:12:30.000Z (10 months ago)
- Last Synced: 2025-04-01T13:43:31.261Z (2 months ago)
- Language: TypeScript
- Homepage: https://dhi.github.io/Arsenal/
- Size: 5.28 MB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @dhi/arsenal.*
> A monorepo workspace for shared library development
+ [Overview](#overview)
+ [Requirements](#requirements)
+ [Usage](#usage)
+ [Package/Library versioning, changelogs, publishing](#packagelibrary-versioning-changelogs-publishing)
+ [Development in other projects](#development-in-other-projects)
+ [Vitejs](#vitejs)
+ [Deprecated functionality](#deprecated-functionality)
## Overview
- `./apps`
Boilerplates or Applications to demonstrate libraries within this repo
- [react-app](./apps/react-app/)
- [stories](./apps/stories/)
- `./libs`
NPM packages, published to Github Packages
- [date-slider](./libs/date-slider/)
- [jsonform](./libs/jsonform/)
- [scenarios](./libs/scenarios/)
- [models](./libs/models/)
- [ui](./libs/ui/)
Tooling:
- `pnpm` with workspaces
- `changesets` for npm package versioning, changelogs & publishing
## Requirements
- To access the NPM registry correctly, update your user ~/.npmrc with a GitHub Access Token. [See this for how to](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry).
## Usage
Project setup essentials:
```bash
git clone [email protected]:DHI/Arsenal.git && cd Arsenal
# Install deps & link everything up
pnpm i
# Build all libraries
pnpm build
```
Developing within the repo:
```bash
# Start developing a library
cd libs/jsonform && pnpm dev
# Start an app
cd apps/stories && pnpm start
```
## Package/Library versioning, changelogs, publishing
**Read this before doing any package versioning or publishing**:
- https://pnpm.io/using-changesets
> Note: All package should conform to this naming structure within NPM/package.json
> @dhi/arsenal.{name}
```bash
# Version libraries
# - Will walk through versioning choices and allow you to specify changed packages
pnpm release:version
# Publish libraries
# - Publishes packages which need to be published
# - Also updates all dependent packages with new version numbers
pnpm release:publish
```
## Development in other projects
By using `pnpm` we can leverage its `pnpm link --global` command to correctly link libraries from this monorepo into any other project.
```bash
pnpm setup # sets up PNPM to work globally
cd libs/scenarios
pnpm link --global # link the package into the global store
pnpm dev # start the development script to update build output on save
```
```bash
cd ~/Work/MyProject
pnpm link --global @dhi/arsenal.scenarios # link in the library we are working on
pnpm dev # start development server
```
Example workflow:
- Update source files in `libs/scenarios`
- Output files are update in `libs/scenarios/x`
- Dev server in `~/Work/MyProject` detects this change from ``~/Work/MyProject/node_modules/@dhi/arsenal.scenarios/x` and reloads the page/hot reloads
### Vitejs
Packages in this project should include `src` files in the bundled package.
These` vite.config.ts` options can enable HMR for dependencies by using source files:
```ts
// ...
resolve: {
alias: {
// Use src files in specific projects to enable hot reloading
'@dhi/arsenal.scenarios': resolve(
'./node_modules/@dhi/arsenal.scenarios/src',
),
},
},
```
This also means you do not have to start the dev script for a library, as it relies on filesystem save events on source files, as if they are a part of your project.
The caveat is that the source must be transpilable by your vite.config.ts, and that is dependent mostly of use of `@emotion/react`.
## Deprecated functionality
The `submodules/libs` `submodules/apps` directories were previously used to facilitate connected workspace automatic linking.
This practice has been abandoned due to `pnpm link` fitting that need, and it introduced issues with pnpm lockfiles becoming malformed.