O que define um "módulo"?

Dayman Novaes — Tue, 07 May 2024 14:04:19 +0000

Eu chamo de módulo, lato senso, qualquer "pedaço de código" minimamente coerente e organizado no mesmo espaço.
(seja no mesmo arquivo, ou na mesma função, ou na mesma pasta, ou num pacote de um package manager qualquer, etc).

E um módulo qualquer tem SEMPRE 3 características:

um funcionamento interno (que é o grande propósito de sua existência);
dependências (usa coisas de fora, de outros módulos);
um entry-point;

Entender isso é essencial pra navegar no mar infinito das tecnologias web atuais.
Uma pasta com vários arquivos pode ser ou não um módulo, dependendo dessa definição. Veja o exemplo abaixo:

Claramente essa pasta é um módulo. Porém, a pasta templates dentro dela não é um módulo por si só, pois não há entry-point, apesar de ter uma coerência.

Perceba que quando a pasta é um módulo ela tende a estar no singular. Quando é apenas um "organizador de arquivos" ela tende a estar no plural (templates/, Documents/, Downloads/, etc).

Observe no seu projeto atual e veja se ele segue essa regra.
Outra questão importante a se observar são as dependências. No exemplo anterior, há um arquivo que não tá muito coerente com os outros, que é o pdf-generator.js. Apesar disso ser um problema, não é um GRANDE problema, pois um módulo precisa de coerência MÍNIMA, não de PERFEITA.
Facilmente, o pdf-generator poderia ser movido para outro módulo, ou importado de um pacote externo ao projeto (usando npm por exemplo).

O que quero chamar a atenção, é que ao ler um código, você tem que ter MUITO CLARO quando que um fluxo COMEÇA e quando que ele SAI do módulo.
Isso pode parecer óbvio, mas não é. Lembre-se, um módulo recebe um input (através do entry-point) e através de seu "funcionamento interno" gera um output. Esse output nem sempre vai para quem chamou o módulo, e nem sempre será na última linha de código.

Como aqui, por exemplo:

Essas tripartição pode inclusive te ajudar a entender a diferença entre teste unitário e teste de integração.

Teste unitário:

testo APENAS o funcionamento interno. E faço isso simulando todas as dependências.

Teste de integração:

testo o módulo sem simular as dependências. Alguns frameworks, principalmente com pegada mais funcional, forçam o desenvolvedor a descrever explicitamente quais os inputs necessários e os outputs de cada componente (módulo).

Isso ajuda, até certo ponto. Mas é essencial que você incorpore esses conceitos na sua prática.

dominando a essência do programação: uma introdução filosófica

Dayman Novaes — Mon, 29 Apr 2024 12:02:51 +0000

Poucos programadores se aprofundam em conceitos filosóficos (especialmente a metafísica aristotélica). Mas eu estou mais do que convencido que vocês precisam.

Um dos conceitos fundamentais pra se entender o mundo é saber a diferença entre Forma e Matéria.

Matéria é aquilo que compõe algo, e Forma é o conjunto de características do algo (unitário e apreensível conceitualmente).

Uma estátua de mármore tem por matéria o mármore (que é cheio de potências para se tornar algo), já a Estátua, como tal, é a atualidade (conceito oposto à potencialidade) da coisa. É a unidade Formal.

são conceitos complexos mas poderosos e pode ser o diferencial para seu progresso na carreira.

Se te pergunto "o que é um pacote node (npm)?", qual resposta espero? Depende. depende se quero a resposta conceitual (formal) ou material.

Conceitualmente falando, posso dizer que é um código para ser compartilhado e usado em outros projetos Javascript para resolver problemas recorrentes.

Mas materialmente, é qualquer pasta que tem um package.json.
Sim, DE FATO, qualquer pasta com um package.json formatado corretamente é considerado (pelo cli do NPM), um pacote npm passível de ser instalado e interpretado pelo Node.

Eu sei que muitos de vocês não têm o costume de ler documentação, mas saiba que o próprio NPM explica isso:

Um pacote é [materialmente]:

a) uma pasta contendo (...) um arquivo package.json
b) um tarball (...) contendo (a)
c) um URL que resolve para (b)
d) um <nome>@<versão> que é publicado no registro com (c)
(...)
g) um <git remote url> que resolve para (a)

Referência: https://docs.npmjs.com/cli/v8/commands/npm-install#:~:text=A%20package%20is,resolves%20to%20(a)

DO MESMO JEITO que um projeto git é qualquer pasta que tenha uma pasta .git/ dentro dela, formatada corretamente.

Perceba que intuitivamente até usamos a palavra "formatado", pois indica a Forma, que está intrinsicamente ligada com a matéria da coisa.

Continuando o exemplo:
De fato o git é um "controlador de versão". De tal forma que quando você roda "git status" ou "git log" ele vai mostrar a diferença dos arquivos atuais com aqueles já versionados ou vai mostrar o histórico de commits, respectivamente.

mas como essas coisas aparecem no terminal? concretamente falando, onde essas informações ficam salvas? e como?

se eu precisasse refazer meu próprio git, que imitasse seu comportamento (forma), como eu faria? quais informações preciso salvar, e onde?

são perguntas que todo programador tem que se fazer o tempo todo.

Do jeito que to falando, parece que "matéria" é só uma outra forma de falar "mais baixo nível" ou "mais concreto". Mas não é bem isso.

Na minha opinião, são conceitos filosoficamente diferentes. O que você acha?

Por enquanto, esse post é apenas uma introdução. Elaborarei
melhor num próximo post.

Forem: Dayman Novaes

O que define um "módulo"?

dominando a essência do programação: uma introdução filosófica