Skip to content

Commit 60571c6

Browse files
author
Will Honey
committed
improved migration docs
1 parent c700877 commit 60571c6

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

docs/rules/order-imports.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -151,9 +151,11 @@ import Baz from 'Baz';
151151

152152
## Upgrading from v0.14 to v1
153153

154-
In v0.14, the `module` setting was split into `builtin`, `external`, `internal`.
154+
### `builtin` | `external` | `internal``module`
155155

156-
If you want to keep the same `builtin` functionality, create a custom regular expression group to replace it, like so. If you don't, the builtin modules will be grouped with the other `module`s.
156+
In v1, `builtin`, `external`, `internal` have all been combined into one group, `module`. This simplifies the logic for this rule and makes it so it ONLY looks at the import strings and doesn't attempt any module resolution itself. The same functionality can be accomplished using regular expression groups.
157+
158+
If you want to keep the same `builtin` functionality, create a custom regular expression group to replace it, like so.
157159

158160
```javascript
159161
// v0.14
@@ -165,4 +167,8 @@ groups: [
165167
];
166168
```
167169

168-
If you want to keep the same `internal`/`external` functionality, create a custom regular expression group with your modules.
170+
If you want to keep the same `internal`/`external` functionality, create a custom regular expression group with your modules names.
171+
172+
### `'newlines-between' → 'newlinesBetween'`
173+
174+
In v1, the `newLinesBetween` configuration option is now in camel case.

0 commit comments

Comments
 (0)