kevin/asdf
1
Fork 0
mirror of https://github.com/asdf-vm/asdf.git synced 2024-11-15 01:28:17 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs: remove text from plugin create doc that says utils.bash functions are available (#1247)

Browse Source 
While the sentence is correct we do not want users relying on `utils.bash` internal functions

Related to the conversation on #682
This commit is contained in:
Trevor Brown 2022-06-13 13:24:55 -04:00 committed by GitHub
parent 7e7a1faa70
commit 950e417271
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/plugins/create.md
View File

@ -197,9 +197,8 @@ $ asdf foo bat baz # same as running `$ASDF_DATA_DIR/plugins/foo/lib/commands/co
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.
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.
When invoked, if extension commands do not have their executable-bit set they will be
sourced as bash scripts. 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.
A good example of this feature is for plugins like [`haxe`](https://github.com/asdf-community/asdf-haxe)