@nx/devkit

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);
}