Add UI spec

This commit is contained in:
Matthias Beyer 2017-09-01 18:59:19 +02:00
parent fbbb26b737
commit 664d85c42f
2 changed files with 114 additions and 0 deletions

View file

@ -1,3 +1,26 @@
//
// imag - the personal information management suite for the commandline
// Copyright (C) 2015, 2016 Matthias Beyer <mail@beyermatthias.de> and contributors
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; version
// 2.1 of the License.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
//
extern crate clap;
mod ui;
fn main() {
println!("Hello, world!");
}

View file

@ -0,0 +1,91 @@
//
// imag - the personal information management suite for the commandline
// Copyright (C) 2015, 2016 Matthias Beyer <mail@beyermatthias.de> and contributors
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; version
// 2.1 of the License.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
//
use clap::{Arg, App, SubCommand};
pub fn build_ui<'a>(app: App<'a, 'a>) -> App<'a, 'a> {
app
.subcommand(SubCommand::with_name("add")
.about("Add GPS coordinates to an entry")
.version("0.1")
.arg(Arg::with_name("longitude")
.long("long")
.takes_value(true)
.required(true)
.multiple(false)
.help("Set the longitude value. Format: <degrees>.<minutes>.<seconds>")
.value_name("LONGITUDE"))
.arg(Arg::with_name("latitude")
.long("lat")
.takes_value(true)
.required(true)
.multiple(false)
.help("Set the latitude. Format: <degrees>.<minutes>.<seconds>")
.value_name("LATITUDE"))
.arg(Arg::with_name("entry")
.index(1)
.takes_value(true)
.required(true)
.multiple(false)
.help("The entry to add the latitude/longitude to")
.value_name("ENTRY"))
)
.subcommand(SubCommand::with_name("remove")
.about("Remove a GPS coordinate pair from an entry")
.version("0.1")
.arg(Arg::with_name("print-removed")
.long("print-removed")
.short("p")
.takes_value(false)
.required(false)
.help("Print the removed values after removing them"))
.arg(Arg::with_name("entry")
.index(1)
.takes_value(true)
.required(true)
.multiple(false)
.help("The entry to remove the latitude/longitude from")
.value_name("ENTRY"))
)
.subcommand(SubCommand::with_name("get")
.about("Get a GPS coordinate pair from an entry")
.version("0.1")
.arg(Arg::with_name("entry")
.index(1)
.takes_value(true)
.required(true)
.multiple(false)
.help("The entry to get the latitude/longitude from")
.value_name("ENTRY"))
.arg(Arg::with_name("format-json")
.long("json")
.takes_value(false)
.required(false)
.multiple(false)
.help("Get as JSON Object"))
.arg(Arg::with_name("format-print")
.long("print")
.takes_value(false)
.required(false)
.multiple(false)
.help("Print as <key>=<value> pairs (2 lines, default)"))
)
}