microsoft / microsoft/TypeScript
request: add accompanying `importsNotUsedAsValues` option for declaration imports
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.4k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 117
Description
Suggestion
I'm looking for the ability to instruct the compiler to preserve imports as 'side-effecting' for declaration files. I'm framing this request in terms of the existing importsNotUsedAsValues option for sake of clarity but this is for declarations only.
I suspect it may require a new accompanying option to importsNotUsedAsValues called, .e.g., declarationImportsAsSideEffects
🔍 Search Terms
- declarations side effect
- importsNotUsedAsValues declarations
- import side effect declarations
✅ Viability Checklist
- This wouldn't be a breaking change in existing TypeScript/JavaScript code
- This wouldn't change the runtime behavior of existing JavaScript code
- This could be implemented without emitting different JS based on the types of the expressions
- This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
- This feature would agree with the rest of TypeScript's Design Goals.
⭐ Suggestion
Based on the existing importsNotUsedAsValues behaviour, imports are emitted to .js to varying degrees. This proposal would ensure that there are accompanying imports within emitted .d.ts files to the same degree. For imports that are value-only and preserved, a "side effecting" import './a-module' would be emitted; others would remain as is
📃 Motivating Example
// plugins/my-plugin.ts
declare global {
export interface AppPlugins {
myPlugin: {some: 'value'}
}
}
export default function() { ... }
// plugin-loader.ts
declare global {
export interface AppPlugins {
corePlugin: {some: 'otherValue' }
}
}
import myPlugin from './plugins/my-plugin'
// import './plugins/my-plugin'. <---- currently required
const plugins: Plugin[] = ...
export default plugins
Compiling yields (tested 4.3.2 with importsNotUsedAsValues='preserve')
// plugin-loader.d.ts
declare global {
export interface AppPlugins {
corePlugin: {some: 'otherValue' }
}
}
// import './plugins/my-plugin' // <---- would be emitted with proposed change
declare const plugins: Plugin[];
export default plugins;
Currently, if another module were to import plugin-loader:
// app.ts
import plugins from './plugin-loader'
type PluginNames = keyof AppPlugins // 'corePlugin'
Note that the augmentation type (global/module) doesn't matter, just that they're included
💻 Use Cases
-
What do you want to use this for?
Enable plugin architectures where augmentations can be reliably expected to have been reached -
What workarounds are you using in the meantime?
"Shadow" side-effect imports to ensure declarations includeimport
What shortcomings exist with current (workaround) approach?
- Redundant, confusing to new eyes etc. In my particular use case where such code will be authored by plugin creators, any decreased DX is particularly unappealing. Worth mentioning that any missed shadow import in the chain would lead to the augmentation going unnoticed so this workaround would snowball
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the existing importsNotUsedAsValues behavior and how declaration files are emitted. Trace how value-only imports are represented in generated .d.ts files. Done means a supported option preserves the required side-effect imports in declarations, with behavior covering the motivating plugin-augmentation example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100