Description
Rename the distdir configuration option to distDir in runable.config.ts to follow the camelCase convention used by Runable configuration options.
The existing distdir option should remain temporarily supported for backward compatibility, but must be marked as deprecated.
export default defineRunableConfig({
// Deprecated
distdir: '.output',
// Recommended
distDir: '.output',
})
Expected behavior
When distdir is used:
- Runable should continue to support it.
- A deprecation warning should be displayed.
distDir should be used internally as the canonical option.
- If both
distDir and distdir are provided, distDir should take precedence.
Example warning:
[runable] `distdir` is deprecated and will be removed in a future version. Use `distDir` instead.
TypeScript
Mark distdir as deprecated so IDEs can surface the migration directly:
interface RunableConfig {
distDir?: string
/**
* @deprecated Use `distDir` instead.
*/
distdir?: string
}
Migration
Before:
export default defineRunableConfig({
distdir: '.output',
})
After:
export default defineRunableConfig({
distDir: '.runable',
})
Acceptance criteria
Description
Rename the
distdirconfiguration option todistDirinrunable.config.tsto follow the camelCase convention used by Runable configuration options.The existing
distdiroption should remain temporarily supported for backward compatibility, but must be marked as deprecated.Expected behavior
When
distdiris used:distDirshould be used internally as the canonical option.distDiranddistdirare provided,distDirshould take precedence.Example warning:
TypeScript
Mark
distdiras deprecated so IDEs can surface the migration directly:Migration
Before:
After:
Acceptance criteria
distDirto the Runable configuration.distdirworking for backward compatibility.distdiras deprecated in TypeScript types.distdiris used.distDirprecedence when both options are provided.distdirwithdistDir.distDir.