Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@nrwl/devkit

Package Overview
Dependencies
Maintainers
6
Versions
1324
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@nrwl/devkit

The Nx Devkit is used to customize Nx for different technologies and use cases. It contains many utility functions for reading and writing files, updating configuration, working with Abstract Syntax Trees(ASTs), and more.

  • 16.5.1
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
4.4M
decreased by-2.28%
Maintainers
6
Weekly downloads
 
Created

What is @nrwl/devkit?

The @nrwl/devkit package is a set of utilities designed to improve the developer experience by providing tools for building, testing, and managing Angular and React projects within a monorepo setup. It is part of the Nx ecosystem, which focuses on bringing a unified approach to working with modern web technologies.

What are @nrwl/devkit's main functionalities?

Generating Components

This feature allows developers to programmatically generate components or other files within their project. The code sample demonstrates how to use the `generateFiles` function to create a new component in a library within the monorepo.

import { generateFiles } from '@nrwl/devkit';
function generateMyComponent(tree, schema) {
  generateFiles(tree, path.join(__dirname, './files'), '/libs/mylib/src/lib', {
    tmpl: '',
    name: schema.name
  });
}

Updating JSON Configuration

This feature provides a straightforward way to update JSON files, such as `tsconfig.json` or `.eslintrc.json`, programmatically. The code sample shows how to modify the `tsconfig.base.json` to add a new path mapping for a library.

import { updateJson } from '@nrwl/devkit';
function updateTsConfig(tree) {
  updateJson(tree, 'tsconfig.base.json', (json) => {
    json.compilerOptions.paths['@myorg/mylib'] = ['libs/mylib/src/index.ts'];
    return json;
  });
}

Executing Schematic Tasks

This feature enables developers to execute tasks such as adding project configurations or formatting files. The code sample illustrates how to add a new library configuration to the workspace and then format all files according to the workspace's prettier or eslint configurations.

import { addProjectConfiguration, Tree, formatFiles } from '@nrwl/devkit';
function addMyLib(tree: Tree) {
  addProjectConfiguration(tree, 'my-lib', {
    root: './libs/my-lib',
    projectType: 'library',
    targets: {},
  });
  formatFiles(tree);
}

Other packages similar to @nrwl/devkit

Keywords

FAQs

Package last updated on 10 Jul 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc