Avoid using wildcard imports JS-C1003
Anti-pattern
Minor
12 days ago
—
a year old
Explicitly import the specific method needed
1import { defineRouter, importHandler, permissionedProcedure, publicProcedure } from '~api/lib/trpc'
2
3import * as schema from './schemas' 4
5const NAMESPACE = 'orgSocialMedia'
6Explicitly import the specific method needed
1import { defineRouter, importHandler, permissionedProcedure, publicProcedure } from '~api/lib/trpc'
2
3import * as schema from './schemas' 4
5const NAMESPACE = 'orgWebsite'
6Explicitly import the specific method needed
1import { defineRouter, importHandler, permissionedProcedure, publicProcedure } from '~api/lib/trpc'
2
3import * as schema from './schemas' 4
5const NAMESPACE = 'component'
6Explicitly import the specific method needed
15import { downloadFromDatastore, formatMessage } from '~db/prisma/common'
16import { createLogger, type JobDef, jobPostRunner } from '~db/prisma/jobPreRun'
17
18import * as jobList from './data-migrations' 19
20/**
21 * Job RunnerExplicitly import the specific method needed
13import { writeFileSync } from 'fs'
14import path from 'path'
15
16import * as job from './generators'17
18/**
19 * It takes a filename and some data, and writes it to a file in the `generated` directory
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);
}