Skip to content

Commit 5927b41

Browse files
authored
README: Add disclaimer and "Known Caveats" section
1 parent 8995f89 commit 5927b41

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ tagless-ember-components-codemod
33

44
Converts regular Ember.js components to `tagName: ''` components
55

6+
**This codemod is experimental and might break your app. Make sure to
7+
review the changes that it creates!**
8+
69

710
Usage
811
------------------------------------------------------------------------------
@@ -47,6 +50,15 @@ export default Component.extend({
4750
```
4851

4952

53+
Known Caveats
54+
------------------------------------------------------------------------------
55+
56+
- Due to the way `jscodeshift` works it sometimes removes empty lines between
57+
component properties, or adds new ones unexpectedly
58+
59+
- [Open Issues](https://github.com/ember-codemods/tagless-ember-components-codemod/issues)
60+
61+
5062
License
5163
------------------------------------------------------------------------------
5264

0 commit comments

Comments
 (0)