fix the PR comments

This commit is contained in:
Luis Carlos 2024-08-26 11:48:58 -04:00
parent 4aef6c6e25
commit ee3a50912a
5 changed files with 20 additions and 30 deletions

View File

@ -1062,13 +1062,8 @@ export default function ControlPanel({
})); }));
}, },
}, },
],
function: () => {},
},
documentation: {
children: [
{ {
Markdown: () => { Readme: () => {
setModal(MODAL.CODE); setModal(MODAL.CODE);
const result = jsonToDocumentation({ const result = jsonToDocumentation({
tables: tables, tables: tables,
@ -1084,7 +1079,7 @@ export default function ControlPanel({
extension: "md", extension: "md",
})); }));
} }
} },
], ],
function: () => {}, function: () => {},
}, },

View File

@ -236,7 +236,6 @@ const en = {
empty_index_name: "Declared an index with no name in table '{{tableName}}'", empty_index_name: "Declared an index with no name in table '{{tableName}}'",
didnt_find_diagram: "Oops! Didn't find the diagram.", didnt_find_diagram: "Oops! Didn't find the diagram.",
unsigned: "Unsigned", unsigned: "Unsigned",
documentation: "Documentation",
}, },
}; };

View File

@ -212,7 +212,6 @@ const es = {
edit_relationship: "{{extra}} Editar relación {{refName}}", edit_relationship: "{{extra}} Editar relación {{refName}}",
delete_relationship: "Eliminar relación {{refName}}", delete_relationship: "Eliminar relación {{refName}}",
not_found: "No encontrado", not_found: "No encontrado",
documentation: "Documentación",
}, },
}; };

View File

@ -217,7 +217,6 @@ const fr = {
edit_relationship: "{{extra}} Modifier la relation {{refName}}", edit_relationship: "{{extra}} Modifier la relation {{refName}}",
delete_relationship: "Supprimer la relation {{refName}}", delete_relationship: "Supprimer la relation {{refName}}",
not_found: "Non trouvé", not_found: "Non trouvé",
documentation: "Documentation",
}, },
}; };

View File

@ -1,5 +1,6 @@
import { dbToTypes } from "../../data/datatypes"; import { dbToTypes } from "../../data/datatypes";
import { jsonToMermaid } from "./mermaid"; import { jsonToMermaid } from "./mermaid";
import { databases } from "../../data/databases";
export function jsonToDocumentation(obj) { export function jsonToDocumentation(obj) {
@ -44,16 +45,13 @@ export function jsonToDocumentation(obj) {
.map((r) => { .map((r) => {
const startTable = obj.tables[r.startTableId].name; const startTable = obj.tables[r.startTableId].name;
const endTable = obj.tables[r.endTableId].name; const endTable = obj.tables[r.endTableId].name;
return `- **${startTable} to ${endTable}**: ${r.cardinality} ${r.comment ? "(" + r.comment + ")" : ""}\n`; return `- **${startTable} to ${endTable}**: ${r.cardinality}\n`;
}).join("") : ""; }).join("") : "";
console.log(obj.tables);
console.log(obj.relationships);
return `# ${obj.title} documentation\n## Summary\n\n- [Introduction](#introduction)\n- [Database Type](#database-type)\n`+ return `# ${obj.title} documentation\n## Summary\n\n- [Introduction](#introduction)\n- [Database Type](#database-type)\n`+
`- [Table Structure](#table-structure)\n${documentationSummary}\n- [Relationships](#relationships)\n- [Database Diagram](#database-Diagram)\n\n`+ `- [Table Structure](#table-structure)\n${documentationSummary}\n- [Relationships](#relationships)\n- [Database Diagram](#database-Diagram)\n\n`+
`## Introduction\n\n## Database type\n\n- **Database system:** `+ `## Introduction\n\n## Database type\n\n- **Database system:** `+
`${obj.database.type}\n## Table structure\n\n${documentationEntities}`+ `${databases[obj.database].name}\n## Table structure\n\n${documentationEntities}`+
`\n\n## Relationships\n\n${documentationRelationships}\n\n`+ `\n\n## Relationships\n\n${documentationRelationships}\n\n`+
`## Database Diagram\n\n\`\`\`${jsonToMermaid(obj)}\`\`\``; `## Database Diagram\n\n\`\`\`${jsonToMermaid(obj)}\`\`\``;
} }