liquido/README.md

Conjunto de ferramentas para desenvolvimento de aplicações para a internet 100% em português

# Liquido

<p align="center">
  <img src="./recursos/imagens/icone-liquido.png" alt="delegua" width="auto" height="130px">
</p>

Conjunto de ferramentas para desenvolvimento de aplicações para a internet 100% em português.

<p align="center">
  <a href="https://github.com/DesignLiquido/liquido/issues" target="_blank">
    <img src="https://img.shields.io/github/issues/Designliquido/liquido" />
  </a>
  <img src="https://img.shields.io/github/stars/Designliquido/liquido" />
  <img src="https://img.shields.io/github/forks/Designliquido/liquido" />
  <a href="https://www.npmjs.com/package/liquido" target="_blank">
    <img src="https://img.shields.io/npm/v/liquido" />
  </a>
  <img src="https://img.shields.io/github/license/Designliquido/liquido" />
</p>

## Motivação

- [Delégua](https://github.com/DesignLiquido/delegua) é uma linguagem de programação 100% em português;
- [Pituguês](https://github.com/DesignLiquido/pitugues) é uma linguagem de programação 100% em português com sintaxe baseada em indentação, inspirada em Python;
- [LMHT](https://github.com/DesignLiquido/LMHT) é uma linguagem de marcação 100% em português, feita para estruturar páginas de internet;
- [FolEs](https://github.com/DesignLiquido/FolEs) é uma linguagem para folhas de estilo, que estilizam páginas de internet.

Liquido é um ferramentário que combina essas linguagens para ser possível desenvolver para a internet 100% em português.

## Instalação

Você deve ter o [Node.js](https://nodejs.org/pt-br/download/) instalado.

Depois de instalar no Node.js, execute o seguinte comando no diretório em que seu projeto está:

```sh
npm i liquido
```

Se preferir usar o [Yarn](https://yarnpkg.com/) ao invés do NPM, use:

```sh
yarn add liquido
```

Isso deve criar um arquivo `package.json` com algumas informações de dependências. Neste arquivo, adicione o seguinte:

```json
  "scripts": {
    "liquido": "node ./node_modules/liquido/index.js"
  }
```

E então execute com:

```sh
yarn liquido
```

Ao rodar `liquido` (ou `yarn liquido`), a aplicação já recarrega automaticamente sempre que houver alteração nos diretórios `rotas`, `visoes` ou `estilos` — não é necessário nenhuma ferramenta externa.

## Primeiros passos

Você pode começar seu primeiro projeto do zero, criando todos os arquivos e diretórios manualmente, ou pode utilizar o modo ILC (Interface por Linha de Comando, ou CLI, em inglês) para gerar uma estrutura básica de arquivos e diretórios.

Para gerar um novo projeto, utilize o comando:

```sh
npx liquido novo [nome-do-projeto]
```

`nome-do-projeto` é opcional. Se não for fornecido, a interface deverá perguntar pelo nome do projeto.

### Olá mundo em Delégua

Crie no seu projeto um diretório chamado `rotas`. Depois, crie dentro de `rotas` um arquivo chamado `inicial.delegua`.

Dentro de `inicial.delegua`, adicione o seguinte:

```js
liquido.rotaGet(funcao(requisicao, resposta) {
  resposta.enviar("Olá mundo").status(200)
})
```

Execute liquido usando o seguinte comando:

```sh
yarn liquido
```

Ou, se preferir o NPM:

```sh
npm run liquido
```

Isso deve iniciar um servidor HTTP na porta 3000. Experimente entrar em http://localhost:3000. A mensagem "Olá mundo" deve aparecer.

### Olá mundo em Pituguês

Para usar Pituguês, defina `liquido.linguagem = 'pituguês'` no arquivo de configuração (veja a seção [Configuração](#configuração)). Crie um diretório chamado `rotas` e dentro dele um arquivo chamado `inicial.pitu`.

Em Pituguês, o registro de rotas é feito da seguinte forma:

```python
funcao minha_rota_get(requisicao, resposta):
    resposta.enviar("Olá mundo").status(200)

liquido.rotaGet(minha_rota_get)
```

Execute liquido normalmente com `yarn liquido` ou `npm run liquido`. A mensagem "Olá mundo" deve aparecer ao acessar http://localhost:3000.

## Inspiração

A maior inspiração deste projeto é a [FastAPI](https://fastapi.tiangolo.com/), mas também há influência de:

- [Next.js](https://nextjs.org/)
- [Nuxt.js](https://nuxtjs.org/)
- [Ruby on Rails](https://rubyonrails.org/)
- [Nyan](https://github.com/bucknellu/Nyan)
- [Express](https://expressjs.com)

Algumas ideias retiradas desses projetos:

- Rotas montadas por convenção: garante coesão do projeto por design, assim como facilita a validação das lógicas das rotas declaradas. Também garante um crescimento natural do projeto de forma ordenada;
- Mínimo de código escrito: programação deve ser uma experiência incrível para cada desenvolvedor, e o conjunto de ferramentas deve colaborar com isso. A inicialização deve ser muito simples e muito rápida, mas o processo não pode ser muito mágico: o desenvolvedor deve ser capaz de compreender facilmente como as coisas funcionam;
- Foco nos fundamentos: como servidores HTTP funcionam, quais são as premissas de REST, o que está por trás de cada tecnologia;
- Auto-descoberta de componentes: o ferramentário deve ser capaz de descobrir o que está habilitado no projeto olhando alguns arquivos e diretórios, e inicializando tudo isso automaticamente.

## Arquitetura

Para uma implementação inicial, foram escolhidas bibliotecas consagradas do Node.js de desenvolvimento para a Internet:

- [Express](https://www.npmjs.com/package/express), um servidor HTTP;
- [Handlebars](https://handlebarsjs.com/), um sistema de _templates_;
- [Helmet](https://helmetjs.github.io/), um _middleware_ para Express.js que define várias configurações de cabeçalho de requisições e respostas que, via de regra, deixam a aplicação mais segura;
- [Morgan](https://github.com/expressjs/morgan), um _middleware_ para estenografia de requisições HTTP, enviando mensagens úteis para desenvolvedores em console;
- [Cors](https://www.npmjs.com/package/cors), um _middleware_ para restringir certas origens de enviar requisições para a aplicação em liquido. É considerado um requisito essencial de segurança;
- [Passport](https://www.passportjs.org/), um _middleware_ básico de autenticação;
- [Cookie Parser](https://www.npmjs.com/package/cookie-parser), um _middleware_ para interpretação de _cookies_ que venham em requisições.

Liquido instancia os componentes básicos de Delégua ou Pituguês (conforme a configuração) e os controla, instrumentando instruções escritas nessas linguagens para JavaScript puro. Isso garante a acessibilidade de se programar em português com o mínimo de impacto no desempenho da aplicação como um todo, além da eliminação da complexidade de se implementar tudo dentro de cada linguagem.

### Convenção de Rotas

Toda e qualquer rota deve ficar em um diretório `rotas`. O arquivo padrão depende da linguagem configurada:

| Linguagem | Extensão | Arquivo padrão    |
|-----------|----------|-------------------|
| Delégua   | `.delegua` | `inicial.delegua` |
| Pituguês  | `.pitu`    | `inicial.pitu`    |

#### Rotas em Delégua

Se queremos criar uma rota na raiz do site, podemos criar um arquivo `inicial.delegua` com o seguinte:

```js
liquido.rotaGet(funcao(requisicao, resposta) {
    resposta.enviar("Olá mundo").status(200)
})
```

#### Rotas em Pituguês

Em Pituguês, o registro de rotas é feito da seguinte forma:

```python
funcao minha_rota_get(requisicao, resposta):
    resposta.enviar("Olá mundo").status(200)

liquido.rotaGet(minha_rota_get)
```

A instrução acima registra uma rota HTTP GET em "/" (por exemplo, `http://localhost:3000/`) que responde com um texto "Olá mundo" e o status HTTP 200.

Se queremos uma rota `http://localhost:3000/teste`, podemos fazer de duas formas:

- Em Delégua: criar um arquivo `teste.delegua` em `/rotas`, ou um diretório `teste` com `inicial.delegua` dentro.
- Em Pituguês: criar um arquivo `teste.pitu` em `/rotas`, ou um diretório `teste` com `inicial.pitu` dentro.

Assim como para o diretório `rotas`, todo e qualquer diretório dentro de `rotas` também tem como arquivo padrão o `inicial.delegua` (Delégua) ou `inicial.pitu` (Pituguês).

Cada arquivo só pode ter uma chamada por método HTTP de rota. Por exemplo, um arquivo não pode ter duas chamadas a `liquido.rotaGet()`. Nada impede um arquivo de ter uma chamada para cada tipo de rota. Os métodos são:

- `liquido.rotaGet()`
- `liquido.rotaPost()`
- `liquido.rotaPut()`
- `liquido.rotaDelete()`
- `liquido.rotaPatch()`
- `liquido.rotaCopy()`
- `liquido.rotaHead()`
- `liquido.rotaOptions()`
- `liquido.rotaPurge()`
- `liquido.rotaLock()`
- `liquido.rotaUnlock()`
- `liquido.rotaPropfind()`

Algumas rotas ainda não são suportadas porque o Express.js 4 não as implementou, mas estão marcadas para implementações futuras (Express.js 5, que ainda é _beta_). São elas:

- `liquido.rotaLink()`
- `liquido.rotaUnlink()`
- `liquido.rotaView()`

### Configuração

Liquido procura por um arquivo chamado `configuracao.delprops` na raiz do seu projeto. Nele ficam as configurações globais da aplicação.

A propriedade `liquido.linguagem` define qual linguagem de back-end será usada. Os valores aceitos são `'delegua'` (padrão) e `'pituguês'`.

Um exemplo de `configuracao.delprops` para um projeto em Delégua:

```js
liquido.arquetipo = 'rest'
liquido.linguagem = 'delegua'
liquido.roteador.cors = verdadeiro
liquido.roteador.bodyParser = verdadeiro
liquido.roteador.morgan = verdadeiro
liquido.roteador.cookieParser = verdadeiro
liquido.roteador.passport = verdadeiro
liquido.roteador.json = verdadeiro
liquido.roteador.helmet = verdadeiro
```

Para usar Pituguês, basta alterar a propriedade `linguagem`:

```js
liquido.arquetipo = 'rest'
liquido.linguagem = 'pituguês'
liquido.roteador.cors = verdadeiro
liquido.roteador.bodyParser = verdadeiro
liquido.roteador.morgan = verdadeiro
liquido.roteador.cookieParser = verdadeiro
liquido.roteador.passport = falso
liquido.roteador.json = verdadeiro
liquido.roteador.helmet = verdadeiro
```

### Servindo arquivos estáticos

Uma aplicação em Liquido pode servir arquivos estáticos se o roteador tiver uma configuração de diretório correspondente. Por exemplo:

```js
liquido.roteador.diretorioEstatico = 'publico'
```

Ou seja, havendo um diretório `publico` na sua aplicação, é possível servir arquivos como imagens, CSS, JS e assim por diante. 

Se uma imagem com o nome `teste.png` é colocada dentro do diretório `publico`, ao iniciar sua aplicação em http://localhost:3000, a imagem pode ser acessada por http://localhost:3000/teste.png. 

#### Conversões automáticas para diretório estático

Ao inicializar, Liquido verifica um diretório `estilos`. Havendo arquivos FolEs nele (extensão `.foles`), cada arquivo é automaticamente convertido para CSS e salvo no diretório configurado em `liquido.estilos.diretorioBase` (padrão: `publico/css`). Ou seja, por padrão, um arquivo `teste.foles` é salvo em `/publico/css/teste.css` e pode ser acessado por http://localhost:3000/css/teste.css.

```js
liquido.estilos.diretorioBase = 'publico/css'
```

### Padrões de Aplicação

Liquido foi pensado para servir qualquer padrão de projeto para aplicações Web. A primeira versão de Liquido garante a implementação dos seguintes padrões:

- MVC (Modelo, Visão, Controle): padrão em três camadas em que o servidor normalmente devolve HTML;
- RESTful API: Padrão em que a aplicação funciona como um serviço não visual, normalmente retornando dados serializáveis como JSON e XML.

Futuras versões de Liquido terão:

- GraphQL
- gRPC

## Banco de Dados

### Inicialização do banco de dados

O comando `liquido banco iniciar` inicializa a estrutura e os dados de um banco de dados a partir do projeto atual. Ele lê as configurações de `configuracao.delprops` para saber qual tecnologia e caminho usar.

Antes de utilizar este comando, certifique-se de que o arquivo de configuração contém as seguintes propriedades:

```js
liquido.dados.lincones.tecnologia = 'sqlite'
liquido.dados.lincones.caminho = 'banco.db'
```

#### Usando LinConEs (padrão)

Por padrão, ou quando `liquido.dados.motor = 'lincones'` estiver definido, o comando lê um script [LinConEs](https://github.com/DesignLiquido/LinConEs) na raiz do projeto. O nome padrão do arquivo é `inicializacao.lincones`, e os enunciados devem ser separados por ponto-e-vírgula (`;`):

```sql
CRIAR TABELA usuarios (
    ID INTEIRO NAO NULO CHAVE PRIMARIA AUTO INCREMENTO,
    NOME TEXTO NAO NULO,
    EMAIL TEXTO NAO NULO
);
INSERIR EM usuarios (NOME, EMAIL) VALORES ('Administrador', 'admin@exemplo.com')
```

Para executar com o nome padrão:

```sh
npx liquido banco iniciar
```

Para usar um arquivo diferente:

```sh
npx liquido banco iniciar --arquivo meu-script.lincones
```

Para executar apenas a estrutura (enunciados DDL como `CRIAR TABELA`, `ALTERAR TABELA`, `REMOVER TABELA`):

```sh
npx liquido banco iniciar --apenas-estrutura
```

Para executar apenas dados (enunciados DML como `INSERIR`, `ATUALIZAR`, `EXCLUIR`, `SELECIONAR`):

```sh
npx liquido banco iniciar --apenas-dados
```

#### Usando delegua-entidades

Se o seu projeto utiliza o pacote [`@designliquido/delegua-entidades`](https://github.com/DesignLiquido/delegua-entidades) para gerenciamento de esquema e semeadura, configure o motor no arquivo de configuração:

```js
liquido.dados.motor = 'delegua-entidades'
liquido.dados.lincones.tecnologia = 'sqlite'
liquido.dados.lincones.caminho = 'banco.db'
```

Instale o pacote como dependência do seu projeto:

```sh
npm install @designliquido/delegua-entidades
```

O comando `liquido banco iniciar` irá:

1. Escanear o diretório `migracoes/` em ordem alfabética, importar cada arquivo e executar a migração que ele exporta como padrão;
2. Escanear o diretório `sementes/` em ordem alfabética, importar cada arquivo e executar as sementes que ele exporta como padrão.

Cada arquivo de migração deve exportar uma instância de `Migracao` como exportação padrão:

```js
// migracoes/001-criar-usuarios.js
const { Migracao } = require('@designliquido/delegua-entidades');

module.exports = new Migracao('001', 'Criar tabela de usuários')
    .criarTabela('usuarios', [
        { nomeColuna: 'id', tipo: 'INTEIRO', nulo: false, chavePrimaria: true, autoIncremento: true },
        { nomeColuna: 'nome', tipo: 'TEXTO', nulo: false },
        { nomeColuna: 'email', tipo: 'TEXTO', nulo: false }
    ]);
```

Com `--apenas-estrutura`, apenas as migrações são executadas. Com `--apenas-dados`, apenas as sementes são executadas.

### Inicialização automática na inicialização do servidor

Quando o banco de dados usa `:memory:` (ou qualquer outro caminho), é possível inicializá-lo automaticamente toda vez que o servidor Líquido é iniciado. Para isso, defina `liquido.dados.lincones.autoInicializar = verdadeiro` no arquivo `configuracao.delprops`:

```js
liquido.dados.lincones.tecnologia = 'sqlite'
liquido.dados.lincones.caminho = ':memory:'
liquido.dados.lincones.autoInicializar = verdadeiro
```

Com essa configuração, ao executar `npx liquido`, o script `inicializacao.lincones` será executado automaticamente antes de o servidor começar a aceitar requisições. Se a inicialização falhar, uma advertência é exibida no console e o servidor continua funcionando normalmente.

Por padrão, o arquivo de script utilizado é `inicializacao.lincones`. Para usar um arquivo diferente, defina a chave `arquivoInicializacao`:

```js
liquido.dados.lincones.autoInicializar = verdadeiro
liquido.dados.lincones.arquivoInicializacao = 'banco-inicial.lincones'
```

> **Importante:** Quando `autoInicializar` está ativo, o Líquido reutiliza a mesma conexão com o banco de dados tanto para a inicialização quanto para as requisições. Isso é necessário para que bancos em memória (`:memory:`) compartilhem os dados entre inicialização e rotas.

## Filosofia de Tradução para o Inglês

Liquido permite a qualquer desenvolvedor que saiba português a escrever aplicações Web, e possivelmente criar um ecossistema profissional a partir dele. Procuramos traduzir o máximo possível de informações e conceitos por uma questão de acessibilidade, mas há limites para isso. Por exemplo, não traduzimos os métodos de HTTP porque entendemos que uma tradução disso implicaria em um protocolo novo de transferência.

O que tentamos fazer é instigar os desenvolvedores a aprenderem inglês conforme vão dominando outros conceitos. Um aprendizado direcionado de inglês é muito mais eficiente do que o aprendizado da língua por si só, sem um objetivo no horizonte.

## Quem já Contribuiu

<a href="https://github.com/DesignLiquido/liquido/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=DesignLiquido/liquido" />
</a>