lectern 0.0.2

Lightning-fast PHP Composer alternative written in Rust
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
use clap::{Args, Parser, Subcommand};
use std::path::PathBuf;

#[derive(Parser, Debug)]
#[command(
    name = "lectern",
    about = "Modern PHP dependency manager with Lectern.toml configuration",
    version
)]
pub struct Cli {
    /// Working directory (defaults to current dir)
    #[arg(long, short = 'd', default_value = ".")]
    pub working_dir: PathBuf,

    /// Verbosity level (-v, -vv, -vvv)
    #[arg(short = 'v', action = clap::ArgAction::Count)]
    pub verbose: u8,

    /// Suppress output
    #[arg(short = 'q', long = "quiet")]
    pub quiet: bool,

    /// Disable interaction
    #[arg(short = 'n', long = "no-interaction")]
    pub no_interaction: bool,

    /// Prefer stable packages
    #[arg(long = "prefer-stable")]
    pub prefer_stable: bool,

    /// Minimum stability level
    #[arg(long = "minimum-stability", default_value = "stable")]
    pub minimum_stability: String,

    /// Memory limit in MB
    #[arg(long = "memory-limit", default_value = "512")]
    pub memory_limit: u32,

    #[command(subcommand)]
    pub command: Option<Commands>,
}

#[derive(Subcommand, Debug)]
pub enum Commands {
    /// Install packages from composer.json
    Install(InstallArgs),
    /// Update dependencies to latest versions
    Update(UpdateArgs),
    /// Add new packages to composer.json
    Require(RequireArgs),
    /// Remove packages from composer.json
    Remove(RemoveArgs),
    /// Show package information
    Show(ShowArgs),
    /// Show autoloader setup
    Autoload(DumpAutoloadArgs),
    /// Search for packages
    Search(SearchArgs),
    /// Initialize a new project
    Init(InitArgs),
    /// List outdated packages
    Outdated,
    /// List installed packages
    Status,
    /// Show licenses of dependencies
    Licenses,
    /// Validate composer.json
    Validate(ValidateArgs),
    /// Create a new project from a package
    CreateProject(CreateProjectArgs),
    /// Dump the autoload
    DumpAutoload(DumpAutoloadArgs),
    /// Run a script defined in composer.json
    RunScript(RunScriptArgs),
    /// Diagnose the system
    Diagnose,
    /// Create an archive of the project
    Archive(ArchiveArgs),
    /// Clear various caches
    ClearCache(ClearCacheArgs),
    /// Get and set configuration options
    Config(ConfigArgs),
    /// Show which packages depend on a given package
    Depends(DependsArgs),
    /// Show which packages prevent installing a given package
    Prohibits(ProhibitsArgs),
    /// Open package repository URL in browser
    Browse(BrowseArgs),
    /// Show suggested packages
    Suggests,
    /// Show funding information
    Fund,
}

#[derive(Args, Debug)]
pub struct InstallArgs {
    /// Don't install dev dependencies
    #[arg(long = "no-dev")]
    pub no_dev: bool,

    /// Dry run mode
    #[arg(long = "dry-run")]
    pub dry_run: bool,

    /// Prefer source installs
    #[arg(long = "prefer-source")]
    pub prefer_source: bool,

    /// Prefer dist installs
    #[arg(long = "prefer-dist")]
    pub prefer_dist: bool,

    /// Ignore platform requirements
    #[arg(long = "ignore-platform-reqs")]
    pub ignore_platform_reqs: bool,

    /// Optimize autoloader
    #[arg(long = "optimize-autoloader")]
    pub optimize_autoloader: bool,
}

#[derive(Args, Debug)]
pub struct UpdateArgs {
    /// Packages to update (empty = all)
    pub packages: Vec<String>,

    /// Don't update dev dependencies
    #[arg(long = "no-dev")]
    pub no_dev: bool,

    /// Dry run mode
    #[arg(long = "dry-run")]
    pub dry_run: bool,

