240db4e2a7
Some checks failed
Server CI / Postgres (shard 0) (push) Has been skipped
Server CI / Postgres (shard 3) (push) Has been skipped
BuildEnv Docker Image / build-image (push) Failing after 4s
BuildEnv Docker Image / build-image-fips (push) Failing after 4s
Migration Review & Release Notes / Generate migration review & release notes (push) Failing after 3s
Server CI / Build Environment (push) Failing after 3s
Server CI / Postgres (shard 1) (push) Has been skipped
Tools CI / check-style (mattermost-govet) (push) Failing after 4s
Server CI / Postgres (shard 2) (push) Has been skipped
Tools CI / check-style (mmgotool) (push) Failing after 3s
Server CI / Elasticsearch v8 Compatibility (push) Has been skipped
Server CI / OpenSearch v2 Compatibility (push) Has been skipped
Server CI / Postgres FIPS (shard 0) (push) Has been skipped
Tools CI / Test (mattermost-govet) (push) Failing after 3s
Server CI / Postgres FIPS (shard 1) (push) Has been skipped
Server CI / Postgres FIPS (shard 2) (push) Has been skipped
Tools CI / Test (mmgotool) (push) Failing after 3s
Server CI / Postgres FIPS (shard 3) (push) Has been skipped
Server CI / Run mmctl tests (push) Has been skipped
Server CI / Run mmctl tests (FIPS) (push) Has been skipped
Server CI / Merge Postgres Test Results (push) Has been skipped
Server CI / Merge Postgres FIPS Test Results (push) Has been skipped
Server CI / Check backport migrations (push) Has been skipped
Server CI / Check generated files (push) Has been skipped
Server CI / check-style (push) Has been skipped
Server CI / Vet API (push) Has been skipped
Server CI / Build mattermost server app (push) Has been skipped
Server CI / Server CI Complete (push) Failing after 2s
Server CI / Server CI Artifacts (push) Has been skipped
Server CI / Sentry Upload (push) Has been skipped
Server CI / Server CI Report (push) Failing after 5m1s
Server CI Nightly Race / Race Detector (push) Has been skipped
CodeQL / Analyze (go) (push) Has been cancelled
CodeQL / Analyze (javascript) (push) Has been cancelled
Webapp CI Cache Warm / Warm Webapp node_modules Cache (push) Has been cancelled
E2E CI Cache Warm / Warm E2E npm Registry Cache (push) Has been cancelled
API / build (push) Has been cancelled
Web App CI / check-types (push) Has been cancelled
Web App CI / check-lint (push) Has been cancelled
Web App CI / check-i18n (push) Has been cancelled
Web App CI / check-external-links (push) Has been cancelled
Web App CI / test (platform) (push) Has been cancelled
Web App CI / test (mattermost-redux) (push) Has been cancelled
Web App CI / test (channels shard 1/4) (push) Has been cancelled
Web App CI / test (channels shard 2/4) (push) Has been cancelled
Web App CI / test (channels shard 3/4) (push) Has been cancelled
Web App CI / test (channels shard 4/4) (push) Has been cancelled
Web App CI / upload-coverage (push) Has been cancelled
Web App CI / build (push) Has been cancelled
YAML Lint / yamllint (push) Has been cancelled
Push mirrored docker images / cd/Push mirrored docker images (push) Has been cancelled
docs-cd / Build and deploy docs (push) Has been cancelled
Docs CI / build (push) Has been cancelled
E2E Cache Warm: Cypress deps / Warm Cypress deps cache (push) Has been cancelled
Scorecards supply-chain security / Scorecard analysis (push) Has been cancelled
Server CI Weekly / Postgres FIPS (push) Has been skipped
Server CI Weekly / Run mmctl tests (FIPS) (push) Has been skipped
Server CI Weekly / Postgres with binary parameters (push) Has been skipped
Server CI Weekly / Build Environment (push) Failing after 1s
Server CI Cache Warm / Warm Go Module and Build Cache (push) Failing after 2s
Server CI Nightly Race / Build Environment (push) Failing after 1s
47 lines
1.8 KiB
Markdown
47 lines
1.8 KiB
Markdown
# CLAUDE: `webapp/platform/`
|
|
|
|
## Purpose
|
|
- Shared packages consumed by every Mattermost web experience (Channels, Boards, Playbooks, plugins).
|
|
- Changes here affect multiple products—coordinate across teams before merging.
|
|
|
|
## Packages
|
|
|
|
| Package | Directory | Purpose |
|
|
|---------|-----------|---------|
|
|
| `@mattermost/types` | `types/` | TypeScript type definitions |
|
|
| `@mattermost/client` | `client/` | REST and WebSocket API client |
|
|
| `@mattermost/components` | `components/` | Shared React components |
|
|
| `@mattermost/shared` | `shared/` | Cross-product components and utilities for the web app and plugins (e.g. `Button`, `WithTooltip`). Prefer these over rolling your own |
|
|
| `@mattermost/eslint-plugin` | `eslint-plugin/` | Custom ESLint rules |
|
|
|
|
## Workspace Basics
|
|
- Each subpackage is its own npm workspace with independent `package.json`, tests, and build scripts.
|
|
- Run commands with `npm run <script> --workspace=@mattermost/<pkg>` (e.g., `@mattermost/client`).
|
|
- Versioning follows the monorepo; publishable artifacts come from CI pipelines.
|
|
|
|
## Import Convention
|
|
Always import using the full package name:
|
|
|
|
```typescript
|
|
// CORRECT
|
|
import {Client4} from '@mattermost/client';
|
|
// INCORRECT - never use relative paths
|
|
import Client4 from '../platform/client/src/client4';
|
|
```
|
|
|
|
## Build Relationship
|
|
Platform packages are automatically built on `npm install` via postinstall hook. Build order: `types` → `client`/`components`.
|
|
|
|
**Note**: When developing in `channels`, changes in `platform` packages may need a rebuild if not using a watcher that supports them.
|
|
|
|
## Adding Dependencies
|
|
When adding dependencies to platform packages:
|
|
```bash
|
|
npm add package-name --workspace=@mattermost/client
|
|
```
|
|
|
|
## Expectations
|
|
- Follow `webapp/STYLE_GUIDE.md`.
|
|
- Maintain 100% TypeScript coverage; no `any`.
|
|
- Update downstream consumers when making breaking changes.
|