typescript_tools 8.0.1

Tools for working with TypeScript monorepos
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

use std::path::PathBuf;

use clap::{crate_version, ArgAction, Parser, ValueEnum};
use typescript_tools::query;

#[derive(Debug, Parser)]
#[clap(name = "monorepo", version = crate_version!(), author = "Eric Crosson <eric.s.crosson@utexas.edu>")]
pub struct Opts {
    #[clap(subcommand)]
    pub subcommand: ClapSubCommand,
}

#[derive(Debug, Parser)]
pub enum ClapSubCommand {
    #[clap(about = "Pin internal dependencies to locally-declared package versions")]
    Pin(Pin),

    #[clap(about = "Configure TypeScript Project References")]
    Link(Link),

    #[clap(about = "Create GNU Makefile containing package dependency information")]
    MakeDepend(MakeDepend),

    #[clap(about = "Query properties of the current monorepo state")]
    Query(Query),

    #[clap(about = "Lint internal packages for consistent use of external dependency versions")]
    Lint(Lint),
}

#[derive(Debug, Parser)]
pub struct Link {
    /// Path to monorepo root
    #[clap(short, long, default_value = ".")]
    pub root: PathBuf,

    /// Modify tsconfig.json files as necessary to restore link invariant
    #[clap(long = "write", action = ArgAction::SetTrue)]
    pub action: Action,
}

#[derive(Debug, Parser)]
pub struct Pin {
    /// Path to monorepo root
    #[clap(short, long, default_value = ".")]
    pub root: PathBuf,

    /// Modify package.json files as necessary to restore pin invariant
    #[clap(long = "write", action = ArgAction::SetTrue)]
    pub action: Action,
}

#[derive(Debug, Parser)]
pub struct MakeDepend {
    /// Path to monorepo root
    #[clap(short, long, default_value = ".")]
    pub root: PathBuf,

    /// Directory to package for which to calculate dependencies
    #[clap(long)]
    pub package_directory: PathBuf,

    /// Output file, relative to the package directory
    #[clap(long)]
    pub output_file: PathBuf,

    /// Include GNU make target for creating package archive with npm pack
    #[clap(long)]
    pub create_pack_target: bool,
}

#[derive(Debug, Parser)]
pub struct Query {
    #[clap(subcommand)]
    pub subcommand: ClapQuerySubCommand,
}

#[derive(Debug, Parser)]
pub enum ClapQuerySubCommand {
    #[clap(
        about = "Print a JSON object mapping a package name to a list of relative paths to its internal dependencies"
    )]
    InternalDependencies(InternalDependencies),
}

#[derive(ValueEnum, Clone, Copy, Debug, Eq, PartialEq, Hash)]
pub enum InternalDependenciesFormat {
    Name,
    Path,
}

impl From<InternalDependenciesFormat> for query::InternalDependenciesFormat {
    fn from(value: InternalDependenciesFormat) -> Self {
        match value {
            InternalDependenciesFormat::Name => Self::Name,
            InternalDependenciesFormat::Path => Self::Path,
        }
    }
}

#[derive(Debug, Parser)]
pub struct InternalDependencies {
    /// Path to monorepo root
    #[clap(short, long, default_value = ".")]
    pub root: PathBuf,

    /// Format in which to describe internal dependencies (defaults to name)
    #[clap(long = "format", value_enum, default_value = "name")]
    pub format: InternalDependenciesFormat,
}

#[derive(Debug, Parser)]
pub struct Lint {
    #[clap(subcommand)]
    pub subcommand: ClapLintSubCommand,
}

#[derive(Debug, Parser)]
pub enum ClapLintSubCommand {
    #[clap(about = "Lint the used versions of an external dependency for consistency")]
    DependencyVersion(DependencyVersion),
}

#[derive(Debug, Parser)]
pub struct DependencyVersion {
    /// Path to monorepo root
    #[clap(short, long, default_value = ".")]
    pub root: PathBuf,

    /// External dependency to lint for consistency of version used
    #[clap(short, long = "dependency")]
    pub dependencies: Vec<String>,
}

#[derive(Clone, Copy, Debug, Eq, PartialEq, Hash)]
pub enum Action {
    Modify,
    Lint,
}

impl From<&str> for Action {
    fn from(value: &str) -> Self {
        match value {
            "true" => Self::Modify,
            "false" => Self::Lint,
            _ => unreachable!(),
        }
    }
}