snapshot of https://github.com/tldraw/tldraw.git (main, 2026-09-23; blobs > 131072B omitted)
Some checks failed
Deploy analytics worker / Deploy analytics worker to ${{ (github.ref == 'refs/heads/production' && 'production') || (github.ref == 'refs/heads/main' && 'staging') || 'preview' }} (push) Failing after 1s
i18n upload strings / Upload latest strings (push) Failing after 1s
Deploy bemo / Deploy bemo to ${{ (github.ref == 'refs/heads/bemo-production' && 'production') || (github.ref == 'refs/heads/main' && 'staging') || 'preview' }} (push) Failing after 1s
Deploy grafana resources / ${{ github.event_name == 'push' && 'Deploy grafana resources' || 'Validate grafana resources (dry run)' }} (push) Failing after 0s
End to end tests (dotcom) / Check for relevant changes (push) Failing after 0s
End to end tests (examples) / Check for relevant changes (push) Failing after 0s
End to end tests (mermaid readability) / Check for relevant changes (push) Failing after 1s
End to end tests (perf) / Check for relevant changes (push) Failing after 0s
Publish editor extensions / Publish editor extensions (push) Failing after 1s
Publish SDK packages / Remove the publish-packages label (push) Has been skipped
Checks / Tests & checks (push) Has been cancelled
Checks / Build all projects (push) Has been cancelled
Deploy templates / Deploy templates (push) Has been cancelled
End to end tests (dotcom) / End to end tests (dotcom) (push) Has been cancelled
End to end tests (mermaid readability) / End to end tests (mermaid readability) (push) Has been cancelled
End to end tests (perf) / End to end tests (perf) (push) Has been cancelled
Deploy .com / Deploy dotcom to ${{ (github.ref == 'refs/heads/production' && 'production') || (github.ref == 'refs/heads/main' && 'staging') || 'preview' }} (push) Has been cancelled
End to end tests (examples) / End to end tests (examples) (push) Has been cancelled
Publish SDK packages / Publish SDK packages (push) Has been cancelled
Publish SDK packages / Tell user released version (push) Has been cancelled
Publish SDK packages / Publishes code templates to separate repositories (push) Has been cancelled
Publish SDK packages / Deploys the template demos with the new SDK version (push) Has been cancelled
Some checks failed
Deploy analytics worker / Deploy analytics worker to ${{ (github.ref == 'refs/heads/production' && 'production') || (github.ref == 'refs/heads/main' && 'staging') || 'preview' }} (push) Failing after 1s
i18n upload strings / Upload latest strings (push) Failing after 1s
Deploy bemo / Deploy bemo to ${{ (github.ref == 'refs/heads/bemo-production' && 'production') || (github.ref == 'refs/heads/main' && 'staging') || 'preview' }} (push) Failing after 1s
Deploy grafana resources / ${{ github.event_name == 'push' && 'Deploy grafana resources' || 'Validate grafana resources (dry run)' }} (push) Failing after 0s
End to end tests (dotcom) / Check for relevant changes (push) Failing after 0s
End to end tests (examples) / Check for relevant changes (push) Failing after 0s
End to end tests (mermaid readability) / Check for relevant changes (push) Failing after 1s
End to end tests (perf) / Check for relevant changes (push) Failing after 0s
Publish editor extensions / Publish editor extensions (push) Failing after 1s
Publish SDK packages / Remove the publish-packages label (push) Has been skipped
Checks / Tests & checks (push) Has been cancelled
Checks / Build all projects (push) Has been cancelled
Deploy templates / Deploy templates (push) Has been cancelled
End to end tests (dotcom) / End to end tests (dotcom) (push) Has been cancelled
End to end tests (mermaid readability) / End to end tests (mermaid readability) (push) Has been cancelled
End to end tests (perf) / End to end tests (perf) (push) Has been cancelled
Deploy .com / Deploy dotcom to ${{ (github.ref == 'refs/heads/production' && 'production') || (github.ref == 'refs/heads/main' && 'staging') || 'preview' }} (push) Has been cancelled
End to end tests (examples) / End to end tests (examples) (push) Has been cancelled
Publish SDK packages / Publish SDK packages (push) Has been cancelled
Publish SDK packages / Tell user released version (push) Has been cancelled
Publish SDK packages / Publishes code templates to separate repositories (push) Has been cancelled
Publish SDK packages / Deploys the template demos with the new SDK version (push) Has been cancelled
This commit is contained in:
59
packages/utils/src/lib/warn.ts
Normal file
59
packages/utils/src/lib/warn.ts
Normal file
@@ -0,0 +1,59 @@
|
||||
const usedWarnings = new Set<string>()
|
||||
|
||||
/**
|
||||
* Issues a deprecation warning for deprecated getter properties, advising users to use
|
||||
* the equivalent getter method instead. The warning is shown only once per property name.
|
||||
*
|
||||
* @param name - The name of the deprecated property (e.g., 'viewport')
|
||||
*
|
||||
* @example
|
||||
* ```ts
|
||||
* // Inside a class with deprecated property access
|
||||
* get viewport() {
|
||||
* warnDeprecatedGetter('viewport')
|
||||
* return this.getViewport()
|
||||
* }
|
||||
*
|
||||
* // Usage will show: "[tldraw] Using 'viewport' is deprecated and will be removed..."
|
||||
* // But only the first time it's accessed
|
||||
* ```
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
export function warnDeprecatedGetter(name: string) {
|
||||
warnOnce(
|
||||
`Using '${name}' is deprecated and will be removed in the near future. Please refactor to use 'get${name[0].toLocaleUpperCase()}${name.slice(
|
||||
1
|
||||
)}' instead.`
|
||||
)
|
||||
}
|
||||
|
||||
/**
|
||||
* Issues a warning message to the console, but only once per unique message.
|
||||
* Subsequent calls with the same message are ignored, preventing console spam.
|
||||
* All messages are prefixed with "[tldraw]".
|
||||
*
|
||||
* @param message - The warning message to display
|
||||
*
|
||||
* @example
|
||||
* ```ts
|
||||
* // Warn about deprecated usage
|
||||
* function oldFunction() {
|
||||
* warnOnce('oldFunction is deprecated, use newFunction instead')
|
||||
* // Continue with implementation...
|
||||
* }
|
||||
*
|
||||
* // First call logs: "[tldraw] oldFunction is deprecated, use newFunction instead"
|
||||
* oldFunction() // Shows warning
|
||||
* oldFunction() // No warning (already shown)
|
||||
* oldFunction() // No warning (already shown)
|
||||
* ```
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
export function warnOnce(message: string) {
|
||||
if (usedWarnings.has(message)) return
|
||||
|
||||
usedWarnings.add(message)
|
||||
console.warn(`[tldraw] ${message}`)
|
||||
}
|
||||
Reference in New Issue
Block a user