@nx/devkit

What is @nx/devkit?

The @nx/devkit package is a set of utilities for building and managing development workflows, particularly in the context of monorepos managed by Nx. It provides APIs for creating plugins, generating files from templates, and interacting with the Nx workspace configuration.

What are @nx/devkit's main functionalities?

Plugin Creation

This code sample demonstrates how to create a simple Nx plugin that writes a greeting to a file, formats the files in the workspace, and schedules a task to install npm packages.

import { Tree, formatFiles, installPackagesTask } from '@nrwl/devkit';

export default async function (tree: Tree, schema: any) {
  tree.write('hello.txt', `Hello ${schema.name}!`);
  await formatFiles(tree);
  return () => {
    installPackagesTask(tree);
  };
}

Workspace Configuration Interaction

This code sample shows how to read and update the workspace configuration in an Nx workspace using the @nx/devkit package.

import { updateWorkspaceConfiguration, readWorkspaceConfiguration } from '@nrwl/devkit';

export function updateWorkspace(tree) {
  const config = readWorkspaceConfiguration(tree);
  config.version = 2;
  updateWorkspaceConfiguration(tree, config);
}

Generating Files from Templates

This example illustrates how to generate files in an Nx workspace from a set of templates, using the options provided to customize the generated output.

import { generateFiles, joinPathFragments } from '@nrwl/devkit';

export function generateComponent(tree, options) {
  const templatePath = './path/to/templates';
  const targetPath = joinPathFragments('libs', options.name);
  generateFiles(tree, templatePath, targetPath, options);
}

Other packages similar to @nx/devkit

yeoman-generator

Yeoman is a generic scaffolding system that allows the creation of any kind of app. It can be used to scaffold complete projects or parts of projects, and it's not tied to a specific project structure like @nx/devkit is with Nx workspaces.

plop

Plop is a micro-generator framework that provides a simple template-based system for code generation. It's less opinionated than @nx/devkit and can be used in any project, not just Nx workspaces.

hygen

Hygen is a scalable code generator that's fast and simple. It's similar to @nx/devkit in that it helps automate the creation of code, but it's not specifically designed for Nx workspaces and can be used in various types of projects.

README

---

Nx: Smart, Fast and Extensible Build System

Nx is a next generation build system with first class monorepo support and powerful integrations.

This package contains a set of utilities for creating Nx plugins.

Getting Started

Creating an Nx Workspace

Using npx

npx create-nx-workspace

Using npm init

npm init nx-workspace

Using yarn create

yarn create nx-workspace

Adding Nx to an Existing Repository

Run:

npx nx@latest init

Documentation & Resources

• Nx.Dev: Documentation, Guides, Tutorials
• Intro to Nx
• Official Nx YouTube Channel
• Blog Posts About Nx