feat: add option to sort results by file path (#41)

* feat: add option to sort results by file path

* chore: add example configs

Author: beeb

.env.example

@@ -6,3 +6,4 @@ LINTSPEC_STRUCT_PARAMS=false # enforce that structs have `@param` for each membe
 LINTSPEC_ENUM_PARAMS=false   # enforce that enums have `@param` for each variant
 LINTSPEC_JSON=false          # output diagnostics as JSON
 LINTSPEC_COMPACT=false       # compact output (minified JSON or compact text)
+LINTSPEC_SORT=false          # sort results by file path

.lintspec.toml

@@ -7,3 +7,4 @@ struct_params = false # enforce that structs have `@param` for each member
 enum_params = false   # enforce that enums have `@param` for each variant
 json = false          # output diagnostics as JSON
 compact = false       # compact output (minified JSON or compact text)
+sort = false          # sort results by file path

README.md

@@ -76,6 +76,7 @@ Options:
       --enum-params                  Enforce that enums have `@param` for each variant
       --json                         Output diagnostics in JSON format
       --compact                      Compact output
+      --sort                         Sort the results by file path
   -h, --help                         Print help (see more with '--help')
   -V, --version                      Print version
 ```

src/config.rs

@@ -67,6 +67,12 @@ pub struct Args {
     /// Can be set with `--compact` (means true), `--compact true` or `--compact false`.
     #[arg(long, num_args = 0..=1, default_missing_value = "true")]
     pub compact: Option<bool>,
+
+    /// Sort the results by file path
+    ///
+    /// Can be set with `--sort` (means true), `--sort true` or `--sort false`.
+    #[arg(long, num_args = 0..=1, default_missing_value = "true")]
+    pub sort: Option<bool>,
 }
 
 #[derive(Debug, Clone, Serialize, Deserialize, bon::Builder)]
@@ -82,6 +88,7 @@ pub struct Config {
     pub enum_params: bool,
     pub json: bool,
     pub compact: bool,
+    pub sort: bool,
 }
 
 impl From<Args> for Config {
@@ -96,6 +103,7 @@ impl From<Args> for Config {
             enum_params: value.enum_params.unwrap_or_default(),
             json: value.json.unwrap_or_default(),
             compact: value.compact.unwrap_or_default(),
+            sort: value.sort.unwrap_or_default(),
         }
     }
 }
@@ -113,6 +121,7 @@ pub fn read_config() -> Result<Config> {
             enum_params: None,
             json: None,
             compact: None,
+            sort: None,
         }))
         .admerge(Toml::file(".lintspec.toml"))
         .admerge(Env::prefixed("LINTSPEC_"))
@@ -138,5 +147,8 @@ pub fn read_config() -> Result<Config> {
     if let Some(compact) = args.compact {
         temp.compact = Some(compact);
     }
+    if let Some(sort) = args.sort {
+        temp.sort = Some(sort);
+    }
     Ok(temp.into())
 }

src/files.rs

@@ -14,7 +14,11 @@ use crate::error::{Error, Result};
 /// Global git ignore configurations as well as parent folder gitignores are not taken into account.
 /// Hidden files are included.
 /// Returned paths are canonicalized.
-pub fn find_sol_files<T: AsRef<Path>>(paths: &[T], exclude: &[T]) -> Result<Vec<PathBuf>> {
+pub fn find_sol_files<T: AsRef<Path>>(
+    paths: &[T],
+    exclude: &[T],
+    sort: bool,
+) -> Result<Vec<PathBuf>> {
     // canonicalize exclude paths
     let exclude = exclude
         .iter()
@@ -97,5 +101,8 @@ pub fn find_sol_files<T: AsRef<Path>>(paths: &[T], exclude: &[T]) -> Result<Vec<
     while let Ok(path) = rx.recv() {
         files.push(path);
     }
+    if sort {
+        files.sort_unstable();
+    }
     Ok(files)
 }

src/main.rs

@@ -14,7 +14,7 @@ fn main() -> Result<()> {
     let config = read_config()?;
 
     // identify Solidity files to parse
-    let paths = find_sol_files(&config.paths, &config.exclude)?;
+    let paths = find_sol_files(&config.paths, &config.exclude, config.sort)?;
     if paths.is_empty() {
         bail!("no Solidity file found, nothing to analyze");
     }