Skip to main content

File

Rules​

deployFiles​

Deploys assets files and optionally applies computation to them.

import { deployFiles, schematic, workspace } from '@hug/ngx-schematics-utilities';
import { Rule } from '@angular-devkit/schematics';

export default (options: any): Rule =>
  schematic('my-schematic', [
    // By default: deploy schematic `./files` folder into project root folder
    deployFiles(),

    // Use defaults but also apply computation to `*.template` files
    deployFiles(options),

    // Use a different source folder
    deployFiles(undefined, './my-files'),

    // Use a different destination folder
    deployFiles(undefined, './files', './my-dest-folder'),

    // Using chainable
    workspace()
      .deployFiles()
      .toRule()
  ]);

deleteFiles​

Deletes a collection of files or folders

import { deleteFiles, schematic, workspace } from '@hug/ngx-schematics-utilities';
import { Rule } from '@angular-devkit/schematics';

export default (options: any): Rule =>
  schematic('my-schematic', [
    deleteFiles([
      'src/assets/.gitkeep',
      'src/app/app.component.spec.ts'
    ]),

    // Folder deletion needs to be forced
    deleteFiles(['src'], true),

    // Using chainable
    workspace()
      .deleteFiles(['file.txt'])
      .toRule()
  ]);

renameFile​

Rename a file

import { renameFile, schematic, workspace } from '@hug/ngx-schematics-utilities';
import { Rule } from '@angular-devkit/schematics';

export default (options: any): Rule =>
  schematic('my-schematic', [
    renameFile('src/old/a.ts', 'src/new/b.ts'),

    // Using chainable
    workspace()
      .renameFile('old.txt', 'new.txt')
      .toRule()
  ]);

createOrUpdateFile​

Creates or updates a file.

import { createOrUpdateFile, schematic, workspace } from '@hug/ngx-schematics-utilities';
import { Rule } from '@angular-devkit/schematics';

export default (options: any): Rule =>
  schematic('my-schematic', [
    createOrUpdateFile('README.md', 'My readme content'),

    // Using chainable
    workspace()
      .createOrUpdateFile('README.md', 'My readme Content')
      .toRule()
  ]);

downloadFile​

Downloads a file.

import { downloadFile, rule, schematic, workspace } from '@hug/ngx-schematics-utilities';
import { chain, Rule } from '@angular-devkit/schematics';

export default (options: any): Rule =>
  schematic('my-schematic', [
    rule(() => {
      const sizes = ['72', '96', '128', '144', '152', '192', '384', '512'];
      return chain(
        sizes.map(size => downloadFile(
          `https://my-cdn.com/icons/icon-${size}x${size}.png`,
          `src/assets/icons/icon-${size}x${size}.png`
        ))
      );
    }),

    // Using chainable
    workspace()
      .downloadFile('https://my-cdn.com/icons/icon.png', './icon.png')
      .toRule()
  ]);

replaceInFile​

Replaces text in a file, using a regular expression or a search string.

import { replaceInFile, schematic, workspace } from '@hug/ngx-schematics-utilities';
import { Rule } from '@angular-devkit/schematics';

export default (options: any): Rule =>
  schematic('my-schematic', [
    replaceInFile('.editorconfig', /(indent_size = )(.*)/gm, '$14'),

    // Using chainable
    workspace()
      .replaceInFile('.editorconfig', /(indent_size = )(.*)/gm, '$14')
      .toRule()
  ]);

addImportToFile​

Adds an import to a file.

import { addImportToFile, schematic, project } from '@hug/ngx-schematics-utilities';
import { Rule } from '@angular-devkit/schematics';

export default (options: any): Rule =>
  schematic('my-schematic', [
    // ES format : `import { environment } from './environments/environment';`
    addImportToFile('src/main.ts', 'environment', './environments/environment'),

    // Default format : `import packageJson from 'package.json';`
    addImportToFile('src/main.ts', 'packageJson', 'package.json', true),

    // Using chainable
    application(options.project)
      .addImportToFile('__MAIN__', 'environment', './environments/environment')
      .toRule()
  ]);

