Geração automática de anotações JSDoc para consultas SQL raw em JavaScript

Detalhes bibliográficos
Autor(a) principal: Pissurno, Patrick Motta Aragão
Data de Publicação: 2022
Tipo de documento: Trabalho de conclusão de curso
Idioma: por
Título da fonte: Repositório Institucional da Universidade Federal Fluminense (RIUFF)
Texto Completo: http://app.uff.br/riuff/handle/1/27036
Resumo: Apesar de comum, a utilização de consultas SQL raw em JavaScript resulta na perda das funções de suporte ao desenvolvimento que os ambientes de desenvolvimento oferecem, dado que seus resultados são mapeados em objetos dinâmicos. A escrita manual de anotações JSDoc visa mitigar este problema, porém causa outros, os quais reduzem severamente seus benefícios. Este trabalho propõe um mecanismo capaz de automatizar este processo: dada a consulta e as credenciais de acesso ao banco de dados, retornar a anotação JSDoc que descreve exatamente a estrutura do resultado da execução da consulta. Através da implementação de uma ferramenta de linha de comando, foi possível atestar a viabilidade da solução proposta. Com a ferramenta, os ambientes de desenvolvimento são capazes de oferecer autocomplete para as consultas SQL raw, assim como suas outras funcionalidades, sem os problemas causados pela escrita manual das anotações.
id UFF-2_f7f7869e614a20b8145dd8d4391dd8d6
oai_identifier_str oai:app.uff.br:1/27036
network_acronym_str UFF-2
network_name_str Repositório Institucional da Universidade Federal Fluminense (RIUFF)
repository_id_str 2120
spelling Geração automática de anotações JSDoc para consultas SQL raw em JavaScriptSQLRawJavaScriptJSDocAutocompleteGeração de códigoSQL (Linguagem de programação de computador)JavaScript (Linguagem de programação de computador)Code generationApesar de comum, a utilização de consultas SQL raw em JavaScript resulta na perda das funções de suporte ao desenvolvimento que os ambientes de desenvolvimento oferecem, dado que seus resultados são mapeados em objetos dinâmicos. A escrita manual de anotações JSDoc visa mitigar este problema, porém causa outros, os quais reduzem severamente seus benefícios. Este trabalho propõe um mecanismo capaz de automatizar este processo: dada a consulta e as credenciais de acesso ao banco de dados, retornar a anotação JSDoc que descreve exatamente a estrutura do resultado da execução da consulta. Através da implementação de uma ferramenta de linha de comando, foi possível atestar a viabilidade da solução proposta. Com a ferramenta, os ambientes de desenvolvimento são capazes de oferecer autocomplete para as consultas SQL raw, assim como suas outras funcionalidades, sem os problemas causados pela escrita manual das anotações.Despite being common practice, the use of raw SQL queries in JavaScript implies fewer features being offered by the code editors, given that with that type of query the results are mapped to dynamic objects. The process of manually writing JSDoc annotations aims to mitigate this issue, but is responsible for others, which in turn severely diminish any benefits it could provide. This work introduces a method capable of automating this process: given a query and the database credentials, return the JSDoc annotation that exactly describes the structure of the result of running the query. Through the implementation of a command-line tool, it was possible to attest the viability of the proposed solution. By using the tool, code editors can offer autocompletion for raw queries, along with their other features, without the issues caused by the process of manually writing the annotations.49 f.Monteiro, Rodrigo Salvadorhttp://lattes.cnpq.br/0023809873085852Oliveira, Daniel Cardoso Moraes dehttp://lattes.cnpq.br/0743793296062293Seixas, Flávio Luizhttp://lattes.cnpq.br/4319951805195534http://lattes.cnpq.br/7499931746427075Pissurno, Patrick Motta Aragão2022-11-22T12:49:47Z2022-11-22T12:49:47Zinfo:eu-repo/semantics/publishedVersioninfo:eu-repo/semantics/bachelorThesisapplication/pdfPISSURNO, Patrick Motta Aragão. Geração automática de anotações JSDoc para consultas SQL raw em JavaScript. 2022. 49 f. Trabalho de Conclusão de Curso (Graduação em Ciência da Computação, Instituto de Ciência da Computação, Universidade Federal Fluminense, Niterói, 2022.http://app.uff.br/riuff/handle/1/27036CC-BY-SAinfo:eu-repo/semantics/openAccessporreponame:Repositório Institucional da Universidade Federal Fluminense (RIUFF)instname:Universidade Federal Fluminense (UFF)instacron:UFF2022-11-22T12:49:51Zoai:app.uff.br:1/27036Repositório InstitucionalPUBhttps://app.uff.br/oai/requestriuff@id.uff.bropendoar:21202022-11-22T12:49:51Repositório Institucional da Universidade Federal Fluminense (RIUFF) - Universidade Federal Fluminense (UFF)false
dc.title.none.fl_str_mv Geração automática de anotações JSDoc para consultas SQL raw em JavaScript
title Geração automática de anotações JSDoc para consultas SQL raw em JavaScript
spellingShingle Geração automática de anotações JSDoc para consultas SQL raw em JavaScript
Pissurno, Patrick Motta Aragão
SQL
Raw
JavaScript
JSDoc
Autocomplete
Geração de código
SQL (Linguagem de programação de computador)
JavaScript (Linguagem de programação de computador)
Code generation
title_short Geração automática de anotações JSDoc para consultas SQL raw em JavaScript
title_full Geração automática de anotações JSDoc para consultas SQL raw em JavaScript
title_fullStr Geração automática de anotações JSDoc para consultas SQL raw em JavaScript
title_full_unstemmed Geração automática de anotações JSDoc para consultas SQL raw em JavaScript
title_sort Geração automática de anotações JSDoc para consultas SQL raw em JavaScript
author Pissurno, Patrick Motta Aragão
author_facet Pissurno, Patrick Motta Aragão
author_role author
dc.contributor.none.fl_str_mv Monteiro, Rodrigo Salvador
http://lattes.cnpq.br/0023809873085852
Oliveira, Daniel Cardoso Moraes de
http://lattes.cnpq.br/0743793296062293
Seixas, Flávio Luiz
http://lattes.cnpq.br/4319951805195534
http://lattes.cnpq.br/7499931746427075
dc.contributor.author.fl_str_mv Pissurno, Patrick Motta Aragão
dc.subject.por.fl_str_mv SQL
Raw
JavaScript
JSDoc
Autocomplete
Geração de código
SQL (Linguagem de programação de computador)
JavaScript (Linguagem de programação de computador)
Code generation
topic SQL
Raw
JavaScript
JSDoc
Autocomplete
Geração de código
SQL (Linguagem de programação de computador)
JavaScript (Linguagem de programação de computador)
Code generation
description Apesar de comum, a utilização de consultas SQL raw em JavaScript resulta na perda das funções de suporte ao desenvolvimento que os ambientes de desenvolvimento oferecem, dado que seus resultados são mapeados em objetos dinâmicos. A escrita manual de anotações JSDoc visa mitigar este problema, porém causa outros, os quais reduzem severamente seus benefícios. Este trabalho propõe um mecanismo capaz de automatizar este processo: dada a consulta e as credenciais de acesso ao banco de dados, retornar a anotação JSDoc que descreve exatamente a estrutura do resultado da execução da consulta. Através da implementação de uma ferramenta de linha de comando, foi possível atestar a viabilidade da solução proposta. Com a ferramenta, os ambientes de desenvolvimento são capazes de oferecer autocomplete para as consultas SQL raw, assim como suas outras funcionalidades, sem os problemas causados pela escrita manual das anotações.
publishDate 2022
dc.date.none.fl_str_mv 2022-11-22T12:49:47Z
2022-11-22T12:49:47Z
dc.type.status.fl_str_mv info:eu-repo/semantics/publishedVersion
dc.type.driver.fl_str_mv info:eu-repo/semantics/bachelorThesis
format bachelorThesis
status_str publishedVersion
dc.identifier.uri.fl_str_mv PISSURNO, Patrick Motta Aragão. Geração automática de anotações JSDoc para consultas SQL raw em JavaScript. 2022. 49 f. Trabalho de Conclusão de Curso (Graduação em Ciência da Computação, Instituto de Ciência da Computação, Universidade Federal Fluminense, Niterói, 2022.
http://app.uff.br/riuff/handle/1/27036
identifier_str_mv PISSURNO, Patrick Motta Aragão. Geração automática de anotações JSDoc para consultas SQL raw em JavaScript. 2022. 49 f. Trabalho de Conclusão de Curso (Graduação em Ciência da Computação, Instituto de Ciência da Computação, Universidade Federal Fluminense, Niterói, 2022.
url http://app.uff.br/riuff/handle/1/27036
dc.language.iso.fl_str_mv por
language por
dc.rights.driver.fl_str_mv CC-BY-SA
info:eu-repo/semantics/openAccess
rights_invalid_str_mv CC-BY-SA
eu_rights_str_mv openAccess
dc.format.none.fl_str_mv application/pdf
dc.source.none.fl_str_mv reponame:Repositório Institucional da Universidade Federal Fluminense (RIUFF)
instname:Universidade Federal Fluminense (UFF)
instacron:UFF
instname_str Universidade Federal Fluminense (UFF)
instacron_str UFF
institution UFF
reponame_str Repositório Institucional da Universidade Federal Fluminense (RIUFF)
collection Repositório Institucional da Universidade Federal Fluminense (RIUFF)
repository.name.fl_str_mv Repositório Institucional da Universidade Federal Fluminense (RIUFF) - Universidade Federal Fluminense (UFF)
repository.mail.fl_str_mv riuff@id.uff.br
_version_ 1807838823272415232

Registros relacionados