4049300129
This tells the TypeScript compiler (only used for type checking in the web app) to use the `imports` and `exports` field of a package's `package.json` to find modules. Those fields are standard in newer versions of Node.js, and hopefully supporting them means that we'll have to do less work to configure tooling in the future. We could also get similar behaviour by using the `nodenext` option, but that adds some additional requirements to include file extensions which ES Modules technically require, but I don't think we need to enforce because other tooling doesn't require them. I wanted to make that change in all of the subpackages as well, but we can't do that without having TypeScript output ES Modules which, unless we change their build processes to generate multiple formats (like the shared package in client package, or the types package which is more than I want to do at the moment. The changes to other files are either because they incorrectly imported types from a file that isn't intentionally exposed by the plugin or it's because we had a typo in a file path. |
||
|---|---|---|
| .. | ||
| channels | ||
| patches | ||
| platform | ||
| scripts | ||
| .gitignore | ||
| .npmrc | ||
| CLAUDE.OPTIONAL.md | ||
| config.mk | ||
| Makefile | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| STYLE_GUIDE.md | ||
Mattermost Web App
This folder contains the client code for the Mattermost web app. It's broken up into multiple packages each of which either contains an area of the app (such as playbooks) or shared logic used across other packages (such as the packages located in the platform directory). For anyone who's used to working in the mattermost/mattermost-webapp repo, most of that is now located in channels.
npm Workspaces
To interact with a workspace using npm, such as to add a dependency or run a script, use the --workspace (or --workspaces) flag. This can be done when using built-in npm commands such as npm add or when running scripts. Those commands should be run from this directory.
# Add a dependency to a single package
npm add react --workspace=playbooks
# Build multiple packages
npm run build --workspace=platform/client --workspace=platform/components
# Test all workspaces
npm test --workspaces
# Clean all workspaces that have a clean script defined
npm run clean --workspaces --if-present
To install dependencies for a workspace, simply run npm install from this folder as you would do normally. Most packages' dependencies will be included in the root node_modules, and all packages' dependencies will appear in the package-lock.json. A node_modules will only be created inside a package if one of its dependencies conflicts with that of another package.
Useful Links
- Developer setup, now included with the Mattermost server developer setup
- Web app developer documentation