forked from electron/electron
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: don't expose deprecate as an internal module (electron#35311)
- Loading branch information
Showing
11 changed files
with
149 additions
and
174 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| type DeprecationHandler = (message: string) => void; | ||
|
|
||
| let deprecationHandler: DeprecationHandler | null = null; | ||
|
|
||
| export function warnOnce (oldName: string, newName?: string) { | ||
| let warned = false; | ||
| const msg = newName | ||
| ? `'${oldName}' is deprecated and will be removed. Please use '${newName}' instead.` | ||
| : `'${oldName}' is deprecated and will be removed.`; | ||
| return () => { | ||
| if (!warned && !process.noDeprecation) { | ||
| warned = true; | ||
| log(msg); | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| export function setHandler (handler: DeprecationHandler | null): void { | ||
| deprecationHandler = handler; | ||
| } | ||
|
|
||
| export function getHandler (): DeprecationHandler | null { | ||
| return deprecationHandler; | ||
| } | ||
|
|
||
| export function warn (oldName: string, newName: string): void { | ||
| if (!process.noDeprecation) { | ||
| log(`'${oldName}' is deprecated. Use '${newName}' instead.`); | ||
| } | ||
| } | ||
|
|
||
| export function log (message: string): void { | ||
| if (typeof deprecationHandler === 'function') { | ||
| deprecationHandler(message); | ||
| } else if (process.throwDeprecation) { | ||
| throw new Error(message); | ||
| } else if (process.traceDeprecation) { | ||
| return console.trace(message); | ||
| } else { | ||
| return console.warn(`(electron) ${message}`); | ||
| } | ||
| } | ||
|
|
||
| // remove a function with no replacement | ||
| export function removeFunction<T extends Function> (fn: T, removedName: string): T { | ||
| if (!fn) { throw Error(`'${removedName} function' is invalid or does not exist.`); } | ||
|
|
||
| // wrap the deprecated function to warn user | ||
| const warn = warnOnce(`${fn.name} function`); | ||
| return function (this: any) { | ||
| warn(); | ||
| fn.apply(this, arguments); | ||
| } as unknown as typeof fn; | ||
| } | ||
|
|
||
| // change the name of a function | ||
| export function renameFunction<T extends Function> (fn: T, newName: string): T { | ||
| const warn = warnOnce(`${fn.name} function`, `${newName} function`); | ||
| return function (this: any) { | ||
| warn(); | ||
| return fn.apply(this, arguments); | ||
| } as unknown as typeof fn; | ||
| } | ||
|
|
||
| // change the name of an event | ||
| export function event (emitter: NodeJS.EventEmitter, oldName: string, newName: string) { | ||
| const warn = newName.startsWith('-') /* internal event */ | ||
| ? warnOnce(`${oldName} event`) | ||
| : warnOnce(`${oldName} event`, `${newName} event`); | ||
| return emitter.on(newName, function (this: NodeJS.EventEmitter, ...args) { | ||
| if (this.listenerCount(oldName) !== 0) { | ||
| warn(); | ||
| this.emit(oldName, ...args); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| // remove a property with no replacement | ||
| export function removeProperty<T, K extends (keyof T & string)>(object: T, removedName: K, onlyForValues?: any[]): T { | ||
| // if the property's already been removed, warn about it | ||
| const info = Object.getOwnPropertyDescriptor((object as any).__proto__, removedName) // eslint-disable-line | ||
| if (!info) { | ||
| log(`Unable to remove property '${removedName}' from an object that lacks it.`); | ||
| return object; | ||
| } | ||
| if (!info.get || !info.set) { | ||
| log(`Unable to remove property '${removedName}' from an object does not have a getter / setter`); | ||
| return object; | ||
| } | ||
|
|
||
| // wrap the deprecated property in an accessor to warn | ||
| const warn = warnOnce(removedName); | ||
| return Object.defineProperty(object, removedName, { | ||
| configurable: true, | ||
| get: () => { | ||
| warn(); | ||
| return info.get!.call(object); | ||
| }, | ||
| set: newVal => { | ||
| if (!onlyForValues || onlyForValues.includes(newVal)) { | ||
| warn(); | ||
| } | ||
| return info.set!.call(object, newVal); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| // change the name of a property | ||
| export function renameProperty<T, K extends (keyof T & string)>(object: T, oldName: string, newName: K): T { | ||
| const warn = warnOnce(oldName, newName); | ||
|
|
||
| // if the new property isn't there yet, | ||
| // inject it and warn about it | ||
| if ((oldName in object) && !(newName in object)) { | ||
| warn(); | ||
| object[newName] = (object as any)[oldName]; | ||
| } | ||
|
|
||
| // wrap the deprecated property in an accessor to warn | ||
| // and redirect to the new property | ||
| return Object.defineProperty(object, oldName, { | ||
| get: () => { | ||
| warn(); | ||
| return object[newName]; | ||
| }, | ||
| set: value => { | ||
| warn(); | ||
| object[newName] = value; | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| export function moveAPI<T extends Function> (fn: T, oldUsage: string, newUsage: string): T { | ||
| const warn = warnOnce(oldUsage, newUsage); | ||
| return function (this: any) { | ||
| warn(); | ||
| return fn.apply(this, arguments); | ||
| } as unknown as typeof fn; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.