Zeedhi Symlink

Este pacote é usado para criar e relacionar os links simbólicos dos pacotes do Zeedhi 3.0

Como usar

Instale globalmente:

npm install -g @zeedhi/symlink

Entre na pasta onde ficam salvos seus clones do Zeedhi 3.0 (a pasta que contém a docs, o zeedhi-vue, zeedhi-client-core, etc...). O pacote só funciona se todos os clones estiverem em uma mesma pasta

Por exemplo, se sua estrutura de pastas for:

home/
├─ zeedhi/
│  ├─ v1/
│  ├─ v3/
│  │  ├─ zeedhi-docs-v3/
│  │  ├─ zeedhi-client-core/
│  │  ├─ zeedhi-vue/

Entre na pasta adequada (no caso /home/zeedhi/v3) e rode o comando

symlink

Como configurar

Por padrão, serão criados symlinks apenas de alguns pacotes, e eles serão linkados em todas as pastas da pasta /v3. É possível configurar quais pacotes serão linkados e para quais pastas os links serão destinados, para isso crie um arquivo symlink-config.json na raiz da pasta /v3, no seguinte formato:

{
  "linkSources": [
    "./zeedhi-client-core/packages/core",
    "./zeedhi-client-core/packages/common",
    "./zeedhi-vue/packages/vue",
    "./zeedhi-vue/packages/vuetify",
    "./zeedhi-miragejs",
    "./field-group/packages/common",
    "./field-group/packages/vue"
  ],
  "linkDestinations": [
    "./zeedhi-vue",
    "./zeedhi-miragejs",
    "./zeedhi-docs-v3",
    "./field-group"
  ],
  // ou
  "linkDestinations": "*"
}

Na entrada "linkSources" você pode informar quais links serão criados (recomendo adicionar todos os pacotes @zeedhi usados pela docs - quando começarmos a publicar as versões, pode remover os pacotes que você não estiver mexendo no momento)

Na entrada "linkDestinations" são informadas para quais pastas os links serão enviados. Normalmente pode deixar com "*" que significa todas as pastas da /v3. Altere isso caso não queira que os links sejam enviados para algum projeto especifico

Como usar (localmente)

Caso tenha clonado este repositório e queira alterar algum funcionamento, você pode rodar localmente. Primeiro crie um link simbólico para o zeedhi-symlink:

cd ./zeedhi-symlink

npm link

Agora use normalmente. Ele vai usar a versão que estiver na sua máquina:

symlink

Solução de problemas

Para verificar se um pacote está realmente sendo usado como symlink, acesse a pasta de algum projeto e use o npm ls, exemplo

cd ./zeedhi-docs-v3

npm ls @zeedhi/core

Se ele exibir o caminho local do projeto do core, significa que está usando o link simbólico.

Para verificar todos os symlinks registrados na sua instalação do node, rode:

npm ls -g --depth=0 --link=true

Para apagar algum link, rode:

npm unlink -g nome-do-pacote

# exemplos:
# npm unlink -g @zeedhi/core
# npm unlink -g @zeedhi/vuetify