Skip to content

Commit dde1372

Browse files
ArthurDibealan-agius4
authored andcommitted
docs(@angular-devkit/schematics): add Task to glossary table
Include explanation about Task Fixes #22764
1 parent 154c7ce commit dde1372

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

packages/angular_devkit/schematics/README.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,17 @@ What distinguishes Schematics from other generators, such as Yeoman or Yarn Crea
1010

1111
# Glossary
1212

13-
| Term | Description |
14-
| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15-
| **Schematics** | A generator that executes descriptive code without side effects on an existing file system. |
16-
| **Collection** | A list of schematics metadata. Schematics can be referred by name inside a collection. |
17-
| **Tool** | The code using the Schematics library. |
18-
| **Tree** | A staging area for changes, containing the original file system, and a list of changes to apply to it. |
19-
| **Rule** | A function that applies actions to a `Tree`. It returns a new `Tree` that will contain all transformations to be applied. |
20-
| **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. |
21-
| **Action** | An atomic operation to be validated and committed to a filesystem or a `Tree`. Actions are created by schematics. |
22-
| **Sink** | The final destination of all `Action`s. |
13+
| Term | Description |
14+
| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15+
| **Schematics** | A generator that executes descriptive code without side effects on an existing file system. |
16+
| **Collection** | A list of schematics metadata. Schematics can be referred by name inside a collection. |
17+
| **Tool** | The code using the Schematics library. |
18+
| **Tree** | A staging area for changes, containing the original file system, and a list of changes to apply to it. |
19+
| **Rule** | A function that applies actions to a `Tree`. It returns a new `Tree` that will contain all transformations to be applied. |
20+
| **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. |
21+
| **Action** | An atomic operation to be validated and committed to a filesystem or a `Tree`. Actions are created by schematics. |
22+
| **Sink** | The final destination of all `Action`s. |
23+
| **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. |
2324

2425
# Tooling
2526

0 commit comments

Comments
 (0)