Skip to content

Added enableDebug FX #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 28, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Added enableDebug FX
  • Loading branch information
eelcoj committed Apr 20, 2025
commit 29cb94808a598875af14f41668e73266d2073f0a
44 changes: 44 additions & 0 deletions src/debuggable.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
export function debuggable(application, { with: features }) {
const register = application.register;

application.register = function(identifier, controller) {
if (!controller.debug) return register.call(application, identifier, controller);

const callbacks = {
initialize: [],
connect: [],
disconnect: []
};

features.forEach(feature => feature(identifier, callbacks));

const { initialize, connect, disconnect } = controller.prototype;
const methods = { initialize, connect, disconnect };

controller.prototype.initialize = function() {
console.group(`${identifier} controller`);

callbacks.initialize.forEach(hook => hook.call(this));

if (methods.initialize) methods.initialize.call(this);
};

controller.prototype.connect = function() {
callbacks.connect.forEach(hook => hook.call(this));

if (methods.connect) methods.connect.call(this);

console.groupEnd();
};

controller.prototype.disconnect = function() {
callbacks.disconnect.forEach(hook => hook.call(this));

if (methods.disconnect) methods.disconnect.call(this);
};

return register.call(application, identifier, controller);
};

return application;
}
14 changes: 14 additions & 0 deletions src/enableDebug.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import { debuggable } from "./debuggable";
import { initialize } from "./enableDebug/initialize";
import { values } from "./enableDebug/values";
import { targets } from "./enableDebug/targets";

export function enableDebug(application) {
const debugFeatures = [
initialize,
targets,
values
];

return debuggable(application, { with: debugFeatures });
}
22 changes: 22 additions & 0 deletions src/enableDebug/initialize.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
export function initialize(identifier, callbacks) {
const debugCallback = ({ for: lifecycle }) => ({
log(context) {
console.group(`#${lifecycle}`);

console.log("details:", {
application: context.application,
identifier,
controller: context,
element: context.element
});

console.groupEnd();
}
});

["initialize", "connect", "disconnect"].forEach(lifecycle => {
callbacks[lifecycle].push(function() {
debugCallback({ for: lifecycle }).log(this);
});
});
}
41 changes: 41 additions & 0 deletions src/enableDebug/targets.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
export function targets(identifier, callbacks) {
callbacks.connect.push(function() {
logTargets({ on: this.element, for: identifier });
});
}

function logTargets({ on: element, for: identifier }) {
const targets = allTargets(element, identifier);

if (Object.keys(targets).length === 0) return;

console.group("Targets");
console.table(formatted(targets))
console.groupEnd();
}

function allTargets(element, identifier) {
const targets = {};
const targetElements = element.querySelectorAll(`[data-${identifier}-target]`);

targetElements.forEach(targetElement => {
const targetNames = targetElement.getAttribute(`data-${identifier}-target`).split(" ");

targetNames.forEach(targetName => {
if (!targets[targetName]) targets[targetName] = [];

targets[targetName].push(targetElement);
});
});

return targets;
}

function formatted(targets) {
return Object.fromEntries(
Object.entries(targets).map(([name, elements]) => [
name,
{ count: elements.length, elements }
])
);
}
36 changes: 36 additions & 0 deletions src/enableDebug/values.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
export function values(identifier, callbacks) {
callbacks.connect.push(function() {
logValues({ on: this.element, for: identifier });
});
}

function logValues({ on: element, for: identifier }) {
const values = allValues(element, identifier);

if (Object.keys(values).length === 0) return;

console.group("Values");
console.table(values);
console.groupEnd();
}

function allValues(element, identifier) {
const prefix = `${identifier}-`;
const dataPrefix = "data-";
const valueSuffix = "-value";

return Object.fromEntries(
Array.from(element.attributes)
.filter(attribute =>
attribute.name.startsWith(dataPrefix) &&
attribute.name.startsWith(prefix, dataPrefix.length) &&
attribute.name.endsWith(valueSuffix)
)
.map(attribute => {
const attributeName = attribute.name.slice(dataPrefix.length);
const valueName = attributeName.slice(prefix.length, attributeName.length - valueSuffix.length);

return [valueName, attribute.value];
})
);
}
2 changes: 2 additions & 0 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@ export function registerActionOptions(application) {
application.registerActionOption(name, method);
});
}

export { enableDebug } from "./enableDebug";