    /// Update to latest versions (ignoring constraints)
    #[arg(long = "with-all-dependencies")]
    pub with_all_dependencies: bool,

    /// Prefer source installs
    #[arg(long = "prefer-source")]
    pub prefer_source: bool,

    /// Prefer dist installs
    #[arg(long = "prefer-dist")]
    pub prefer_dist: bool,

    /// Ignore platform requirements
    #[arg(long = "ignore-platform-reqs")]
    pub ignore_platform_reqs: bool,

    /// Optimize autoloader
    #[arg(long = "optimize-autoloader")]
    pub optimize_autoloader: bool,
}

#[derive(Args, Debug)]
pub struct RequireArgs {
    /// Packages to add (format: vendor/package:constraint)
    pub packages: Vec<String>,

    /// Add to dev dependencies
    #[arg(long = "dev")]
    pub dev: bool,

    /// Dry run mode
    #[arg(long = "dry-run")]
    pub dry_run: bool,

    /// Don't update dependencies after require
    #[arg(long = "no-update")]
    pub no_update: bool,

    /// Update with dependencies
    #[arg(long = "update-with-dependencies")]
    pub update_with_dependencies: bool,

    /// Ignore platform requirements
    #[arg(long = "ignore-platform-reqs")]
    pub ignore_platform_reqs: bool,
}

#[derive(Args, Debug)]
pub struct RemoveArgs {
    /// Packages to remove
    pub packages: Vec<String>,

    /// Remove from dev dependencies
    #[arg(long = "dev")]
    pub dev: bool,

    /// Dry run mode
    #[arg(long = "dry-run")]
    pub dry_run: bool,

    /// Don't update after removal
    #[arg(long = "no-update")]
    pub no_update: bool,

    /// Update with dependencies
    #[arg(long = "update-with-dependencies")]
    pub update_with_dependencies: bool,
}

#[derive(Args, Debug)]
pub struct ShowArgs {
    /// Package name to show info for
    pub package: Option<String>,

    /// Show available versions
    #[arg(long = "available")]
    pub available: bool,

    /// Include platform packages
    #[arg(long = "platform")]
    pub platform: bool,

    /// Show only direct dependencies
    #[arg(long = "direct")]
    pub direct: bool,

    /// Show dependency tree
    #[arg(long = "tree")]
    pub tree: bool,

    /// Output format (table, json)
    #[arg(long = "format", default_value = "table")]
    pub format: String,
}

#[derive(Args, Debug)]
pub struct DumpAutoloadArgs {
    /// Optimize autoloader (PSR-4 to classmap)
    #[arg(long = "optimize", short = 'o')]
    pub optimize: bool,

    /// Generate authoritative classmap
    #[arg(long = "classmap-authoritative")]
    pub classmap_authoritative: bool,

    /// Use `APCu` cache
    #[arg(long = "apcu")]
    pub apcu: bool,

    /// Don't include dev autoload
    #[arg(long = "no-dev")]
    pub no_dev: bool,
}

#[derive(Args, Debug)]
pub struct SearchArgs {
    /// Search terms
    pub terms: Vec<String>,
}

#[derive(Args, Debug)]
pub struct InitArgs {
    /// Project name
    #[arg(long = "name")]
    pub name: Option<String>,

    /// Project description
    #[arg(long = "description")]
    pub description: Option<String>,

    /// Author name
    #[arg(long = "author")]
    pub author: Option<String>,

    /// Project type
    #[arg(long = "type", default_value = "library")]
    pub project_type: String,

    /// Homepage URL
    #[arg(long = "homepage")]
    pub homepage: Option<String>,

    /// Require dependencies interactively
    #[arg(long = "require")]
    pub require: bool,

    /// Require dev dependencies interactively
    #[arg(long = "require-dev")]
    pub require_dev: bool,

    /// Minimum stability
    #[arg(long = "stability")]
    pub stability: Option<String>,

