Skip to content

Commit 6f5ccc7

Browse files
committed
Update README
1 parent ab66f52 commit 6f5ccc7

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,11 @@ Then add this plugin in `tsconfig.json`.
7575

7676
### paths (required)
7777

78+
Value: `string[]`
79+
7880
Specify directory in relative path to the project's root (`tsconfig.json`'s dir). All `.ts` or `.js` files in the directories can be Namespace Imported with auto-completion.
7981

80-
example:
82+
Example:
8183

8284
```json
8385
"options": {
@@ -87,13 +89,32 @@ example:
8789

8890
### ignoreNamedExport
8991

92+
Value: `boolean`
93+
9094
If true, named export from files in `paths` won't be shown in auto-completion.
9195

92-
example:
96+
Example:
9397

9498
```json
9599
"options": {
96100
"paths": ["src/logics"],
97101
"ignoreNamedExport": true
98102
}
99103
```
104+
105+
### nameTransform
106+
107+
Value: `"upperCamelCase" | "lowerCamelCase"`
108+
109+
Transform import name. If not set, the filename will be used as an import name.
110+
111+
Example:
112+
113+
```json
114+
"options": {
115+
"paths": ["src/logics"],
116+
"nameTransform": "lowerCamelCase"
117+
}
118+
```
119+
120+
Then `SomeLogic.ts` will be imported like `import * as someLogic from "./SomeLogic"`.

0 commit comments

Comments
 (0)