Bruno Miiller 48b4f7e19c Add docs/ARCHITECTURE, CONTRIBUTING and DEVELOPMENT

- ARCHITECTURE.md: high-level view of FakeFs abstraction, sync flow, state
- DEVELOPMENT.md: mise setup + npm commands + local install
- CONTRIBUTING.md: workflow, English commit conventions, upstream PR cherry-pick

2026-05-19 22:10:31 -03:00

1.4 KiB

Raw Blame History

Desenvolvimento

Setup

Pré-requisito: mise instalado.

mise install              # instala Node conforme mise.toml
npm ci                    # instala dependências do lockfile

Comandos

npm run dev               # webpack watch (dev)
npm run build             # build de produção (webpack)
npm run dev2              # esbuild watch (alternativo)
npm run build2            # build de produção (esbuild + tsc check)
npm test                  # mocha (tests/ + pro/tests/)
npm run format            # biome check --write
npm run clean             # remove main.js

Instalar build local no Obsidian

Após npm run build, copiar para o vault:

cp main.js manifest.json styles.css \
   /path/to/vault/.obsidian/plugins/remotely-save/

Reload do Obsidian (Ctrl+R) para carregar a nova versão.

Testes

Framework: Mocha + chai-as-promised + tsx (sem transpile separado).

Estrutura:

tests/         testes do código público (src/)
pro/tests/     testes do código pro/

Comando: npm test.

Lint/format

Biome (biome.json na raiz):

npm run format            # corrige automaticamente
npx @biomejs/biome check  # só verifica

Release

Disparado via tag git. Workflow .github/workflows/release.yml constrói e publica artefatos:

git tag x.y.z
git push origin x.y.z

1.4 KiB Raw Blame History