askalono-cli 0.4.6

a tool to detect the contents of license files
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

// Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0

use std::path::PathBuf;

use clap::arg_enum;
use structopt::StructOpt;

arg_enum! {
    #[allow(non_camel_case_types)]
    pub enum OutputFormat {
        text,
        json
    }
}

#[derive(StructOpt)]
#[structopt(name = "askalono")]
pub struct Opt {
    /// Path to a cache file containing compiled license information
    #[structopt(long = "cache", short = "c", parse(from_os_str))]
    pub cache: Option<PathBuf>,

    /// Output type: text (default), json
    #[structopt(long = "format")]
    #[structopt(raw(possible_values = "&OutputFormat::variants()"))]
    pub format: Option<OutputFormat>,

    #[structopt(subcommand)]
    pub subcommand: Subcommand,
}

#[derive(StructOpt)]
pub enum Subcommand {
    /// Identify a single file
    #[structopt(name = "identify", alias = "id")]
    Identify {
        /// File to identify
        #[structopt(name = "FILE", required_unless = "batch", parse(from_os_str))]
        filename: Option<PathBuf>,

        /// Try to find the location of a license within the given file
        #[structopt(long = "optimize", short = "o")]
        optimize: bool,

        #[structopt(raw(hidden = "true"))]
        #[structopt(long = "diff")]
        diff: bool,

        /// Read in filenames on stdin for batch identification
        #[structopt(long = "batch", short = "b")]
        batch: bool,
    },

    /// Crawl a directory identifying license files
    #[structopt(name = "crawl")]
    Crawl {
        /// Directory to crawl
        #[structopt(name = "DIR", parse(from_os_str))]
        directory: PathBuf,

        /// Follow symlinks
        #[structopt(long = "follow")]
        follow_links: bool,

        /// Glob of files to check (defaults to license-like files)
        #[structopt(long = "glob")]
        glob: Option<String>,
    },

    /// Cache management actions
    #[structopt(name = "cache")]
    Cache {
        #[structopt(subcommand)]
        subcommand: CacheSubcommand,
    },
}

#[derive(StructOpt)]
pub enum CacheSubcommand {
    /// Load an SPDX license directory (see https://github.com/spdx/license-list-data/tree/master/json/details for format)
    #[structopt(name = "load-spdx")]
    LoadSpdx {
        /// JSON "details" directory
        #[structopt(name = "DIR", parse(from_os_str))]
        dir: PathBuf,

        /// Store texts in cache along with match data
        #[structopt(long = "store")]
        store_texts: bool,
    },
}