Avoid using wildcard imports JS-C1003
Anti-pattern
Minor
a month ago
—
3 months old
Explicitly import the specific method needed
3
4import { getConfigProperty } from '../../helpers/functions.config.js'
5import { type ConfigBatchExport_RBCPreauthorized } from '../../types/configTypes.js'
6import type * as recordTypes from '../../types/recordTypes.js' 7import type { GetBatchExportReturn } from '../batchExport.js'
8
9import {Explicitly import the specific method needed
1import * as dateTimeFunctions from '@cityssm/expressjs-server-js/dateTimeFns.js' 2import { toModernJulianDate } from '@cityssm/modern-julian-date'
3
4import { getConfigProperty } from '../../helpers/functions.config.js'Explicitly import the specific method needed
7import camelCase from 'camelcase'
8
9import { licencesDB as databasePath } from '../data/databasePaths.js'
10import * as cacheFunctions from '../helpers/functions.cache.js' 11import { getConfigProperty, getCustomReport } from '../helpers/functions.config.js'
12
13export type ReportParameters = Record<string, string | number>Explicitly import the specific method needed
1/* eslint-disable @eslint-community/eslint-comments/disable-enable-pair */
2/* eslint-disable no-case-declarations */
3
4import * as dateTimeFunctions from '@cityssm/expressjs-server-js/dateTimeFns.js' 5import getCanadianBankName from '@cityssm/get-canadian-bank-name'
6import sqlite from 'better-sqlite3'
7import camelCase from 'camelcase'Explicitly import the specific method needed
3import sqlite from 'better-sqlite3';
4import camelCase from 'camelcase';
5import { licencesDB as databasePath } from '../data/databasePaths.js';
6import * as cacheFunctions from '../helpers/functions.cache.js'; 7import { getConfigProperty, getCustomReport } from '../helpers/functions.config.js';
8const licenceAliasSQL = camelCase(getConfigProperty('settings.licenceAlias'));
9const licenseeAliasSQL = camelCase(getConfigProperty('settings.licenseeAlias'));
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);
}