nx/docs/generated/devkit/addDependenciesToPackageJson.md
Juri Strumpflohner b51676a89a
docs(core): restructure guides into technologies sections (#31288)
Updates the docs structure, navigation etc to be easier + better suited
for showing Nx technology support beyond just TS.

**Notes:**

- API (`/nx-api`) tab is removed from the navigation (i.e. menu bar),
but pages still remain for now until we update references in `*.md`
files.
- Redirects are set up `/nx-api` to go to their respect new location
e.g. `/technologies` or `/reference/core-api`
- Old URLs still exist in the sitemap for now, but majority of them will
be redirected -- a follow-up PR can remove them.

**Preview:**
https://nx-dev-git-nx-dev-polyglot-docs-restructure-nrwl.vercel.app/docs

---------

Co-authored-by: Jack Hsu <jack.hsu@gmail.com>
2025-05-29 14:55:34 -04:00

30 lines
1.8 KiB
Markdown

# Function: addDependenciesToPackageJson
**addDependenciesToPackageJson**(`tree`, `dependencies`, `devDependencies`, `packageJsonPath?`, `keepExistingVersions?`): [`GeneratorCallback`](/reference/core-api/devkit/documents/GeneratorCallback)
Add Dependencies and Dev Dependencies to package.json
For example:
```typescript
addDependenciesToPackageJson(tree, { react: 'latest' }, { jest: 'latest' });
```
This will **add** `react` and `jest` to the dependencies and devDependencies sections of package.json respectively.
#### Parameters
| Name | Type | Description |
| :---------------------- | :-------------------------------------------------- | :-------------------------------------------------------------------------- |
| `tree` | [`Tree`](/reference/core-api/devkit/documents/Tree) | Tree representing file system to modify |
| `dependencies` | `Record`\<`string`, `string`\> | Dependencies to be added to the dependencies section of package.json |
| `devDependencies` | `Record`\<`string`, `string`\> | Dependencies to be added to the devDependencies section of package.json |
| `packageJsonPath?` | `string` | Path to package.json |
| `keepExistingVersions?` | `boolean` | If true, prevents existing dependencies from being bumped to newer versions |
#### Returns
[`GeneratorCallback`](/reference/core-api/devkit/documents/GeneratorCallback)
Callback to install dependencies only if necessary, no-op otherwise