    /// License
    #[arg(long = "license")]
    pub license: Option<String>,

    /// Repository type
    #[arg(long = "repository")]
    pub repository: Option<String>,
}

#[derive(Args, Debug)]
pub struct ValidateArgs {
    /// Don't check for publish issues
    #[arg(long = "no-check-publish")]
    pub no_check_publish: bool,

    /// Check for typos in composer.json
    #[arg(long = "with-dependencies")]
    pub with_dependencies: bool,

    /// Strict validation
    #[arg(long = "strict")]
    pub strict: bool,
}

#[derive(Args, Debug)]
pub struct CreateProjectArgs {
    /// Package name (vendor/package)
    pub package: String,

    /// Directory to install into
    pub directory: Option<String>,

    /// Version constraint
    pub version: Option<String>,

    /// Prefer source installs
    #[arg(long = "prefer-source")]
    pub prefer_source: bool,

    /// Prefer dist installs
    #[arg(long = "prefer-dist")]
    pub prefer_dist: bool,

    /// Repository to install from
    #[arg(long = "repository")]
    pub repository: Option<String>,

    /// Install dev dependencies
    #[arg(long = "dev")]
    pub dev: bool,

    /// Don't install dependencies
    #[arg(long = "no-install")]
    pub no_install: bool,

    /// Ignore platform requirements
    #[arg(long = "ignore-platform-reqs")]
    pub ignore_platform_reqs: bool,
}

#[derive(Args, Debug)]
pub struct RunScriptArgs {
    /// Script name to run
    pub script: String,

    /// Additional arguments to pass to the script
    pub args: Vec<String>,

    /// Run in dev mode
    #[arg(long = "dev")]
    pub dev: bool,

    /// List available scripts
    #[arg(long = "list")]
    pub list: bool,
}

#[derive(Args, Debug)]
pub struct ArchiveArgs {
    /// Package name to archive
    pub package: Option<String>,

    /// Version to archive
    pub version: Option<String>,

    /// Output file name
    #[arg(long = "file")]
    pub file: Option<String>,

    /// Output directory
    #[arg(long = "dir")]
    pub dir: Option<String>,

    /// Archive format (tar, zip)
    #[arg(long = "format", default_value = "tar")]
    pub format: String,
}

#[derive(Args, Debug)]
pub struct ClearCacheArgs {
    /// Clear specific cache type (repo, files, vcs, all)
    pub cache_type: Option<String>,
}

#[derive(Args, Debug)]
pub struct ConfigArgs {
    /// Config key to get or set
    pub key: Option<String>,

    /// Value to set (if setting)
    pub value: Option<String>,

    /// List all config values
    #[arg(long = "list")]
    pub list: bool,

    /// Get global config
    #[arg(long = "global")]
    pub global: bool,

    /// Unset a config value
    #[arg(long = "unset")]
    pub unset: bool,
}

#[derive(Args, Debug)]
pub struct DependsArgs {
    /// Package name to check
    pub package: String,

    /// Version constraint
    pub constraint: Option<String>,

    /// Check recursively
    #[arg(long = "recursive")]
    pub recursive: bool,

    /// Show tree
    #[arg(long = "tree")]
    pub tree: bool,
}

#[derive(Args, Debug)]
pub struct ProhibitsArgs {
    /// Package name to check
    pub package: String,

    /// Version constraint
    pub constraint: Option<String>,

    /// Check recursively
    #[arg(long = "recursive")]
    pub recursive: bool,

    /// Show tree
    #[arg(long = "tree")]
    pub tree: bool,
}

#[derive(Args, Debug)]
pub struct BrowseArgs {
    /// Package name to browse
    pub package: String,

    /// Open homepage instead of repository
    #[arg(long = "homepage")]
    pub homepage: bool,

    /// Show URL instead of opening browser
    #[arg(long = "show")]
    pub show: bool,
}