Hide recipes with names starting with an _ from --list and --sumamary (…

…#229)

CHANGELOG.md

@@ -5,7 +5,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-
 ## [Unreleased]
+
+## [0.3.1] - 2017-10-06
 ### Added
 - Started keeping a changelog in CHANGELOG.md
+- Recipes whose names begin with an underscore will not appear in `--list` or `--summary`

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name        = "just"
-version     = "0.3.0"
+version     = "0.3.1"
 description = "🤖 Just a command runner"
 authors     = ["Casey Rodarmor <[email protected]>"]
 license     = "WTFPL OR MIT OR Apache-2.0"

src/app.rs

@@ -232,7 +232,13 @@ pub fn app() {
     if justfile.count() == 0 {
       eprintln!("Justfile contains no recipes.");
     } else {
-      println!("{}", justfile.recipes.keys().cloned().collect::<Vec<_>>().join(" "));
+      let summary = justfile.recipes.iter()
+        .filter(|&(_, recipe)| !recipe.private)
+        .map(|(name, _)| name)
+        .cloned()
+        .collect::<Vec<_>>()
+        .join(" ");
+      println!("{}", summary);
     }
     process::exit(EXIT_SUCCESS);
   }
@@ -246,6 +252,9 @@ pub fn app() {
     let doc_color = color.stdout().doc();
     println!("Available recipes:");
     for (name, recipe) in &justfile.recipes {
+      if recipe.private {
+        continue;
+      }
       print!("    {}", name);
       for parameter in &recipe.parameters {
         if color.stdout().active() {

src/integration.rs

@@ -139,7 +139,10 @@ integration_test! {
   justfile: "b: a
 a:
 d: c
-c: b",
+c: b
+_z: _y
+_y:
+",
   args:     ("--summary"),
   stdout:   "a b c d\n",
   stderr:   "",
@@ -1020,6 +1023,9 @@ hello a b='B	' c='C':
 # this comment will be ignored
 
 a Z="\t z":
+
+# this recipe will not appear
+_private-recipe:
 "#,
   args:     ("--list"),
   stdout:   r"Available recipes:

src/lib.rs

@@ -105,6 +105,7 @@ struct Recipe<'a> {
   lines:             Vec<Vec<Fragment<'a>>>,
   name:              &'a str,
   parameters:        Vec<Parameter<'a>>,
+  private:           bool,
   quiet:             bool,
   shebang:           bool,
 }
@@ -2015,6 +2016,7 @@ impl<'a> Parser<'a> {
       dependencies:      dependencies,
       dependency_tokens: dependency_tokens,
       parameters:        parameters,
+      private:           &name.lexeme[0..1] == "_",
       lines:             lines,
       shebang:           shebang,
       quiet:             quiet,