diff options
author | casey <casey@users.noreply.github.com> | 2023-12-29 20:16:55 +0000 |
---|---|---|
committer | casey <casey@users.noreply.github.com> | 2023-12-29 20:16:55 +0000 |
commit | 6deb287ba5018276d38ebada157aca7a93cfb464 (patch) | |
tree | 74ffbbd3d0cb78ee8f0edf9a91a062247f384605 | |
parent | b3983ee238f6fb2bf2b73b2106fd24508ec9bb79 (diff) |
67 files changed, 1295 insertions, 495 deletions
diff --git a/man/en/chapter_1.html b/man/en/chapter_1.html index 0dad4031..c1c1cb64 100644 --- a/man/en/chapter_1.html +++ b/man/en/chapter_1.html @@ -197,8 +197,10 @@ <br> <p><code>just</code> is a handy way to save and run project-specific commands.</p> <p>This readme is also available as a <a href="https://just.systems/man/en/">book</a>.</p> -<p>(中文文档在 <a href="https://github.com/casey/just/blob/master/README.%E4%B8%AD%E6%96%87.md">这里</a>, 快看过来!)</p> -<p>Commands, called recipes, are stored in a file called <code>justfile</code> with syntax inspired by <code>make</code>:</p> +<p>(中文文档在 <a href="https://github.com/casey/just/blob/master/README.%E4%B8%AD%E6%96%87.md">这里</a>, +快看过来!)</p> +<p>Commands, called recipes, are stored in a file called <code>justfile</code> with syntax +inspired by <code>make</code>:</p> <p><img src="https://raw.githubusercontent.com/casey/just/master/screenshot.png" alt="screenshot" /></p> <p>You can then run them with <code>just RECIPE</code>:</p> <pre><code class="language-sh">$ just test-all @@ -209,40 +211,52 @@ Yay, all your tests passed! <p><code>just</code> has a ton of useful features, and many improvements over <code>make</code>:</p> <ul> <li> -<p><code>just</code> is a command runner, not a build system, so it avoids much of <a href="chapter_76.html"><code>make</code>’s complexity and idiosyncrasies</a>. No need for <code>.PHONY</code> recipes!</p> +<p><code>just</code> is a command runner, not a build system, so it avoids much of +<a href="chapter_76.html"><code>make</code>’s complexity and idiosyncrasies</a>. +No need for <code>.PHONY</code> recipes!</p> </li> <li> -<p>Linux, MacOS, and Windows are supported with no additional dependencies. (Although if your system doesn’t have an <code>sh</code>, you’ll need to <a href="chapter_26.html#shell">choose a different shell</a>.)</p> +<p>Linux, MacOS, and Windows are supported with no additional dependencies. +(Although if your system doesn’t have an <code>sh</code>, you’ll need to +<a href="chapter_26.html#shell">choose a different shell</a>.)</p> </li> <li> -<p>Errors are specific and informative, and syntax errors are reported along with their source context.</p> +<p>Errors are specific and informative, and syntax errors are reported along +with their source context.</p> </li> <li> <p>Recipes can accept <a href="chapter_38.html">command line arguments</a>.</p> </li> <li> -<p>Wherever possible, errors are resolved statically. Unknown recipes and circular dependencies are reported before anything runs.</p> +<p>Wherever possible, errors are resolved statically. Unknown recipes and +circular dependencies are reported before anything runs.</p> </li> <li> -<p><code>just</code> <a href="chapter_26.html#dotenv-settings">loads <code>.env</code> files</a>, making it easy to populate environment variables.</p> +<p><code>just</code> <a href="chapter_26.html#dotenv-settings">loads <code>.env</code> files</a>, making it easy to populate +environment variables.</p> </li> <li> <p>Recipes can be <a href="chapter_24.html">listed from the command line</a>.</p> </li> <li> -<p>Command line completion scripts are <a href="chapter_65.html">available for most popular shells</a>.</p> +<p>Command line completion scripts are +<a href="chapter_65.html">available for most popular shells</a>.</p> </li> <li> -<p>Recipes can be written in <a href="chapter_41.html">arbitrary languages</a>, like Python or NodeJS.</p> +<p>Recipes can be written in +<a href="chapter_41.html">arbitrary languages</a>, like Python or NodeJS.</p> </li> <li> -<p><code>just</code> can be invoked from any subdirectory, not just the directory that contains the <code>justfile</code>.</p> +<p><code>just</code> can be invoked from any subdirectory, not just the directory that +contains the <code>justfile</code>.</p> </li> <li> <p>And <a href="https://just.systems/man/en/">much more</a>!</p> </li> </ul> -<p>If you need help with <code>just</code> please feel free to open an issue or ping me on <a href="https://discord.gg/ezYScXR">Discord</a>. Feature requests and bug reports are always welcome!</p> +<p>If you need help with <code>just</code> please feel free to open an issue or ping me on +<a href="https://discord.gg/ezYScXR">Discord</a>. Feature requests and bug reports are +always welcome!</p> </main> diff --git a/man/en/chapter_10.html b/man/en/chapter_10.html index 6fc95b01..ab23e0c9 100644 --- a/man/en/chapter_10.html +++ b/man/en/chapter_10.html @@ -177,7 +177,8 @@ <div id="content" class="content"> <main> <h2 id="editor-support"><a class="header" href="#editor-support">Editor Support</a></h2> -<p><code>justfile</code> syntax is close enough to <code>make</code> that you may want to tell your editor to use <code>make</code> syntax highlighting for <code>just</code>.</p> +<p><code>justfile</code> syntax is close enough to <code>make</code> that you may want to tell your +editor to use <code>make</code> syntax highlighting for <code>just</code>.</p> </main> diff --git a/man/en/chapter_11.html b/man/en/chapter_11.html index dd44fb73..401b073d 100644 --- a/man/en/chapter_11.html +++ b/man/en/chapter_11.html @@ -178,8 +178,10 @@ <main> <h3 id="vim-and-neovim"><a class="header" href="#vim-and-neovim">Vim and Neovim</a></h3> <h4 id="vim-just"><a class="header" href="#vim-just"><code>vim-just</code></a></h4> -<p>The <a href="https://github.com/NoahTheDuke/vim-just">vim-just</a> plugin provides syntax highlighting for <code>justfile</code>s.</p> -<p>Install it with your favorite package manager, like <a href="https://github.com/junegunn/vim-plug">Plug</a>:</p> +<p>The <a href="https://github.com/NoahTheDuke/vim-just">vim-just</a> plugin provides syntax +highlighting for <code>justfile</code>s.</p> +<p>Install it with your favorite package manager, like +<a href="https://github.com/junegunn/vim-plug">Plug</a>:</p> <pre><code class="language-vim">call plug#begin() Plug 'NoahTheDuke/vim-just' @@ -192,9 +194,12 @@ cd ~/.vim/pack/vendor/start git clone https://github.com/NoahTheDuke/vim-just.git </code></pre> <h4 id="tree-sitter-just"><a class="header" href="#tree-sitter-just"><code>tree-sitter-just</code></a></h4> -<p><a href="https://github.com/IndianBoy42/tree-sitter-just">tree-sitter-just</a> is an <a href="https://github.com/nvim-treesitter/nvim-treesitter">Nvim Treesitter</a> plugin for Neovim.</p> +<p><a href="https://github.com/IndianBoy42/tree-sitter-just">tree-sitter-just</a> is an +<a href="https://github.com/nvim-treesitter/nvim-treesitter">Nvim Treesitter</a> plugin +for Neovim.</p> <h4 id="makefile-syntax-highlighting"><a class="header" href="#makefile-syntax-highlighting">Makefile Syntax Highlighting</a></h4> -<p>Vim’s built-in makefile syntax highlighting isn’t perfect for <code>justfile</code>s, but it’s better than nothing. You can put the following in <code>~/.vim/filetype.vim</code>:</p> +<p>Vim’s built-in makefile syntax highlighting isn’t perfect for <code>justfile</code>s, but +it’s better than nothing. You can put the following in <code>~/.vim/filetype.vim</code>:</p> <pre><code class="language-vimscript">if exists("did_load_filetypes") finish endif @@ -203,7 +208,8 @@ augroup filetypedetect au BufNewFile,BufRead justfile setf make augroup END </code></pre> -<p>Or add the following to an individual <code>justfile</code> to enable <code>make</code> mode on a per-file basis:</p> +<p>Or add the following to an individual <code>justfile</code> to enable <code>make</code> mode on a +per-file basis:</p> <pre><code class="language-text"># vim: set ft=make : </code></pre> diff --git a/man/en/chapter_12.html b/man/en/chapter_12.html index c97cdac9..927ac598 100644 --- a/man/en/chapter_12.html +++ b/man/en/chapter_12.html @@ -177,9 +177,13 @@ <div id="content" class="content"> <main> <h3 id="emacs"><a class="header" href="#emacs">Emacs</a></h3> -<p><a href="https://github.com/leon-barrett/just-mode.el">just-mode</a> provides syntax highlighting and automatic indentation of <code>justfile</code>s. It is available on <a href="https://melpa.org/">MELPA</a> as <a href="https://melpa.org/#/just-mode">just-mode</a>.</p> -<p><a href="https://github.com/psibi/justl.el">justl</a> provides commands for executing and listing recipes.</p> -<p>You can add the following to an individual <code>justfile</code> to enable <code>make</code> mode on a per-file basis:</p> +<p><a href="https://github.com/leon-barrett/just-mode.el">just-mode</a> provides syntax +highlighting and automatic indentation of <code>justfile</code>s. It is available on +<a href="https://melpa.org/">MELPA</a> as <a href="https://melpa.org/#/just-mode">just-mode</a>.</p> +<p><a href="https://github.com/psibi/justl.el">justl</a> provides commands for executing and +listing recipes.</p> +<p>You can add the following to an individual <code>justfile</code> to enable <code>make</code> mode on +a per-file basis:</p> <pre><code class="language-text"># Local Variables: # mode: makefile # End: diff --git a/man/en/chapter_13.html b/man/en/chapter_13.html index f66b97f4..4541623e 100644 --- a/man/en/chapter_13.html +++ b/man/en/chapter_13.html @@ -177,11 +177,15 @@ <div id="content" class="content"> <main> <h3 id="visual-studio-code"><a class="header" href="#visual-studio-code">Visual Studio Code</a></h3> -<p>An extension for VS Code by <a href="https://github.com/skellock">skellock</a> is <a href="https://marketplace.visualstudio.com/items?itemName=skellock.just">available here</a> (<a href="https://github.com/skellock/vscode-just">repository</a>), but is no longer actively developed.</p> +<p>An extension for VS Code by <a href="https://github.com/skellock">skellock</a> is +<a href="https://marketplace.visualstudio.com/items?itemName=skellock.just">available here</a> +(<a href="https://github.com/skellock/vscode-just">repository</a>), but is no longer +actively developed.</p> <p>You can install it from the command line by running:</p> <pre><code class="language-sh">code --install-extension skellock.just </code></pre> -<p>An more recently active fork by <a href="https://github.com/sclu1034">sclu1034</a> is available <a href="https://github.com/sclu1034/vscode-just">here</a>.</p> +<p>An more recently active fork by <a href="https://github.com/sclu1034">sclu1034</a> is +available <a href="https://github.com/sclu1034/vscode-just">here</a>.</p> </main> diff --git a/man/en/chapter_14.html b/man/en/chapter_14.html index 8f2b30c9..4c239d00 100644 --- a/man/en/chapter_14.html +++ b/man/en/chapter_14.html @@ -177,7 +177,8 @@ <div id="content" class="content"> <main> <h3 id="jetbrains-ides"><a class="header" href="#jetbrains-ides">JetBrains IDEs</a></h3> -<p>A plugin for JetBrains IDEs by <a href="https://github.com/linux-china">linux_china</a> is <a href="https://plugins.jetbrains.com/plugin/18658-just">available here</a>.</p> +<p>A plugin for JetBrains IDEs by <a href="https://github.com/linux-china">linux_china</a> is +<a href="https://plugins.jetbrains.com/plugin/18658-just">available here</a>.</p> </main> diff --git a/man/en/chapter_15.html b/man/en/chapter_15.html index 7e54c2d9..5493286e 100644 --- a/man/en/chapter_15.html +++ b/man/en/chapter_15.html @@ -177,7 +177,8 @@ <div id="content" class="content"> <main> <h3 id="kakoune"><a class="header" href="#kakoune">Kakoune</a></h3> -<p>Kakoune supports <code>justfile</code> syntax highlighting out of the box, thanks to TeddyDD.</p> +<p>Kakoune supports <code>justfile</code> syntax highlighting out of the box, thanks to +TeddyDD.</p> </main> diff --git a/man/en/chapter_16.html b/man/en/chapter_16.html index 027fc8c8..f0340290 100644 --- a/man/en/chapter_16.html +++ b/man/en/chapter_16.html @@ -177,7 +177,8 @@ <div id="content" class="content"> <main> <h3 id="helix"><a class="header" href="#helix">Helix</a></h3> -<p><a href="https://helix-editor.com/">Helix</a> supports <code>justfile</code> syntax highlighting out-of-the-box since version 23.05.</p> +<p><a href="https://helix-editor.com/">Helix</a> supports <code>justfile</code> syntax highlighting +out-of-the-box since version 23.05.</p> </main> diff --git a/man/en/chapter_17.html b/man/en/chapter_17.html index 80267175..c69f205d 100644 --- a/man/en/chapter_17.html +++ b/man/en/chapter_17.html @@ -177,7 +177,9 @@ <div id="content" class="content"> <main> <h3 id="sublime-text"><a class="header" href="#sublime-text">Sublime Text</a></h3> -<p>The <a href="https://github.com/nk9/just_sublime">Just package</a> by <a href="https://github.com/nk9">nk9</a> with <code>just</code> syntax and some other tools is available on <a href="https://packagecontrol.io/packages/Just">PackageControl</a>.</p> +<p>The <a href="https://github.com/nk9/just_sublime">Just package</a> by +<a href="https://github.com/nk9">nk9</a> with <code>just</code> syntax and some other tools is +available on <a href="https://packagecontrol.io/packages/Just">PackageControl</a>.</p> </main> diff --git a/man/en/chapter_18.html b/man/en/chapter_18.html index 3201f1e0..1821e7c6 100644 --- a/man/en/chapter_18.html +++ b/man/en/chapter_18.html @@ -177,7 +177,8 @@ <div id="content" class="content"> <main> <h3 id="micro"><a class="header" href="#micro">Micro</a></h3> -<p><a href="https://micro-editor.github.io/">Micro</a> supports Justfile syntax highlighting out of the box, thanks to <a href="https://github.com/tomodachi94">tomodachi94</a>.</p> +<p><a href="https://micro-editor.github.io/">Micro</a> supports Justfile syntax highlighting +out of the box, thanks to <a href="https://github.com/tomodachi94">tomodachi94</a>.</p> </main> diff --git a/man/en/chapter_19.html b/man/en/chapter_19.html index bbe1c044..81826bb3 100644 --- a/man/en/chapter_19.html +++ b/man/en/chapter_19.html @@ -177,7 +177,8 @@ <div id="content" class="content"> <main> <h3 id="other-editors"><a class="header" href="#other-editors">Other Editors</a></h3> -<p>Feel free to send me the commands necessary to get syntax highlighting working in your editor of choice so that I may include them here.</p> +<p>Feel free to send me the commands necessary to get syntax highlighting working +in your editor of choice so that I may include them here.</p> </main> diff --git a/man/en/chapter_20.html b/man/en/chapter_20.html index 8d27b49a..d2b35478 100644 --- a/man/en/chapter_20.html +++ b/man/en/chapter_20.html @@ -177,9 +177,13 @@ <div id="content" class="content"> <main> <h2 id="quick-start"><a class="header" href="#quick-start">Quick Start</a></h2> -<p>See <a href="chapter_2.html">the installation section</a> for how to install <code>just</code> on your computer. Try running <code>just --version</code> to make sure that it’s installed correctly.</p> -<p>For an overview of the syntax, check out <a href="https://cheatography.com/linux-china/cheat-sheets/justfile/">this cheatsheet</a>.</p> -<p>Once <code>just</code> is installed and working, create a file named <code>justfile</code> in the root of your project with the following contents:</p> +<p>See <a href="chapter_2.html">the installation section</a> for how to install <code>just</code> on your +computer. Try running <code>just --version</code> to make sure that it’s installed +correctly.</p> +<p>For an overview of the syntax, check out +<a href="https://cheatography.com/linux-china/cheat-sheets/justfile/">this cheatsheet</a>.</p> +<p>Once <code>just</code> is installed and working, create a file named <code>justfile</code> in the +root of your project with the following contents:</p> <pre><code class="language-just">recipe-name: echo 'This is a recipe!' @@ -187,8 +191,11 @@ another-recipe: @echo 'This is another recipe.' </code></pre> -<p>When you invoke <code>just</code> it looks for file <code>justfile</code> in the current directory and upwards, so you can invoke it from any subdirectory of your project.</p> -<p>The search for a <code>justfile</code> is case insensitive, so any case, like <code>Justfile</code>, <code>JUSTFILE</code>, or <code>JuStFiLe</code>, will work. <code>just</code> will also look for files with the name <code>.justfile</code>, in case you’d like to hide a <code>justfile</code>.</p> +<p>When you invoke <code>just</code> it looks for file <code>justfile</code> in the current directory +and upwards, so you can invoke it from any subdirectory of your project.</p> +<p>The search for a <code>justfile</code> is case insensitive, so any case, like <code>Justfile</code>, +<code>JUSTFILE</code>, or <code>JuStFiLe</code>, will work. <code>just</code> will also look for files with the +name <code>.justfile</code>, in case you’d like to hide a <code>justfile</code>.</p> <p>Running <code>just</code> with no arguments runs the first recipe in the <code>justfile</code>:</p> <pre><code class="language-sh">$ just echo 'This is a recipe!' @@ -198,14 +205,18 @@ This is a recipe! <pre><code class="language-sh">$ just another-recipe This is another recipe. </code></pre> -<p><code>just</code> prints each command to standard error before running it, which is why <code>echo 'This is a recipe!'</code> was printed. This is suppressed for lines starting with <code>@</code>, which is why <code>echo 'This is another recipe.'</code> was not printed.</p> -<p>Recipes stop running if a command fails. Here <code>cargo publish</code> will only run if <code>cargo test</code> succeeds:</p> +<p><code>just</code> prints each command to standard error before running it, which is why +<code>echo 'This is a recipe!'</code> was printed. This is suppressed for lines starting +with <code>@</code>, which is why <code>echo 'This is another recipe.'</code> was not printed.</p> +<p>Recipes stop running if a command fails. Here <code>cargo publish</code> will only run if +<code>cargo test</code> succeeds:</p> <pre><code class="language-just">publish: cargo test # tests passed, time to publish! cargo publish </code></pre> -<p>Recipes can depend on other recipes. Here the <code>test</code> recipe depends on the <code>build</code> recipe, so <code>build</code&g |