Skip to content

Initial Support for Progress Bar To Track Node Progress #1297

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+35 −3
Open

Initial Support for Progress Bar To Track Node Progress #1297

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e77d22
Initial Support for Progress Bar
smell-of-curry Dec 17, 2024
a03df9c
Greatly Improve Progress Bar Look
smell-of-curry Dec 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
"multimatch": "5.0.0",
"opencollective-postinstall": "2.0.3",
"process": "0.11.10",
"progress": "^2.0.3",
"reflect-metadata": "0.1.13",
"source-map-support": "0.5.21",
"string-template": "1.0.0",
Expand All @@ -61,6 +62,7 @@
"@types/mocha": "10.0.1",
"@types/multimatch": "4.0.0",
"@types/node": "18.13.0",
"@types/progress": "^2.0.7",
"@types/rimraf": "3.0.2",
"@types/sinon": "10.0.13",
"@types/string-template": "1.0.2",
Expand Down
36 changes: 33 additions & 3 deletions src/node-transformers/NodeTransformersRunner.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ import { VisitorDirection } from '../enums/node-transformers/VisitorDirection';
import { NodeGuards } from '../node/NodeGuards';
import { NodeMetadata } from '../node/NodeMetadata';

import ProgressBar from 'progress';

@injectable()
export class NodeTransformersRunner implements INodeTransformersRunner {
/**
Expand Down Expand Up @@ -74,8 +76,9 @@ export class NodeTransformersRunner implements INodeTransformersRunner {
this.buildNormalizedNodeTransformers(nodeTransformerNames, nodeTransformationStage);
const nodeTransformerNamesGroups: NodeTransformer[][] =
this.nodeTransformerNamesGroupsBuilder.build(normalizedNodeTransformers);
const nodeTransformerEntries = nodeTransformerNamesGroups.entries();

for (const nodeTransformerNamesGroup of nodeTransformerNamesGroups) {
for (const [i, nodeTransformerNamesGroup] of nodeTransformerEntries) {
const enterVisitors: IVisitor[] = [];
const leaveVisitors: IVisitor[] = [];

Expand All @@ -100,10 +103,37 @@ export class NodeTransformersRunner implements INodeTransformersRunner {
continue;
}

let totalNodes = 0;
estraverse.traverse(astTree, {enter: () => totalNodes++});
const nodeBar = new ProgressBar(
`Node Progress ${i + 1}/${nodeTransformerNamesGroups.length} [:bar] :current/:total (:percent) :etas`,
{
total: totalNodes,
width: 40,
clear: true
}
);

estraverse.replace(astTree, {
enter: this.mergeVisitorsForDirection(enterVisitors, VisitorDirection.Enter),
leave: this.mergeVisitorsForDirection(leaveVisitors, VisitorDirection.Leave)
enter: (node, parentNode) => {
// Ensure that the progress bar is not at 100% after the last node
if (nodeBar.curr >= totalNodes) {
totalNodes++;
nodeBar.total = totalNodes;
nodeBar.complete = false;
nodeBar.update(nodeBar.curr / nodeBar.total);
} else {
nodeBar.tick();
}

return this.mergeVisitorsForDirection(enterVisitors, VisitorDirection.Enter)(node, parentNode);
},
leave: (node, parentNode) => this.mergeVisitorsForDirection(leaveVisitors, VisitorDirection.Leave)(node, parentNode)
});

// Ensure that the progress bar is at 100% after the last node
nodeBar.update(1);
nodeBar.terminate();
}

return astTree;
Expand Down
Loading