Skip to content

Update Language Merging to Support Projects with Multiple Additional Repositories #6255

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

Merged
t-will-gillis merged 1 commit into from
Feb 15, 2024
Merged

Update Language Merging to Support Projects with Multiple Additional Repositories #6255

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 _layouts/project.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ <h2 id='contributor-header' class='project-page-card-title title6'>All-Time Cont
src="/assets/js/project.js"
type="module"
projectId="{{ page.identification }}"
additionalRepoIdNums="{{ page.additional-repo-ids }}"
additionalRepoIdNums="{{ page.additional-repo-ids | join: ',' }}"
imageHero="{{ page.image-hero }}"
projectTitle="{{ page.title }}">
</script>
3 changes: 2 additions & 1 deletion _projects/civic-tech-index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
# 'identification' is the 9 digit ID for your repo in the GitHub API.
identification: '241519642'
additional-repo-ids: '275296439'
additional-repo-ids:
- 275296439
title: Civic Tech Index
description: Our goal of the project is to create a comprehensive, searchable index of all civic tech open source software projects around the world. We have created the framework and an interest list. We are currently working on building out the website and other marketing tools that demonstrate the power of the index.
image: /assets/images/projects/civic-tech-index.png
Expand Down
133 changes: 77 additions & 56 deletions assets/js/current-projects.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,81 +90,102 @@ document.addEventListener("DOMContentLoaded",function(){
* Retrieves project data from jekyll _projects collection using liquid and transforms it into a javascript object
* The function returns a javascript array of objects representing all the projects under the _projects directory
*/
function retrieveProjectDataFromCollection(){
function retrieveProjectDataFromCollection() {
// { "project": {"id":"/projects/311-data","relative_path":"_projects/311-data.md","excerpt"
{% assign projects = site.data.external.github-data %}
{% assign visible_projects = site.projects | where: "visible", "true" %}
let projects = JSON.parse(decodeURIComponent("{{ projects | jsonify | uri_escape }}"));
// const scriptTag = document.getElementById("projectScript");
// const projectId = scriptTag.getAttribute("projectId");
// Search for correct project
let projectLanguagesArr = [];
projects.forEach(project=> {
if(project.languages){
let projectLanguagesArray = [];
projects.forEach(project => {
if (project.languages) {
const projectLanguages = {
id: project.id,
languages: project.languages
};
projectLanguagesArr.push(projectLanguages);
projectLanguagesArray.push(projectLanguages);
}
})
});

let projectData = [{%- for project in visible_projects -%}
// Construct project data objects for visible projects,
// including dynamic properties like additional repositories.
let projectData = [
{%- for project in visible_projects -%}
{
"project": {
'id': "{{project.id | default: 0}}",
'identification': {{project.identification | default: 0}},
'additionalRepoIds': {{project.additional-repo-ids | default: 0}},
"status": "{{ project.status }}"
{%- if project.image -%},
"image": '{{ project.image }}'
{%- endif -%}
{%- if project.alt -%},
"alt": `{{ project.alt }}`
{%- endif -%}
{%- if project.title -%},
"title": `{{ project.title }}`
{%- endif -%}
{%- if project.description -%},
"description": `{{ project.description }}`
{%- endif -%}
{%- if project.partner -%},
"partner": `{{ project.partner }}`
{%- endif -%}
{%- if project.tools -%},
"tools": {{ project.tools | jsonify }}
{%- endif -%}
{%- if project.looking -%},
"looking": {{ project.looking | jsonify }}
{%- endif -%}
{%- if project.links -%},
"links": {{ project.links | jsonify }}
{%- endif -%}
{%- if project.technologies -%},
"technologies": {{ project.technologies | jsonify }}
{%- endif -%}
{%- if project.program-area -%},
"programAreas": {{ project.program-area | jsonify }}
{%- endif -%}
{%- if project.languages -%},
"languages": {{ project.languages }}
{%- endif -%}
}
}{%- unless forloop.last -%}, {% endunless %}
{%- endfor -%}]
projectData.forEach((data,i) => {
"id": `{{project.id | default: 0}}`,
"identification": {{ project.identification | default: 0 }},
{%- if project.additional-repo-ids -%}
"additionalRepoIds": [{{ project.additional-repo-ids | join: ',' }}],
{% endif %}
"status": `{{ project.status }}`,
{%- if project.image -%}
"image": `{{ project.image }}`,
{%- endif -%}
{%- if project.alt -%}
"alt": `{{ project.alt }}`,
{%- endif -%}
{%- if project.title -%}
"title": `{{ project.title }}`,
{%- endif -%}
{%- if project.description -%}
"description": `{{ project.description }}`,
{%- endif -%}
{%- if project.partner -%}
"partner": `{{ project.partner }}`,
{%- endif -%}
{%- if project.tools -%}
"tools": {{ project.tools | jsonify }},
{%- endif -%}
{%- if project.looking -%}
"looking": {{ project.looking | jsonify }},
{%- endif -%}
{%- if project.links -%}
"links": {{ project.links | jsonify }},
{%- endif -%}
{%- if project.technologies -%}
"technologies": {{ project.technologies | jsonify }},
{%- endif -%}
{%- if project.program-area -%}
"programAreas": {{ project.program-area | jsonify }},
{%- endif -%}
{%- if project.languages -%}
"languages": {{ project.languages }}
{%- endif -%}
}
}
{%- unless forloop.last -%},{% endunless %}
{%- endfor -%}
];

projectData.forEach((data, i) => {
const { project } = data;
const matchingProject = projectLanguagesArr.find(x=> x.id === project.identification);
if(matchingProject) {
const matchingProject = projectLanguagesArray.find(repo => repo.id === project.identification);

if (matchingProject) {
project.languages = matchingProject.languages;
if(project.additionalRepoIds != 0){
const additionalMatchingProject = projectLanguagesArr.find(x=> x.id === project.additionalRepoIds);
const langArr = [...matchingProject.languages, ...additionalMatchingProject.languages];
let set = new Set(langArr);
project.languages = Array.from(set);

// Merge languages from additional GitHub repositories to ensure
// a comprehensive list of languages used on a single project.
if (project.additionalRepoIds) {
const additionalRepoIdNums = project.additionalRepoIds;
let languagesArray = [...project.languages];

additionalRepoIdNums.forEach(repoId => {
const additionalRepo = projectLanguagesArray.find(repo => repo.id === repoId);
if (additionalRepo && additionalRepo.languages) {
languagesArray = [...languagesArray, ...additionalRepo.languages];
}
});

let uniqueLanguages = new Set(languagesArray);
project.languages = Array.from(uniqueLanguages);
}
}
})
});

return projectData;
}

Expand Down
24 changes: 15 additions & 9 deletions assets/js/project.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,22 @@ function findProjectById(identification){
}
}

// Merge the language sections if there's a second repo
if (scriptTag.getAttribute("additionalRepoIdNums")){
const additionalRepoIdNums = scriptTag.getAttribute("additionalRepoIdNums");
const firstLangs = project.languages;
const additionalLangs = findProjectById(additionalRepoIdNums).languages;

let languagesArr = [...firstLangs, ...additionalLangs];
let set = new Set(languagesArr);
project.languages = Array.from(set);
// Merge language lists from multiple GitHub repositories associated with a single project
if (scriptTag.getAttribute('additionalRepoIdNums')) {
const additionalRepoIdNums = scriptTag.getAttribute('additionalRepoIdNums').split(',');
let languagesArray = [...project.languages];

additionalRepoIdNums.forEach(repoId => {
const additionalRepo = findProjectById(repoId);
if (additionalRepo && additionalRepo.languages) {
languagesArray = [...languagesArray, ...additionalRepo.languages];
}
});

let uniqueLanguages = new Set(languagesArray);
project.languages = Array.from(uniqueLanguages);
}

/*
Assign hero background image
*/
Expand Down