Add according documentation

import-js · Jun 12, 2020 · 017c18e · 017c18e
1 parent c285962
commit 017c18e
Showing 1 changed file with 13 additions and 8 deletions.
diff --git a/docs/rules/order.md b/docs/rules/order.md
@@ -22,6 +22,8 @@ import bar from './bar';
 import baz from './bar/baz';
 // 6. "index" of the current directory
 import main from './';
+// 7. "object"-imports (only available in TypeScript)
+import log = console.log;
 ```
 
 Unassigned imports are ignored, as the order they are imported in may be important.
@@ -77,21 +79,24 @@ This rule supports the following options:
 
 ### `groups: [array]`:
 
-How groups are defined, and the order to respect. `groups` must be an array of `string` or [`string`]. The only allowed `string`s are: `"builtin"`, `"external"`, `"internal"`, `"unknown"`, `"parent"`, `"sibling"`, `"index"`. The enforced order is the same as the order of each element in a group. Omitted types are implicitly grouped together as the last element. Example:
+How groups are defined, and the order to respect. `groups` must be an array of `string` or [`string`]. The only allowed `string`s are:
+`"builtin"`, `"external"`, `"internal"`, `"unknown"`, `"parent"`, `"sibling"`, `"index"`, `"object"`.
+The enforced order is the same as the order of each element in a group. Omitted types are implicitly grouped together as the last element. Example:
 ```js
 [
   'builtin', // Built-in types are first
   ['sibling', 'parent'], // Then sibling and parent types. They can be mingled together
   'index', // Then the index file
+  'object',
   // Then the rest: internal and external type
 ]
 ```
-The default value is `["builtin", "external", "parent", "sibling", "index"]`.
+The default value is `["builtin", "external", "parent", "sibling", "index", "object"]`.
 
 You can set the options like this:
 
 ```js
-"import/order": ["error", {"groups": ["index", "sibling", "parent", "internal", "external", "builtin"]}]
+"import/order": ["error", {"groups": ["index", "sibling", "parent", "internal", "external", "builtin", "object"]}]
 ```
 
 ### `pathGroups: [array of objects]`:
@@ -100,11 +105,11 @@ To be able to group by paths mostly needed with aliases pathGroups can be define
 
 Properties of the objects
 
-| property       | required | type   | description   |
-|----------------|:--------:|--------|---------------|
-| pattern        |     x    | string | minimatch pattern for the paths to be in this group (will not be used for builtins or externals) |
-| patternOptions |          | object | options for minimatch, default: { nocomment: true } |
-| group          |     x    | string | one of the allowed groups, the pathGroup will be positioned relative to this group |
+| property       | required | type   | description                                                                                                                                              |
+| -------------- | :------: | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| pattern        |    x     | string | minimatch pattern for the paths to be in this group (will not be used for builtins or externals)                                                         |
+| patternOptions |          | object | options for minimatch, default: { nocomment: true }                                                                                                      |
+| group          |    x     | string | one of the allowed groups, the pathGroup will be positioned relative to this group                                                                       |
 | position       |          | string | defines where around the group the pathGroup will be positioned, can be 'after' or 'before', if not provided pathGroup will be positioned like the group |
 
 ```json