Skip to content

Update CLAUDE.md to include info about the clientAPIs directory #1344

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.

Sign up for GitHub

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
labkey-alan merged 1 commit into from
Apr 21, 2026
Merged

Update CLAUDE.md to include info about the clientAPIs directory #1344

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,14 @@ Dual database support (PostgreSQL and MS SQL Server). Configuration lives in `se

Mix of JSPs, React (via `@labkey/components`, `@labkey/premium`), ExtJS, and vanilla JS. Modules with TypeScript have their own `package.json` and use Webpack builds (via `@labkey/build`). TypeScript code is linted and formatted with `@labkey/eslint-config`. Node.js and npm versions are pinned in `gradle.properties` and downloaded during build.

The path to the local copy of the `@labkey/components` package is located in the `LABKEY_UI_COMPONENTS_HOME` environment variable. The path to the local copy of `@labkey/premium` is located in the `LABKEY_UI_PREMIUM_HOME` environment variable. The local copies of the packages may contain changes related to the current branches in any of the modules that have an NPM build. For example there may be changes to the `@labkey/components` package that affect the package in the `server/modules/platform/core` module.
We keep local copies of the `@labkey` packages in the `clientAPIs/` directory. You can find the following packages in this directory:
- `@labkey/api`: `clientAPIs/labkey-api-js/`
- `@labkey/components`: `clientAPIs/labkey-ui-components/packages/components/`
- `@labkey/build`: `clientAPIs/labkey-ui-components/packages/build/`
- `@labkey/eslint-config`: `clientAPIs/labkey-ui-components/packages/eslint-config/`
- `@labkey/premium`: `clientAPIs/labkey-ui-premium/`

The local copies of the packages may contain changes related to the current branches in any of the modules that have an NPM build. For example there may be changes to the `@labkey/components` package that affect the package in the `server/modules/platform/core` module. These packages are not required to be present to build the project, so they may not be available. If they are not present, you can assume that there are no changes in those packages relevant to the current branch. If you suspect an issue is with one of the packages, but it is not present you may prompt the user to check out a local copy of the relevant package.

### Distributions

Expand Down
Loading