From 49cd7f5a933f5a973d174830e97ff3097e1b1dc7 Mon Sep 17 00:00:00 2001 From: Casey Rodarmor Date: Wed, 11 Dec 2019 17:08:48 -0800 Subject: [PATCH] Improve pre-publish check (#562) - Ensure man page is up to date - Build with summary feature --- justfile | 5 ++- man/just.1 | 24 ++++++++++---- src/summary.rs | 88 +++++++++++++++++++++++++++++++------------------- 3 files changed, 76 insertions(+), 41 deletions(-) diff --git a/justfile b/justfile index adcf758..9f7fbbd 100755 --- a/justfile +++ b/justfile @@ -44,15 +44,18 @@ man: --no-info \ target/debug/just \ > man/just.1 + +view-man: man man man/just.1 version := `sed -En 's/version[[:space:]]*=[[:space:]]*"([^"]+)"/v\1/p' Cargo.toml | head -1` # publish to crates.io -publish-check: lint clippy test +publish-check: lint clippy test man git branch | grep '* master' git diff --no-ext-diff --quiet --exit-code grep {{version}} CHANGELOG.md + cargo build --features summary cargo +nightly generate-lockfile -Z minimal-versions cargo test git checkout Cargo.lock diff --git a/man/just.1 b/man/just.1 index 74d2aec..016257a 100644 --- a/man/just.1 +++ b/man/just.1 @@ -1,15 +1,18 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.10. -.TH JUST "1" "July 2019" "just 0.4.4" "JUST MANUAL" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.11. +.TH JUST "1" "December 2019" "just 0.5.2" "JUST MANUAL" .SH NAME just \- save and run commands .SH DESCRIPTION -just 0.4.4 +just 0.5.2 \- Please see https://github.com/casey/just for more information. .SS "USAGE:" .IP just [FLAGS] [OPTIONS] [\-\-] [ARGUMENTS]... .SS "FLAGS:" .TP +\fB\-\-clear\-shell\-args\fR +Clear shell arguments +.TP \fB\-\-dry\-run\fR Print what just would do without doing it .TP @@ -17,7 +20,7 @@ Print what just would do without doing it Print entire justfile .TP \fB\-e\fR, \fB\-\-edit\fR -Open justfile with $EDITOR +Edit justfile with editor given by $VISUAL or $EDITOR, falling back to `vim` .TP \fB\-\-evaluate\fR Print evaluated variables @@ -25,9 +28,15 @@ Print evaluated variables \fB\-\-highlight\fR Highlight echoed recipe lines in bold .TP +\fB\-\-init\fR +Initialize new justfile in project root +.TP \fB\-l\fR, \fB\-\-list\fR List available recipes and their arguments .TP +\fB\-\-no\-highlight\fR +Don't highlight echoed recipe lines in bold +.TP \fB\-q\fR, \fB\-\-quiet\fR Suppress all output .TP @@ -53,11 +62,14 @@ Print colorful output [default: auto] Use as justfile. .TP \fB\-\-set\fR -Set to +Override with .TP \fB\-\-shell\fR Invoke to run recipes [default: sh] .TP +\fB\-\-shell\-arg\fR ... +Invoke shell with as an argument [default: \fB\-cu]\fR +.TP \fB\-s\fR, \fB\-\-show\fR Show information about .HP @@ -67,4 +79,4 @@ Use as working directory. \fB\-\-justfile\fR must also be s .SS "ARGS:" .TP ... -The recipe(s) to run, defaults to the first recipe in the justfile +Overrides and recipe(s) to run, defaulting to the first recipe in the justfile diff --git a/src/summary.rs b/src/summary.rs index 6ceebf8..1a51a66 100644 --- a/src/summary.rs +++ b/src/summary.rs @@ -12,18 +12,14 @@ //! ensuring that changes to just do not inadvertently break or //! change the interpretation of existing justfiles. -use std::{ - collections::{BTreeMap, BTreeSet}, - fs, io, - path::Path, -}; +use std::{collections::BTreeMap, fs, io, path::Path}; use crate::compiler::Compiler; mod full { pub(crate) use crate::{ - assignment::Assignment, expression::Expression, fragment::Fragment, justfile::Justfile, - line::Line, parameter::Parameter, recipe::Recipe, + assignment::Assignment, dependency::Dependency, expression::Expression, fragment::Fragment, + justfile::Justfile, line::Line, parameter::Parameter, recipe::Recipe, thunk::Thunk, }; } @@ -48,7 +44,7 @@ impl Summary { for alias in justfile.aliases.values() { aliases - .entry(alias.target.lexeme()) + .entry(alias.target.name()) .or_insert_with(Vec::new) .push(alias.name.to_string()); } @@ -60,13 +56,13 @@ impl Summary { .map(|(name, recipe)| { ( name.to_string(), - Recipe::new(recipe, aliases.remove(name).unwrap_or_default()), + Recipe::new(&recipe, aliases.remove(name).unwrap_or_default()), ) }) .collect(), assignments: justfile .assignments - .into_iter() + .iter() .map(|(name, assignment)| (name.to_string(), Assignment::new(assignment))) .collect(), } @@ -76,7 +72,7 @@ impl Summary { #[derive(Eq, PartialEq, Hash, Ord, PartialOrd, Debug, Clone)] pub struct Recipe { pub aliases: Vec, - pub dependencies: BTreeSet, + pub dependencies: Vec, pub lines: Vec, pub private: bool, pub quiet: bool, @@ -85,18 +81,18 @@ pub struct Recipe { } impl Recipe { - fn new(recipe: full::Recipe, aliases: Vec) -> Recipe { + fn new(recipe: &full::Recipe, aliases: Vec) -> Recipe { Recipe { private: recipe.private, shebang: recipe.shebang, quiet: recipe.quiet, dependencies: recipe .dependencies - .into_iter() - .map(|name| name.lexeme().to_string()) + .iter() + .map(|dependency| Dependency::new(dependency)) .collect(), - lines: recipe.body.into_iter().map(Line::new).collect(), - parameters: recipe.parameters.into_iter().map(Parameter::new).collect(), + lines: recipe.body.iter().map(Line::new).collect(), + parameters: recipe.parameters.iter().map(Parameter::new).collect(), aliases, } } @@ -110,11 +106,11 @@ pub struct Parameter { } impl Parameter { - fn new(parameter: full::Parameter) -> Parameter { + fn new(parameter: &full::Parameter) -> Parameter { Parameter { variadic: parameter.variadic, name: parameter.name.lexeme().to_owned(), - default: parameter.default.map(Expression::new), + default: parameter.default.as_ref().map(Expression::new), } } } @@ -125,9 +121,9 @@ pub struct Line { } impl Line { - fn new(line: full::Line) -> Line { + fn new(line: &full::Line) -> Line { Line { - fragments: line.fragments.into_iter().map(Fragment::new).collect(), + fragments: line.fragments.iter().map(Fragment::new).collect(), } } } @@ -139,7 +135,7 @@ pub enum Fragment { } impl Fragment { - fn new(fragment: full::Fragment) -> Fragment { + fn new(fragment: &full::Fragment) -> Fragment { match fragment { full::Fragment::Text { token } => Fragment::Text { text: token.lexeme().to_owned(), @@ -158,10 +154,10 @@ pub struct Assignment { } impl Assignment { - fn new(assignment: full::Assignment) -> Assignment { + fn new(assignment: &full::Assignment) -> Assignment { Assignment { exported: assignment.export, - expression: Expression::new(assignment.expression), + expression: Expression::new(&assignment.value), } } } @@ -188,22 +184,31 @@ pub enum Expression { } impl Expression { - fn new(expression: full::Expression) -> Expression { + fn new(expression: &full::Expression) -> Expression { use full::Expression::*; match expression { Backtick { contents, .. } => Expression::Backtick { - command: contents.to_owned(), + command: (*contents).to_owned(), }, - Call { - function, - arguments, - } => Expression::Call { - name: function.lexeme().to_owned(), - arguments: arguments.into_iter().map(Expression::new).collect(), + Call { thunk } => match thunk { + full::Thunk::Nullary { name, .. } => Expression::Call { + name: name.lexeme().to_owned(), + arguments: Vec::new(), + }, + full::Thunk::Unary { name, arg, .. } => Expression::Call { + name: name.lexeme().to_owned(), + arguments: vec![Expression::new(arg)], + }, + full::Thunk::Binary { + name, args: [a, b], .. + } => Expression::Call { + name: name.lexeme().to_owned(), + arguments: vec![Expression::new(a), Expression::new(b)], + }, }, Concatination { lhs, rhs } => Expression::Concatination { - lhs: Box::new(Expression::new(*lhs)), - rhs: Box::new(Expression::new(*rhs)), + lhs: Box::new(Expression::new(lhs)), + rhs: Box::new(Expression::new(rhs)), }, StringLiteral { string_literal } => Expression::String { text: string_literal.cooked.to_string(), @@ -211,7 +216,22 @@ impl Expression { Variable { name, .. } => Expression::Variable { name: name.lexeme().to_owned(), }, - Group { contents } => Expression::new(*contents), + Group { contents } => Expression::new(contents), + } + } +} + +#[derive(Eq, PartialEq, Hash, Ord, PartialOrd, Debug, Clone)] +pub struct Dependency { + pub recipe: String, + pub arguments: Vec, +} + +impl Dependency { + fn new(dependency: &full::Dependency) -> Dependency { + Dependency { + recipe: dependency.recipe.name().to_owned(), + arguments: dependency.arguments.iter().map(Expression::new).collect(), } } }