Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: App support in Pkg #3772

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
62 changes: 62 additions & 0 deletions docs/src/apps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# [**?.** Apps](@id Apps)

!!! note
The app support in Pkg is currently considered experimental and some functionality and API may change.

Apps are Julia packages that are intended to be run as a "standalone programs" (by e.g. typing the name of the app in the terminal possibly together with some arguments or flags/options).
This is in contrast to most Julia packages that are used as "libraries" and are loaded by other files or in the Julia REPL.

## Creating a Julia app

A Julia app is structured similar to a standard Julia library with the following additions:

- A `@main` entry point in the package module (see the Julia help on `@main` for details)
- An `[app]` section in the `Project.toml` file listing the executable names that the package provides.

A very simple example of an app that prints the reversed input arguments would be:

```julia
# src/MyReverseApp.jl
module MyReverseApp

function (@main)(ARGS)
for arg in ARGS
print(stdout, reverse(arg), " ")
end
return
end

end # module
```

```toml
# Project.toml

# standard fields here

[apps]
reverse = {}
```

The empty table `{}` is to allow for giving metadata about the app but it is currently unused.

After installing this app one could run:

```
$ reverse some input string
emos tupni gnirts
```

directly in the terminal.

## Installing Julia apps

The installation of Julia apps are similar to installing julia libraries but instead of using e.g. `Pkg.add` or `pkg> add` one uses `Pkg.Apps.add` or `pkg> app add` (`develop` is also available).

!!! note
The path `.julia/bin` has to be added to your `PATH` in order for apps to be runnable after being installed.
Pkg currently does not do this for you.

## Other information

- The app will currently run with the same Julia executable as was used to install the app.
17 changes: 17 additions & 0 deletions ext/REPLExt/completions.jl
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,23 @@ function complete_add_dev(options, partial, i1, i2; hint::Bool)
return comps, idx, !isempty(comps)
end

# TODO: Move
import Pkg: Operations, Types, Apps
function complete_installed_apps(options, partial; hint)
manifest = try
Types.read_manifest(joinpath(Apps.app_env_folder(), "AppManifest.toml"))
catch err
err isa PkgError || rethrow()
return String[]
end
apps = String[]
for (uuid, entry) in manifest.deps
append!(apps, keys(entry.apps))
push!(apps, entry.name)
end
return unique!(apps)
end

########################
# COMPLETION INTERFACE #
########################
Expand Down
Loading
Loading