Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
@discourse/babel-plugin-debug-macros
Advanced tools
Readme
This provides debug macros and feature flagging.
The plugin takes 4 types options: flags
, svelte
, debugTools
, and
externalizeHelpers
. The importSpecifier
is used as a hint to this plugin as
to where macros are being imported and completely configurable by the host.
Like Babel you can supply your own helpers using the externalizeHelpers
options.
{
plugins: [
['babel-debug-macros', {
// @optional
debugTools: {
isDebug: true,
source: 'debug-tools',
// @optional
assertPredicateIndex: 0
},
flags: [
{ source: '@ember/env-flags', flags: { DEBUG: true } },
{
name: 'ember-source',
source: '@ember/features',
flags: {
FEATURE_A: false,
FEATURE_B: true,
DEPRECATED_CONTROLLERS: "2.12.0"
}
}
],
// @optional
svelte: {
'ember-source': "2.15.0"
},
// @optional
externalizeHelpers: {
module: true,
// global: '__my_global_ns__'
}
}]
]
}
Flags and features are inlined into the consuming module so that something like UglifyJS will DCE them when they are unreachable.
import { DEBUG } from '@ember/env-flags';
import { FEATURE_A, FEATURE_B } from '@ember/features';
if (DEBUG) {
console.log('Hello from debug');
}
let woot;
if (FEATURE_A) {
woot = () => 'woot';
} else if (FEATURE_B) {
woot = () => 'toow';
}
woot();
Transforms to:
if (true /* DEBUG */) {
console.log('Hello from debug');
}
let woot;
if (false /* FEATURE_A */) {
woot = () => 'woot';
} else if (true) {
woot = () => 'toow';
}
woot();
warn
macro expansionimport { warn } from 'debug-tools';
warn('this is a warning');
Expands into:
(true && console.warn('this is a warning'));
assert
macro expansionThe assert
macro can expand in a more intelligent way with the correct
configuration. When babel-plugin-debug-macros
is provided with the
assertPredicateIndex
the predicate is injected in front of the assertion
in order to avoid costly assertion message generation when not needed.
import { assert } from 'debug-tools';
assert((() => {
return 1 === 1;
})(), 'You bad!');
With the debugTools: { assertPredicateIndex: 0 }
configuration the following expansion is done:
(true && !((() => { return 1 === 1;})()) && console.assert(false, 'this is a warning'));
When assertPredicateIndex
is not specified, the following expansion is done:
(true && console.assert((() => { return 1 === 1;})(), 'this is a warning'));
deprecate
macro expansionimport { deprecate } from 'debug-tools';
let foo = 2;
deprecate('This is deprecated.', foo % 2);
Expands into:
let foo = 2;
(true && !(foo % 2) && console.warn('This is deprecated.'));
When you externalize helpers you must provide runtime implementations for the above macros. An expansion will still occur, however we will emit references to those runtime helpers.
A global expansion looks like the following:
import { warn } from 'debug-tools';
warn('this is a warning');
Expands into:
(true && Ember.warn('this is a warning'));
While externalizing the helpers to a module looks like the following:
import { warn } from 'debug-tools';
warn('this is a warning');
Expands into:
(true && warn('this is a warning'));
Svelte allows for consumers to opt into stripping deprecated code from your dependecies. By adding a package name and minimum version that contains no deprecations, that code will be compiled away.
For example, consider you are on ember-source@2.10.0
and you have no
deprecations. All deprecated code in ember-source
that is <=2.10.0
will be
removed.
svelte: {
"ember-source": "2.10.0"
}
Now if you bump to ember-source@2.11.0
you may encounter new deprecations.
The workflow would then be to clear out all deprecations and then bump the
version in the svelte
options.
svelte: {
"ember-source": "2.11.0"
}
FAQs
Debug macros and feature flag stripping (Discourse-owned fork to maintain deprecate() calls in production)
The npm package @discourse/babel-plugin-debug-macros receives a total of 73 weekly downloads. As such, @discourse/babel-plugin-debug-macros popularity was classified as not popular.
We found that @discourse/babel-plugin-debug-macros demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.