Skip to content

Commit 647c50f

Browse files
Revise migrate-config-components Readme
1 parent f9251be commit 647c50f

File tree

1 file changed

+12
-25
lines changed
  • packages/devextreme-schematics/src/migrate-config-components

1 file changed

+12
-25
lines changed
Lines changed: 12 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# migrate-config-components
22

3-
A schematic that migrates deprecated DevExtreme configuration components.
3+
A schematic that migrates old DevExtreme configuration components.
44

55
## Description
66

7-
This schematic automatically migrates deprecated DevExtreme Angular configuration components. The migration command is available as a top-level DevExtreme CLI command that you can run from any directory.
7+
This schematic automatically migrates old DevExtreme Angular configuration components. The migration command is available as a top-level DevExtreme CLI command that you can run from any directory.
88

99
## Usage
1010

1111
### Via DevExtreme CLI (Recommended)
1212

13-
The migration command can be run from any directory and will work both inside and outside Angular workspaces:
13+
You can run the migration command from any directory, including both inside and outside Angular workspaces:
1414

1515
```bash
1616
devextreme migrate angular-config-components
@@ -19,8 +19,8 @@ devextreme migrate angular-config-components
1919
### Options (All Optional)
2020

2121
- `--include`: Glob patterns of template files to include (default: `**/*.html`). Separate multiple patterns with commas.
22-
- `--script-include`: Glob patterns for TypeScript/JavaScript files to scan for inline `@Component({ template })` (default: `**/*.ts,**/*.js`). Set to empty to disable.
23-
- `--dry`: Run in dry mode to preview changes without applying them (default: `false`)
22+
- `--script-include`: Glob patterns for TypeScript/JavaScript files to scan for inline templates (default: `**/*.ts,**/*.js`). Set empty ('' or []) to disable.
23+
- `--dry`: Run in dry mode to preview changes without applying them (default: `false`).
2424

2525
### Examples
2626

@@ -43,45 +43,32 @@ devextreme migrate angular-config-components --include="*.html,*.ts" --dry
4343

4444
### Via Angular CLI
4545

46-
Alternatively, you can run the schematic directly with Angular CLI:
46+
You can also use the Angular CLI to run the schematic:
4747

4848
```bash
4949
ng g devextreme-schematics:migrate-config-components
5050
```
5151

52-
## What it does
52+
## Sample results
5353

54-
This schematic automatically updates your templates to replace deprecated nested components with the new config-based component structure. For example:
55-
56-
**Before (deprecated nested):**
54+
**Old configuration components:**
5755
```html
5856
<dx-data-grid>
5957
<dxi-column field="name"></dxi-column>
6058
<dxi-column field="age"></dxi-column>
6159
</dx-data-grid>
6260
```
6361

64-
**After (config-based):**
62+
**New configuration components:**
6563
```html
6664
<dx-data-grid>
6765
<dxi-data-grid-column field="name"></dxi-data-grid-column>
6866
<dxi-data-grid-column field="age"></dxi-data-grid-column>
6967
</dx-data-grid>
7068
```
7169

72-
### Why migrate?
73-
74-
DevExtreme Angular components are moving from a nested structure (e.g., `<dxi-column>`) to a config-based structure (e.g., `<dxi-data-grid-column>`) for improved clarity, maintainability, and future compatibility. This schematic automates the migration process to help you keep your codebase up to date with the latest DevExtreme standards.
75-
7670
## Requirements
7771

78-
- Node.js and npm/yarn installed
79-
- Angular application with DevExtreme components (when running inside a workspace)
80-
- DevExtreme Angular version that supports the new component structure
81-
82-
## Notes
83-
84-
- The command can be run from any directory, not just Angular workspaces
85-
- When run outside an Angular workspace, the underlying Angular CLI will show appropriate error messages
86-
- All options are optional and have sensible defaults
87-
- The command uses the latest version of `devextreme-schematics` automatically
72+
- Node.js and npm or yarn
73+
- Angular application with DevExtreme components
74+
- DevExtreme Angular version that supports new configuration components structure

0 commit comments

Comments
 (0)