refactor: Introduce crates folder

.github/workflows/ci.yaml

@@ -60,7 +60,7 @@ jobs:
           target: wasm32-unknown-unknown
       - uses: Swatinem/rust-cache@v1
       - run: cargo clippy --workspace --all-targets --all-features -- -D warnings -W clippy::pedantic
-      - run: cargo clippy -p ruff --target wasm32-unknown-unknown --all-features -- -D warnings -W clippy::pedantic
+      - run: cargo clippy -p ruff_analyze --target wasm32-unknown-unknown --all-features -- -D warnings -W clippy::pedantic
 
   cargo-test:
     name: "cargo test"

.github/workflows/playground.yaml

@@ -31,7 +31,7 @@ jobs:
       - uses: jetli/wasm-pack-action@v0.4.0
       - uses: jetli/wasm-bindgen-action@v0.2.0
       - name: "Run wasm-pack"
-        run: wasm-pack build --target web --out-dir playground/src/pkg . -- -p ruff
+        run: wasm-pack build --target web --out-dir ../../playground/src/pkg crates/ruff_analyze --out-name=ruff
       - name: "Install Node dependencies"
         run: npm ci
         working-directory: playground

Cargo.toml

@@ -1,85 +1,10 @@
 [workspace]
 members = [
-  "flake8_to_ruff",
+  "crates/*",
   "ruff_dev",
-  "ruff_cli",
 ]
-default-members = [".", "ruff_cli"]
 
-[package]
-name = "ruff"
-version = "0.0.229"
-authors = ["Charlie Marsh <charlie.r.marsh@gmail.com>"]
-edition = "2021"
-rust-version = "1.65.0"
-documentation = "https://github.com/charliermarsh/ruff"
-homepage = "https://github.com/charliermarsh/ruff"
-repository = "https://github.com/charliermarsh/ruff"
-readme = "README.md"
-license = "MIT"
-
-[lib]
-name = "ruff"
-crate-type = ["cdylib", "rlib"]
-doctest = false
-
-[dependencies]
-anyhow = { version = "1.0.66" }
-bitflags = { version = "1.3.2" }
-cfg-if = { version = "1.0.0" }
-chrono = { version = "0.4.21", default-features = false, features = ["clock"] }
-clap = { version = "4.0.1", features = ["derive", "env"] }
-colored = { version = "2.0.0" }
-dirs = { version = "4.0.0" }
-fern = { version = "0.6.1" }
-glob = { version = "0.3.0" }
-globset = { version = "0.4.9" }
-ignore = { version = "0.4.18" }
-imperative = { version = "1.0.3" }
-itertools = { version = "0.10.5" }
-libcst = { git = "https://github.com/charliermarsh/LibCST", rev = "f2f0b7a487a8725d161fe8b3ed73a6758b21e177" }
-log = { version = "0.4.17" }
-natord = { version = "1.0.9" }
-nohash-hasher = { version = "0.2.0" }
-num-bigint = { version = "0.4.3" }
-num-traits = "0.2.15"
-once_cell = { version = "1.16.0" }
-path-absolutize = { version = "3.0.14", features = ["once_cell_cache", "use_unix_paths_on_wasm"] }
-regex = { version = "1.6.0" }
-ruff_macros = { version = "0.0.229", path = "ruff_macros" }
-rustc-hash = { version = "1.1.0" }
-rustpython-ast = { features = ["unparse"], git = "https://github.com/RustPython/RustPython.git", rev = "62aa942bf506ea3d41ed0503b947b84141fdaa3c" }
-rustpython-common = { git = "https://github.com/RustPython/RustPython.git", rev = "62aa942bf506ea3d41ed0503b947b84141fdaa3c" }
-rustpython-parser = { features = ["lalrpop"], git = "https://github.com/RustPython/RustPython.git", rev = "62aa942bf506ea3d41ed0503b947b84141fdaa3c" }
-schemars = { version = "0.8.11" }
-semver = { version = "1.0.16" }
-serde = { version = "1.0.147", features = ["derive"] }
-shellexpand = { version = "3.0.0" }
-smallvec = { version = "1.10.0" }
-strum = { version = "0.24.1", features = ["strum_macros"] }
-strum_macros = { version = "0.24.3" }
-textwrap = { version = "0.16.0" }
-thiserror = { version = "1.0" }
-titlecase = { version = "2.2.1" }
-toml_edit = { version = "0.17.1", features = ["easy"] }
-
-# https://docs.rs/getrandom/0.2.7/getrandom/#webassembly-support
-# For (future) wasm-pack support
-[target.'cfg(all(target_family = "wasm", target_os = "unknown"))'.dependencies]
-getrandom = { version = "0.2.7", features = ["js"] }
-console_error_panic_hook = { version = "0.1.7" }
-console_log = { version = "0.2.0" }
-serde-wasm-bindgen = { version = "0.4" }
-js-sys = { version = "0.3.60" }
-wasm-bindgen = { version = "0.2.83" }
-
-[dev-dependencies]
-insta = { version = "1.19.1", features = ["yaml"] }
-test-case = { version = "2.2.2" }
-wasm-bindgen-test = { version = "0.3.33" }
-
-[target.'cfg(not(target_family = "wasm"))'.dev-dependencies]
-criterion = { version = "0.4.0" }
+default-members = ["crates/ruff_analyze", "crates/ruff_cli"]
 
 [profile.release]
 panic = "abort"
