From dde1372f5ba8217e57a7b931802352deb9a00da8 Mon Sep 17 00:00:00 2001 From: Arthur Dibe Date: Thu, 9 Nov 2023 23:49:17 -0500 Subject: [PATCH] docs(@angular-devkit/schematics): add Task to glossary table Include explanation about Task Fixes #22764 --- packages/angular_devkit/schematics/README.md | 21 ++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/packages/angular_devkit/schematics/README.md b/packages/angular_devkit/schematics/README.md index b4f47a101e..a0b9d8e3e2 100644 --- a/packages/angular_devkit/schematics/README.md +++ b/packages/angular_devkit/schematics/README.md @@ -10,16 +10,17 @@ What distinguishes Schematics from other generators, such as Yeoman or Yarn Crea # Glossary -| Term | Description | -| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **Schematics** | A generator that executes descriptive code without side effects on an existing file system. | -| **Collection** | A list of schematics metadata. Schematics can be referred by name inside a collection. | -| **Tool** | The code using the Schematics library. | -| **Tree** | A staging area for changes, containing the original file system, and a list of changes to apply to it. | -| **Rule** | A function that applies actions to a `Tree`. It returns a new `Tree` that will contain all transformations to be applied. | -| **Source** | A function that creates an entirely new `Tree` from an empty filesystem. For example, a file source could read files from disk and create a Create Action for each of those. | -| **Action** | An atomic operation to be validated and committed to a filesystem or a `Tree`. Actions are created by schematics. | -| **Sink** | The final destination of all `Action`s. | +| Term | Description | +| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Schematics** | A generator that executes descriptive code without side effects on an existing file system. | +| **Collection** | A list of schematics metadata. Schematics can be referred by name inside a collection. | +| **Tool** | The code using the Schematics library. | +| **Tree** | A staging area for changes, containing the original file system, and a list of changes to apply to it. | +| **Rule** | A function that applies actions to a `Tree`. It returns a new `Tree` that will contain all transformations to be applied. | +| **Source** | A function that creates an entirely new `Tree` from an empty filesystem. For example, a file source could read files from disk and create a Create Action for each of those. | +| **Action** | An atomic operation to be validated and committed to a filesystem or a `Tree`. Actions are created by schematics. | +| **Sink** | The final destination of all `Action`s. | +| **Task** | A Task is a way to execute an external command or script in a schematic. A Task can be used to perform actions such as installing dependencies, running tests, or building a project. A Task is created by using the `SchematicContext` object and can be scheduled to run before or after the schematic `Tree` is applied. | # Tooling