Avoid using wildcard imports JS-C1003
Anti-pattern
Minor
2 months ago
—
7 months old
Explicitly import the specific method needed
1import * as vscode from "vscode"; 2import * as config from "./config";
3
4type BracketType = {Explicitly import the specific method needed
1import * as vscode from "vscode";
2import * as utils from "./utils";
3import * as doc from "./document_parser"; 4
5import { SelectedText } from "./selected_text";
6import { printConstructor } from "./print_constructor";Explicitly import the specific method needed
1import * as vscode from "vscode";
2import * as config from "./config"; 3
4type BracketType = {
5 opening: string;Explicitly import the specific method needed
1import * as vscode from "vscode";
2import * as utils from "./utils"; 3import * as doc from "./document_parser";
4
5import { SelectedText } from "./selected_text";Explicitly import the specific method needed
1import * as vscode from "vscode"; 2import * as utils from "./utils";
3import * as doc from "./document_parser";
4
Description
Wildcard imports are easier to write, but make it harder to pick out the specific functions or objects from a dependency that are used in a file.
import * from 'module';
// there is no clear way to tell if
// `someFunction` has been imported
// from 'module'.
someFunction();
Therefore, it is recommended to explicit imports wherever possible.
NOTE: Some libraries do not expose themselves as ESModules. In cases like these, it is recommended to use a skipcq comment to suppress this issue.
Bad Practice
import * as axios from 'axios'
import * as Sentry from '@sentry/node'
try {
const result = await axios.get();
// ...
} catch (err) {
Sentry.captureException(err);
}
Recommended
import axios from 'axios'
// skipcq: JS-C1003 - sentry does not expose itself as an ES Module.
import * as Sentry from '@sentry/node'
try {
const result = await axios.get();
// ...
} catch (err) {
Sentry.captureException(err);
}