mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-01-26 10:59:53 +00:00
feat: deprecated API alert (#6090)
When an extension imports deprecated APIs, this log will appear: ```bash [ComfyUI Deprecated] Importing from <file path> is deprecated. <guidance information>. This will be removed in <version>. See: <url> ``` ┆Issue is synchronized with this [Notion page](https://www.notion.so/PR-6090-feat-deprecated-API-alert-28e6d73d365081898c5ddafcc025d6f8) by [Unito](https://www.unito.io)
This commit is contained in:
@@ -6,6 +6,34 @@ interface ShimResult {
|
||||
exports: string[]
|
||||
}
|
||||
|
||||
const SKIP_WARNING_FILES = new Set(['scripts/app', 'scripts/api'])
|
||||
|
||||
/** Files that will be removed in v1.34 */
|
||||
const DEPRECATED_FILES = [
|
||||
'scripts/ui',
|
||||
'extensions/core/maskEditorOld',
|
||||
'extensions/core/groupNode'
|
||||
] as const
|
||||
|
||||
function getWarningMessage(
|
||||
fileKey: string,
|
||||
shimFileName: string
|
||||
): string | null {
|
||||
if (SKIP_WARNING_FILES.has(fileKey)) {
|
||||
return null
|
||||
}
|
||||
|
||||
const isDeprecated = DEPRECATED_FILES.some((deprecatedPath) =>
|
||||
fileKey.startsWith(deprecatedPath)
|
||||
)
|
||||
|
||||
if (isDeprecated) {
|
||||
return `[ComfyUI Deprecated] Importing from "${shimFileName}" is deprecated and will be removed in v1.34.`
|
||||
}
|
||||
|
||||
return `[ComfyUI Notice] "${shimFileName}" is an internal module, not part of the public API. Future updates may break this import.`
|
||||
}
|
||||
|
||||
function isLegacyFile(id: string): boolean {
|
||||
return (
|
||||
id.endsWith('.ts') &&
|
||||
@@ -63,12 +91,22 @@ export function comfyAPIPlugin(isDev: boolean): Plugin {
|
||||
const relativePath = path.relative(path.join(projectRoot, 'src'), id)
|
||||
const shimFileName = relativePath.replace(/\.ts$/, '.js')
|
||||
|
||||
const shimComment = `// Shim for ${relativePath}\n`
|
||||
let shimContent = `// Shim for ${relativePath}\n`
|
||||
|
||||
const fileKey = relativePath.replace(/\.ts$/, '').replace(/\\/g, '/')
|
||||
const warningMessage = getWarningMessage(fileKey, shimFileName)
|
||||
|
||||
if (warningMessage) {
|
||||
// It will only display once because it is at the root of the file.
|
||||
shimContent += `console.warn('${warningMessage}');\n`
|
||||
}
|
||||
|
||||
shimContent += result.exports.join('')
|
||||
|
||||
this.emitFile({
|
||||
type: 'asset',
|
||||
fileName: shimFileName,
|
||||
source: shimComment + result.exports.join('')
|
||||
source: shimContent
|
||||
})
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user