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

Add filetree on left of diff view #21012

Merged
merged 29 commits into from
Sep 27, 2022
Merged
Show file tree
Hide file tree
Changes from 24 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
5ae314d
Add filelist on left of diff view
sebastian-sauer Aug 31, 2022
4f2ea0a
Hide file tree on small screens
sebastian-sauer Aug 31, 2022
1dd45c8
Use ellipsis class and overflow auto
sebastian-sauer Aug 31, 2022
6706cf8
Use vue and create a tree layout for diff files
sebastian-sauer Sep 1, 2022
fcd9d1a
Merge remote-tracking branch 'origin/main' into feature/18192_pr_tree…
sebastian-sauer Sep 2, 2022
ce0b4ec
Rework vue component and add toggle button
sebastian-sauer Sep 2, 2022
a6a0761
Only pass needed infos to vue template
sebastian-sauer Sep 2, 2022
6d53226
Fix styling and overflow
sebastian-sauer Sep 2, 2022
e1ff913
Hover styles and some padding improvements
sebastian-sauer Sep 2, 2022
2651860
Converted file list to vue component and fix show more button
sebastian-sauer Sep 4, 2022
4bdcb2d
Set initial css width of diff to 100%
sebastian-sauer Sep 4, 2022
de2f3c9
Merge remote-tracking branch 'origin/main' into feature/18192_pr_tree…
sebastian-sauer Sep 4, 2022
327fd74
Remove unused style from difffiletree
sebastian-sauer Sep 4, 2022
50ecb2f
Merge folders containing only folders
sebastian-sauer Sep 6, 2022
f5f2daa
Merge branch 'main' into feature/18192_pr_tree_view
sebastian-sauer Sep 6, 2022
5469b99
Merge remote-tracking branch 'origin/main' into feature/18192_pr_tree…
sebastian-sauer Sep 22, 2022
f0080ab
Add comments to js code
sebastian-sauer Sep 22, 2022
902a5bc
Merge remote-tracking branch 'fork/feature/18192_pr_tree_view' into f…
sebastian-sauer Sep 22, 2022
52475b6
Remove inline javascript and create click listener
sebastian-sauer Sep 22, 2022
834b592
isolate DiffFileList related code into its component
wxiaoguang Sep 26, 2022
b6748c1
use flex instead of #diff-file-tree[style*='display: block'] ~ #diff-…
wxiaoguang Sep 26, 2022
c013fcc
fine tune
wxiaoguang Sep 26, 2022
6763545
reformat
wxiaoguang Sep 26, 2022
e5ebc6d
fix lint
wxiaoguang Sep 26, 2022
a8891d2
make code more readable
wxiaoguang Sep 26, 2022
980a7d1
remove unnecessary style
wxiaoguang Sep 26, 2022
de678c8
Merge branch 'main' into feature/18192_pr_tree_view
wxiaoguang Sep 26, 2022
a14e42a
make code more readable
wxiaoguang Sep 26, 2022
19daf20
Merge branch 'main' into feature/18192_pr_tree_view
wxiaoguang Sep 27, 2022
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: 1 addition & 1 deletion templates/repo/commit_page.tmpl
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{{template "base/head" .}}
<div class="page-content repository diff">
{{template "repo/header" .}}
<div class="ui container {{if .IsSplitStyle}}fluid padded{{end}}">
<div class="ui container fluid padded">
{{$class := ""}}
{{if .Commit.Signature}}
{{$class = (printf "%s%s" $class " isSigned")}}
Expand Down
269 changes: 140 additions & 129 deletions templates/repo/diff/box.tmpl

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion templates/repo/diff/compare.tmpl
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{{template "base/head" .}}
<div class="page-content repository diff {{if .PageIsComparePull}}compare pull{{end}}">
{{template "repo/header" .}}
<div class="ui container {{if .IsSplitStyle}}fluid padded{{end}}">
<div class="ui container fluid padded">

