Skip to content

Commit d1ba10b

Browse files
committed
improve doc
1 parent 7587c1b commit d1ba10b

File tree

2 files changed

+39
-39
lines changed

2 files changed

+39
-39
lines changed

Chinese.md

-39
Original file line numberDiff line numberDiff line change
@@ -140,42 +140,3 @@ import abc from 'package-1/abc'
140140
//if import statement exceed maxLen, the statement will be split into multiple lines.
141141
"js-import.maxLen": 100
142142
```
143-
144-
# TODO
145-
Currently in beta, there are a lot of work to do;
146-
- [x] full suport in node_modules, only extract export form main file and support module.exports = require('./lib/React')
147-
- [x] full support import statement, such as 'feedline' in import statement
148-
- [x] option for insert position (ability to skip flow, Copyright, Lisence comment in top of file)
149-
- [ ] sort import statement by eslint rule, deal with comment
150-
- [x] support autocomplete
151-
- [x] support auto fix by eslint rule
152-
- [x] support option for max-line like eslint rule max-line, auto split statement to mutilines
153-
- [ ] support shortcut goto module under cursor, spec react conpoment
154-
- [x] support import "module-name"
155-
- [ ] autofix useless import statement or identifier by using eslint rule(no-unused-vars)
156-
- [x] support import scss, css, less, json, bmp, gif, jpe, jpeg, png file
157-
- [ ] support commonjs, considering require nodejs built-in modules
158-
- [ ] full support typescript, using typescript parse
159-
- [ ] full support flow, export type and import type
160-
- [ ] support action for remove unused import identifier using eslint or tslint
161-
162-
# Export RegExp
163-
```
164-
exports.default\\s*=\\s*(\\w+).default
165-
module.exports\\s*=\\s*(\\w+)
166-
exports\\[[\\'\\"]default[\\'\\"]\\]\\s*=\\s*(\\w+)
167-
export\\s+(default\\s+){0,1}(?:(?:const|let|var|function|function\\*|class)\\s+){0,1}([\\w]+)
168-
exports\\.([\\w]+)\\s*=
169-
exports\\[\\"([\\w]+)\\"\\]\\s*=
170-
Object.defineProperty\\(\\s*exports\\s*,\\s*[\\'|\\"]([\\w]+)[\\'|\\"]
171-
export\\s+(?:default\\s+){0,1}(\\{[^\\}]+\\})
172-
```
173-
174-
## Contributing
175-
176-
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/wangtao0101/vscode-js-import/issues).
177-
178-
# Thanks
179-
some code from [import-js](https://github.com/Galooshi/import-js)
180-
181-
# [CHANGELOG](https://github.com/wangtao0101/vscode-js-import/blob/master/CHANGELOG.md)

README.md

+39
Original file line numberDiff line numberDiff line change
@@ -148,3 +148,42 @@ We will watch the change of package.json, and auto add and remove module.
148148
//if import statement exceed maxLen, the statement will be split into multiple lines.
149149
"js-import.maxLen": 100
150150
```
151+
152+
# TODO
153+
Currently in beta, there are a lot of work to do;
154+
- [x] full suport in node_modules, only extract export form main file and support module.exports = require('./lib/React')
155+
- [x] full support import statement, such as 'feedline' in import statement
156+
- [x] option for insert position (ability to skip flow, Copyright, Lisence comment in top of file)
157+
- [ ] sort import statement by eslint rule, deal with comment
158+
- [x] support autocomplete
159+
- [x] support auto fix by eslint rule
160+
- [x] support option for max-line like eslint rule max-line, auto split statement to mutilines
161+
- [ ] support shortcut goto module under cursor, spec react conpoment
162+
- [x] support import "module-name"
163+
- [ ] autofix useless import statement or identifier by using eslint rule(no-unused-vars)
164+
- [x] support import scss, css, less, json, bmp, gif, jpe, jpeg, png file
165+
- [ ] support commonjs, considering require nodejs built-in modules
166+
- [ ] full support typescript, using typescript parse
167+
- [ ] full support flow, export type and import type
168+
- [ ] support action for remove unused import identifier using eslint or tslint
169+
170+
# Export RegExp
171+
```
172+
exports.default\\s*=\\s*(\\w+).default
173+
module.exports\\s*=\\s*(\\w+)
174+
exports\\[[\\'\\"]default[\\'\\"]\\]\\s*=\\s*(\\w+)
175+
export\\s+(default\\s+){0,1}(?:(?:const|let|var|function|function\\*|class)\\s+){0,1}([\\w]+)
176+
exports\\.([\\w]+)\\s*=
177+
exports\\[\\"([\\w]+)\\"\\]\\s*=
178+
Object.defineProperty\\(\\s*exports\\s*,\\s*[\\'|\\"]([\\w]+)[\\'|\\"]
179+
export\\s+(?:default\\s+){0,1}(\\{[^\\}]+\\})
180+
```
181+
182+
## Contributing
183+
184+
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/wangtao0101/vscode-js-import/issues).
185+
186+
# Thanks
187+
some code from [import-js](https://github.com/Galooshi/import-js)
188+
189+
# [CHANGELOG](https://github.com/wangtao0101/vscode-js-import/blob/master/CHANGELOG.md)

0 commit comments

Comments
 (0)