@@ -97,3 +22,4 @@ opt-level = 3
 # https://github.com/bytecodealliance/wasm-tools/blob/b5c3d98e40590512a3b12470ef358d5c7b983b15/crates/wasmparser/src/limits.rs#L29
 [profile.dev.package.rustpython-parser]
 opt-level = 1
+

README.md

@@ -1698,37 +1698,37 @@ To benchmark the release build:
 
 ```shell
 cargo build --release && hyperfine --ignore-failure --warmup 10 \
-  "./target/release/ruff ./resources/test/cpython/ --no-cache" \
-  "./target/release/ruff ./resources/test/cpython/"
+  "./target/release/ruff ../../resources/test/cpython/ --no-cache" \
+  "./target/release/ruff ../../resources/test/cpython/"
 
-Benchmark 1: ./target/release/ruff ./resources/test/cpython/ --no-cache
+Benchmark 1: ./target/release/ruff ../../resources/test/cpython/ --no-cache
   Time (mean ± σ):     293.8 ms ±   3.2 ms    [User: 2384.6 ms, System: 90.3 ms]
   Range (min … max):   289.9 ms … 301.6 ms    10 runs
 
   Warning: Ignoring non-zero exit code.
 
-Benchmark 2: ./target/release/ruff ./resources/test/cpython/
+Benchmark 2: ./target/release/ruff ../../resources/test/cpython/
   Time (mean ± σ):      48.0 ms ±   3.1 ms    [User: 65.2 ms, System: 124.7 ms]
   Range (min … max):    45.0 ms …  66.7 ms    62 runs
 
   Warning: Ignoring non-zero exit code.
 
 Summary
-  './target/release/ruff ./resources/test/cpython/' ran
-    6.12 ± 0.41 times faster than './target/release/ruff ./resources/test/cpython/ --no-cache'
+  './target/release/ruff ../../resources/test/cpython/' ran
+    6.12 ± 0.41 times faster than './target/release/ruff ../../resources/test/cpython/ --no-cache'
 ```
 
 To benchmark against the ecosystem's existing tools:
 
 ```shell
 hyperfine --ignore-failure --warmup 5 \
-  "./target/release/ruff ./resources/test/cpython/ --no-cache" \
+  "./target/release/ruff ../../resources/test/cpython/ --no-cache" \
   "pyflakes resources/test/cpython" \
   "autoflake --recursive --expand-star-imports --remove-all-unused-imports --remove-unused-variables --remove-duplicate-keys resources/test/cpython" \
   "pycodestyle resources/test/cpython" \
   "flake8 resources/test/cpython"
 
-Benchmark 1: ./target/release/ruff ./resources/test/cpython/ --no-cache
+Benchmark 1: ./target/release/ruff ../../resources/test/cpython/ --no-cache
   Time (mean ± σ):     294.3 ms ±   3.3 ms    [User: 2467.5 ms, System: 89.6 ms]
   Range (min … max):   291.1 ms … 302.8 ms    10 runs
 
@@ -1757,7 +1757,7 @@ Benchmark 5: flake8 resources/test/cpython
   Warning: Ignoring non-zero exit code.
 
 Summary
-  './target/release/ruff ./resources/test/cpython/ --no-cache' ran
+  './target/release/ruff ../../resources/test/cpython/ --no-cache' ran
    20.98 ± 0.62 times faster than 'autoflake --recursive --expand-star-imports --remove-all-unused-imports --remove-unused-variables --remove-duplicate-keys resources/test/cpython'
    41.66 ± 1.18 times faster than 'flake8 resources/test/cpython'
    53.64 ± 0.77 times faster than 'pyflakes resources/test/cpython'

flake8_to_ruff/Cargo.toml → crates/flake8_to_ruff/Cargo.toml

@@ -10,7 +10,7 @@ colored = { version = "2.0.0" }
 configparser = { version = "3.0.2" }
 once_cell = { version = "1.16.0" }
 regex = { version = "1.6.0" }
-ruff = { path = "..", default-features = false }
+ruff_analyze = { path = "../ruff_analyze", default-features = false }
 rustc-hash = { version = "1.1.0" }
 serde = { version = "1.0.147", features = ["derive"] }
 serde_json = { version = "1.0.87" }

flake8_to_ruff/src/main.rs → crates/flake8_to_ruff/src/main.rs

@@ -18,7 +18,7 @@ use std::path::PathBuf;
 use anyhow::Result;
 use clap::Parser;
 use configparser::ini::Ini;
-use ruff::flake8_to_ruff;
+use ruff_analyze::flake8_to_ruff;
 
 #[derive(Parser)]
 #[command(

crates/ruff_analyze/Cargo.toml

@@ -0,0 +1,75 @@
+[package]
+name = "ruff_analyze"
+version = "0.0.229"
+authors = ["Charlie Marsh <charlie.r.marsh@gmail.com>"]
+edition = "2021"
+rust-version = "1.65.0"
+documentation = "https://github.com/charliermarsh/ruff"
+homepage = "https://github.com/charliermarsh/ruff"
+repository = "https://github.com/charliermarsh/ruff"
+readme = "README.md"
+license = "MIT"
+
+[lib]
+crate-type = ["cdylib", "rlib"]
+doctest = false
+
+[dependencies]
+anyhow = { version = "1.0.66" }
+bitflags = { version = "1.3.2" }
+cfg-if = { version = "1.0.0" }
+chrono = { version = "0.4.21", default-features = false, features = ["clock"] }
+clap = { version = "4.0.1", features = ["derive", "env"] }
+colored = { version = "2.0.0" }
+dirs = { version = "4.0.0" }
+fern = { version = "0.6.1" }
+glob = { version = "0.3.0" }
+globset = { version = "0.4.9" }
+ignore = { version = "0.4.18" }
+imperative = { version = "1.0.3" }
+itertools = { version = "0.10.5" }
+libcst = { git = "https://github.com/charliermarsh/LibCST", rev = "f2f0b7a487a8725d161fe8b3ed73a6758b21e177" }
+log = { version = "0.4.17" }
+natord = { version = "1.0.9" }
+nohash-hasher = { version = "0.2.0" }
+num-bigint = { version = "0.4.3" }
+num-traits = "0.2.15"
+once_cell = { version = "1.16.0" }
+path-absolutize = { version = "3.0.14", features = ["once_cell_cache", "use_unix_paths_on_wasm"] }
+regex = { version = "1.6.0" }
+ruff_macros = { path = "../ruff_macros" }
+rustc-hash = { version = "1.1.0" }
+rustpython-ast = { features = ["unparse"], git = "https://github.com/RustPython/RustPython.git", rev = "62aa942bf506ea3d41ed0503b947b84141fdaa3c" }
+rustpython-common = { git = "https://github.com/RustPython/RustPython.git", rev = "62aa942bf506ea3d41ed0503b947b84141fdaa3c" }
+rustpython-parser = { features = ["lalrpop"], git = "https://github.com/RustPython/RustPython.git", rev = "62aa942bf506ea3d41ed0503b947b84141fdaa3c" }
+schemars = { version = "0.8.11" }
+semver = { version = "1.0.16" }
+serde = { version = "1.0.147", features = ["derive"] }
+shellexpand = { version = "3.0.0" }
+smallvec = { version = "1.10.0" }
+strum = { version = "0.24.1", features = ["strum_macros"] }
+strum_macros = { version = "0.24.3" }
+textwrap = { version = "0.16.0" }
+thiserror = { version = "1.0" }
+titlecase = { version = "2.2.1" }
+toml_edit = { version = "0.17.1", features = ["easy"] }
+
+# https://docs.rs/getrandom/0.2.7/getrandom/#webassembly-support
+# For (future) wasm-pack support
+[target.'cfg(all(target_family = "wasm", target_os = "unknown"))'.dependencies]
+getrandom = { version = "0.2.7", features = ["js"] }
+console_error_panic_hook = { version = "0.1.7" }
+console_log = { version = "0.2.0" }
+serde-wasm-bindgen = { version = "0.4" }
+js-sys = { version = "0.3.60" }
+wasm-bindgen = { version = "0.2.83" }
+
+[dev-dependencies]
+insta = { version = "1.19.1", features = ["yaml"] }
+test-case = { version = "2.2.2" }
+wasm-bindgen-test = { version = "0.3.33" }
+
+[target.'cfg(not(target_family = "wasm"))'.dev-dependencies]
+criterion = { version = "0.4.0" }
+
+

build.rs → crates/ruff_analyze/build.rs

@@ -24,13 +24,13 @@ fn generate_linter_name_and_url(out_dir: &Path) {
     let mut url_match_arms: String = r#"Linter::Ruff => None,"#.into();
 
     for file in fs::read_dir("src/rules/")
-        .unwrap()
+        .expect("Rules directory to exist")
         .flatten()
         .filter(|f| f.file_type().unwrap().is_dir() && f.file_name() != "ruff")
     {
         let mod_rs_path = file.path().join("mod.rs");
         let mod_rs_path = mod_rs_path.to_str().unwrap();
-        let first_line = BufReader::new(fs::File::open(mod_rs_path).unwrap())
+        let first_line = BufReader::new(fs::File::open(mod_rs_path).expect("mod.rs to exist"))
             .lines()
             .next()
             .unwrap()

src/packaging.rs → crates/ruff_analyze/src/packaging.rs

@@ -126,49 +126,49 @@ mod tests {
         assert_eq!(
             detect_package_root(
                 PathBuf::from(env!("CARGO_MANIFEST_DIR"))
-                    .join("resources/test/package/src/package")
+                    .join("../../resources/test/package/src/package")
                     .as_path(),
                 &[],
             ),
             Some(
                 PathBuf::from(env!("CARGO_MANIFEST_DIR"))
-                    .join("resources/test/package/src/package")
+                    .join("../../resources/test/package/src/package")
                     .as_path()
             )
         );
 
         assert_eq!(
             detect_package_root(
                 PathBuf::from(env!("CARGO_MANIFEST_DIR"))
-                    .join("resources/test/project/python_modules/core/core")
+                    .join("../../resources/test/project/python_modules/core/core")
                     .as_path(),
                 &[],
             ),
             Some(
                 PathBuf::from(env!("CARGO_MANIFEST_DIR"))
-                    .join("resources/test/project/python_modules/core/core")
+                    .join("../../resources/test/project/python_modules/core/core")
                     .as_path()
             )
         );
 
         assert_eq!(
             detect_package_root(
                 PathBuf::from(env!("CARGO_MANIFEST_DIR"))
-                    .join("resources/test/project/examples/docs/docs/concepts")
+                    .join("../../resources/test/project/examples/docs/docs/concepts")
                     .as_path(),
                 &[],
             ),
             Some(
                 PathBuf::from(env!("CARGO_MANIFEST_DIR"))
-                    .join("resources/test/project/examples/docs/docs")
+                    .join("../../resources/test/project/examples/docs/docs")
                     .as_path()
             )
         );
 
         assert_eq!(
             detect_package_root(
                 PathBuf::from(env!("CARGO_MANIFEST_DIR"))
-                    .join("setup.py")
+                    .join("../../../setup.py")
                     .as_path(),
                 &[],
             ),

src/rules/eradicate/mod.rs → crates/ruff_analyze/src/rules/eradicate/mod.rs

@@ -17,7 +17,7 @@ mod tests {
     fn rules(rule_code: Rule, path: &Path) -> Result<()> {
         let snapshot = format!("{}_{}", rule_code.code(), path.to_string_lossy());
         let diagnostics = test_path(
-            Path::new("./resources/test/fixtures/eradicate")
+            Path::new("../../resources/test/fixtures/eradicate")
                 .join(path)
                 .as_path(),
             &settings::Settings::for_rule(rule_code),

src/rules/flake8_2020/mod.rs → crates/ruff_analyze/src/rules/flake8_2020/mod.rs

@@ -25,7 +25,7 @@ mod tests {
     fn rules(rule_code: Rule, path: &Path) -> Result<()> {
         let snapshot = format!("{}_{}", rule_code.code(), path.to_string_lossy());
         let diagnostics = test_path(
-            Path::new("./resources/test/fixtures/flake8_2020")
+            Path::new("../../resources/test/fixtures/flake8_2020")
                 .join(path)
                 .as_path(),
             &settings::Settings::for_rule(rule_code),