Commit Graph

191 Commits

Author SHA1 Message Date
Amar Sood
55f43e3546
docs: fish symlink completions rather than copying (#860) 2021-02-07 18:38:40 +11:00
James Hegedus
7deedad304
docs: update bats link to bats-core org 2021-02-02 15:16:40 +11:00
Robert Buchberger
f4acfa7d02
docs: explain ASDF_DIR (#855) 2021-01-25 09:02:23 +11:00
Hyunwoo Park
bdace81ae9
docs: fix GitHub typo (#847) 2021-01-13 08:41:33 +11:00
Trevor Brown
f55fca4e94
Merge pull request #839 from jthegedus/docs/link-github-discussions
docs: github dicsussions link
2021-01-04 09:39:03 -05:00
N1H1L0
954a5db19d
docs: improve zsh completion directions for macOS,ZSH,Homebrew (#843) 2020-12-31 11:53:18 +11:00
jthegedus
05a7f15dca docs: github dicsussions link 2020-12-18 17:31:27 +11:00
Dan Jackson
84f4301736
Fix broken image link for GitHub icon
icongram.jgog.in is returning a 525 error through cloudflare for me. As far as I can tell, it has switched to icongr.am

This also matches the icon on the StackOverflow Tag link.
2020-11-17 22:45:57 -08:00
James Hegedus
11b5403abb
chore: remove -vm from common usage as the tool is just asdf (#798) 2020-09-19 15:40:11 +10:00
Trevor Brown
c6145d08d0 Update version to 0.8.0 2020-09-07 20:16:35 -04:00
James Hegedus
96b87f4c96
docs: link to Homebrew common issues from documentation site (#795) 2020-09-08 09:07:17 +10:00
Trevor Brown
8745ae8a62 Add details on implementing backwards compatible plugins to documentation
Fixes #768
2020-09-07 11:00:54 -04:00
Dave Nicolson
1479ec83be
fix: fish init command (#792) 2020-09-01 08:10:50 +10:00
James Hegedus
cc929d2fdf
docs: link to our community and place(s) for q&a (#775) 2020-08-11 09:03:13 +10:00
Daniel Perez
f09532478b
Merge pull request #774 from jthegedus/docs/homebrew-prefix
fix: revert to cmds to precompute brew prefix on addition to shell config
2020-08-10 01:28:48 +01:00
James Hegedus
a76880d25a
fix: typo in subshell for fish instructions 2020-08-10 09:03:05 +10:00
James Hegedus
1a4c1c15b8 fix: revert to commands to precompute brew prefix on addition to shell config 2020-08-09 22:57:50 +00:00
Trevor Brown
e0142eed55 Update version to 0.8.0-rc1 2020-07-31 09:01:41 -04:00
Trevor Brown
cc0023b022
feat: plugin documentation callback support 🎉 (#757) 2020-07-31 18:47:18 +10:00
Trevor Brown
62d2d9cb8b
Merge pull request #760 from fajpunk/install-one-tool
Install one tool specified in .tool-versions
2020-07-15 08:38:23 -04:00
Dan Fuchs
6a1855e26f Install one tool specified in .tool-versions
`asdf install <name>` installs that single tool at the version specified
in `.tool-versions`.  If there is no `.tool-versions` or if that tool is
not in it, an error message is shown and `asdf` exits `1`.

Implements #759
2020-07-09 18:16:50 -05:00
Dan Fuchs
ae87dca99f Docs: Clarify shim creation for writing plugins 2020-07-09 09:51:19 -05:00
Kazuki Suda
15f7227933
Use v1 plugin-test action instead of v1.0.0 in document 2020-06-30 10:33:03 +09:00
James Hegedus
605be10046
docs: synchronize help text (#742) 2020-06-17 08:25:04 +10:00
Alexandre ZANNI
f5c7dae331
fix: asdf shell command docs & help output (#737)
Co-authored-by: James Hegedus <james@jthegedus.com>
2020-06-13 10:43:52 +10:00
James Hegedus
45fffa9ce3
docs: improve introduction and lift dependencies higher (#740) 2020-06-11 10:28:28 +10:00
raimon
a39f26cd0c Fix dead link by changing the extension to sh 2020-05-28 23:56:48 +09:00
Trevor Brown
a7252e687a
Merge pull request #669 from asdf-vm/tb/keep-source
Keep Source
2020-05-14 09:24:48 -04:00
Cal Jacobson
a90793547b
Fix typo in docs/core-manage-versions.md (#722) 2020-05-09 16:22:17 +10:00
Trevor Brown
2a058af9eb
Merge branch 'master' into tb/keep-source 2020-05-08 10:21:59 -04:00
Danny Guo
5003cbdc85
Fix a typo in the env command documentation (#717) 2020-04-30 19:21:19 +10:00
Alexandre ZANNI
ad73ea1fe2
docs: asdf dependencies for openSUSE and ArchLinux (#714) 2020-04-27 08:23:48 +10:00
James F McMahon
bdc7dd8aa8
Documentation: Fix Fish source syntax (#709) 2020-04-25 11:25:08 +10:00
Trevor Brown
4f2c6ad91d
Change plugin dependencies section to asdf dependencies (#710) 2020-04-25 11:24:32 +10:00
James Hegedus
678b3efc35
Documentation install section update (#699) 2020-04-21 11:34:45 +10:00
Trevor Brown
4a3e3d6ebd Update version to 0.7.8 2020-03-23 09:36:32 -04:00
Jochen Schalanda
3c3f0e67f6
Rename custom plugin-add/plugin-remove for plugins (#684)
Rename custom scripts for `plugin-add` and `plugin-remove` phases in plugins to make clear when they are executed:

`plugin-add` -> `post-plugin-add`
`plugin-remove` -> `pre-plugin-remove`
2020-03-22 12:57:54 +11:00
Jochen Schalanda
57186be6d9
Support customizing plugin-add and plugin-remove
* Add support for custom `plugin-add` and `plugin-remove` in plugins
* Add configurable command hooks for plugin installation and removal

```shell
pre_asdf_plugin_remove = echo will remove plugin ${1}
pre_asdf_plugin_remove_foo = echo will remove plugin foo
post_asdf_plugin_remove = echo removed plugin ${1}
post_asdf_plugin_remove_foo = echo removed plugin foo
```

Closes #670
2020-03-21 14:59:33 +01:00
James Hegedus
3246c26d52
fix: remove automatic compinit (#678)
* fix: remove automatic compinit

Raised by concerns in https://github.com/asdf-vm/asdf/issues/674 about performance implications and unexpected intrusive behaviour

* docs: fix ZSH compinit recommendations

* docs: clarify zsh completions further

* docs: fpath steps and notes on framework plugins

* docs: be verbose in explanation

* fix: remove fpath & compinit calls
2020-03-20 07:37:25 +11:00
Victor Borja
9536de6c4a
Remove old README. 2020-03-16 09:18:23 -06:00
Victor Borja
0dee6a7051
Fixes to extension commands documentation. 2020-03-16 08:28:55 -06:00
Victor Hugo Borja
a26bed6586 Make sure extension commands are properly displayed by asdf help 2020-03-15 11:45:09 -06:00
Trevor Brown
dd608b869c Add documentation on always_keep_download configuration option 2020-03-06 18:03:12 -05:00
Trevor Brown
09df6851dd fixup! Add documentation on new bin/download script 2020-03-06 18:03:12 -05:00
Trevor Brown
7bf33e8dfd Add documentation on new bin/download script 2020-03-06 18:03:12 -05:00
Trevor Brown
4b2b71a070 Update version to 0.7.7 2020-03-04 09:13:43 -05:00
Victor Borja
7cdfc0fa2a
Merge pull request #664 from asdf-vm/tb/file-extensions
Add .bash file extension to files executed by Bash
2020-03-02 14:39:26 -06:00
Trevor Brown
8b90d883ee Require .bash extension for plugin extension commands 2020-03-02 13:13:20 -05:00
Trevor Brown
52cbf1165c Add .bash file extensions to files containing code executed by Bash 2020-03-02 12:48:05 -05:00
James Hegedus
73c44e09ad improve zsh docs now we have our own completions 2020-02-19 16:09:06 -05:00
Phil Pennock
a8016c321d zsh-native asdf completion setup
Add a zsh-native completion system function for `asdf`.

I too often hit snags with bash completions in zsh, so I bias strongly
towards zsh-native completions.

This needs to end up in `$fpath` with a filename of `_asdf` but it
seemed unfriendly to use that name in this repo, so call it `_asdf.zsh`
and document a symlink.  Mark the file as executable to be compatible
with one convention of "personal functions should only autoload if
executable" (but that's probably so historic that very few people still
use it; I'm one of them, though).
2020-02-19 16:06:00 -05:00
James Hegedus
a409b334a9
Merge branch 'master' into master 2020-02-14 17:14:33 +11:00
Raul de Melo
4911678c5b docs: update example with maintained project url (#652) 2020-02-10 08:00:41 +11:00
Jesse Jackson
3a4342a6be Update examples using subcommands
Replace references to aliases in the form of
`command-subcommand` with `command subcommand`
2020-01-30 15:59:05 -06:00
Victor Hugo Borja
6207e42cec Update version to 0.7.6 2019-12-15 23:09:57 -06:00
Andrew Cole
5bb651af58
Update installation for Zsh on macOS Catalina 2019-12-09 11:17:44 -08:00
Aaron Ross
5ca74a8012
docs: update plugin-* usage 2019-12-08 21:18:09 -05:00
John Meguerian
743035d0d3
Add instructions to use latest branch with Homebrew
Related to #598 
this adds a line of instruction for how to install with homebrew and pull in the latest changes from master.
2019-12-02 11:00:08 -05:00
Victor Hugo Borja
41461b22df Mention asdf-vm/actions for testing plugins 2019-11-30 18:30:26 -06:00
Victor Hugo Borja
3d3595c7a3 Improvements to asdf plugin commands. 2019-11-30 14:18:37 -06:00
Victor Hugo Borja
100917c0e4 Add more commands to documentation. 2019-11-27 12:50:31 -06:00
Victor Borja
ced617fd64
Update core-commands.md 2019-11-27 12:41:14 -06:00
Victor Hugo Borja
367886e47d Update example commands to not use hypen and use subcommand CLI. 2019-11-27 12:25:34 -06:00
Victor Hugo Borja
64d7cac9fd Update documentation 2019-11-27 12:18:00 -06:00
Victor Hugo Borja
e72a92d1ef Remove outdated doc about shims metadata. 2019-11-25 14:39:56 -06:00
Victor Hugo Borja
a22733f819 Resolve asdf PLUGIN_NAME default command.
When calling `asdf foo` and the `foo` plugin provides a `bin/default-command`
2019-11-25 02:47:55 -06:00
Victor Hugo Borja
0e8e1f8f84 New feature: asdf extension commands
It's possible for plugins to define new asdf commands. This way plugins can extend asdf capabilities or expose utilities related to their managed tool.

For example, a `foo` plugin might expose the command `asdf foo bar` by providing an executable file at `bin/bar`.
If `bin/bar` is a file but has no executable bit set, then its considered a source-able bash script, and will be sourced
with all the functions in `$ASDF_DIR/lib/utils.sh` already loaded.

A good example of this feature is the `nodejs` plugin, where people must import the release team keyring before
installing a nodejs version. People can execute the following command without having to know where exactly is the plugin located.
2019-11-25 02:24:46 -06:00
Kevin Lane
48c53f24bd
Add documentation in core commands for managing latest stable versions 2019-11-22 10:37:53 -08:00
Kevin Lane
301cd3db3f
Add support for installing the latest stable version of a tool 2019-11-22 10:37:53 -08:00
Kevin Lane
36ba38d921
Add asdf latest command to show latest stable version of a tool 2019-11-22 10:37:52 -08:00
Kevin Lane
292d5951bd
Add ability to show available versions that begin with a given string 2019-11-22 10:37:46 -08:00
Trevor Brown
c3ad7e0357 Update version to 0.7.5 2019-11-04 19:42:50 -05:00
Victor Borja
e6909fa3cc
Mention asdf-direnv on shims section.
Many users might want not to use shims and would prefer the asdf environment be automatically set for them when entering the project directory. Add a link to asdf-direnv plugin README for more details on how to integrate asdf with direnv to achieve this.
2019-10-27 11:29:09 -06:00
Victor Borja
65e88bb39e
Fix documentation on Shim metadata.
Now the comment should include also the plugin version
2019-08-18 11:09:31 -05:00
Trevor Brown
58eaad8ebd Update version to 0.7.4 2019-08-14 22:42:05 -04:00
Daniel Perez
f80b66c2a4
Avoid adding brew command to fish init code 2019-07-23 13:34:51 +01:00
Daniel Perez
07211e3c37
Merge pull request #553 from olets/zshrc-optimization
Docs: Homebrew setup: do not add brew commands to the shell profile
2019-07-23 13:26:49 +01:00
Lee Dohm
d9a16e4f65
Add Homebrew instructions for fish shell 2019-07-22 10:34:44 -07:00
Henry Bley-Vroman
a72ceef299
Docs: Homebrew setup: do not add brew commands to the shell profile
The recommended Homebrew setup required adding two `brew --prefix` commands
to the shell profile. `brew` commands canbe slow, so this introduced a notable
lag when sourcing the shell profile.

Homebrew paths do not change, so we can determine the necessary paths one time
during setup and use static paths in the shell profile.
2019-07-22 10:12:44 -04:00
Daniel Perez
7b0035b720
Merge pull request #537 from HeroicEric/add-homebrew-zsh-instructions
Add Homebrew instructions for ZSH
2019-07-22 14:06:18 +01:00
Eric Kelly
69da8e51b4
Fix typo 2019-07-22 07:25:56 -04:00
Trevor Brown
ce01bcf849 Update version to 0.7.3 2019-07-13 17:32:13 -04:00
Eric Kelly
ef36046e93 Add Homebrew instructions for ZSH
Adds instructions for adding asdf to your shell when using zsh and
Homebrew.

This was mostly copied from https://github.com/asdf-vm/asdf/pull/496
2019-06-06 14:56:09 -07:00
Trevor Brown
ac2eede6bd Update version to 0.7.2 2019-05-18 16:32:41 -04:00
Stefan Sedich
59a9c03267 Add common plugin dependencies to getting started docs (#510)
* Add extra plugin dependencies

I found on a fresh Ubuntu install test that it pays to have unzip and curl installed for some of the asdf plugins to install properly so it seems to make sense adding these here to give a nicer getting started experience.

I do not have brew or spack handy to test but from what I can see these packages should exist.

* Update core-manage-asdf-vm.md
2019-04-10 09:15:15 +10:00
Daniel Perez
611fafbadc Update version to 0.7.1 2019-03-31 21:15:17 +01:00
Carsten Dreesbach
e9bc12c80c Fix verison typo 2019-03-26 08:36:50 -04:00
James Hegedus
510bcdb118
note legacy version files in core setup guide (#500)
as suggested in https://github.com/asdf-vm/asdf/issues/499
2019-03-26 10:31:08 +11:00
Trevor Brown
bc1d9cb2c2
Merge pull request #497 from asdf-vm/rc-releases
Add support for RC releases
2019-03-25 08:19:30 -04:00
Trevor Brown
85057b6969 Add support for RC versions to asdf update command 2019-03-24 18:24:19 -04:00
Damian Bouné
19167aafce Add Homebrew instructions for install and bash (#496) 2019-03-25 09:12:23 +11:00
Daniel Perez
5a89e48045
Merge pull request #495 from asdf-vm/fix-edit-on-github
Use custom edit on github plugin. Fix #469
2019-03-24 19:26:22 +00:00
Daniel Perez
2d29d9534c Use custom edit on github plugin. Fix #469 2019-03-24 14:30:53 +00:00
James Hegedus
96e010396a
rename docs/hompage to docs/README to use default Docsify settings (#492)
rename docs/homepage.md to docs/README.md as the Docsify default of loading README.md works in a multi-lang setup whereas defining a custom homepage does not at this time.
2019-03-22 17:37:37 +11:00
James Hegedus
68ff07e09d
fix quote typo in docs homepage (#490)
# Summary

The homepage wasn't importing the required `.md` files appropriately due to the Docsify embed feature requiring single quotes, not double quotes.

## Other Information

We should update the information about Prettier use to specify that these pages require single quotes.
2019-03-22 17:27:07 +11:00
Daniel Perez
f372833226 Add documentation about multiple versions 2019-03-16 19:45:38 +00:00
Trevor Brown
9e30218766 Update version to 0.7.0 2019-03-02 09:45:43 -05:00
Isaac Whitfield
cf6149f622 document Spack to install plugin deps (#471) 2019-02-22 08:25:40 +11:00
Trevor Brown
62cd0561e2 Create CNAME 2019-02-12 09:12:13 -05:00
James Hegedus
abea57501d
add "versions" to docs subtitle (#462)
as with #460
2019-02-11 17:39:15 +11:00