Skip to content
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

Expand directory summary for delta mode #2708

Closed
2 tasks
Hall-Ma opened this issue Mar 9, 2022 · 5 comments · Fixed by #2890
Closed
2 tasks

Expand directory summary for delta mode #2708

Hall-Ma opened this issue Mar 9, 2022 · 5 comments · Fixed by #2890
Assignees
Labels
difficulty:low Solving this is likely not that difficult good first issue pr-visualization Issues that touch the visualization pr(oject) which means web and desktop features. priority:high Set by PO

Comments

@Hall-Ma
Copy link
Contributor

Hall-Ma commented Mar 9, 2022

Feature request

Description

As a user, I want to see the number of changed files in a selected folder next to added and removed files in delta mode so that I get a quick overview of the dimension of the changes of both maps.

Acceptance criteria

  • UI suggestion
    image

Development notes (optional Task Breakdown)

  • check every node, when a delta value is not equal to 0 then there is a changed file
  • add a new property to fileCount property in squarifiedNode
@Hall-Ma Hall-Ma added pr-visualization Issues that touch the visualization pr(oject) which means web and desktop features. difficulty:low Solving this is likely not that difficult good first issue labels Mar 9, 2022
@BridgeAR BridgeAR added the priority:high Set by PO label Mar 11, 2022
@knoffi
Copy link
Contributor

knoffi commented Jul 5, 2022

Question about the UI suggestion:
The blue number equals 4 because of ( 1 - (-1) ) ^ 2 = 4 ?

(Or in other words, the blue number equals the square of changed files?

@BridgeAR
Copy link
Member

BridgeAR commented Jul 5, 2022

@knoffi green represents all newly added files. Red represents removed files and blue represents existing changed files that were not removed.

@knoffi
Copy link
Contributor

knoffi commented Jul 5, 2022

@BridgeAR Thanks for the fast reply. So the black text "5 files" stands for the number of changed files, and thus
"blue = 5 - 1"?

@BridgeAR
Copy link
Member

BridgeAR commented Jul 5, 2022

No, there is no real correlation between the entries. Black represents the total number of files. Blue is the number of changed files (a subset of black).

@knoffi knoffi self-assigned this Jul 14, 2022
@knoffi
Copy link
Contributor

knoffi commented Jul 15, 2022

Finally, I fully understand my confusion:

In the description, it is stated: "... when a delta value is not equal to 0 then there is a changed file." This refers to the property in
interface squarifiedNode { ... deltas?: { [key: string]: number } ... }

I thought that the description was refering to the displayed values "∆1 | ∆-1 " , because "∆" is a big delta letter. Thus, I was assuming there was some correlation between them.

Additionally, when I read "squarified" I was assuming someone was calculating the square number of something. Sorry for the delay.

knoffi added a commit that referenced this issue Jul 15, 2022
[Less symmetry in expected result when counting added+deleted files]
knoffi added a commit that referenced this issue Jul 15, 2022
[check english grammar for plural/singular edge cases]
knoffi added a commit that referenced this issue Jul 15, 2022
[edge case of folder with 0 files is now displayed with correct grammar]
knoffi added a commit that referenced this issue Jul 15, 2022
[Text shows correctly that a file changed if and only a metric changed]
knoffi added a commit that referenced this issue Jul 21, 2022
knoffi added a commit that referenced this issue Jul 21, 2022
[ .metricsChanged to .changed ]
knoffi added a commit that referenced this issue Jul 22, 2022
[For-loop instead of lambda-functions for perfomance in delta generator]
knoffi added a commit that referenced this issue Jul 25, 2022
knoffi added a commit that referenced this issue Jul 25, 2022
[Using set instead of array to improve performance]
knoffi added a commit that referenced this issue Jul 26, 2022
[0 should equal undefined when comparing attributes]
knoffi added a commit that referenced this issue Jul 26, 2022
knoffi added a commit that referenced this issue Jul 26, 2022
[Snapshots use https and mocks have correct propery order]
knoffi added a commit that referenced this issue Jul 27, 2022
[Reduce duplicated lines marked by sonarqube]
knoffi added a commit that referenced this issue Jul 27, 2022
[Extract fileMeta proeprty to reduce code duplication]
knoffi added a commit that referenced this issue Jul 27, 2022
[Reduce code duplication for sonar qube]
@MW-Friedrich MW-Friedrich linked a pull request Jul 27, 2022 that will close this issue
knoffi added a commit that referenced this issue Jul 27, 2022
* Improve delta generator spec #2708
[Less symmetry in expected result when counting added+deleted files]

* Improve nodePath spec #2708
[check english grammar for plural/singular edge cases]

* Fix grammar in file count display #2708
[edge case of folder with 0 files is now displayed with correct grammar]

* Add mocked display of changed files #2708

* Fix information display about changed files #2708
[Text shows correctly that a file changed if and only a metric changed]

* Add file comparing in delta generator #2708

* Add metricsChanged by delta generator #2708

* Add display of changed files in html from store #2708

* Fix fileCount selector spec #2708

* Add collecting of metric changes from children #2708

* Refactor FileCount property #2708
[ .metricsChanged to .changed ]

* Fix snapshots for delta generator spec #2708

* Fix logic of delta generator #2708
[For-loop instead of lambda-functions for perfomance in delta generator]

* Document changelog #2708

* Refactor deltaGenerator internally #2708
[Using set instead of array to improve performance]

* Fix file-changed-logic in deltaGenerator #2708
[0 should equal undefined when comparing attributes]

* Change google link to https #2708

* Adjust test mocks and snapshots #2708
[Snapshots use https and mocks have correct propery order]

* Refactor test mock objects #2708
[Reduce duplicated lines marked by sonarqube]

* Refactor mock objects for unit tests #2708
[Extract fileMeta proeprty to reduce code duplication]

* Refactor test mock objects #2707
[Extracted default file and default fileMap]

* Refactor mock files in deltaGenerator spec #2708
[Reduce code duplication for sonar qube]

* Try out comment to disable sonar in line #2708

* fix SonarQube not excluding dataMocks.ts
#1532

Co-authored-by: MW-Friedrich <108457762+MW-Friedrich@users.noreply.github.com>
Co-authored-by: Jan N. Rückert <31436472+jannikr@users.noreply.github.com>
MW-Friedrich added a commit that referenced this issue Jul 28, 2022
Fix missing wildcard pattern in sonar.properties
#2708
MW-Friedrich added a commit that referenced this issue Jul 28, 2022
* Fix CHANGELOG.md entry for delta display
Fix missing wildcard pattern in sonar.properties
#2708

* Update CHANGELOG.md

Remove weird line break
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty:low Solving this is likely not that difficult good first issue pr-visualization Issues that touch the visualization pr(oject) which means web and desktop features. priority:high Set by PO
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants