Templater : extensão do editor VS Code para armazenamento de snippets e busca na base de conhecimentos do Stack Overflow

Abstract

Templates são fundamentalmente trechos de código reutilizáveis que atendem uma funcionalidade simples e específica. Conhecidos como Snippets em algumas plataformas de edição de código, o objetivo destes fragmentos é que o programador possa rapidamente incluir um bloco de código e adequar este para o seu caso de uso atual, evitando a necessidade de escrever todo o seu programa do zero. No caso do editor VS Code este conceito é chamado Snippet e suportado pela plataforma naturalmente, oferecendo a possibilidade de criar e utilizar facilmente estes trechos. Em muitos momentos durante o desenvolvimento de código os programadores encaram dificuldades ao escrever seus programas e precisam buscar soluções para seus problemas, tipicamente em fóruns de sua área de trabalho. Um exemplo deste tipo de fórum é o Stack Overflow, que é um fórum aberto onde os usuários cadastrados podem fazer e responder perguntas da área de desenvolvimento de software e computação em geral. O Stack Overflow é uma boa fonte de informações, pois mesmo usuários não cadastrados podem pesquisar a base de conhecimentos em busca de questionamentos similares que possam sanar suas necessidades. Nesse contexto, seria muito conveniente para um usuário da ferramenta VS Code, por exemplo, que a pesquisa na base de conhecimento pudesse ser realizada através da própria plataforma de edição e que o código apresentado como solução para a pergunta pudesse ser salvo como um Snippet para ser reutilizado quando novamente surgir o cenário que causou dificuldades ao programador. O ambiente de edição VS Code é extensível através da adição de funcionalidades programadas como pequenos pacotes de ferramentas para que possam ser adicionadas a ele melhorias específicas para facilitar seu uso. Para proporcionar uma experiência melhorada para o usuário, é proposta a extensão Templater. Templater é uma ferramenta adicional que expande as funcionalidades do editor de texto incluíndo pesquisa no fórum e armazenamento facilitado dos trechos selecionados.

Templates are basically code fragments that can be reused and fulfill a specific function. Known as Snippets in some code editing platforms, the main objective is to provide a kick way to add blocks of code and adapt them to the current needs, avoiding the need to write the whole code from scratch. In the VS Code environment this concept is known as Snippet has native support, offering the possibility to create an use such easily. On the process of developing code, programmers often face challenges and must search for solutions typically on forums in their field of work. A good example of such forums is Stack Overflow, which is an open forum where registered users can ask and answer questions about software development and computing general aspects. Stack Overflow is a good source of information for even unregistered users can search the knowledge base for similar questions to address their needs. In this context it would be convenient for a VS Code user, for instance, to be able to search this knowledge base through the editor and also save the code that was presented as an answer in the form of a Snippet for re-utilization when the difficult scenario arises again. The VS Code environment is fully extensible through the addition of functionalities programmed as small packages of tools to add specific improvements to make it more usable. To provide a better experience for the users, the Templater extension is proposed. Templater is an additional tool that expands the functionalities of the text editor including searching in the forum and easy storage of selected code blocks.