https://github.com/wyntau/schematics-task

https://github.com/wyntau/schematics-task

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/wyntau/schematics-task
• Owner: wyntau
• Created: 2021-10-16T16:59:20.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-07-31T19:54:16.000Z (2 months ago)
• Last Synced: 2024-09-01T00:19:27.730Z (about 1 month ago)
• Language: TypeScript
• Size: 150 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# schematics-task

add and run task like schematics's `NodePackageInstallTask`

## TaskFn

```ts

import { Rule } from '@angular-devkit/schematics';

type TaskFn = Rule;

```

`TaskFn` has no difference with a normal `Rule`.

## Export

- `addTask`, return a `Rule`, so you can use it like other `Rule` generators.

- `newTask`, task generate utility, then you can add the result to `context.addTask`

## Usage

### Use as a `Rule`

```ts

import { addTask } from 'schematics-task';

import { chain, Rule } from '@angular-devkit/schematics';

function foo(tree, context): Rule {

  return chain([

    // ...

    addTask(async () => {

      // Let's run a shell script

      await execa('echo', ['hello', 'world'], {stdio: 'inherit'});

      // do whatever you want

    }),

  ]);

}

```

### Use as a utility function

```ts

import { newTask } from 'schematics-task';

import { Tree, SchematicContext } from '@angular-devkit/schematics';

import execa from 'execa';

function foo(tree: Tree, context: SchematicContext) {

  context.addTask(

    newTask(async (_tree, _context) => {

      // you can also use tree & context here

      // Let's run a shell script

      await execa('echo', ['hello', 'world'], {stdio: 'inherit'});

      // do whatever you want

    })

  );

  return tree;

}

```

## License

MIT