workspacejson

workspacejson is a configuration file used by some monorepo tooling to describe the structure and buildable components within a workspace. It stores project definitions and the tasks that can be run for each project, such as building, testing, linting, and packaging. The file is typically named workspace.json or workspace.jsonc (JSON with optional comments) and is placed at the repository root.

In a workspace.json, the workspace is represented as a collection of projects. Each project contains metadata such as its root path, source code location, and type (for example, application or library). Projects also define a set of targets or architects, which specify task executors (builders) and their options. Common targets include build, test, lint, and serve. The structure enables tooling to orchestrate complex workflows across multiple projects from a single configuration.

The file is often used in conjunction with other configuration files (for example, nx.json or project.json in newer setups) to specify scope, implicit dependencies, tags, and environment configurations. While workspace.json provides a centralized view, some toolchains increasingly adopt per-project project.json files for better modularity. This can lead to migration or coexistence where workspace.json remains for compatibility, and project-specific files handle individual project configurations.

Example:

{

"projects": {

"my-app": {

"root": "apps/my-app",

"sourceRoot": "apps/my-app/src",

"projectType": "application",

"targets": {

"build": { "executor": "@nrwl/node:build", "options": { "outputPath": "dist/apps/my-app" } }

}

}

}

}

Notes: workspacejson is tool- and version-specific; exact schemas and field names may vary across ecosystems.