licensa 0.1.9

CLI tool for seamless source code license management, supporting 65+ file types
Documentation 
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

// Copyright 2024 Nelson Dominguez
// SPDX-License-Identifier: MIT OR Apache-2.0

use crate::commands::apply::ApplyArgs;
use crate::commands::init::InitArgs;
use crate::commands::verify::VerifyArgs;

use clap::{Parser, Subcommand};

/// Licensa is a powerful CLI tool designed for seamless source code license management.
///
/// Developers can effortlessly verify, apply, modify, and enforce SPDX license headers
/// across their source code.
#[derive(Parser, Debug)]
#[command(author, version, about, long_about = None)]
#[command(propagate_version = true)]
#[command(next_line_help = true)]
pub struct Cli {
    #[arg(short, long, default_value_t = false)]
    pub verbose: bool,

    #[command(subcommand)]
    pub command: Command,
}

#[derive(Debug, Subcommand)]
pub enum Command {
    /// Initialize Licensa configuration for the current workspace.
    ///
    /// The `init` command simplifies the configuration process by creating a `.licensarc` file
    /// in the current working directory. This file contains workspace-wide Licensa configurations,
    /// eliminating the need to pass them as arguments for subsequent subcommands like `apply`.
    ///
    /// When you run the `init` command, the following steps are performed:
    ///
    /// 1. Creation of a `.licensarc` file based on the provided command arguments.
    ///
    /// 2. Generation of a `.licensaignore` file containing glob patterns.
    ///
    /// # Errors
    ///
    /// The `init` workflow fails in the following scenarios:
    ///
    /// - The current working directory already contains a `.licensarc` file.
    ///
    /// - Invalid arguments are provided.
    #[command(name = "init")]
    Init(InitArgs),

    /// Verify presence of license headers in one or more files.
    ///
    /// A glob pattern may be used to verify multiple files that recursively.
    #[command(name = "verify")]
    Verify(VerifyArgs),

    /// Apply copyright license headers to source code files.
    ///
    /// The `apply` command recursively scans specified directory patterns and seamlessly adds
    /// license headers to source files that don't already contain them. Existing headers are
    /// left untouched, ensuring that files are modified in place without overwriting existing
    /// licensing information.
    ///
    /// You can customize which files and directories are considered for license header application
    /// by using patterns in the `.gitignore` or `.licensaignore` file. Patterns provided in the
    /// `.licensaignore` file take precedence over those in the `.gitignore` file.
    ///
    /// If a `.licensarc` config file exists in the current working directory, its configuration
    /// fields are merged with the supplied command arguments. However, command arguments take
    /// precedence over config field values.
    ///
    /// # Errors
    ///
    /// The `apply` command may fail in the following scenarios:
    ///
    /// - Invalid `.licensarc` config file format (if present)
    ///
    /// - Invalid argument value
    ///
    /// - Missing required argument
    ///
    /// - Insufficient read/write permissions for source files
    #[command(name = "apply")]
    Apply(ApplyArgs),
}