Emit deprecation warnings for legacy JS API #331
Conversation
lib/src/deprecations.ts
Outdated
| /** | ||
| * Shorthand for the subset of options related to deprecations. | ||
| */ | ||
| export type DeprecationOptions = { |
There was a problem hiding this comment.
Consider using Pick<> to derive this from the options type.
lib/src/deprecations.ts
Outdated
|
|
||
| /** | ||
| * Handles a host-side deprecation warning, either emitting a warning, throwing | ||
| * and error, or doing nothing depending on the deprecation options used. |
There was a problem hiding this comment.
| * and error, or doing nothing depending on the deprecation options used. | |
| * an error, or doing nothing depending on the deprecation options used. |
lib/src/deprecations.ts
Outdated
| * This is used to determine which options to use when handling host-side | ||
| * deprecation warnings that aren't explicitly tied to a particular compilation. | ||
| */ | ||
| export const activeDeprecationOptions: Map<Object, DeprecationOptions> = |
There was a problem hiding this comment.
If you're using Symbols as the key here, you could actually just use a Record<Symbol, DeprecationOptions>. Either way, the key type should be Symbol.
There was a problem hiding this comment.
Changed the key type to Symbol, but keeping this as a Map because it's better for adding/removing and checking the size
lib/src/deprecations.ts
Outdated
| */ | ||
| export function warnForHostSideDeprecation( | ||
| message: string, | ||
| deprecation: Deprecation, | ||
| options?: DeprecationOptions | ||
| ): void { | ||
| if (options) throw Error(message); |
There was a problem hiding this comment.
I don't understand this line. Is it left over from debugging?
There was a problem hiding this comment.
Yes, though I'd removed it before requesting review, so I think this was just GitHub's review interface being bad
lib/src/deprecations.ts
Outdated
| } | ||
| return false; | ||
| } | ||
| return getDeprecationIds(options?.silenceDeprecations ?? []).includes( |
There was a problem hiding this comment.
| return getDeprecationIds(options?.silenceDeprecations ?? []).includes( | |
| return getDeprecationIds(options.silenceDeprecations ?? []).includes( |
There's no way for options to be undefined here. Also below.
See sass/sass#3932
See sass/sass-spec#2016
See sass/dart-sass#2343