<h2 class="ui header">
{{if and $.PageIsComparePull $.IsSigned (not .Repository.IsArchived)}}
Expand Down
2 changes: 1 addition & 1 deletion templates/repo/diff/options_dropdown.tmpl
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<div class="ui dropdown tiny basic button icon-button tooltip" data-content="{{.locale.Tr "repo.diff.options_button"}}">
{{svg "octicon-kebab-horizontal"}}
<div class="menu">
<a class="item tiny basic toggle button" data-target="#diff-files">{{.locale.Tr "repo.diff.show_diff_stats"}}</a>
<a class="item tiny basic toggle button" id="show-file-list-btn">{{.locale.Tr "repo.diff.show_diff_stats"}}</a>
{{if .Issue.Index}}
<a class="item" href="{{$.RepoLink}}/pulls/{{.Issue.Index}}.patch" download="{{.Issue.Index}}.patch">{{.locale.Tr "repo.diff.download_patch"}}</a>
<a class="item" href="{{$.RepoLink}}/pulls/{{.Issue.Index}}.diff" download="{{.Issue.Index}}.diff">{{.locale.Tr "repo.diff.download_diff"}}</a>
Expand Down
2 changes: 1 addition & 1 deletion templates/repo/pulls/files.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

<div class="page-content repository view issue pull files diff">
{{template "repo/header" .}}
<div class="ui container {{if .IsSplitStyle}}fluid padded{{end}}">
<div class="ui container fluid padded">
<div class="navbar">
{{template "repo/issue/navbar" .}}
<div class="ui right">
Expand Down
81 changes: 81 additions & 0 deletions web_src/js/components/DiffFileList.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
<template>
<ol class="diff-detail-box diff-stats m-0" id="diff-files" v-if="fileListIsVisible">
<li v-for="file in files" :key="file.NameHash">
<div class="bold df ac pull-right">
<span v-if="file.IsBin" class="ml-1 mr-3">{{ binaryFileMessage }}</span>
{{ file.IsBin ? '' : file.Addition + file.Deletion }}
<span v-if="!file.IsBin" class="diff-stats-bar tooltip mx-3" :data-content="statisticsMessage.replace('%d', (file.Addition + file.Deletion)).replace('%d', file.Addition).replace('%d', file.Deletion)">
<div class="diff-stats-add-bar" :style="{ 'width': diffStatsWidth(file.Addition, file.Deletion) }" />
</span>
</div>
<!-- todo finish all file status, now modify, add, delete and rename -->
<span :class="['status', diffTypeToString(file.Type), 'tooltip']" :data-content="diffTypeToString(file.Type)" data-position="right center">&nbsp;</span>
<a class="file mono" :href="'#diff-' + file.NameHash">{{ file.Name }}</a>
</li>
<li v-if="isIncomplete" id="diff-too-many-files-stats" class="pt-2">
<span class="file df ac sb">{{ tooManyFilesMessage }}
<a :class="['ui', 'basic', 'tiny', 'button', isLoadingNewData === true ? 'disabled' : '']" id="diff-show-more-files-stats" @click.stop="loadMoreData">{{ showMoreMessage }}</a>
</span>
</li>
</ol>
</template>

<script>
import {initTooltip} from '../modules/tippy.js';
import {doLoadMoreFiles} from '../features/repo-diff.js';

const {pageData} = window.config;

