Commit Graph

251 Commits

Author SHA1 Message Date
Greg Shuflin
c2cfdd7a9c
Clarify [unix] attribute in readme (#1619) 2023-06-15 17:48:43 +00:00
Greg Shuflin
41aee4572d
Add better documentation for --dump and --fmt (#1603) 2023-06-12 17:02:13 +00:00
Quentin Nerden
6a407813b4
Document Helix editor support in readme (#1604) 2023-06-12 16:42:06 +00:00
John Baber-Lucero
444ce130ba
Fix justfile search link (#1607) 2023-05-28 00:48:14 +00:00
Scott Robinson
9f03441eef
Link to private recipes section in readme (#1542) 2023-02-07 21:07:12 +00:00
Greg Shuflin
941a40e051
Update README to reflect new attribute syntax (#1538) 2023-01-27 08:04:44 +00:00
Casey Rodarmor
a81b094441
Downgrade to TLS 1.2 in install script (#1536)
Revert "Update install script and readmes to use tls v1.3 (#1481)"

This reverts commit 9b6b0b7fac.
2023-01-27 02:49:03 +00:00
Casey Rodarmor
94a93c97a0 Note that justfiles are order-insensitive (#1529) 2023-01-24 21:07:54 -08:00
Greg Shuflin
1a5f07c672 Ignore additional search path arguments (#1528)
- Revert #1475
- Add a test that arguments with different path  prefixes are allowed
2023-01-24 21:07:22 -08:00
Martin Junghanns
42b4c084c4
Put default setting values in backticks (#1512) 2023-01-15 10:18:57 +00:00
Martin Junghanns
3fe06de660
Use lowercase boolean literals in readme (#1511) 2023-01-15 09:51:56 +00:00
Casey Rodarmor
7aff35a37b
Document invocation_directory_native() (#1508) 2023-01-13 19:20:37 +00:00
Greg Shuflin
912863bc1e
Add !include directives (#1470) 2023-01-13 03:25:28 +00:00
Casey Rodarmor
5e5583d43c
Remove --unstable from fallback example in readme (#1502) 2023-01-12 07:35:53 +00:00
Greg Shuflin
d499227dcb
Allow matching search path arguments (#1475) 2023-01-12 07:06:17 +00:00
Casey Rodarmor
fcb71e2cea
Note that install.sh may fail on GitHub actions (#1499) 2023-01-12 06:44:55 +00:00
Auberi R Sky
69516962fb
Fix readme typo (#1489) 2023-01-10 19:20:57 +00:00
Casey Rodarmor
9b6b0b7fac
Update install script and readmes to use tls v1.3 (#1481) 2023-01-07 21:01:37 +00:00
Justin Ma
44ae78c83f
Update Chinese translation of readme (#1476) 2023-01-04 22:01:50 -08:00
Casey Rodarmor
b0e6ec699b
Release 1.11.0 (#1472)
- Bump version: 1.10.0 → 1.11.0
- Update changelog
- Update changelog contributor credits
- Update man page
- Document that fallback is stable in readme
2023-01-04 06:41:13 +00:00
Nick Kocharhook
bb5b962c3d
Update Sublime syntax instructions (#1455) 2023-01-02 09:44:06 +00:00
Casey Rodarmor
66993e874d
Release 1.10.0 (#1468)
- Bump version: 1.9.0 → 1.10.0
- Update changelog
- Update changelog contributor credits
- Update dependencies
- Update man page
- Update version references in readme
- Update update-contributors binary
2023-01-02 01:53:53 +00:00
Brett Cannon
5c4b21db77
Fix section title grammar (#1466) 2023-01-01 02:10:15 +00:00
Josh Soref
50f3750842
Fix spelling (#1463) 2022-12-30 20:36:08 +00:00
Azzam S.A
e7721d0a84
Add instructions for taiki-e/install-action (#1459) 2022-12-26 19:49:36 +00:00
Greg Shuflin
fbe1c4c7a3
Allow private attribute on aliases (#1434) 2022-12-20 00:44:19 -08:00
Dialga
c7acaa82cb
Differentiate between shell and nushell example (#1427) 2022-12-18 00:50:35 +00:00
Casey Rodarmor
d530fea378
Link regex docs in readme (#1454) 2022-12-18 00:28:44 +00:00
Cameron Steffen
216df31543
Eliminate lazy_static (#1442) 2022-12-15 16:53:21 -08:00
nico
1119d226fe
Use just in readme codeblocks (#1447) 2022-12-15 20:28:02 +00:00
Casey Rodarmor
5926300678
Update MSRV in readme (#1446) 2022-12-15 05:37:21 +00:00
Casey Rodarmor
efb929153e
Release 1.9.0 (#1426)
- Bump version: 1.8.0 → 1.9.0
- Update changelog
- Update changelog contributor credits
- Update dependencies
- Update man page
- Update version references in readme
2022-11-25 21:15:13 +00:00
Casey Rodarmor
2b46af1cae
Hide recipes with [private] attribute (#1422) 2022-11-23 00:25:57 +00:00
Casey Rodarmor
38a5481cbb
Document how shebang recipes are executed (#1412) 2022-11-16 02:13:03 +00:00
Casey Rodarmor
755ac61bee
Fix typo: regec → regex (#1409) 2022-11-08 06:51:09 +00:00
miles
7d6483b995
Add replace_regex function (#1393) 2022-11-08 06:47:33 +00:00
asdfasdf
0a2c2692b3
Use powershell.exe instead of pwsh.exe in readme (#1394) 2022-11-08 06:34:48 +00:00
Casey Rodarmor
dc2fe21e40
Expand alternatives and prior art in readme (#1401) 2022-11-03 07:03:53 +00:00
Casey Rodarmor
331f61f59c
Add [no-cd] attribute (#1400) 2022-11-02 23:37:35 -07:00
Casey Rodarmor
d74c7a3bd5
Release 1.8.0 (#1398)
- Bump version: 1.7.0 → 1.8.0
- Update changelog
- Update dependencies
- Update man page
2022-11-02 23:57:33 +00:00
Casey Rodarmor
9984d77b31
Link to sclu1034/vscode-just in readme (#1396) 2022-11-02 02:58:20 +00:00
Casey Rodarmor
73777f7183
Add OS Configuration Attributes (#1387) 2022-10-31 00:52:03 -07:00
Casey Rodarmor
c834fb1e4e
Release 1.7.0 (#1386)
- Bump version: 1.6.0 → 1.7.0
- Update changelog
- Update changelog contributor credits
- Update dependencies
- Update man page
- Update version references in readme
2022-10-27 06:02:27 +00:00
Giancarlo França
be11a26226
Add more case-conversion functions (#1383) 2022-10-27 03:44:18 +00:00
Kenichi Kamiya
4349c1bac8
Update asdf just plugin repository (#1380) 2022-10-27 00:38:22 +00:00
David Matos
beeaa6ce2d Add tempdir setting (#1369) 2022-10-25 16:57:32 -07:00
Gökhan Karabulut
8b7640b633
Add [no-exit-message] recipe annotation (#1354)
When a recipe wraps cli tool and the tool exits with a non-zero code,
just adds its own extra exit error message along with the messages
from the tool. Introduce the `[no-exit-message]` attribute to suppress
this additional message.
2022-10-25 16:32:36 -07:00
Cihan Demirci
aaef61b908
Add capitalize(s) function (#1375)
`capitalize(s)` converts the first character of s to uppercase
and the rest to lowercase.
2022-10-24 20:39:40 -07:00
Casey Rodarmor
28be873dfc
Require set fallback := true to enable recipe fallback (#1368) 2022-10-19 19:00:09 -07:00
Casey Rodarmor
27e196c9bb
Note version in which absolute path construction was added (#1361) 2022-10-07 23:10:19 +00:00
Greg Shuflin
e445cfb47d
Add skip-comments setting (#1333)
Add a new setting "skip-comments", which defaults to true. If unset,
this causes lines internal to a non-shebang recipe beginning with the
character '#' (including '#!' internal to a non-shebang recipe; that is,
any such instances occurring after the first line of a recipe) to be
treated as comments of the justfile itself. They will not be echoed to
stderr when the recipe executes.
2022-10-05 00:32:30 +00:00
Erik Krieg
154930cc8a
Allow constructing absolute paths with / operator (#1320) 2022-09-11 07:48:02 +00:00
Michael Zeller
35fb61af89
Add an example of using a variable in a recipe parameter (#1311) 2022-08-16 18:25:10 +00:00
Casey Rodarmor
7c0a960555
Fix shell setting precedence (#1306) 2022-08-09 02:50:31 +00:00
Casey Rodarmor
c6809b3364
Don't hardcode homebrew prefix (#1295) 2022-08-05 17:28:45 +00:00
JP Bochi
051f4389f3
Add usage note to default list recipe (#1296) 2022-08-01 14:31:50 +00:00
Hunter Wittenborn
b6d06583f9
Add MPR/Prebuilt-MPR installation instructions to README.md (#1280) 2022-07-30 08:37:10 +00:00
Casey Rodarmor
b427be6b08
Add make and makesure to readme (#1299) 2022-07-29 17:09:28 +00:00
Nick Kocharhook
2c206abb0e
Document how to configure zsh completions on MacOS (#1285) 2022-07-27 08:33:41 +00:00
Casey Rodarmor
76e4ce6176
Convert package table to HTML (#1291) 2022-07-26 23:58:59 +00:00
Thiago Brandão Damasceno
2af8336410
Update just-install reference on README.md (#1275) 2022-07-22 22:08:49 +00:00
jaacko-torus
64b4d71d66
Add asdf package to readme(#1264) 2022-07-11 23:07:56 +00:00
Kian-Meng Ang
d2d405aa28
Fix typo: argumant -> argument (#1257) 2022-07-04 19:40:34 +00:00
Damian Kula
0b750b6cd7
Explain how to pass arguments of a command to a dependency (#1254) 2022-06-28 07:32:05 +00:00
Justin Ma
dbe05d2d23
Update Chinese translation of README.md (#1253) 2022-06-28 00:05:49 -07:00
Casey Rodarmor
a46be41699
Add / operator (#1237) 2022-06-25 09:39:06 +00:00
Casey Rodarmor
0e4b443742
Publish to snap store (#1245) 2022-06-22 04:49:50 +00:00
Alex Brombal
691b3dcf56
Add just-install to README file (#1241) 2022-06-20 19:38:24 +00:00
William Droz
9fcaa2f692
Fix dead readme link (#1240) 2022-06-20 17:42:46 +00:00
Casey Rodarmor
180672b0e1
Fix readme punctuation (#1235) 2022-06-16 22:39:24 +00:00
Casey Rodarmor
5d223b113e
Add argument splitting section to readme (#1230) 2022-06-14 02:05:40 +00:00
Casey Rodarmor
8c0bb3dde7
Add notes about environment variables to readme (#1229) 2022-06-14 01:28:22 +00:00
Casey Rodarmor
c710d5a685
Fix book links (#1227) 2022-06-13 01:02:09 +00:00
Justin Ma
2710df4207
Add nushell README.md (#1224) 2022-06-09 23:16:41 -05:00
Casey Rodarmor
c8c5fe1789
Use absolute links in readme (#1223) 2022-06-09 20:12:11 +00:00
Casey Rodarmor
97fde19a93
Build Chinese language user manual (#1219) 2022-06-08 20:04:06 -05:00
Justin Ma
cb39d6c577
Translate all of README.md into Chinese (#1217) 2022-06-07 23:50:21 -05:00
Casey Rodarmor
908c9824cb
Make link to examples directory absolute (#1213) 2022-06-05 04:51:19 +00:00
Libing Chen
60ba81a796
Add JetBrains IDE plugin to readme (#1209) 2022-06-01 22:48:50 +00:00
Casey Rodarmor
c24a194602
Add windows-shell setting (#1198) 2022-05-31 13:01:59 -07:00
Justin Ma
ccc54fb8d9
Translate editor support and quick start to Chinese (#1206)
Based on commit c87909c.
2022-05-29 23:51:18 -07:00
peter
6fccdd001a
Add nix package manager install instructions (#1194) 2022-05-28 05:14:31 +00:00
Vlad-Shcherbina
8ff7c87d96
Fix broken link in readme (#1183) 2022-05-08 09:11:39 +00:00
mbodmer
862d6a52ab
SHA-256 and UUID functions (#1170) 2022-05-04 23:18:31 +00:00
Casey Rodarmor
b63efb70a5
Center readme (#1178) 2022-05-04 06:35:03 +00:00
Casey Rodarmor
3adef6d4b7
Style and add links to homepage (#1177) 2022-05-04 06:27:27 +00:00
Casey Rodarmor
9a7067e624
Fix readme badge links (#1176) 2022-05-04 06:13:58 +00:00
Casey Rodarmor
12fe9371f6
Generate book from readme (#1155) 2022-05-04 06:05:55 +00:00
Casey Rodarmor
32e15a2e51
Document that invocation_directory() returns an absolute path (#1162) 2022-04-21 04:51:03 +00:00
Casey Rodarmor
7800c56c95
Fix absolute_path documentation (#1160) 2022-04-19 21:36:41 +00:00
Máté FARKAS
df8eabb3ef
Add cross-platform justfile example (#1152) 2022-04-12 04:39:55 +00:00
Casey Rodarmor
52f73db33d
Search for missing recipes in parent directory justfiles (#1149) 2022-03-31 05:13:59 +00:00
Casey Rodarmor
1c9297452b
Document indentation rules (#1142) 2022-03-24 04:20:36 +00:00
Casey Rodarmor
ddac064296
Remove stale link from readme (#1141) 2022-03-24 03:23:20 +00:00
Chris Hamons
7299353977
Add error() function (#1118) 2022-03-03 00:48:28 +00:00
Laura Demkowicz-Duffy
a3f61a19ff
Add absolute_path function (#1121) 2022-03-03 00:41:48 +00:00
Quentin Nerden
88922b8974
Detail environment variable usage in readme (#1086) 2022-02-24 01:14:24 -08:00
Casey Rodarmor
fecb5e3f9d
Add hint for Node.js script compatibility (#1113) 2022-02-23 01:15:00 +00:00
Casey Rodarmor
a56af47e88
Release 1.0 (#1112) 2022-02-22 21:13:24 +00:00
Damian Kula
6271e94bc9
Add path_exists() function (#1106) 2022-02-21 21:45:30 +00:00
Casey Rodarmor
b4a0a8090d
Note that pipefail isn't normally set (#1108) 2022-02-17 22:02:03 +00:00
Casey Rodarmor
57d47fe59a
Fix dotenv-load documentation (#1104) 2022-02-15 20:20:52 +00:00
Greg Lutostanski
bcdaa95a66
Allow duplicate recipes (#1095) 2022-02-15 02:37:06 +00:00
Casey Rodarmor
0988a424ed
Add arrow pointing to table of contents button (#1096) 2022-02-10 17:15:35 +00:00
Austin Ziegler
4882b5aac0
Improve readme (#1093) 2022-02-08 20:30:25 +00:00
Casey Rodarmor
c3ba16ad74
Convert README.adoc to markdown (#1091) 2022-02-06 16:09:20 -08:00
Casey Rodarmor
6e3b43ac9e Overhaul README (#231)
- Switch to asciidoc, since it supports an auto-generated table of contents
- Re-organize into sections
- Document private recipes
- Document windows dependencies
- Document doc comments
2017-10-12 16:12:23 -07:00
Casey Rodarmor
35748f191f Add say thanks badge to readme (#215) 2017-08-16 21:19:39 -07:00
Jordan Danford
23f8881117 Fix typos in README.md (#213) 2017-08-07 13:35:05 -07:00
Casey Rodarmor
95ef27b32b Add a gitter badge (#170) 2017-04-18 22:18:36 -07:00
Casey Rodarmor
e45164da4d Improve syntax highlighting suggestions in readme (#164)
- Recognize Justfile as a justfile for vim filetypes snippet
- Add vim modeline and emacs local variables block
2017-03-12 19:20:33 -07:00
Casey Rodarmor
9c552fe8d0 readme: 'the in' -> 'in the' (#143) 2016-12-30 01:01:57 -08:00
Casey Rodarmor
b267d0444e Allow path-prefixed first arguments (#139)
If the first argument to just contains a `/`, then it will be handled
specially. Everything before the last `/` is treated as a directory, and
just will search for the justfile starting there, instead of in the
current directory.
2016-12-30 00:09:35 -08:00
Casey Rodarmor
86755582bb Readme: email -> issue (#138) 2016-12-15 18:48:31 -08:00
Casey Rodarmor
c6256333ed Lift limitations on recipes that take parameters (#137)
Previously, only one recipe with parameters could be passed on the
command line. This was to avoid confusion in case the number of
parameters a recipe took changed, and wound up using as an argument was
was once a recipe.

However, I don't think this is actually particularly confusing in
practice, and could be a slightly annoying limitation.

Now, any number of recipes with parameters may be given on the command
line.

Fixes #70
2016-12-10 16:35:52 -08:00
Casey Rodarmor
99e48fe2c6 Mention prebuilts in readme (#135) 2016-11-23 20:41:58 -08:00
Casey Rodarmor
1ac5b4ea42 Add variadic parameters (#127)
Recipes may now have a final variadic parameter:

```make
foo bar+:
  @echo {{bar}}
```

Variadic parameters accept one or more arguments, and expand to a string containing those arguments separated by spaces:

```sh
$ just foo a b c d e
a b c d e
```

I elected to accept one or more arguments instead of zero or more arguments since unexpectedly empty arguments can sometimes be dangerous. 

```make
clean dir:
  rm -rf {{dir}}/bin
```

If `dir` is empty in the above recipe, you'll delete `/bin`, which is probably not what was intended.
2016-11-18 07:03:34 -08:00
Casey Rodarmor
d11e679e4b Just is no longer a trival program ;_; (#120) 2016-11-15 19:29:41 -08:00
Casey Rodarmor
0ac2cdd124 Mention {{...}} substitution gotcha in readme (#117)
Fixes #116
2016-11-14 20:19:35 -08:00
Casey Rodarmor
3d7888708c Add multiline raw string example to readme (#109) 2016-11-13 14:21:34 -08:00
Casey Rodarmor
1e7a0fa63b Fix readme typo (#108)
'rather not rust' -> 'rather not install rust'
2016-11-13 14:07:04 -08:00
Casey Rodarmor
112462ec62 Toggle meaning of '@' on recipes prefixed with '@' (#100)
Fixes #65
2016-11-12 16:12:00 -08:00
Casey Rodarmor
7cfc37f647 Line up names in --evaluate (#93)
Fixes #66
2016-11-12 13:12:43 -08:00
Casey Rodarmor
6e8289c624 Make --list print recipes with arguments (#88)
Added `--summary` which just prints recipe names, like `--list` previous
to this change.

Fixes #75
2016-11-12 11:40:52 -08:00
Casey Rodarmor
886acf2f95 Let recipes take default arguments (#77)
Looks like this:

```make
recipe argument default-argument='default value':
  echo argument is {{argument}}
  echo default-argument is {{default-argument}}
```

Thanks @deckarep for the feature request!

Fixes #49
2016-11-12 09:15:13 -08:00
Casey Rodarmor
166c4bf48f Rename grammar.md to GRAMMAR.md (#73)
To match the `README.md` and `FAQ.md`
2016-11-11 23:09:40 -08:00
Casey Rodarmor
bd69f3298e Link to justfiles here and in the wild (#69) 2016-11-11 20:54:50 -08:00
Casey Rodarmor
f071f75c67 Improve recipes with parameters section of readme (#41) 2016-11-11 13:31:26 -08:00
Casey Rodarmor
ef39637c00 Add examples of comments to readme (#40)
Thanks @vitiral for suggesting this.
2016-11-11 13:04:47 -08:00
Jason Grlicky
1aebe92199 Fixed typo in Readme (#38)
`not.` -> `not`
2016-11-11 12:30:17 -08:00
Casey Rodarmor
d56ab91e8d Add build status badge to readme (#27) 2016-11-06 01:33:00 -07:00
Florian Gilcher
5d98bab31d Fix small typo in readme (#22)
suprising -> surprising
2016-11-05 13:13:27 -07:00
Casey Rodarmor
9a742e6336 Allow justfile to be named Justfile (#19)
Priority is given to `justfile` to match the behavior of GNU make.
2016-11-05 01:25:36 -07:00
Casey Rodarmor
7bc2be2caf Fix "whyc" typo in README.md 2016-11-04 23:18:20 -07:00
Casey Rodarmor
3b312e2728 Add escape sequences and raw strings to README.md 2016-11-02 00:09:58 -07:00
Casey Rodarmor
390491f7fa Readme done 2016-10-31 22:13:12 -07:00
Casey Rodarmor
398fb15c8b Readme. 2016-10-31 22:07:48 -07:00
Casey Rodarmor
763f73f0a8 Readme and notes 2016-10-31 22:06:28 -07:00
Casey Rodarmor
ed14b4d32a Readme wording 2016-10-31 22:05:31 -07:00
Casey Rodarmor
aeedf5ddff Mention overrides. 2016-10-31 22:03:27 -07:00
Casey Rodarmor
cef8b4fbdf Updated readme 2016-10-31 21:53:31 -07:00
Casey Rodarmor
ca9a0b7bff Update readme. 2016-10-31 21:27:10 -07:00
Casey Rodarmor
7f6a74af24 Rename arguments to parameters. 2016-10-31 19:11:27 -07:00
Casey Rodarmor
8a59d19cc7 Fix shield link 2016-10-30 22:47:29 -07:00
Casey Rodarmor
8de21fdc26 Add crates.io shield 2016-10-30 22:44:14 -07:00
Casey Rodarmor
8fd580dadd Notes and readme 2016-10-30 19:15:43 -07:00
Casey Rodarmor
ca3d159ae4 Add cat. 2016-09-28 22:13:35 -07:00
Casey Rodarmor
fc3b526b24 Further ramblings in readme 2016-09-28 22:07:03 -07:00
Casey Rodarmor
7529c628ca Expanded README.md 2016-09-28 21:58:18 -07:00
Casey Rodarmor
3b78451f23 Update stuff 2016-09-27 22:57:30 -07:00