mirror of
https://github.com/asdf-vm/asdf.git
synced 2024-11-15 01:28:17 -07:00
docs: updates portuguese translation in the documentation (#1210)
* docs: <getting started> translate missing snippets * docs: translate missing snippets * docs: translate plugins create article * docs: translate documentation to contribute * docs: translate contribute core * docs: translate first-party-plugins * docs: translate contribute/github-actiosn
This commit is contained in:
Josué Lobo
GitHub
parent
27f7ef7852
commit
068432f114
@ -2,11 +2,11 @@
|
||||
|
||||
> Hi, we've recently migrated our docs and added some new pages. If you would like to help translate this page, see the "Edit this page" link at the bottom of the page.
|
||||
|
||||
`asdf` core contribution guide.
|
||||
guia de contribuição principal `asdf`.
|
||||
|
||||
## Initial Setup
|
||||
## Configuração inicial
|
||||
|
||||
Fork `asdf` on GitHub and/or Git clone the default branch:
|
||||
Fork `asdf` no GitHub e/ou Git clone o branch padrão:
|
||||
|
||||
```shell:no-line-numbers
|
||||
# clone your fork
|
||||
@ -15,7 +15,7 @@ git clone https://github.com/<GITHUB_USER>/asdf.git
|
||||
git clone https://github.com/asdf-vm/asdf.git
|
||||
```
|
||||
|
||||
The tools for core development are in this repo's `.tool-versions`. If you wish to manage with `asdf` itself, add the plugins:
|
||||
As ferramentas para o desenvolvimento do núcleo estão em `.tool-versions` deste repositório. Se você deseja gerenciar com o próprio `asdf`, adicione os plugins:
|
||||
|
||||
```shell:no-line-numbers
|
||||
asdf plugin add bats https://github.com/timgluz/asdf-bats.git
|
||||
@ -23,23 +23,23 @@ asdf plugin add shellcheck https://github.com/luizm/asdf-shellcheck.git
|
||||
asdf plugin add shfmt https://github.com/luizm/asdf-shfmt.git
|
||||
```
|
||||
|
||||
Install the versions to develop `asdf` with:
|
||||
Instale as versões para desenvolver `asdf` com:
|
||||
|
||||
```shell:no-line-numbers
|
||||
asdf install
|
||||
```
|
||||
|
||||
It _may_ be useful to not use `asdf` to manage the tools during development on your local machine as you may need to break functionality which would then break your dev tooling. Here's the raw list of tools:
|
||||
_pode_ ser útil não usar `asdf` para gerenciar as ferramentas durante o desenvolvimento em sua máquina local, pois você pode precisar quebrar funcionalidades que, então, quebrariam suas ferramentas de desenvolvimento. Aqui está a lista bruta de ferramentas:
|
||||
|
||||
- [bats-core](https://github.com/bats-core/bats-core): Bash Automated Testing System, for unit testing Bash or POSIX compliant scripts.
|
||||
- [shellcheck](https://github.com/koalaman/shellcheck): Static analysis tool for shell scripts.
|
||||
- [shfmt](https://github.com/mvdan/sh): A shell parser, formatter, and interpreter with bash support; includes shfmt
|
||||
- [bats-core](https://github.com/bats-core/bats-core): Bash Automated Testing System, para testes unitários de scripts compatíveis com Bash ou POSIX.
|
||||
- [shellcheck](https://github.com/koalaman/shellcheck): Ferramenta de análise estática para scripts de shell.
|
||||
- [shfmt](https://github.com/mvdan/sh): Um analisador, formatador e interpretador de shell com suporte a bash; inclui shfmt
|
||||
|
||||
## Development
|
||||
## Desenvolvimento
|
||||
|
||||
If you want to try out your changes without making change to your installed `asdf`, you can set the `$ASDF_DIR` variable to the path where you cloned the repository, and temporarily prepend the `bin` and `shims` directory of the directory to your path.
|
||||
Se você quiser testar suas alterações sem fazer alterações em seu `asdf` instalado, você pode definir a variável `$ASDF_DIR` para o caminho onde você clonou o repositório e anexar temporariamente o diretório `bin` e `shims` do diretório para o seu caminho.
|
||||
|
||||
It is best to format, lint and test your code locally before you commit or push to the remote. Use the following scripts/commands:
|
||||
É melhor formatar, lint e testar seu código localmente antes de confirmar ou enviar para o controle remoto. Use os seguintes scripts/comandos:
|
||||
|
||||
```shell:no-line-numbers
|
||||
# Shellcheck
|
||||
@ -56,15 +56,15 @@ bats test/list_commands.bash
|
||||
|
||||
::: tip
|
||||
|
||||
**Add tests!** - Tests are **required** for new features and speed up review of bug fixes. Please cover new code paths before you create a Pull Request. See [bats-core documentation](https://bats-core.readthedocs.io/en/stable/index.html)
|
||||
**Adicione testes!** - Os testes são **necessários** para novos recursos e aceleram a revisão de correções de bugs. Por favor, cubra novos caminhos de código antes de criar um Pull Request. Consulte [documentação do bats-core](https://bats-core.readthedocs.io/en/stable/index.html)
|
||||
|
||||
:::
|
||||
|
||||
## Bats Testing
|
||||
## Teste de morcego
|
||||
|
||||
It is **strongly encouraged** to examine the existing test suite and the [bats-core documentation](https://bats-core.readthedocs.io/en/stable/index.html) before writing tests.
|
||||
É **fortemente recomendado** examinar o conjunto de testes existente e a [documentação do bats-core](https://bats-core.readthedocs.io/en/stable/index.html) antes de escrever os testes.
|
||||
|
||||
Bats debugging can be difficult at times. Using the TAP output with `-t` flag will enable you to print outputs with the special file descriptor `>&3` during test execution, simplifying debugging. As an example:
|
||||
A depuração de morcegos pode ser difícil às vezes. Usar a saída TAP com o sinalizador `-t` permitirá que você imprima saídas com o descritor de arquivo especial `>&3` durante a execução do teste, simplificando a depuração. Como um exemplo:
|
||||
|
||||
```shell
|
||||
# test/some_tests.bats
|
||||
@ -73,15 +73,15 @@ printf "%s\n" "Will not be printed during bats test/some_tests.bats"
|
||||
printf "%s\n" "Will be printed during bats -t test/some_tests.bats" >&3
|
||||
```
|
||||
|
||||
This is further documented in bats-core [Printing to the Terminal](https://bats-core.readthedocs.io/en/stable/writing-tests.html#printing-to-the-terminal).
|
||||
Isso está documentado em bats-core [Imprimindo no Terminal](https://bats-core.readthedocs.io/en/stable/writing-tests.html#printing-to-the-terminal).
|
||||
|
||||
## Pull Requests, Releases & Conventional Commits
|
||||
## Pull Requests, Releases e Commits Convencionais
|
||||
|
||||
`asdf` is using an automated release tool called [Release Please](https://github.com/googleapis/release-please) to automatically bump the [SemVer](https://semver.org/) version and generate the [Changelog](https://github.com/asdf-vm/asdf/blob/master/CHANGELOG.md). This information is determined by reading the commit history since the last release.
|
||||
O `asdf` está usando uma ferramenta de lançamento automatizada chamada [Release Please](https://github.com/googleapis/release-please) para aumentar automaticamente a versão [SemVer](https://semver.org/) e gerar a [Changelog](https://github.com/asdf-vm/asdf/blob/master/CHANGELOG.md). Essas informações são determinadas lendo o histórico de confirmação desde a última versão.
|
||||
|
||||
[Conventional Commit messages](https://www.conventionalcommits.org/) define the format of the Pull Request Title which becomes the commit message format on the default branch. This is enforced with GitHub Action [`amannn/action-semantic-pull-request`](https://github.com/amannn/action-semantic-pull-request).
|
||||
[Mensagens de confirmação convencionais](https://www.conventionalcommits.org/) definem o formato do título da solicitação pull que se torna o formato da mensagem de confirmação na ramificação padrão. Isso é aplicado com GitHub Action [`amannn/action-semantic-pull-request`](https://github.com/amannn/action-semantic-pull-request).
|
||||
|
||||
Conventional Commit follows this format:
|
||||
O Commit Convencional segue este formato:
|
||||
|
||||
```:no-line-numbers
|
||||
<type>[optional scope][optional !]: <description>
|
||||
@ -94,22 +94,22 @@ docs(website): some change for the website
|
||||
feat!: feature with breaking change
|
||||
```
|
||||
|
||||
The full list of `<types>` are: `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`, `revert`.
|
||||
A lista completa de `<types>` é: `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`, `revert`.
|
||||
|
||||
The `!` indicates a breaking change.
|
||||
O `!` indica uma mudança de ruptura.
|
||||
|
||||
`fix`: will create a new SemVer `patch`
|
||||
`feat`: will create a new SemVer `minor`
|
||||
`<type>!`: will create a new SemVer `major`
|
||||
|
||||
The Pull Request Title must follow this format.
|
||||
O título da solicitação pull deve seguir este formato.
|
||||
|
||||
::: tip
|
||||
|
||||
Use Conventional Commit message format for your Pull Request Title.
|
||||
Use o formato de mensagem de confirmação convencional para seu título de solicitação de pull.
|
||||
|
||||
:::
|
||||
|
||||
## Docker Images
|
||||
## Imagens Docker
|
||||
|
||||
The [asdf-alpine](https://github.com/vic/asdf-alpine) and [asdf-ubuntu](https://github.com/vic/asdf-ubuntu) projects are an ongoing effort to provide Dockerized images of some asdf tools. You can use these docker images as base for your development servers, or for running your production apps.
|
||||
Os projetos [asdf-alpine](https://github.com/vic/asdf-alpine) e [asdf-ubuntu](https://github.com/vic/asdf-ubuntu) são um esforço contínuo para fornecer imagens de algumas ferramentas asdf. Você pode usar essas imagens docker como base para seus servidores de desenvolvimento ou para executar seus aplicativos de produção.
|
||||
|
||||
@ -2,11 +2,11 @@
|
||||
|
||||
> Hi, we've recently migrated our docs and added some new pages. If you would like to help translate this page, see the "Edit this page" link at the bottom of the page.
|
||||
|
||||
Documentation & site contribution guide.
|
||||
Documentação e guia de contribuição do site.
|
||||
|
||||
## Initial Setup
|
||||
## Configuração inicial
|
||||
|
||||
Fork `asdf` on GitHub and/or Git clone the default branch:
|
||||
Fork `asdf` no GitHub e/ou Git clone o branch padrão:
|
||||
|
||||
```shell:no-line-numbers
|
||||
# clone your fork
|
||||
@ -15,73 +15,72 @@ git clone https://github.com/<GITHUB_USER>/asdf.git
|
||||
git clone https://github.com/asdf-vm/asdf.git
|
||||
```
|
||||
|
||||
The tools for Docs site development are managed with `asdf` in the `docs/.tool-versions`. Add the plugins with:
|
||||
As ferramentas para desenvolvimento de sites Docs são gerenciadas com `asdf` em `docs/.tool-versions`. Adicione os plugins com:
|
||||
|
||||
```shell:no-line-numbers
|
||||
asdf plugin add nodejs https://github.com/asdf-vm/asdf-nodejs
|
||||
```
|
||||
|
||||
Install the tool version(s) with:
|
||||
Instale a(s) versão(ões) da ferramenta com:
|
||||
|
||||
```shell:no-line-numbers
|
||||
asdf install
|
||||
```
|
||||
|
||||
- [Node.js](https://nodejs.org): JavaScript runtime built on Chrome's V8 JavaScript engine.
|
||||
|
||||
Install Node.js dependencies from `docs/package.json`:
|
||||
- [Node.js](https://nodejs.org): tempo de execução JavaScript criado no mecanismo JavaScript V8 do Chrome.
|
||||
-
|
||||
Instale as dependências do Node.js do `docs/package.json`:
|
||||
|
||||
```shell:no-line-numbers
|
||||
npm install
|
||||
```
|
||||
|
||||
## Development
|
||||
## Desenvolvimento
|
||||
|
||||
[Vuepress (v2)](https://v2.vuepress.vuejs.org/) is the Static Site Generator (SSG) we use to build the asdf documentation site. It was chosen to replace [Docsify.js](https://docsify.js.org/) as we would like to support an HTML only fallback when users do not have JavaScript available or enabled. This was not possible with Docsify. Other than this, the feature-set is largely the same, with the focus on writing Markdown files with minimal configuration.
|
||||
[Vuepress (v2)](https://v2.vuepress.vuejs.org/) é o Static Site Generator (SSG) que usamos para construir o site de documentação do asdf. Foi escolhido para substituir [Docsify.js](https://docsify.js.org/), pois gostaríamos de oferecer suporte a um substituto somente HTML quando os usuários não tiverem JavaScript disponível ou ativado. Isso não era possível com o Docsify. Fora isso, o conjunto de recursos é basicamente o mesmo, com foco em escrever arquivos Markdown com configuração mínima.
|
||||
|
||||
`package.json` contains the scripts required for development:
|
||||
`package.json` contém os scripts necessários para o desenvolvimento:
|
||||
|
||||
@[code json{3-5}](../package.json)
|
||||
|
||||
To start the local development server:
|
||||
Para iniciar o servidor de desenvolvimento local:
|
||||
|
||||
```shell:no-line-numbers
|
||||
npm run dev
|
||||
```
|
||||
|
||||
Format the code before committing:
|
||||
Formate o código antes de confirmar:
|
||||
|
||||
```shell:no-line-numbers
|
||||
npm run format
|
||||
```
|
||||
|
||||
## Pull Requests, Releases & Conventional Commits
|
||||
## Pull Requests, Releases e Commits Convencionais
|
||||
|
||||
`asdf` is using an automated release pipeline which relies on Conventional Commits in PR titles. Detailed documentation found in the [core contribution guide](./core.md).
|
||||
`asdf` está usando um pipeline de lançamento automatizado que depende de Commits Convencionais em títulos de PR. Documentação detalhada encontrada no [guia de contribuição principal](./core.md).
|
||||
|
||||
When creating a PR for documentation changes please make the PR title with the Conventional Commit type `docs` in the format `docs: <description>`.
|
||||
Ao criar um PR para alterações na documentação, por favor, faça o título do PR com o tipo de Commit Convencional `docs` no formato `docs: <description>`.
|
||||
|
||||
## Vuepress
|
||||
|
||||
Configuration of the site is contained within a few JavaScript files with JS Objects used to represent the config. They are:
|
||||
A configuração do site está contida em alguns arquivos JavaScript com objetos JS usados para representar a configuração. Eles estão:
|
||||
|
||||
- `docs/.vuepress/config.js`: the root config file for the site. Read the [Vuepress documentation](https://v2.vuepress.vuejs.org/guide/configuration.html#config-file) for it's spec.
|
||||
- `docs/.vuepress/config.js`: o arquivo de configuração raiz do site. Leia a [documentação do Vuepress](https://v2.vuepress.vuejs.org/guide/configuration.html#config-file) para obter as especificações.
|
||||
|
||||
To simplify the root config, the larger JS Objects representing the _navbar_ and _sidebar_ configuration have been extracted and separated by their locale. See both in:
|
||||
Para simplificar a configuração raiz, os objetos JS maiores que representam a configuração _navbar_ e _sidebar_ foram extraídos e separados por sua localidade. Veja os dois em:
|
||||
|
||||
- `docs/.vuepress/navbar.js`
|
||||
- `docs/.vuepress/sidebar.js`
|
||||
|
||||
With the official documentation for these configs living in the [Default Theme Reference](https://v2.vuepress.vuejs.org/reference/default-theme/config.html#locale-config).
|
||||
Com a documentação oficial para essas configurações vivendo na [Referência de tema padrão](https://v2.vuepress.vuejs.org/reference/default-theme/config.html#locale-config).
|
||||
|
||||
## I18n
|
||||
|
||||
Vuepress has first-class support for internationalization. The
|
||||
root config `docs/.vuepress/config.js` defines the supported locales with their URL, title in the selection dropdown menu and navbar/sidebar configs references.
|
||||
Vuepress tem suporte de primeira classe para internacionalização. O root config `docs/.vuepress/config.js` define os locais suportados com sua URL, título no menu suspenso de seleção e referências de configurações navbar/sidebar.
|
||||
|
||||
The navbar/sidebar configs are captured in the aforementioned config files, separated by locale and exported individually.
|
||||
As configurações da barra de navegação/barra lateral são capturadas nos arquivos de configuração mencionados acima, separadas por localidade e exportadas individualmente.
|
||||
|
||||
The markdown content for each locale must fall under a folder with the same name as the keys for `locales` in the root config. That is:
|
||||
O conteúdo de markdown para cada localidade deve estar em uma pasta com o mesmo nome das chaves para `locales` na configuração raiz. Isso é:
|
||||
|
||||
```js
|
||||
{
|
||||
@ -103,7 +102,7 @@ The markdown content for each locale must fall under a folder with the same name
|
||||
}
|
||||
```
|
||||
|
||||
`/pt-BR/` will require the same set of markdown files located under `docs/pt-BR/`, like so:
|
||||
`/pt-BR/` exigirá o mesmo conjunto de arquivos markdown localizados em `docs/pt-BR/`, assim:
|
||||
|
||||
```shell:no-line-numbers
|
||||
docs
|
||||
@ -118,4 +117,4 @@ docs
|
||||
└─ README.md
|
||||
```
|
||||
|
||||
The [official Vuepress i18n documentation](https://v2.vuepress.vuejs.org/guide/i18n.html#site-i18n-config) goes into more detail.
|
||||
A [documentação oficial do Vuepress i18n](https://v2.vuepress.vuejs.org/guide/i18n.html#site-i18n-config) entra em mais detalhes.
|
||||
|
||||
@ -2,14 +2,14 @@
|
||||
|
||||
> Hi, we've recently migrated our docs and added some new pages. If you would like to help translate this page, see the "Edit this page" link at the bottom of the page.
|
||||
|
||||
The asdf core team has authored some plugins relevant to their daily work life. Help is always welcome in maintaining and improving these plugins. See the associated repo for each linked below:
|
||||
A equipe principal do asdf criou alguns plugins relevantes para sua vida profissional diária. A ajuda é sempre bem-vinda na manutenção e melhoria desses plugins. Veja o repositório associado para cada link abaixo:
|
||||
|
||||
- [Elixir](https://github.com/asdf-vm/asdf-elixir)
|
||||
- [Erlang](https://github.com/asdf-vm/asdf-erlang)
|
||||
- [Node.js](https://github.com/asdf-vm/asdf-nodejs)
|
||||
- [Ruby](https://github.com/asdf-vm/asdf-ruby)
|
||||
|
||||
For community plugins, see:
|
||||
Para plugins da comunidade, consulte:
|
||||
|
||||
- [`asdf-community` organisation](https://github.com/asdf-community): A collaborative, community-driven project for long-term maintenance of `asdf` plugins.
|
||||
- [`asdf-plugins` shortname repo](https://github.com/asdf-vm/asdf-plugins): Short-name list used by `asdf` core to lookup popular `asdf` plugins.
|
||||
|
||||
@ -2,4 +2,4 @@
|
||||
|
||||
> Hi, we've recently migrated our docs and added some new pages. If you would like to help translate this page, see the "Edit this page" link at the bottom of the page.
|
||||
|
||||
Thanks for your interest, please see the [asdf actions repo](https://github.com/asdf-vm/actions) for their existing Issues, conversations and Contributing Guidelines.
|
||||
Obrigado pelo seu interesse, consulte o [repositório de ações asdf](https://github.com/asdf-vm/actions) para ver os problemas, conversas e diretrizes de contribuição existentes.
|
||||
|
||||
@ -148,7 +148,7 @@ O auto completar é configurado automaticamente durante a instalação do pacote
|
||||
|
||||
::: details Elvish & Git
|
||||
|
||||
Add `asdf.elv` to your `~/.config/elvish/rc.elv` with:
|
||||
Adicione `asdf.elv` ao `~/.config/elvish/rc.elv` através do comando:
|
||||
|
||||
```shell:no-line-numbers
|
||||
mkdir -p ~/.config/elvish/lib; ln -s ~/.asdf/asdf.elv ~/.config/elvish/lib/asdf.elv
|
||||
@ -156,13 +156,13 @@ echo "\n"'use asdf _asdf; var asdf~ = $_asdf:asdf~' >> ~/.config/elvish/rc.elv
|
||||
echo "\n"'set edit:completion:arg-completer[asdf] = $_asdf:arg-completer~' >> ~/.config/elvish/rc.elv
|
||||
```
|
||||
|
||||
Completions are automatically configured.
|
||||
Ao concluir atualizará automaticamente
|
||||
|
||||
:::
|
||||
|
||||
::: details Elvish & Homebrew
|
||||
|
||||
Add `asdf.elv` to your `~/.config/elvish/rc.elv` with:
|
||||
Adicione `asdf.elv` ao `~/.config/elvish/rc.elv` através do comando:
|
||||
|
||||
```shell:no-line-numbers
|
||||
mkdir -p ~/.config/elvish/lib; ln -s (brew --prefix asdf)/libexec/asdf.elv ~/.config/elvish/lib/asdf.elv
|
||||
@ -170,12 +170,12 @@ echo "\n"'use asdf _asdf; var asdf~ = $_asdf:asdf~' >> ~/.config/elvish/rc.elv
|
||||
echo "\n"'set edit:completion:arg-completer[asdf] = $_asdf:arg-completer~' >> ~/.config/elvish/rc.elv
|
||||
```
|
||||
|
||||
Completions are automatically configured.
|
||||
Ao concluir atualizará automaticamente
|
||||
:::
|
||||
|
||||
::: details Elvish & Pacman
|
||||
|
||||
Add `asdf.elv` to your `~/.config/elvish/rc.elv` with:
|
||||
Adicione `asdf.elv` ao `~/.config/elvish/rc.elv` através do comando:
|
||||
|
||||
```shell:no-line-numbers
|
||||
mkdir -p ~/.config/elvish/lib; ln -s /opt/asdf-vm/asdf.elv ~/.config/elvish/lib/asdf.elv
|
||||
@ -183,7 +183,7 @@ echo "\n"'use asdf _asdf; var asdf~ = $_asdf:asdf~' >> ~/.config/elvish/rc.elv
|
||||
echo "\n"'set edit:completion:arg-completer[asdf] = $_asdf:arg-completer~' >> ~/.config/elvish/rc.elv
|
||||
```
|
||||
|
||||
Completions are automatically configured.
|
||||
Ao concluir atualizará automaticamente
|
||||
:::
|
||||
|
||||
::: details ZSH & Git
|
||||
|
||||
@ -2,6 +2,6 @@
|
||||
|
||||
> Hi, we've recently migrated our docs and added some new pages. If you would like to help translate this page, see the "Edit this page" link at the bottom of the page.
|
||||
|
||||
The list of all commands available in `asdf`. This list is the `asdf help` command text.
|
||||
A lista de todos os comandos disponíveis em `asdf`. Esta lista é o texto do comando `asdf help`.
|
||||
|
||||
@[code](../../../help.txt)
|
||||
|
||||
@ -2,13 +2,13 @@
|
||||
|
||||
> Hi, we've recently migrated our docs and added some new pages. If you would like to help translate this page, see the "Edit this page" link at the bottom of the page.
|
||||
|
||||
Configuration of `asdf` encompasses both the sharable `.tool-versions` files as well as user specific customisations with `.asdfrc` and Environment Variables.
|
||||
A configuração do `asdf` abrange tanto os arquivos `.tool-versions` compartilháveis quanto as personalizações específicas do usuário com `.asdfrc` e variáveis de ambiente.
|
||||
|
||||
## .tool-versions
|
||||
|
||||
Sempre que o arquivo `.tool-versions` estiver presente em um diretório, as versões da ferramenta que ele declara serão usadas nesse diretório e em seus subdiretórios.
|
||||
|
||||
?> Configurações globais podem ser modificadas no arquivo `$HOME/.tool-versions`
|
||||
Configurações globais podem ser modificadas no arquivo `$HOME/.tool-versions`
|
||||
|
||||
O arquivo `.tool-versions` se parece assim:
|
||||
|
||||
@ -56,7 +56,7 @@ legacy_version_file = yes
|
||||
|
||||
## Variáveis de ambiente
|
||||
|
||||
- `ASDF_CONFIG_FILE` - O padrão é `~ / .asdfrc` conforme descrito acima. Pode ser definido para qualquer local.
|
||||
- `ASDF_CONFIG_FILE` - O padrão é `~ /.asdfrc` conforme descrito acima. Pode ser definido para qualquer local.
|
||||
- `ASDF_DEFAULT_TOOL_VERSIONS_FILENAME` - O nome do arquivo que armazena os nomes e versões das ferramentas. O padrão é `.tool-versions`. Pode ser qualquer nome de arquivo válido. Normalmente você não deve substituir o valor padrão, a menos que deseja que o asdf ignore os arquivos `.tool-versions`.
|
||||
- `ASDF_DIR` - O padrão é `~/.asdf` - Localização dos arquivos `asdf`. Se você instalar `asdf` em algum outro diretório, defina-o para esse diretório. Por exemplo, se você estiver instalando através do AUR, você deve definir isso para `/ opt / asdf-vm`.
|
||||
- `ASDF_DIR` - O padrão é `~/.asdf` - Localização dos arquivos `asdf`. Se você instalar `asdf` em algum outro diretório, defina-o para esse diretório. Por exemplo, se você estiver instalando através do AUR, você deve definir isso para `/opt/asdf-vm`.
|
||||
- `ASDF_DATA_DIR` - O padrão é `~/.asdf` - Local onde `asdf` instala plugins, correções e instalações. Pode ser definido para qualquer local antes de fornecer `asdf.sh` ou `asdf.fish` mencionado na seção acima. Para Elvish, isso pode ser definido acima de `use asdf`.
|
||||
|
||||
@ -2,23 +2,23 @@
|
||||
|
||||
> Hi, we've recently migrated our docs and added some new pages. If you would like to help translate this page, see the "Edit this page" link at the bottom of the page.
|
||||
|
||||
The core `asdf` command list is rather small, but can facilitate many workflows.
|
||||
A lista de comandos do núcleo `asdf` é bastante pequena, mas pode facilitar muitos fluxos de trabalho.
|
||||
|
||||
## Installation & Setup
|
||||
## Instalação e configuração
|
||||
|
||||
Covered in the [Getting Started](/pt-br/guide/getting-started.md) guide.
|
||||
Baseado no [Guia de Introdução](/pt-br/guide/getting-started.md).
|
||||
|
||||
## Exec
|
||||
## Execute
|
||||
|
||||
```shell:no-line-numbers
|
||||
asdf exec <command> [args...]
|
||||
```
|
||||
|
||||
Executes the command shim for the current version.
|
||||
Executa o comando shim para a versão atual
|
||||
|
||||
<!-- TODO: expand on this with example -->
|
||||
|
||||
## Env
|
||||
## Variável de Ambiente
|
||||
|
||||
```shell:no-line-numbers
|
||||
asdf env <command> [util]
|
||||
@ -26,13 +26,13 @@ asdf env <command> [util]
|
||||
|
||||
<!-- TODO: expand on this with example -->
|
||||
|
||||
## Info
|
||||
## Informações
|
||||
|
||||
```shell:no-line-numbers
|
||||
asdf info
|
||||
```
|
||||
|
||||
A helper command to print the OS, Shell and `asdf` debug information. Share this when making a bug report.
|
||||
Um comando auxiliar para imprimir as informações de depuração do SO, Shell e `asdf`. Compartilhe isso ao fazer um relatório de bug.
|
||||
|
||||
## Reshim
|
||||
|
||||
@ -40,17 +40,17 @@ A helper command to print the OS, Shell and `asdf` debug information. Share this
|
||||
asdf reshim <name> <version>
|
||||
```
|
||||
|
||||
This recreates the shims for the current version of a package. By default, shims are created by plugins during installation of a tool. Some tools like the [npm CLI](https://docs.npmjs.com/cli/) allow global installation of executables, for example, installing [Yarn](https://yarnpkg.com/) via `npm install -g yarn`. Since this executable was not installed via the plugin lifecycle, no shim exists for it yet. `asdf reshim nodejs <version>` will force recalculation of shims for any new executables, like `yarn`, for `<version>` of `nodejs` .
|
||||
Isso recria os shims para a versão atual de um pacote. Por padrão, os calços são criados por plugins durante a instalação de uma ferramenta. Algumas ferramentas como a [npm CLI](https://docs.npmjs.com/cli/) permitem a instalação global de executáveis, por exemplo, instalando [Yarn](https://yarnpkg.com/) via `npm install -g fio`. Como este executável não foi instalado por meio do ciclo de vida do plug-in, ainda não existe shim para ele. `asdf reshim nodejs <version>` forçará o recálculo de shims para quaisquer novos executáveis, como `yarn`, para `<version>` de `nodejs`.
|
||||
|
||||
## Shim-versions
|
||||
## Versionamento do Shim
|
||||
|
||||
```shell:no-line-numbers
|
||||
asdf shim-versions <command>
|
||||
```
|
||||
|
||||
Lists the plugins and versions that provide shims for a command.
|
||||
Lista os plugins e versões que fornecem shims para um comando.
|
||||
|
||||
As an example, [Node.js](https://nodejs.org/) ships with two executables, `node` and `npm`. When many versions of the tools are installed with [`asdf-nodejs`](https://github.com/asdf-vm/asdf-nodejs/) `shim-versions` can return:
|
||||
Como exemplo, o [Node.js](https://nodejs.org/) vem com dois executáveis, `node` e `npm`. Quando muitas versões das ferramentas são instaladas com [`asdf-nodejs`](https://github.com/asdf-vm/asdf-nodejs/) `shim-versions` pode retornar:
|
||||
|
||||
```shell:no-line-numbers
|
||||
➜ asdf shim-versions node
|
||||
@ -68,7 +68,7 @@ nodejs 16.5.0
|
||||
|
||||
## Atualizar
|
||||
|
||||
`asdf` has a built in command to update which relies on Git (our recommended installation method). If you installed using a different method you should follow the steps for that method:
|
||||
`asdf` tem um comando embutido para atualização que depende do Git (nosso método de instalação recomendado). Se você instalou usando um método diferente, siga as etapas para esse método:
|
||||
|
||||
| Method | Latest Stable Release | Latest commit on `master` |
|
||||
| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- |
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
|
||||
Plugins são como `asdf` sabe lidar com diferentes ferramentas, tais quais Node.js, Ruby, Elixir etc.
|
||||
|
||||
See [Creating Plugins](/pt-br/plugins/create.md) for the plugin API used to support more tools.
|
||||
Veja [Criando Plugins](/pt-br/plugins/create.md) para a API do plugin usada para suportar mais ferramentas.
|
||||
|
||||
## Adicionar
|
||||
|
||||
@ -48,8 +48,8 @@ asdf plugin list --urls
|
||||
asdf plugin list all
|
||||
```
|
||||
|
||||
See [Plugins Shortname Index](https://github.com/asdf-vm/asdf-plugin-template) for the entire short-name list of plugins.
|
||||
|
||||
Veja [Plugins Shortname Index](https://github.com/asdf-vm/asdf-plugin-template) para toda a lista de nomes curtos de plugins.
|
||||
|
||||
## Atualizar
|
||||
|
||||
```shell:no-line-numbers
|
||||
|
||||
@ -1,100 +1,101 @@
|
||||
# Create a Plugin
|
||||
# Criar um plug-in
|
||||
|
||||
> Hi, we've recently migrated our docs and added some new pages. If you would like to help translate this page, see the "Edit this page" link at the bottom of the page.
|
||||
|
||||
## What's in a Plugin
|
||||
## O que há em um plug-in
|
||||
|
||||
A plugin is a git repo, with a couple executable scripts, to support versioning another language or tool. These scripts are run when `list-all`, `install` or `uninstall` commands are run. You can set or unset env vars and do anything required to setup the environment for the tool.
|
||||
Um plugin é um repositório git, com alguns scripts executáveis, para dar suporte ao versionamento de outra linguagem ou ferramenta. Esses scripts são executados quando os comandos `list-all`, `install` ou `uninstall` são executados. Você pode definir ou desmarcar env vars e fazer qualquer coisa necessária para configurar o ambiente para a ferramenta.
|
||||
|
||||
## Required Scripts
|
||||
## Scripts obrigatórios
|
||||
|
||||
- `bin/list-all` - lists all installable versions
|
||||
- `bin/download` - download source code or binary for the specified version
|
||||
- `bin/install` - installs the specified version
|
||||
|
||||
## Environment Variables
|
||||
- `bin/list-all` - lista todas as versões instaláveis
|
||||
- `bin/download` - baixe o código fonte ou binário para a versão especificada
|
||||
- `bin/install` - instala a versão especificada
|
||||
|
||||
All scripts except `bin/list-all` will have access to the following env vars to act upon:
|
||||
## Variavéis de Ambiente
|
||||
|
||||
- `ASDF_INSTALL_TYPE` - `version` or `ref`
|
||||
- `ASDF_INSTALL_VERSION` - if `ASDF_INSTALL_TYPE` is `version` then this will be the version number. Else it will be the git ref that is passed. Might point to a tag/commit/branch on the repo.
|
||||
- `ASDF_INSTALL_PATH` - the dir where the it _has been_ installed (or _should_ be installed in case of the `bin/install` script)
|
||||
Todos os scripts, exceto `bin/list-all`, terão acesso aos seguintes env vars para agir:
|
||||
|
||||
These additional environment variables will be available to the `bin/install` script:
|
||||
- `ASDF_INSTALL_TYPE` - `version` ou `ref`
|
||||
- `ASDF_INSTALL_VERSION` - se `ASDF_INSTALL_TYPE` é `version` então este será o número da versão. Caso contrário, será o git ref que será passado. Pode apontar para uma tag/commit/branch no repositório.
|
||||
- `ASDF_INSTALL_PATH` - o diretório onde _foi_ instalado (ou _deve_ ser instalado no caso do script `bin/install`)
|
||||
|
||||
- `ASDF_CONCURRENCY` - the number of cores to use when compiling the source code. Useful for setting `make -j`.
|
||||
- `ASDF_DOWNLOAD_PATH` - the path to where the source code or binary was downloaded by the `bin/download` script.
|
||||
Essas variáveis de ambiente adicionais estarão disponíveis para o script `bin/install`:
|
||||
|
||||
These additional environment variables will be available to the `bin/download` script:
|
||||
- `ASDF_CONCURRENCY` - o número de núcleos a serem usados ao compilar o código-fonte. Útil para definir `make -j`.
|
||||
- `ASDF_DOWNLOAD_PATH` - o caminho para onde o código fonte ou binário foi baixado pelo script `bin/download`.
|
||||
|
||||
- `ASDF_DOWNLOAD_PATH` - the path to where the source code or binary should be downloaded.
|
||||
Essas variáveis de ambiente adicionais estarão disponíveis para o script `bin/download`:
|
||||
|
||||
- `ASDF_DOWNLOAD_PATH` - o caminho para onde o código-fonte ou binário deve ser baixado.
|
||||
|
||||
#### bin/list-all
|
||||
|
||||
Must print a string with a space-separated list of versions. Example output would be the following:
|
||||
Deve imprimir uma string com uma lista de versões separadas por espaço. A saída de exemplo seria a seguinte:
|
||||
|
||||
```shell
|
||||
1.0.1 1.0.2 1.3.0 1.4
|
||||
```
|
||||
|
||||
Note that the newest version should be listed last so it appears closer to the user's prompt. This is helpful since the `list-all` command prints each version on it's own line. If there are many versions it's possible the early versions will be off screen.
|
||||
Observe que a versão mais recente deve ser listada por último para que apareça mais próxima do prompt do usuário. Isso é útil já que o comando `list-all` imprime cada versão em sua própria linha. Se houver muitas versões, é possível que as primeiras versões fiquem fora da tela.
|
||||
|
||||
If versions are being pulled from releases page on a website it's recommended to not sort the versions if at all possible. Often the versions are already in the correct order or, in reverse order, in which case something like `tac` should suffice. If you must sort versions manually you cannot rely on `sort -V` since it is not supported on OSX. An alternate sort function [like this is a better choice](https://github.com/vic/asdf-idris/blob/master/bin/list-all#L6).
|
||||
Se as versões estiverem sendo extraídas da página de lançamentos em um site, é recomendável não classificar as versões, se possível. Muitas vezes as versões já estão na ordem correta ou, na ordem inversa, nesse caso algo como `tac` deve ser suficiente. Se você precisar classificar as versões manualmente, não poderá confiar em `sort -V`, pois não é suportado no OSX. Uma função de classificação alternativa [como esta é uma escolha melhor](https://github.com/vic/asdf-idris/blob/master/bin/list-all#L6).
|
||||
|
||||
#### bin/download
|
||||
|
||||
This script must download the source or binary, in the path contained in the `ASDF_DOWNLOAD_PATH` environment variable. If the downloaded source or binary is compressed, only the uncompressed source code or binary may be placed in the `ASDF_DOWNLOAD_PATH` directory.
|
||||
Este script deve baixar o código fonte ou binário, no caminho contido na variável de ambiente `ASDF_DOWNLOAD_PATH`. Se o código-fonte ou binário baixado estiver compactado, apenas o código-fonte ou binário descompactado poderá ser colocado no diretório `ASDF_DOWNLOAD_PATH`.
|
||||
|
||||
The script must exit with a status of `0` when the download is successful. If the download fails the script must exit with any non-zero exit status.
|
||||
O script deve sair com um status de `0` quando o download for bem-sucedido. Se o download falhar, o script deve sair com qualquer status de saída diferente de zero.
|
||||
|
||||
If possible the script should only place files in the `ASDF_DOWNLOAD_PATH`. If the download fails no files should be placed in the directory.
|
||||
Se possível, o script deve apenas colocar arquivos no `ASDF_DOWNLOAD_PATH`. Se o download falhar, nenhum arquivo deve ser colocado no diretório.
|
||||
|
||||
If this script is not present asdf will assume that the `bin/install` script is present and will download and install the version. asdf only works without this script to support legacy plugins. All plugins must include this script, and eventually support for legacy plugins will be removed.
|
||||
Se este script não estiver presente, o asdf assumirá que o script `bin/install` está presente e fará o download e instalará a versão. asdf só funciona sem este script para suportar plugins legados. Todos os plugins devem incluir este script e, eventualmente, o suporte para plugins legados será removido.
|
||||
|
||||
#### bin/install
|
||||
|
||||
This script should install the version, in the path mentioned in `ASDF_INSTALL_PATH`. By default, asdf will create shims for any files in `$ASDF_INSTALL_PATH/bin` (this can be customized with the optional [bin/list-bin-paths](#binlist-bin-paths) script).
|
||||
Este script deve instalar a versão, no caminho mencionado em `ASDF_INSTALL_PATH`. Por padrão, o asdf criará shims para qualquer arquivo em `$ASDF_INSTALL_PATH/bin` (isso pode ser personalizado com o script opcional [bin/list-bin-paths](#binlist-bin-paths)).
|
||||
|
||||
The install script should exit with a status of `0` when the installation is successful. If the installation fails the script should exit with any non-zero exit status.
|
||||
O script de instalação deve sair com um status de `0` quando a instalação for bem-sucedida. Se a instalação falhar, o script deve sair com qualquer status de saída diferente de zero.
|
||||
|
||||
If possible the script should only place files in the `ASDF_INSTALL_PATH` directory once the build and installation of the tool is deemed successful by the install script. asdf [checks for the existence](https://github.com/asdf-vm/asdf/blob/242d132afbf710fe3c7ec23c68cec7bdd2c78ab5/lib/utils.sh#L44) of the `ASDF_INSTALL_PATH` directory in order to determine if that version of the tool is installed. If the `ASDF_INSTALL_PATH` directory is populated at the beginning of the installation process other asdf commands run in other terminals during the installation may consider that version of the tool installed, even when it is not fully installed.
|
||||
Se possível, o script deve apenas colocar os arquivos no diretório `ASDF_INSTALL_PATH` uma vez que a compilação e instalação da ferramenta são consideradas bem sucedidas pelo script de instalação. asdf [verifica a existência](https://github.com/asdf-vm/asdf/blob/242d132afbf710fe3c7ec23c68cec7bdd2c78ab5/lib/utils.sh#L44) do diretório `ASDF_INSTALL_PATH` para determinar se essa versão da ferramenta está instalado. Se o diretório `ASDF_INSTALL_PATH` for preenchido no início do processo de instalação, outros comandos asdf executados em outros terminais durante a instalação podem considerar essa versão da ferramenta instalada, mesmo quando não estiver totalmente instalada.
|
||||
|
||||
If you want your plugin to work with asdf version 0.7._ and earlier and version 0.8._ and newer check for the presence of the `ASDF_DOWNLOAD_PATH` environment variable. If it is not set download the source code in the bin/install callback. If it is set assume the `bin/download` script already downloaded it.
|
||||
Se você quiser que seu plugin funcione com asdf versão 0.7._ e anterior e versão 0.8._ e mais recente, verifique a presença da variável de ambiente `ASDF_DOWNLOAD_PATH`. Se não estiver definido, baixe o código-fonte no retorno de chamada bin/install. Se estiver definido, suponha que o script `bin/download` já tenha baixado.
|
||||
|
||||
## Optional Scripts
|
||||
## Scripts Opcional
|
||||
|
||||
#### bin/help scripts
|
||||
#### scripts bin/help
|
||||
|
||||
This is not one callback script but rather a set of callback scripts that each print different documentation to STDOUT. The possible callback scripts are listed below. Note that `bin/help.overview` is a special case as it must be present for any help output to be displayed for the script.
|
||||
Este não é um script de retorno de chamada, mas sim um conjunto de scripts de retorno de chamada que imprimem documentação diferente para STDOUT. Os scripts de retorno de chamada possíveis estão listados abaixo. Observe que `bin/help.overview` é um caso especial, pois deve estar presente para que qualquer saída de ajuda seja exibida para o script.
|
||||
|
||||
- `bin/help.overview` - This script should output a general description about the plugin and the tool being managed. No heading should be printed as asdf will print headings. Output may be free-form text but ideally only one short paragraph. This script must be present if you want asdf to provide help information for your plugin. All other help callback scripts are optional.
|
||||
- `bin/help.deps` - This script should output the list of dependencies tailored to the operating system. One dependency per line.
|
||||
- `bin/help.config` - This script should print any required or optional configuration that may be available for the plugin and tool. Any environment variables or other flags needed to install or compile the tool (for the users operating system when possible). Output can be free-form text.
|
||||
- `bin/help.links` - This should be a list of links relevant to the plugin and tool (again, tailored to the current operating system when possible). One link per line. Lines may be in the format `<title>: <link>` or just `<link>`.
|
||||
- `bin/help.overview` - Este script deve gerar uma descrição geral sobre o plugin e a ferramenta que está sendo gerenciada. Nenhum título deve ser impresso, pois o asdf imprimirá títulos. A saída pode ser um texto de formato livre, mas idealmente apenas um parágrafo curto. Este script deve estar presente se você quiser que o asdf forneça informações de ajuda para seu plugin. Todos os outros scripts de retorno de chamada de ajuda são opcionais.
|
||||
- `bin/help.deps` - Esse script deve gerar a lista de dependências adaptadas ao sistema operacional. Uma dependência por linha.
|
||||
- `bin/help.config` - Este script deve imprimir qualquer configuração obrigatória ou opcional que possa estar disponível para o plug-in e a ferramenta. Quaisquer variáveis de ambiente ou outros sinalizadores necessários para instalar ou compilar a ferramenta (para o sistema operacional dos usuários quando possível). A saída pode ser texto de formato livre.
|
||||
- `bin/help.links` - Esta deve ser uma lista de links relevantes para o plug-in e a ferramenta (mais uma vez, adaptados ao sistema operacional atual, quando possível). Um link por linha. As linhas podem estar no formato `<title>: <link>` ou apenas `<link>`.
|
||||
|
||||
Each of these scripts should tailor their output to the current operating system. For example, when on Ubuntu the deps script could output the dependencies as apt-get packages that must be installed. The script should also tailor its output to the value of `ASDF_INSTALL_VERSION` and `ASDF_INSTALL_TYPE` when the variables are set. They are optional and will not always be set.
|
||||
Cada um desses scripts deve adaptar sua saída ao sistema operacional atual. Por exemplo, quando no Ubuntu, o script deps pode gerar as dependências como pacotes apt-get que devem ser instalados. O script também deve adaptar sua saída ao valor de `ASDF_INSTALL_VERSION` e `ASDF_INSTALL_TYPE` quando as variáveis forem definidas. Eles são opcionais e nem sempre serão definidos.
|
||||
|
||||
The help callback script MUST NOT output any information that is already covered in the core asdf-vm documentation. General asdf usage information must not be present.
|
||||
O script de retorno de chamada de ajuda NÃO DEVE gerar nenhuma informação que já esteja coberta na documentação principal do asdf-vm. As informações gerais de uso do asdf não devem estar presentes.
|
||||
|
||||
#### bin/list-bin-paths
|
||||
|
||||
List executables for the specified version of the tool. Must print a string with a space-separated list of dir paths that contain executables. The paths must be relative to the install path passed. Example output would be:
|
||||
Liste os executáveis para a versão especificada da ferramenta. Deve imprimir uma string com uma lista separada por espaços de caminhos de diretórios que contêm executáveis. Os caminhos devem ser relativos ao caminho de instalação passado. A saída de exemplo seria:
|
||||
|
||||
```shell
|
||||
bin tools veggies
|
||||
```
|
||||
|
||||
This will instruct asdf to create shims for the files in `<install-path>/bin`, `<install-path>/tools` and `<install-path>/veggies`
|
||||
Isso instruirá o asdf a criar shims para os arquivos em `<install-path>/bin`, `<install-path>/tools` e `<install-path>/veggies`
|
||||
|
||||
If this script is not specified, asdf will look for the `bin` dir in an installation and create shims for those.
|
||||
Se este script não for especificado, o asdf procurará o diretório `bin` em uma instalação e criará shims para eles.
|
||||
|
||||
#### bin/exec-env
|
||||
|
||||
Setup the env to run the binaries in the package.
|
||||
Configure o env para executar os binários no pacote.
|
||||
|
||||
#### bin/exec-path
|
||||
|
||||
Get the executable path for the specified version of the tool. Must print a string with the relative executable path. This allows the plugin to conditionally override the shim's specified executable path, otherwise return the default path specified by the shim.
|
||||
Obtenha o caminho executável para a versão especificada da ferramenta. Deve imprimir uma string com o caminho executável relativo. Isso permite que o plug-in substitua condicionalmente o caminho executável especificado do shim, caso contrário, retorne o caminho padrão especificado pelo shim.
|
||||
|
||||
```shell
|
||||
Usage:
|
||||
@ -109,29 +110,29 @@ Output:
|
||||
|
||||
#### bin/uninstall
|
||||
|
||||
Uninstalls a specific version of a tool.
|
||||
Desinstala uma versão específica de uma ferramenta.
|
||||
|
||||
#### bin/list-legacy-filenames
|
||||
|
||||
Register additional setter files for this plugin. Must print a string with a space-separated list of filenames.
|
||||
Registre arquivos setter adicionais para este plugin. Deve imprimir uma string com uma lista de nomes de arquivos separados por espaços.
|
||||
|
||||
```shell
|
||||
.ruby-version .rvmrc
|
||||
```
|
||||
|
||||
Note: This will only apply for users who have enabled the `legacy_version_file` option in their `~/.asdfrc`.
|
||||
Nota: Isso só se aplica a usuários que habilitaram a opção `legacy_version_file` em seu `~/.asdfrc`.
|
||||
|
||||
#### bin/parse-legacy-file
|
||||
|
||||
This can be used to further parse the legacy file found by asdf. If `parse-legacy-file` isn't implemented, asdf will simply cat the file to determine the version. The script will be passed the file path as its first argument.
|
||||
Isso pode ser usado para analisar ainda mais o arquivo legado encontrado pelo asdf. Se o `parse-legacy-file` não for implementado, o asdf simplesmente irá cat o arquivo para determinar a versão. O script receberá o caminho do arquivo como seu primeiro argumento.
|
||||
|
||||
#### bin/post-plugin-add
|
||||
|
||||
This can be used to run any post-installation actions after the plugin has been added to asdf.
|
||||
Isso pode ser usado para executar qualquer ação pós-instalação depois que o plug-in for adicionado ao asdf.
|
||||
|
||||
The script has access to the path the plugin was installed (`${ASDF_PLUGIN_PATH}`) and the source URL (`${ASDF_PLUGIN_SOURCE_URL}`), if any was used.
|
||||
O script tem acesso ao caminho em que o plugin foi instalado (`${ASDF_PLUGIN_PATH}`) e o URL de origem (`${ASDF_PLUGIN_SOURCE_URL}`), se algum foi usado.
|
||||
|
||||
See also the related hooks:
|
||||
Veja também os ganchos relacionados:
|
||||
|
||||
- `pre_asdf_plugin_add`
|
||||
- `pre_asdf_plugin_add_${plugin_name}`
|
||||
@ -140,23 +141,23 @@ See also the related hooks:
|
||||
|
||||
#### bin/pre-plugin-remove
|
||||
|
||||
This can be used to run any pre-removal actions before the plugin will be removed from asdf.
|
||||
Isso pode ser usado para executar qualquer ação de pré-remoção antes que o plug-in seja removido do asdf.
|
||||
|
||||
The script has access to the path the plugin was installed in (`${ASDF_PLUGIN_PATH}`).
|
||||
O script tem acesso ao caminho em que o plugin foi instalado (`${ASDF_PLUGIN_PATH}`).
|
||||
|
||||
See also the related hooks:
|
||||
Veja também os ganchos relacionados:
|
||||
|
||||
- `pre_asdf_plugin_remove`
|
||||
- `pre_asdf_plugin_remove_${plugin_name}`
|
||||
- `post_asdf_plugin_remove`
|
||||
- `post_asdf_plugin_remove_${plugin_name}`
|
||||
|
||||
## Extension commands for asdf CLI.
|
||||
## Comandos de extensão para asdf CLI.
|
||||
|
||||
It's possible for plugins to define new asdf commands by providing `lib/commands/command*.bash` scripts or executables that
|
||||
will be callable using the asdf command line interface by using the plugin name as a subcommand.
|
||||
|
||||
For example, suppose a `foo` plugin has:
|
||||
É possível que plugins definam novos comandos asdf fornecendo scripts ou executáveis `lib/commands/command*.bash` que será chamado usando a interface de linha de comando asdf usando o nome do plug-in como um subcomando.
|
||||
|
||||
Por exemplo, suponha que um plugin `foo` tenha:
|
||||
|
||||
```shell
|
||||
foo/
|
||||
@ -167,7 +168,7 @@ foo/
|
||||
command-help.bash
|
||||
```
|
||||
|
||||
Users can now execute
|
||||
Os usuários agora podem executar
|
||||
|
||||
```shell
|
||||
$ asdf foo # same as running `$ASDF_DATA_DIR/plugins/foo/lib/commands/command.bash`
|
||||
@ -177,53 +178,53 @@ $ asdf foo bat man # same as running `$ASDF_DATA_DIR/plugins/foo/lib/commands/co
|
||||
$ asdf foo bat baz # same as running `$ASDF_DATA_DIR/plugins/foo/lib/commands/command-bat.bash baz`
|
||||
```
|
||||
|
||||
Plugin authors can use this feature to provide utilities related to their tools,
|
||||
or even create plugins that are just new command extensions for asdf itself.
|
||||
Os autores de plugins podem usar esse recurso para fornecer utilitários relacionados às suas ferramentas,
|
||||
ou até mesmo criar plugins que são apenas novas extensões de comando para o próprio asdf.
|
||||
|
||||
When invoked, if extension commands do not have their executable-bit set, they will be
|
||||
sourced as bash scripts, having all of the functions from `$ASDF_DIR/lib/utils.bash` available.
|
||||
Also, the `$ASDF_CMD_FILE` resolves to the full path of the file being sourced.
|
||||
If the executable bit is set, they are just executed and replace the asdf execution.
|
||||
Quando invocados, se os comandos de extensão não tiverem seus bits executáveis definidos, eles serão
|
||||
originado como scripts bash, tendo todas as funções de `$ASDF_DIR/lib/utils.bash` disponíveis.
|
||||
Além disso, o `$ASDF_CMD_FILE` resolve para o caminho completo do arquivo que está sendo originado.
|
||||
Se o bit executável estiver definido, eles são apenas executados e substituem a execução do asdf.
|
||||
|
||||
A good example of this feature is for plugins like [`haxe`](https://github.com/asdf-community/asdf-haxe)
|
||||
which provides the `asdf haxe neko-dylibs-link` to fix an issue where haxe executables expect to find
|
||||
dynamic libraries relative to the executable directory.
|
||||
Um bom exemplo desse recurso é para plugins como [`haxe`](https://github.com/asdf-community/asdf-haxe)
|
||||
que fornece o `asdf haxe neko-dylibs-link` para corrigir um problema onde os executáveis haxe esperam encontrar
|
||||
bibliotecas dinâmicas relativas ao diretório executável.
|
||||
|
||||
If your plugin provides an asdf extension command, be sure to mention about it on your plugin's README.
|
||||
Se o seu plug-in fornecer um comando de extensão asdf, certifique-se de mencioná-lo no README do seu plug-in.
|
||||
|
||||
## Custom shim templates
|
||||
## Modelos de calços personalizados
|
||||
|
||||
**PLEASE use this feature only if absolutely required**
|
||||
**POR FAVOR, use este recurso apenas se for absolutamente necessário**
|
||||
|
||||
asdf allows custom shim templates. For an executable called `foo`, if there's a `shims/foo` file in the plugin, then asdf will copy that file instead of using it's standard shim template.
|
||||
asdf permite modelos de calços personalizados. Para um executável chamado `foo`, se houver um arquivo `shims/foo` no plug-in, o asdf copiará esse arquivo em vez de usar seu modelo padrão de shim.
|
||||
|
||||
This must be used wisely. For now AFAIK, it's only being used in the Elixir plugin, because an executable is also read as an Elixir file apart from just being an executable. Which makes it not possible to use the standard bash shim.
|
||||
Isso deve ser usado com sabedoria. Por enquanto AFAIK, está sendo usado apenas no plugin Elixir, porque um executável também é lido como um arquivo Elixir, além de ser apenas um executável. O que torna impossível usar o calço bash padrão.
|
||||
|
||||
## Testing plugins
|
||||
## Testando plug-ins
|
||||
|
||||
`asdf` contains the `plugin-test` command to test your plugin. You can use it as follows
|
||||
`asdf` contém o comando `plugin-test` para testar seu plugin. Você pode usá-lo da seguinte forma
|
||||
|
||||
```shell
|
||||
asdf plugin test <plugin-name> <plugin-url> [--asdf-tool-version <version>] [--asdf-plugin-gitref <git-ref>] [test-command*]
|
||||
```
|
||||
|
||||
Only the two first arguments are required.
|
||||
If \__version_ is specified, the tool will be installed with that specific version. Defaults to whatever returns `asdf latest <plugin-name>`.
|
||||
If _git-ref_ is specified, the plugin itself is checked out at that commit/branch/tag, useful for testing a pull-request on your plugin's CI.
|
||||
Apenas os dois primeiros argumentos são necessários.
|
||||
Se \__version_ for especificado, a ferramenta será instalada com essa versão específica. O padrão é o que retorna `asdf mais recente <plugin-name>`.
|
||||
Se _git-ref_ for especificado, o plug-in em si é verificado nesse commit/branch/tag, útil para testar um pull-request no CI do seu plug-in.
|
||||
|
||||
Rest arguments are considered the command to execute to ensure the installed tool works correctly.
|
||||
Normally it would be something that takes `--version` or `--help`.
|
||||
For example, to test the NodeJS plugin, we could run
|
||||
Os argumentos Rest são considerados o comando a ser executado para garantir que a ferramenta instalada funcione corretamente.
|
||||
Normalmente seria algo que leva `--version` ou `--help`.
|
||||
Por exemplo, para testar o plugin NodeJS, podemos executar
|
||||
|
||||
```shell
|
||||
asdf plugin test nodejs https://github.com/asdf-vm/asdf-nodejs.git node --version
|
||||
```
|
||||
|
||||
We strongly recommend you test your plugin on a CI environment and make sure it works on both Linux and OSX.
|
||||
É altamente recomendável que você teste seu plug-in em um ambiente CI e verifique se ele funciona no Linux e no OSX.
|
||||
|
||||
#### Example GitHub Action
|
||||
#### Exemplo GitHub Action
|
||||
|
||||
The [asdf-vm/actions](https://github.com/asdf-vm/actions) repo provides a GitHub Action for testing your plugins hosted on github.
|
||||
O repositório [asdf-vm/actions](https://github.com/asdf-vm/actions) fornece uma ação do GitHub para testar seus plugins hospedados no github.
|
||||
|
||||
```yaml
|
||||
steps:
|
||||
@ -235,9 +236,9 @@ steps:
|
||||
GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }} # automatically provided
|
||||
```
|
||||
|
||||
#### Example TravisCI config
|
||||
#### Exemplo de configuração do TravisCI
|
||||
|
||||
Here is a sample `.travis.yml` file, customize it to your needs
|
||||
Aqui está um arquivo `.travis.yml` de amostra, personalize-o de acordo com suas necessidades
|
||||
|
||||
```yaml
|
||||
language: c
|
||||
@ -250,22 +251,22 @@ os:
|
||||
- osx
|
||||
```
|
||||
|
||||
Note:
|
||||
When using another CI, you will need to check what variable maps to the repo path.
|
||||
Notas:
|
||||
Ao usar outro IC, você precisará verificar qual variável mapeia para o caminho do repositório.
|
||||
|
||||
You also have the option to pass a relative path to `plugin-test`.
|
||||
Você também tem a opção de passar um caminho relativo para `plugin-test`.
|
||||
|
||||
For example, if the test script is ran in the repo directory: `asdf plugin test nodejs . 'node --version'`.
|
||||
Por exemplo, se o script de teste for executado no diretório: `asdf plugin test nodejs . 'node --version'`.
|
||||
|
||||
## GitHub API Rate Limiting
|
||||
## Limitação de taxa da API do GitHub
|
||||
|
||||
If your plugin's `list-all` depends on accessing the GitHub API, make sure you provide an Authorization token when accessing it, otherwise your tests might fail due to rate limiting.
|
||||
Se o `list-all` do seu plug-in depender do acesso à API do GitHub, certifique-se de fornecer um token de autorização ao acessá-lo, caso contrário, seus testes podem falhar devido à limitação de taxa.
|
||||
|
||||
To do so, create a [new personal token](https://github.com/settings/tokens/new) with only `public_repo` access.
|
||||
Para fazer isso, crie um [novo token pessoal](https://github.com/settings/tokens/new) com apenas acesso `public_repo`.
|
||||
|
||||
Then on your travis.ci build settings add a _secure_ environment variable for it named something like `GITHUB_API_TOKEN`. And _DO NOT_ EVER publish your token in your code.
|
||||
Em seguida, nas configurações de compilação do travis.ci, adicione uma variável de ambiente _secure_ para ela chamada algo como `GITHUB_API_TOKEN`. E _NUNCA_ publique seu token em seu código.
|
||||
|
||||
Finally, add something like the following to `bin/list-all`
|
||||
Finalmente, adicione algo como o seguinte para `bin/list-all`
|
||||
|
||||
```shell
|
||||
cmd="curl -s"
|
||||
@ -276,10 +277,10 @@ fi
|
||||
cmd="$cmd $releases_path"
|
||||
```
|
||||
|
||||
## Submitting plugins to the official plugins repository
|
||||
## Enviando plugins para o repositório oficial de plugins
|
||||
|
||||
`asdf` can easily install plugins by specifying the plugin repository url, e.g. `plugin add my-plugin https://github.com/user/asdf-my-plugin.git`.
|
||||
`asdf` pode facilmente instalar plugins especificando o url do repositório de plugins, por exemplo. `plugin add my-plugin https://github.com/user/asdf-my-plugin.git`.
|
||||
|
||||
To make it easier on your users, you can add your plugin to the official plugins repository to have your plugin listed and easily installable using a shorter command, e.g. `asdf plugin add my-plugin`.
|
||||
Para facilitar para seus usuários, você pode adicionar seu plugin ao repositório oficial de plugins para ter seu plugin listado e facilmente instalável usando um comando mais curto, por exemplo `asdf plugin add my-plugin`.
|
||||
|
||||
Follow the instruction at the plugins repository: [asdf-vm/asdf-plugins](https://github.com/asdf-vm/asdf-plugins).
|
||||
Siga as instruções no repositório de plugins: [asdf-vm/asdf-plugins](https://github.com/asdf-vm/asdf-plugins).
|
||||
|
||||
Loading…
Reference in New Issue
Block a user