export default {
name: 'DiffFileList',

data: () => {
return pageData.diffFileInfo;
},

watch: {
fileListIsVisible(newValue) {
if (newValue === true) {
this.$nextTick(() => {
for (const el of this.$el.querySelectorAll('.tooltip')) {
initTooltip(el);
}
});
}
}
},

mounted() {
document.getElementById('show-file-list-btn').addEventListener('click', this.toggleFileList);
},

unmounted() {
document.getElementById('show-file-list-btn').removeEventListener('click', this.toggleFileList);
},

methods: {
toggleFileList() {
this.fileListIsVisible = !this.fileListIsVisible;
},
diffTypeToString(pType) {
const diffTypes = {
1: 'add',
2: 'modify',
3: 'del',
4: 'rename',
5: 'copy',
};
return diffTypes[pType];
},
diffStatsWidth(adds, dels) {
return `${adds / (adds + dels) * 100}%`;
},
loadMoreData() {
this.isLoadingNewData = true;
doLoadMoreFiles(this.link, this.diffEnd, () => {
this.isLoadingNewData = false;
});
}
},
};
</script>
129 changes: 129 additions & 0 deletions web_src/js/components/DiffFileTree.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
<template>
<div
v-show="fileTreeIsVisible"
id="diff-file-tree"
class="mr-3 mt-3 diff-detail-box"
>
<!-- only render the tree if we're visible. in many cases this is something that doesn't change very often -->
<div class="ui list" v-if="fileTreeIsVisible">
<DiffFileTreeItem v-for="item in fileTree" :key="item.name" :item="item" />
</div>
<div v-if="isIncomplete" id="diff-too-many-files-stats" class="pt-2">
<span>{{ tooManyFilesMessage }}</span><a :class="['ui', 'basic', 'tiny', 'button', isLoadingNewData === true ? 'disabled' : '']" id="diff-show-more-files-stats" @click.stop="loadMoreData">{{ showMoreMessage }}</a>
</div>
</div>
</template>

<script>
import DiffFileTreeItem from './DiffFileTreeItem.vue';
import {doLoadMoreFiles} from '../features/repo-diff.js';

const {pageData} = window.config;
const LOCAL_STORAGE_KEY = 'diff_file_tree_visible';

export default {
name: 'DiffFileTree',
components: {DiffFileTreeItem},

data: () => {
const fileTreeIsVisible = localStorage.getItem(LOCAL_STORAGE_KEY) === 'true';
pageData.diffFileInfo.fileTreeIsVisible = fileTreeIsVisible;
return pageData.diffFileInfo;
},

computed: {
fileTree() {
const result = [];
for (const file of this.files) {
// Split file into directories
const splits = file.Name.split('/');
let index = 0;
let parent = null;
let isFile = false;
for (const split of splits) {
index += 1;
// reached the end
if (index === splits.length) {
isFile = true;
}
let newParent = {
name: split,
children: [],
isFile
};

if (isFile === true) {
newParent.file = file;
}

if (parent) {
// check if the folder already exists
const existingFolder = parent.children.find(
(x) => x.name === split
);
if (existingFolder) {
newParent = existingFolder;
} else {
parent.children.push(newParent);
}
} else {
const existingFolder = result.find((x) => x.name === split);
if (existingFolder) {
newParent = existingFolder;
} else {
result.push(newParent);
}
}
parent = newParent;
}
}
const mergeChildIfOnlyOneDir = (entries) => {
for (const entry of entries) {
if (entry.children) {
mergeChildIfOnlyOneDir(entry.children);
}
if (entry.children.length === 1 && entry.children[0].isFile === false) {
// Merge it to the parent
entry.name = `${entry.name}/${entry.children[0].name}`;
entry.children = entry.children[0].children;
}
}
};
// Merge folders with just a folder as children in order to
// reduce the depth of our tree.
mergeChildIfOnlyOneDir(result);
return result;
}
},

mounted() {
// ensure correct buttons when we are mounted to the dom
this.adjustToggleButton(this.fileTreeIsVisible);
document.querySelector('.diff-toggle-file-tree-button').addEventListener('click', this.toggleVisibility);
},
unmounted() {
document.querySelector('.diff-toggle-file-tree-button').removeEventListener('click', this.toggleVisibility);
},
methods: {
toggleVisibility() {
this.updateVisibility(!this.fileTreeIsVisible);
},
updateVisibility(visible) {
this.fileTreeIsVisible = visible; // toggle the visibility
localStorage.setItem(LOCAL_STORAGE_KEY, this.fileTreeIsVisible);
this.adjustToggleButton(this.fileTreeIsVisible);
},
adjustToggleButton(visible) {
const icons = document.querySelectorAll('.diff-toggle-file-tree-button .icon'); // icons[0] is "ToShow", icons[1] is "ToHide"
icons[0 + visible].classList.remove('hide'); // 0+true=1 (show the "ToShow"), 0+false=0 (show the "ToHide")
icons[1 - visible].classList.add('hide'); // 1-true=0 (hide the "ToHide"), 1-false=1 (hide the "ToShow")
wxiaoguang marked this conversation as resolved.
Show resolved Hide resolved
},
loadMoreData() {
this.isLoadingNewData = true;
doLoadMoreFiles(this.link, this.diffEnd, () => {
this.isLoadingNewData = false;
});
}
},
};
</script>
150 changes: 150 additions & 0 deletions web_src/js/components/DiffFileTreeItem.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
<template>
<div v-show="show">
<div class="item" :class="item.isFile ? 'filewrapper p-1' : ''">
<!-- Files -->
<SvgIcon
v-if="item.isFile"
data-position="right center"
name="octicon-file"
class="svg-icon file"
/>
<a
v-if="item.isFile"
class="file ellipsis"
:href="item.isFile ? '#diff-' + item.file.NameHash : ''"
>{{ item.name }}</a>
<SvgIcon
v-if="item.isFile"
data-position="right center"
:name="getIconForDiffType(item.file.Type)"
:class="['svg-icon', getIconForDiffType(item.file.Type), 'status']"
/>

