import-path-alias
a relative import path in a package that configures aliases
Deterministic checkadvisory by defaultbasecode
The argument
Use the package's configured path alias for every import.
- When a package defines path aliases — in
package.json→importsor intsconfig.json→compilerOptions.paths— NEVER use relative paths (./,../) — not even for sibling files,common/subfolders, or a package entry's re-exports - Either declaration counts: a package that declares
importshas configured aliases just as surely as one that declarespaths - If a package defines no path aliases, use relative paths consistently — and consider adding aliases
- This applies to every file: components, constants, interfaces, types, utils, hooks, etc.
✅ GOOD: Path alias for everything
A package that declares imports in package.json — the specifier carries its extension:
import { ClassName } from '#src/path/to/ClassName.ts';
import { methodName } from '#src/common/utils/methodName.ts';
import { features } from '#src/features/home/components/HomeIssueDetails/common/constants/features.ts';
import { MockIssuePanel } from '#src/features/home/components/HomeIssueDetails/components/MockIssuePanel.tsx';
A package that declares paths in tsconfig.json:
import { ClassName } from '@/path/to/ClassName';
import { methodName } from '@/common/utils/methodName';
import { features } from '@/features/home/components/HomeIssueDetails/common/constants/features';
import { MockIssuePanel } from '@/features/home/components/HomeIssueDetails/components/MockIssuePanel';
❌ BAD: Relative paths in an alias-configured package
import { helper } from './helper';
import { util } from '../common/utils/util';
import { features } from './common/constants/features';
The proof
fail
import { formatRate } from '../common/utils/formatRate';
export const getChargeLabel = (): string => formatRate();
pass
import { formatRate } from '@/common/utils/formatRate';
export const getChargeLabel = (): string => formatRate();
Turn it down
Both lines go in your lightsout.config.json.
"standards-checks": { "import-path-alias": "advisory" }"standards-checks": { "import-path-alias": "off" }