Skip to content

Commit

Permalink
docs(@angular-devkit/schematics): add Task to glossary table
Browse files Browse the repository at this point in the history 
Include explanation about Task

Fixes #22764

(cherry picked from commit dde1372)
  • Loading branch information
@ArthurDibe @alan-agius4
ArthurDibe authored and alan-agius4 committed Nov 23, 2023
1 parent 99b6472 commit 0f9f2fa
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions packages/angular_devkit/schematics/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 0f9f2fa

Please sign in to comment.