fslint 0.1.3

Linter for filesystem consistency: names, metadata, permissions and sizes.
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

# fslint

`fslint` is a file linter (alpha stage — work in progress) that scans the current directory (or `--path`) using `fslint.json`, checking only files matching the `include` patterns.

### rules

See full list of supported [linter rules](./linter-rules.md).

### installation

```zsh
$ cargo install fslint
```

### usage

```zsh
$ fslint --help
Linter for filesystem consistency: names, metadata, permissions and sizes.

Usage: fslint [OPTIONS]

Options:
  -p, --path <PATH>  [default: .]
  -v, --verbose...
  -s, --schema
  -h, --help         Print help
  -V, --version      Print version
```

### config schema

Validate your config against [schema.json](https://raw.githubusercontent.com/grubyak/fslint/main/schema.json) or generate a local one with:

```zsh
$ fslint -s > schema.json
```

<!-- [schemastore](https://www.schemastore.org/fslint.json) -->

To enable schema validation in your editor, add the following to your `fslint.json`:

```json
"$schema": "https://raw.githubusercontent.com/grubyak/fslint/main/schema.json"
```

### sample config

```json
{
  "$schema": "https://raw.githubusercontent.com/grubyak/fslint/main/schema.json",
  "entries": [
    {
      "include": ["**/*.cr3"],
      "rules": {
        "exif-has-coords": {
          "level": "warn",
          "latitude": true,
          "longitude": true
        },
        "exif-has-capture-datetime": {
          "level": "error",
          "date": true
        }
      }
    },
    {
      // ...
    }
  ]
}
```

### output

```
$ fslint
/Users/foo/Desktop/not-an-image.cr3
    error exif-has-capture-datetime: exif metadata is missing
    error exif-has-coords: exif metadata is missing

/Users/foo/Desktop/test.cr3
    warn  exif-has-coords: missing latitude

✖ 3 problems (2 errors, 1 warning) -- inspected 2 files, skipped 18031 [130.25ms]
```

### debugging (verbosity)

```zsh
$ fslint -v    # logs
$ fslint -vv   # more logs
$ fslint -vvv  # max
```

### coffee

If you find this useful, consider [buying me a coffee](https://coff.ee/grubyak).

<a href="https://coff.ee/grubyak">
  <img src="bmc.png" alt="buy me a coffee" width="200"/>
</a>