This package provides a collection of Nx plugins and generators for workspace management. It includes tools for initializing workspaces, managing Docker Compose configurations, fixing implicit internal dependencies, and generating CI information. The plugins and generators aim to streamline common workspace tasks and enforce consistent configurations.
Add the package to your workspace:
yarn add @rxap/plugin-workspaceExecute the init generator:
yarn nx g @rxap/plugin-workspace:initdocker-compose generator
nx g @rxap/plugin-workspace:docker-compose| Option | Type | Default | Description |
|---|---|---|---|
| tags | array | The tags a project needs to be used to generate docker compose service | |
| ignoreProjects | array | The projects to ignore when generating docker compose service | |
| skipFormat | boolean | false | |
| serviceEnvironments | array | The environment variables to be used in docker compose service | |
| rootDomain | string | The root domain to be used in docker compose service | |
| middlewares | array | The traefik middlewares to be add to each service |
init generator
nx g @rxap/plugin-workspace:init| Option | Type | Default | Description |
|---|---|---|---|
| packages | boolean | false | If true, the workspace will be initialized for package development |
| fullStack | boolean | false | If true, the workspace will be initialized for full stack application development |
| standalone | boolean | false | If true, the workspace will be initialized for standalone development |
| overwrite | boolean | false | Whether to overwrite existing files |
| skipFormat | boolean | false | |
| skipProjects | boolean | false | Whether to skip executing project specific initialization |
| skipLicense | boolean | false | Whether to skip adding a license file |
| license | string | gpl | |
| repositoryUrl | string | The URL of the repository | |
| withHusky | boolean |
project-target generator
nx g @rxap/plugin-workspace:project-target| Option | Type | Default | Description |
|---|---|---|---|
| projects | array | ||
| overwrite | boolean | false | Whether to overwrite existing files |
| cleanup | boolean | false | remove if empty object for any configuration and the options property. After configuration cleanup |
| simplify | boolean | false | if the property for the target is equal to the default from the nx.json then remove the property |
| reorder | boolean | false | reorder all target properties to be in alphabetic order |
| project | string |
fix-implicit-internal-dependencies generator
nx g @rxap/plugin-workspace:fix-implicit-internal-dependencies| Option | Type | Default | Description |
|---|---|---|---|
| projects | array | ||
| project | string |
rename generator
nx g @rxap/plugin-workspace:rename| Option | Type | Default | Description |
|---|---|---|---|
| project | string | The name of project that should be renamed | |
| name | string | The new name of the project | |
| tags | array |
ci-info executor
| Option | Type | Default | Description |
|---|---|---|---|
| branch | string | ||
| tag | string | ||
| release | string | ||
| commit | string | ||
| timestamp | string |