search

tc39 / proposal-signals

A proposal to add signals to JavaScript.
MIT License
2.87k stars 54 forks source link

Consider removing/renaming ngDevMode const declaration from the polyfill #174

Open Maximaximum opened 1 month ago

Maximaximum commented 1 month ago

Currenty, the polyfill depends on the existence of the ngDevMode variable in several places to decide whether it should throw useful error messages. This is obviously a copy-paste artifact from the Angular signals codebase.

Looks like the variable should be renamed to something framework-agnostic, like signal-polyfill-debug, and its usage should be documented in the README. Otherwise, any mentions of ngDevMode could be removed altogether, and the debug messages could just always be printed.

I'd be willing to make a PR for that if needed.

NullVoxPopuli commented 1 month ago

Why not import.meta?.env?.DEBUG?

This is a rising standard, iirc

Maximaximum commented 1 month ago

Sounds reasonable. Created a PR for that: https://github.com/tc39/proposal-signals/pull/175

littledan commented 1 month ago

Is this declaration preventing anyone from debugging their code with signals? If not, I'd prefer to leave things as they are now, to facilitate later re-upstreaming into Angular. Maybe we can work out a better solution with them.

I'm not so sure about that query--sounds like it'll always be false in browsers!

Maximaximum commented 1 month ago

Is this declaration preventing anyone from debugging their code with signals? If not, I'd prefer to leave things as they are now, to facilitate later re-upstreaming into Angular. Maybe we can work out a better solution with them.

No, it's not preventing from debugging, it's just that:

  1. It's an undocumented prerequisite for being able to get meaningful error messages in 2 locations in the code of the polyfill
  2. The name of the variable is clearly Angular-specific. That variable is used throughout the Angular codebase for enabling additional runtime checks and errors. People using the polyfill outside of Angular might be confused by depending on this variable

At the end of the day, though, if you're planning to postpone any updates to the polyfill code or its documentation until some time later for whatever reason, it's totally fine.

NullVoxPopuli commented 1 month ago

Can we get angular to support import.meta.env.DEV?

littledan commented 1 month ago

Yeah let's discuss this with Angular upstream to see what we can do next.