<!-- Directories -->
<div v-if="!item.isFile" class="directory p-1" @click.stop="handleClick(item.isFile)">
<SvgIcon
class="svg-icon"
:name="collapsed ? 'octicon-chevron-right' : 'octicon-chevron-down'"
/>
<SvgIcon
class="svg-icon directory"
name="octicon-file-directory-fill"
/>
<span class="ellipsis">{{ item.name }}</span>
</div>
<div v-show="!collapsed">
<DiffFileTreeItem v-for="childItem in item.children" :key="childItem.name" :item="childItem" class="list" />
</div>
</div>
</div>
</template>

<script>
import {SvgIcon} from '../svg.js';

export default {
name: 'DiffFileTreeItem',
components: {
SvgIcon,
},

props: {
item: {
type: Object,
required: true
},
show: {
type: Boolean,
required: false,
default: true
}
},

data: () => ({
collapsed: false,
}),
methods: {
handleClick(itemIsFile) {
if (itemIsFile) {
return;
}
this.$set(this, 'collapsed', !this.collapsed);
},
getIconForDiffType(pType) {
const diffTypes = {
1: 'octicon-diff-added',
2: 'octicon-diff-modified',
3: 'octicon-diff-removed',
4: 'octicon-diff-renamed',
5: 'octicon-diff-modified', // there is no octicon for copied, so modified should be ok
};
return diffTypes[pType];
},
},
};
</script>

<style scoped>
span.svg-icon.status {
float: right;
}
span.svg-icon.file {
color: var(--color-secondary-dark-7);
}

span.svg-icon.directory {
color: var(--color-primary);
}

span.svg-icon.octicon-diff-modified {
color: var(--color-yellow);
}

span.svg-icon.octicon-diff-added {
color: var(--color-green);
}

span.svg-icon.octicon-diff-removed {
color: var(--color-red);
}

span.svg-icon.octicon-diff-renamed {
color: var(--color-teal);
}

.item.filewrapper {
display: grid !important;
grid-template-columns: 20px 7fr 1fr;
padding-left: 18px !important;
}

.item.filewrapper:hover {
color: var(--color-text);
background: var(--color-hover);
border-radius: 4px;
}

div.directory {
display: grid;
grid-template-columns: 18px 20px auto;
}

div.directory:hover {
color: var(--color-text);
background: var(--color-hover);
border-radius: 4px;
}

div.list {
padding-bottom: 0 !important;
padding-top: inherit !important;
}

a {
text-decoration: none;
}

a:hover {
text-decoration: none;
}
</style>
Loading