Avoid using wildcard imports JS-C1003
Anti-pattern
Minor
a year ago
—
2 years old
Explicitly import the specific method needed
6import { tmpdir, platform } from "node:os";
7import { join } from "node:path";
8
9import * as StreamZip from "node-stream-zip";10
11export async function downloadBinary() {
12 const url = await getDownloadUrl();Explicitly import the specific method needed
1// eslint-disable-next-line @typescript-eslint/ban-ts-comment
2/// @ts-nocheck
3import * as xss from "xss"; 4import svgTagWhiteList from "./svg";
5import kaTexWhiteList from "./KaTex";
6import { attrWhiteList, prefixAttrWhiteList, tags } from "./common";Explicitly import the specific method needed
12import * as abbr from "markdown-it-abbr";
13import * as attrs from "markdown-it-attrs";
14import * as emoji from "markdown-it-emoji";
15import * as container from "markdown-it-container"; 16import xss from "./xss";
17import Prismjs from "prismjs";
18Explicitly import the specific method needed
11import * as deflist from "markdown-it-deflist";
12import * as abbr from "markdown-it-abbr";
13import * as attrs from "markdown-it-attrs";
14import * as emoji from "markdown-it-emoji"; 15import * as container from "markdown-it-container";
16import xss from "./xss";
17import Prismjs from "prismjs";Explicitly import the specific method needed
10import * as footnote from "markdown-it-footnote";
11import * as deflist from "markdown-it-deflist";
12import * as abbr from "markdown-it-abbr";
13import * as attrs from "markdown-it-attrs"; 14import * as emoji from "markdown-it-emoji";
15import * as container from "markdown-it-container";
16import xss from "./xss";
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);
}