mago 1.20.1

A comprehensive suite of PHP tooling inspired by Rust’s approach, providing parsing, linting, formatting, and more through a unified CLI and library interface.
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

use std::path::PathBuf;
use std::sync::LazyLock;

use tracing::error;

use mago_php_version::PHPVersion;

/// Targets for which official pre-built binaries are provided.
///
/// This list must match the build matrix in `.github/workflows/cd.yml`.
pub const SUPPORTED_TARGETS: &[&str] = &[
    "x86_64-pc-windows-msvc",
    "aarch64-apple-darwin",
    "x86_64-apple-darwin",
    "aarch64-unknown-linux-gnu",
    "aarch64-unknown-linux-musl",
    "x86_64-unknown-linux-gnu",
    "x86_64-unknown-linux-musl",
    "x86_64-pc-windows-gnu",
    "x86_64-unknown-freebsd",
    "arm-unknown-linux-gnueabi",
    "arm-unknown-linux-gnueabihf",
    "arm-unknown-linux-musleabi",
    "arm-unknown-linux-musleabihf",
    "armv7-unknown-linux-gnueabihf",
    "armv7-unknown-linux-musleabihf",
];

/// The current version of mago.
pub const VERSION: &str = env!("CARGO_PKG_VERSION");

/// The target triple for the current build.
pub const TARGET: &str = env!("TARGET");

/// The name of the binary.
pub const BIN: &str = env!("CARGO_PKG_NAME");

/// The extension for the archive file for the current platform.
#[cfg(target_os = "windows")]
pub const ARCHIVE_EXTENSION: &str = "zip";
#[cfg(not(target_os = "windows"))]
pub const ARCHIVE_EXTENSION: &str = "tar.gz";

/// The extension for PHP files.
pub const PHP_EXTENSION: &str = "php";

/// The name of the repository owner.
pub const REPO_OWNER: &str = "carthage-software";

/// The name of the repository.
pub const REPO_NAME: &str = "mago";

/// The URL for creating new issues.
pub const ISSUE_URL: &str = "https://github.com/carthage-software/mago/issues/new";

/// The name of the environment variable prefix for mago.
pub const ENVIRONMENT_PREFIX: &str = "MAGO";

/// The name of the configuration file for mago.
pub const CONFIGURATION_FILE_NAME: &str = "mago";

/// The name of the distributed configuration file for mago.
pub const CONFIGURATION_DIST_FILE_NAME: &str = "mago.dist";

/// The name of `composer.json` file.
pub const COMPOSER_JSON_FILE: &str = "composer.json";

/// The minimum stack size for each thread (8 MB).
pub const MINIMUM_STACK_SIZE: usize = 8 * 1024 * 1024;

/// The default stack size for each thread (12 MB).
pub const DEFAULT_STACK_SIZE: usize = 12 * 1024 * 1024;

/// The maximum stack size for each thread (256 MB).
pub const MAXIMUM_STACK_SIZE: usize = 256 * 1024 * 1024;

/// The default php version.
pub const DEFAULT_PHP_VERSION: PHPVersion = PHPVersion::LATEST;

/// The minimum supported PHP version.
pub const MINIMUM_PHP_VERSION: PHPVersion = PHPVersion::PHP80;

/// The maximum supported PHP version.
pub const MAXIMUM_PHP_VERSION: PHPVersion = PHPVersion::NEXT;

/// The number of logical CPUs on the system.
pub static LOGICAL_CPUS: LazyLock<usize> = LazyLock::new(|| {
    std::thread::available_parallelism().map(|n| n.get()).unwrap_or_else(|e| {
        error!("Failed to get the number of logical CPUs: {}", e);
        error!("Falling back to 1 logical CPU. This might result in slower performance.");
        error!("Need help? Open an issue at {}.", ISSUE_URL);

        1
    })
});

/// The current working directory.
pub static CURRENT_DIR: LazyLock<PathBuf> = LazyLock::new(|| {
    std::env::current_dir().unwrap_or_else(|e| {
        error!("Failed to get the current working directory: {}", e);
        error!("This might occur if the directory has been deleted or if the process lacks the necessary permissions.");
        error!("Please ensure that the directory exists and that you have the required permissions to access it.");
        error!("Need help? Open an issue at {}.", ISSUE_URL);

        std::process::exit(1);
    })
});

pub const PRELUDE_BYTES: &[u8] = include_bytes!(concat!(env!("OUT_DIR"), "/prelude.bin"));