Skip to content

Commit

Permalink
direnv
Browse files Browse the repository at this point in the history
  • Loading branch information
@vic
vic committed Oct 27, 2019
0 parents commit ca7e214
Show file tree
Hide file tree
Showing 10 changed files with 555 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .dependabot/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
version: 1
update_configs:
- package_manager: 'github_actions'
directory: '/'
update_schedule: 'daily'
8 changes: 8 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
root = true

[*]
indent_style = space
indent_size = 2
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
53 changes: 53 additions & 0 deletions .github/workflows/workflow.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: Main workflow

on: [push, pull_request]

jobs:
build:
strategy:
matrix:
os: [ubuntu-latest, macOS-latest]
direnv: [2.20.0]

runs-on: ${{ matrix.os }}

steps:
- name: Checkout
uses: actions/checkout@v1

- name: Install asdf
run: git clone https://github.com/asdf-vm/asdf.git $HOME/asdf

- name: Install direnv and print version
run: |
. $HOME/asdf/asdf.sh
asdf plugin-add direnv $GITHUB_WORKSPACE
asdf install direnv ${{ matrix.direnv }}
asdf global direnv ${{ matrix.direnv }}
direnv --version
test:
runs-on: macOS-latest

steps:
- name: Checkout
uses: actions/checkout@v1

- name: Install asdf
run: git clone https://github.com/asdf-vm/asdf.git $HOME/asdf

- name: Test plugin
env:
GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
. $HOME/asdf/asdf.sh
asdf plugin-add direnv $GITHUB_WORKSPACE
bats test
lint:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v1
- name: Run ShellCheck
run: shellcheck bin/*
201 changes: 201 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
93 changes: 93 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
<div align="center">
<h1>asdf-direnv</h1>
[direnv](https://direnv.net/) plugin for asdf version manager
</div>
<hr />

[![Main workflow](https://github.com/asdf-community/asdf-direnv/workflows/Main%20workflow/badge.svg)](https://github.com/asdf-community/asdf-direnv/actions)
[![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/asdf-community/asdf-direnv.svg)](https://isitmaintained.com/project/asdf-community/asdf-direnv 'Average time to resolve an issue')
[![Percentage of issues still open](https://isitmaintained.com/badge/open/asdf-community/asdf-direnv.svg)](https://isitmaintained.com/project/asdf-community/asdf-direnv 'Percentage of issues still open')
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
[![License](https://img.shields.io/github/license/asdf-community/asdf-direnv?color=brightgreen)](https://github.com/asdf-community/asdf-direnv/blob/master/LICENSE)

## Motivation (or shims de-motivation)

[asdf](https://asdf-vm.com) is a great tool for managing multiple versions of command line tools. 99% of the time these managed tools work just as expected.

Shims are just tiny executables managed by asdf that just forward execution to the *real* versioned executables installed by asdf.
This way asdf has a single shims directory added to your PATH and has no need of mangling the PATH for every installed tool.

So, when you execute an asdf-managed command, like `node`, it will actually run an asdf-shim, which will determine which `node` version
to activate according to your `.tool-versions` file.

As convenient as it is, every single time you run `node` asdf will have to determine again which version to use. Even if you haven't
changed your `.tool-versions` file to upgrade the nodejs plugin version. And this happens for every shim execution, which could lead
to some users experiencing certain _slowness_ while asdf is looking up versions (since it has to check not only .tool-versions, but
probably also legacy version files every time)

Another inconvenience is that commands installed by these tools can have some problems by the way asdf shims work. For example,
if a command tries to find itself by name in PATH (eg, using `which my-command`) it will find the asdf shim executable and
not the *actual* executable delegated-to by asdf. This might cause problems if the command tries to use this location
as an installation root to find auxiliary files, since shims will mask the real executable.

Another problem usually found by asdf users is, if you have an asdf-managed package manager, say `npm`, `hex`, `gem` and the like.
Any new binaries installed by these tools is not available on PATH unless you `asdf reshim`. This is because asdf has no way of knowing
what the `npm install` command does, and it's untill `asdf reshim` that it will figure out new executables are available and will
create shims for them accordingly.

## Solution

All these previously mentioned issues can be solved by using asdf along with the [direnv](https://direnv.net/) tool.

Just like asdf is a tools manager, direnv is an environment-variables manager.
It can update your shell env upon directory change and clean it up when you leave that directory.

This `asdf-direnv` plugin lets you install `direnv` and also provides a tiny script to integrate both.
Allowing `direnv` to manage any variables exposed by asdf tools, primarily the PATH environment, but also
any other variable exposed by your plugin (eg, MIX_HOME exposed by the asdf-elixir plugin).

This way, running `node` will not invoke the asdf-shim but the *real* asdf-managed executable in PATH.
Which will improve speed since version is resolution is out of the way and made only once by `direnv` upon entering your project directory.
Commands trying to find themselves in PATH will find their expected location.
Also no more _re-shim_ needed upon `npm install`.


## Prerequirements

- Make sure you have the required dependencies installed:
- curl
- git

## Installation

```bash
asdf plugin-add direnv https://github.com/asdf-community/asdf-direnv.git
```

## Usage


First, make sure you install and globally activate the most recent direnv version:

```bash
asdf install direnv 2.20.0
asdf global direnv 2.20.0
```

Follow the [instructions to hook direnv](https://github.com/direnv/direnv/blob/master/docs/hook.md) into your SHELL.

Then on your project root where you have a `.tool-versions` file, create a `.envrc` file with the following content:

```bash
source $(asdf which direnv_use_adf)
use asdf

# Other valid `use asdf` examples:
# use asdf /path/to/other/.tool-versions # if you want to load from another location
# use asdf rust 1.38.0 # even if no present in your local versions file
```


## Useful links

Read [direnv documentation](https://direnv.net/) for more on `.envrc`
Loading

0 comments on commit ca7e214

Please sign in to comment.