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
|
use std::{
default::Default,
fs, io,
path::{Path, PathBuf},
str::FromStr,
};
use clap::Clap;
use globset::{Error as GlobError, GlobBuilder, GlobSet, GlobSetBuilder};
use vfs::ReadOnlyVfs;
use crate::err::ConfigErr;
/// Lints and suggestions for the Nix programming language
#[derive(Clap, Debug)]
#[clap(version = "0.1.0", author = "Akshay <[email protected]>")]
pub struct Opts {
/// File or directory to run statix on
#[clap(default_value = ".")]
pub target: String,
/// Globs of file patterns to skip
#[clap(short, long)]
pub ignore: Vec<String>,
/// Output format.
/// Supported values: errfmt, json (on feature flag only)
#[clap(short = 'o', long)]
format: Option<OutFormat>,
/// Find and fix issues raised by statix
#[clap(short = 'f', long)]
pub fix: bool,
/// Do not fix files in place, display a diff instead
#[clap(short = 'd', long = "dry-run")]
diff_only: bool,
}
#[derive(Debug, Copy, Clone)]
pub enum OutFormat {
#[cfg(feature = "json")]
Json,
Errfmt,
StdErr,
}
impl Default for OutFormat {
fn default() -> Self {
OutFormat::StdErr
}
}
impl FromStr for OutFormat {
type Err = &'static str;
fn from_str(value: &str) -> Result<Self, Self::Err> {
match value.to_ascii_lowercase().as_str() {
#[cfg(feature = "json")] "json" => Ok(Self::Json),
"errfmt" => Ok(Self::Errfmt),
"stderr" => Ok(Self::StdErr),
"json" => Err("statix was not compiled with the `json` feature flag"),
_ => Err("unknown output format, try: json, errfmt"),
}
}
}
#[derive(Debug)]
pub struct LintConfig {
pub files: Vec<PathBuf>,
pub format: OutFormat,
}
impl LintConfig {
pub fn from_opts(opts: Opts) -> Result<Self, ConfigErr> {
let ignores = build_ignore_set(&opts.ignore).map_err(|err| {
ConfigErr::InvalidGlob(err.glob().map(|i| i.to_owned()), err.kind().clone())
})?;
let files = walk_nix_files(&opts.target)?
.filter(|path| !ignores.is_match(path))
.collect();
Ok(Self {
files,
format: opts.format.unwrap_or_default(),
})
}
pub fn vfs(&self) -> Result<ReadOnlyVfs, ConfigErr> {
let mut vfs = ReadOnlyVfs::default();
for file in self.files.iter() {
let _id = vfs.alloc_file_id(&file);
let data = fs::read_to_string(&file).map_err(ConfigErr::InvalidPath)?;
vfs.set_file_contents(&file, data.as_bytes());
}
Ok(vfs)
}
}
pub struct FixConfig {
pub files: Vec<PathBuf>,
pub diff_only: bool,
}
impl FixConfig {
pub fn from_opts(opts: Opts) -> Result<Self, ConfigErr> {
let ignores = build_ignore_set(&opts.ignore).map_err(|err| {
ConfigErr::InvalidGlob(err.glob().map(|i| i.to_owned()), err.kind().clone())
})?;
let files = walk_nix_files(&opts.target)?
.filter(|path| !ignores.is_match(path))
.collect();
let diff_only = opts.diff_only;
Ok(Self { files, diff_only })
}
pub fn vfs(&self) -> Result<ReadOnlyVfs, ConfigErr> {
let mut vfs = ReadOnlyVfs::default();
for file in self.files.iter() {
let _id = vfs.alloc_file_id(&file);
let data = fs::read_to_string(&file).map_err(ConfigErr::InvalidPath)?;
vfs.set_file_contents(&file, data.as_bytes());
}
Ok(vfs)
}
}
mod dirs {
use std::{
fs,
io::{self, Error, ErrorKind},
path::{Path, PathBuf},
};
#[derive(Default, Debug)]
pub struct Walker {
dirs: Vec<PathBuf>,
files: Vec<PathBuf>,
}
impl Walker {
pub fn new<P: AsRef<Path>>(target: P) -> io::Result<Self> {
let target = target.as_ref().to_path_buf();
if !target.exists() {
Err(Error::new(
ErrorKind::NotFound,
format!("file not found: {}", target.display()),
))
} else if target.is_dir() {
Ok(Self {
dirs: vec![target],
..Default::default()
})
} else {
Ok(Self {
files: vec![target],
..Default::default()
})
}
}
}
impl Iterator for Walker {
type Item = PathBuf;
fn next(&mut self) -> Option<Self::Item> {
if let Some(dir) = self.dirs.pop() {
if dir.is_dir() {
for entry in fs::read_dir(dir).ok()? {
let entry = entry.ok()?;
let path = entry.path();
if path.is_dir() {
self.dirs.push(path);
} else if path.is_file() {
self.files.push(path);
}
}
}
}
self.files.pop()
}
}
}
fn build_ignore_set(ignores: &Vec<String>) -> Result<GlobSet, GlobError> {
let mut set = GlobSetBuilder::new();
for pattern in ignores {
let glob = GlobBuilder::new(&pattern).build()?;
set.add(glob);
}
set.build()
}
fn walk_nix_files<P: AsRef<Path>>(target: P) -> Result<impl Iterator<Item = PathBuf>, io::Error> {
let walker = dirs::Walker::new(target)?;
Ok(walker.filter(|path: &PathBuf| matches!(path.extension(), Some(e) if e == "nix")))
}
|
