Commit Graph

77 Commits

Author SHA1 Message Date
Casey Rodarmor
b8a65149be
Fix typo in readme: Recipe -> recipe (#805) 2021-04-24 18:41:36 -07:00
Casey Rodarmor
67bd318bf9
Add positional-arguments setting (#804)
Allow recipe arguments to be passed as positional arguments to commands.
2021-04-24 18:29:58 -07:00
Casey Rodarmor
fec979c2c6
Reform and improve string literals (#793)
- Combine and simplify string and backtick lexing.
- Allow newlines in strings and backticks.
- Add triple-delimited indented strings and backticks. Common indented literal non-blank line leading whitespace is stripped.
- If a literal newline is escaped, it will be suppressed.
- Backticks starting with `#!` are reserved for a future upgrade.
2021-04-05 21:28:37 -07:00
Casey Rodarmor
dd578d141c
Unify string lexing (#790)
Unify lexing of backticks, cooked strings, and raw strings. Also allow
newlines in backticks and cooked strings, since I can't think of a reason
not to.
2021-04-04 16:41:02 -07:00
Casey Rodarmor
7a649eb8f6
Add shell setting examples to README (#787) 2021-03-30 19:46:03 -07:00
Casey Rodarmor
18b9799e8d
Add dotenv-load setting (#778)
The `dotenv-load` setting controls whether or not a `.env` file will be
loaded if present. It currently defaults to true.
2021-03-28 22:38:07 -07:00
Benoit de Chezelles
13e9f406c8
Add just_executable() function (#775)
The `just_executable()` function returns the absolute path of the
currently running `just` executable.
2021-03-28 15:44:02 -07:00
Casey Rodarmor
6f42c8b737
Prefix parameters with $ to export to environment (#773)
If a parameter is prefixed with an `$`, it will be exported as an
environment variable.
2021-03-25 18:35:24 -07:00
Casey Rodarmor
b66a979c08
Add set export to export all variables as environment variables (#767)
Add a setting that exports all variables by default, regardless of
whether they use the `export` keyword. This includes assignments as well
as parameters.

Just does dependency analysis of variable uses, allowing variables to be
used out of order in assignments, as long as there are no circular
dependencies.

However, use of environment variable is not known to Just, so exported
variables are only exported to child scopes, to avoid ordering dependencies,
since dependency analysis cannot be done.
2021-03-25 17:00:32 -07:00
Casey Rodarmor
d398417de3
De-emphasize cmd.exe in readme (#768)
cmd.exe is very fiddly, and Powershell is widely available, so recommend
Powershell over cmd.exe in the readme
2021-03-25 15:45:29 -07:00
Casey Rodarmor
d3b277c04c
Allow escaping double braces with {{{{ (#765) 2021-03-24 19:46:53 -07:00
Casey Rodarmor
7cbce4374f
Reorganize readme to highlight editor support (#764) 2021-03-24 18:29:16 -07:00
Valery V. Vorotyntsev
2ea13af50a
Fix command output in readme (#760) 2021-03-19 16:27:14 -07:00
Leon Barrett
5f3f4dee51
Note Emacs package just-mode in readme (#759) 2021-03-11 20:08:19 -08:00
Casey Rodarmor
7ae890ce61
Note shebang line splitting inconsistency in readme (#757) 2021-02-15 01:18:31 -08:00
Casey Rodarmor
bac851ff68
Add options to control list formatting (#753)
Add the `--list-heading` option, to override the heading text printed
before a list, defaulting to `Available recipes:\n`, and
`--list-prefix`, to override the indentation before each list item.
2021-02-09 01:00:20 -08:00
Casey Rodarmor
6305114024
Document how to change the working directory in a recipe (#752) 2021-02-02 23:47:07 -08:00
Jakub Jirutka
1ecdbd5353
Add Alpine Linux package to readme (#736) 2021-01-14 12:37:57 -08:00
Ross MacArthur
d43241a781
Add link in readme to GitHub Action (#729) 2020-11-27 00:14:46 -08:00
Ralph Minderhoud
dae44f0024
Add docs for justfile() and justfile_directory() (#726) 2020-11-19 17:20:12 -08:00
Casey Rodarmor
8502cf6618
Improve readme (#725)
- Add section about using `set -euxo pipefail`
- Add section about setting variables inside recipes
2020-11-08 13:49:39 -08:00
Casey Rodarmor
c4835c8ff1
Replace saythanks.io link with malto: link (#723)
Saythanks.io now includes the email address in the link, so I think I'm
just use a mailto link instead.
2020-10-30 16:59:20 -07:00
Casey Rodarmor
19f7ad09a7
Add conditional expressions (#714)
Add conditional expressions of the form:

   foo := if lhs == rhs { then } else { otherwise }

`lhs`, `rhs`, `then`, and `otherwise` are all arbitrary expressions, and
can recursively include other conditionals. Conditionals short-circuit,
so the branch not taken isn't evaluated.

It is also possible to test for inequality with `==`.
2020-10-26 18:16:42 -07:00
Casey Rodarmor
a1dec5d667
Add FreeBSD port to readme (#705) 2020-10-12 22:50:18 -07:00
Casey Rodarmor
d1efc18174
Allow choosing multiple recipes to run (#700)
Modifies the `--choose` subcommand to allow a chooser to return
space-separated recipe names recipes to run.
2020-10-10 17:54:58 -07:00
Quentin Nerden
601cc69028
Fix readme documentation for ignoring errors (#692)
The example justfile omitted the `-`.
2020-10-04 13:28:47 -07:00
Casey Rodarmor
30fee97f73
Document how to ignore errors with - in readme (#690) 2020-10-03 14:23:51 -07:00
Casey Rodarmor
9d0246998d
Add the --choose subcommand (#680)
The `--choose` subcommand runs a chooser to select a recipe to run. The
chooser should read lines containing recipe names from standard input,
and write one of those names to standard output.

The chooser defaults to `fzf`, a popular fuzzy finder, but can be
overridden by setting $JUST_CHOOSER or passing `--chooser <CHOOSER>`.
2020-09-17 19:43:04 -07:00
Casey Rodarmor
c62ff5a3d0
Document --unsorted flag in readme (#672) 2020-09-01 12:44:53 -07:00
Casey Rodarmor
75898e29b6
Mention Linux, MacOS and Windows support in readme (#666) 2020-08-19 14:05:01 -07:00
Casey Rodarmor
5e2b51e83e
Add list highlighting nice features to readme (#664)
This was suggested by @zaiste, to make it clearer how Just differs from
Make, and what features it has.
2020-08-05 19:20:11 -07:00
Casey Rodarmor
5533073f56
Only use cygpath on shebang if it contains / (#652)
On Windows, skip conversion if a shebang path does not include `/`. In
this case it is not a Unix path, and does not need to be converted to a
Windows path before running.
2020-06-27 16:38:56 -07:00
Richard Berry
7615fe13a5
Clarify variadic parameter default values (#646)
Clarify that both `+` and `*` variadics can take default values
in readme.
2020-06-13 13:56:28 -07:00
Richard Berry
1ff619295c
Add variadic parameters that accept zero or more arguments (#645)
Add "star" variadic parameters that accept zero or more arguments,
distinguished with a `*` in front of the parameter name.
2020-06-13 01:49:13 -07:00
Casey Rodarmor
97aa9251ce
Link example justfiles in readme (#641) 2020-06-09 22:08:16 -07:00
Casey Rodarmor
4fdb771731
Document how to run recipes after another recipe (#630)
Add a section to the readme documenting how to shell out to Just at the
end of a recipe, to simulate dependencies that run after a recipe,
instead of before.

This is certainly not as good as having an explicit syntax for this, but
it's a common question so it would be good to document the current best
workaround.
2020-05-26 15:17:10 -07:00
Casey Rodarmor
d04942073a
Add Discord link to readme (#622) 2020-04-03 03:40:55 -07:00
Casey Rodarmor
42c22b5744
Link to recently indexed justfiles in the readme (#616) 2020-03-19 10:46:35 -07:00
Casey Rodarmor
a7ce94f63e
Document behavior of @ on shebang recipes (#602)
Shebang recipes have the somewhat confusing property of being quiet by
default, with `@` before a shebang recipe name causing just to print out
the recipe before executing it.

This is somewhat questionable behavior, since it's the opposite of
linewise recipes, but it should be documented, even if it might change
in the future.
2020-03-05 19:24:53 -08:00
Casey Rodarmor
33ad82f5c7
Add github pages site with improved install script (#597)
- Add a very basic github pages site that links to the github repo.
- Add new install script in the root of the site
- Document the new script in the readme
2020-02-20 06:32:06 -08:00
Casey Rodarmor
c12c683286
Delete old CI configuration and update build badge (#595)
- Delete travis and appveyor configuration
- Update build badge to github actions
2020-02-18 02:49:11 -08:00
Casey Rodarmor
3adef16b53
Add download count badge to readme (#594) 2020-02-18 02:33:29 -08:00
Casey Rodarmor
11bd8d448f
List solus package in readme (#579) 2020-01-25 20:03:45 -08:00
Isak Johansson
5cb15532e8 Fix readme typo: interpetation -> interpretation (#578) 2020-01-21 00:42:20 -08:00
Casey Rodarmor
85e8015702
Generate shell completion scripts with --completions (#572)
Make just print clap-generated shell completion scripts with `--completions`
command. Currently, Bash, Zsh, Fish, PowerShell, and Elvish are supported.

Additionally, the generated completion scripts are checked in to the
`completions` folder.
2020-01-15 01:20:38 -08:00
Casey Rodarmor
eeb603160a
Add table of package managers that include just to readme (#568) 2019-12-20 04:22:37 -08:00
Hendrik
b8d6fc6681 Remove yaourt AUR helper from readme (#567) 2019-12-18 17:15:56 -08:00
Casey Rodarmor
0931fa8dbf
Allow passing arguments to dependencies (#555)
Allow recipes that take parameters to be used as dependencies.
2019-12-07 04:03:03 -08:00
Casey Rodarmor
7046443b39
Mention set shell as altenative to installing sh (#533)
Mention that `set shell := [...]` can be used as an alternative to installing `sh`
in the installation section.
2019-11-13 15:26:07 -08:00
Casey Rodarmor
9f82ed9015
Document settings in readme (#527) 2019-11-12 13:34:00 -08:00