modifyImportInFile​

Modifies or removes an import inside a file.

import { modifyImportInFile, schematic, project } from '@hug/ngx-schematics-utilities';
import { Rule } from '@angular-devkit/schematics';

export default (options: any): Rule =>
  schematic('my-schematic', [
    // Rename an import
    modifyImportInFile('src/main.ts', 'name', 'newName', 'src/my-file'),

    // Remove an import
    modifyImportInFile('src/main.ts', 'environment', undefined, 'src/environments/environment'),

    // Using chainable
    project(options.project)
      .modifyImportInFile('__MAIN__', 'name', 'newName', 'src/my-file')
      .toRule()
  ]);

removeImportFromFile​

Removes an import inside a file.

import { modifyImportInFile, schematic, project } from '@hug/ngx-schematics-utilities';
import { Rule } from '@angular-devkit/schematics';

export default (options: any): Rule =>
  schematic('my-schematic', [
    removeImportFromFile('src/main.ts', 'environment', 'src/environments/environment'),

    // Using chainable
    project(options.project)
      .removeImportFromFile('__MAIN__', 'environment', 'src/environments/environment')
      .toRule()
  ]);

modifyJsonFile​

Adds, modifies or removes an element in a JSON file.

import { modifyJsonFile, schematic, workspace } from '@hug/ngx-schematics-utilities';
import { Rule } from '@angular-devkit/schematics';

export default (options: any): Rule =>
  schematic('my-schematic', [
    // Add or update an element
    modifyJsonFile('tsconfig.json', ['compilerOptions', 'emitDecoratorMetadata'], true),

    // Remove an element
    modifyJsonFile('tsconfig.json', ['compilerOptions', 'strict'], undefined),

    // Add an element at the beginning
    modifyJsonFile('tsconfig.json', ['extends'], './my-tsconfig.json', () => 0),

    // Using chainable
    workspace()
      .modifyJsonFile('tsconfig.json', ['compilerOptions', 'emitDecoratorMetadata'], true)
      .toRule()
  ]);

removeFromJsonFile​

Removes an element inside a JSON file.

import { removeFromJsonFile, schematic, workspace } from '@hug/ngx-schematics-utilities';
import { Rule } from '@angular-devkit/schematics';

export default (options: any): Rule =>
  schematic('my-schematic', [
    removeFromJsonFile('package.json', ['scripts', 'start']),

    // Using chainable
    workspace()
      .removeFromJsonFile('package.json', ['scripts', 'start'])
      .toRule()
  ]);

Helpers​

serializeToJson​

Converts a JavaScript value to a JavaScript Object Notation (JSON) string.

Note

Uses a default indentation of 2.

import { serializeToJson, schematic, rule } from '@hug/ngx-schematics-utilities';
import { chain, Rule } from '@angular-devkit/schematics';

export default (options: any): Rule =>
  schematic('my-schematic', [
    rule((): Rule => {
      const data = { key: 'value' };
      const str = serializeToJson(data);
      ...
    })
  ]);

getTsSourceFile​

Gets the source of a TypeScript file.

import { getTsSourceFile, schematic, rule } from '@hug/ngx-schematics-utilities';
import { Rule, Tree } from '@angular-devkit/schematics';

export const myRule = (filePath: string): Rule =>
  rule((tree: Tree): void => {
    const sourceFile = getTsSourceFile(tree, filePath);
    ...
  });

commitChanges​

Applies changes on a file inside the current schematic's project tree.

import { commitChanges, rule } from '@hug/ngx-schematics-utilities';
import { Rule, Tree } from '@angular-devkit/schematics';

export const myRule = (filePath: string): Rule =>
  rule((tree: Tree): void => {
    ...
    commitChanges(tree, filePath, changes);
  });