Refactor repo's files

This is intended to allow calling both rust lib and python lib "cpp-linter" when installing with cargo or pip.

Also when using python, the entry point script is now the same as it is in v1.x: `cpp_linter.main()`.

Author: 2bndy5

.github/workflows/build-docs.yml

@@ -34,11 +34,11 @@ jobs:
       - name: Install mdbook
         uses: taiki-e/install-action@v2
         with:
-          tool: mdbook,cargo-binstall
+          tool: mdbook,cargo-binstall,just
       - name: Install mdbook plugins
         run: cargo binstall -y mdbook-alerts
       - name: Build book
-        run: mdbook build docs
+        run: just docs-build
       - name: Upload docs build as artifact
         uses: actions/upload-artifact@v4
         with:
@@ -63,7 +63,11 @@ jobs:
         with:
           path: ~/.cargo
           key: ${{ runner.os }}-docs-cargo-${{ hashFiles('Cargo.lock') }}
-      - run: cargo doc --no-deps --manifest-path cpp-linter-lib/Cargo.toml
+      - name: Install mdbook
+        uses: taiki-e/install-action@v2
+        with:
+          tool: just
+      - run: just docs-rs
       - name: upload rustdoc build as artifact
         uses: actions/upload-artifact@v4
         with:

.pre-commit-config.yaml

@@ -3,7 +3,7 @@ repos:
     rev: v4.6.0
     hooks:
       - id: trailing-whitespace
-        exclude: cpp-linter-lib/tests/.*\.(?:patch|diff)
+        exclude: cpp-linter/tests/.*\.(?:patch|diff)
       - id: end-of-file-fixer
       - id: check-docstring-first
       - id: check-added-large-files

Cargo.lock

@@ -1,7 +1,7 @@
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [workspace]
-members = ["cpp-linter-lib", "cpp-linter-py", "docs"]
+members = ["cpp-linter", "py-binding", "docs"]
 resolver = "2"
 
 [workspace.package]

Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "cpp-linter-lib"
+name = "cpp-linter"
 edition = "2021"
 repository = "https://github.com/cpp-linter/cpp_linter_rs/tree/main/cpp-linter-lib"
 readme = "README.md"

cpp-linter-py/cpp_linter/__init__.py

@@ -279,7 +279,7 @@ mod test {
 
     #[test]
     fn normalize_no_root() {
-        let src = PathBuf::from("../cpp-linter-lib");
+        let src = PathBuf::from("../cpp-linter");
         let mut cur_dir = current_dir().unwrap();
         cur_dir = cur_dir
             .strip_prefix(current_dir().unwrap().parent().unwrap())

cpp-linter-py/cpp_linter/entry_point.py

@@ -2,7 +2,7 @@
 /// This crate is the binary executable's entrypoint.
 use std::env;
 
-use cpp_linter_lib::run::run_main;
+use ::cpp_linter::run::run_main;
 
 /// This function simply forwards CLI args to [`run_main()`].
 #[tokio::main]

cpp-linter-py/src/lib.rs

@@ -1,6 +1,6 @@
 use chrono::Utc;
-use cpp_linter_lib::cli::{LinesChangedOnly, ThreadComments};
-use cpp_linter_lib::run::run_main;
+use cpp_linter::cli::{LinesChangedOnly, ThreadComments};
+use cpp_linter::run::run_main;
 use mockito::Matcher;
 use std::{env, fmt::Display, io::Write, path::Path};
 use tempfile::NamedTempFile;

cpp-linter-lib/.gitignore renamed to cpp-linter/.gitignore

@@ -4,7 +4,7 @@ use common::{create_test_space, mock_server};
 use mockito::Matcher;
 use tempfile::{NamedTempFile, TempDir};
 
-use cpp_linter_lib::{
+use cpp_linter::{
     common_fs::FileFilter,
     rest_api::{github_api::GithubApiClient, RestApiClient},
 };

cpp-linter-lib/Cargo.toml renamed to cpp-linter/Cargo.toml

@@ -1,5 +1,5 @@
 use chrono::Utc;
-use cpp_linter_lib::{
+use cpp_linter::{
     cli::LinesChangedOnly,
     rest_api::{COMMENT_MARKER, USER_OUTREACH},
     run::run_main,

cpp-linter-lib/README.md renamed to cpp-linter/README.md

@@ -9,7 +9,7 @@ homepage.workspace = true
 license.workspace = true
 
 [dependencies]
-cpp-linter-lib = { path = "../cpp-linter-lib" }
+cpp-linter = { path = "../cpp-linter" }
 clap = "4.5.17"
 mdbook = "0.4.40"
 semver = "1.0.23"

cpp-linter-lib/src/clang_tools/clang_format.rs renamed to cpp-linter/src/clang_tools/clang_format.rs

@@ -12,7 +12,7 @@ use semver::{Version, VersionReq};
 use std::io;
 use std::process;
 
-extern crate cpp_linter_lib;
+extern crate cpp_linter;
 
 use cli_gen_lib::CliGen;
 
@@ -82,7 +82,7 @@ mod cli_gen_lib {
     use mdbook::book::Book;
     use mdbook::preprocess::{Preprocessor, PreprocessorContext};
 
-    use cpp_linter_lib::cli;
+    use cpp_linter::cli;
 
     pub struct CliGen;
 

cpp-linter-lib/src/clang_tools/clang_tidy.rs renamed to cpp-linter/src/clang_tools/clang_tidy.rs

@@ -1,27 +1,10 @@
 set windows-shell := ["powershell.exe", "-NoLogo", "-Command"]
 
-# activate python venv
-[group("python")]
-[windows]
-venv:
-    ./.env/Scripts/activate
-
-# activate python venv
-[group("python")]
-[linux]
-venv:
-    . ./.env/bin/activate
-
-# install python bindings
-[group("python")]
-py-dev:
-    maturin dev --manifest-path cpp-linter-py/Cargo.toml
-
 # run the test suite
 [group("code coverage")]
 test arg='':
     cargo llvm-cov --no-report \
-    nextest --manifest-path cpp-linter-lib/Cargo.toml \
+    nextest --manifest-path cpp-linter/Cargo.toml \
     --lib --tests --color always {{ arg }}
 
 # Clear previous test build artifacts
@@ -60,17 +43,17 @@ docs-build open='':
 # rust docs
 [group("docs")]
 docs-rs open='':
-    cargo doc --no-deps --lib --manifest-path cpp-linter-lib/Cargo.toml {{ open }}
+    cargo doc --no-deps --lib --manifest-path cpp-linter/Cargo.toml {{ open }}
 
 # run cpp-linter native binary
 [group("bin")]
 run *args:
-    cargo run --bin cpp-linter --manifest-path cpp-linter-lib/Cargo.toml -- {{ args }}
+    cargo run --bin cpp-linter --manifest-path cpp-linter/Cargo.toml -- {{ args }}
 
 # build the native binary
 [group("bin")]
 build *args='':
-    cargo build --bin cpp-linter --manifest-path cpp-linter-lib/Cargo.toml {{ args }}
+    cargo build --bin cpp-linter --manifest-path cpp-linter/Cargo.toml {{ args }}
 
 # run clippy and rustfmt
 lint:

cpp-linter-lib/src/clang_tools/mod.rs renamed to cpp-linter/src/clang_tools/mod.rs

@@ -17,8 +17,8 @@ crate-type = ["cdylib"]
 
 [dependencies]
 pyo3 = { version = "0.22.3", features = ["extension-module"] }
-cpp-linter-lib = { path = "../cpp-linter-lib" }
+cpp-linter = { path = "../cpp-linter" }
 tokio = "1.40.0"
 
 [features]
-openssl-vendored = ["cpp-linter-lib/openssl-vendored"]
+openssl-vendored = ["cpp-linter/openssl-vendored"]

cpp-linter-lib/src/cli/mod.rs renamed to cpp-linter/src/cli/mod.rs

@@ -0,0 +1,14 @@
+# type: ignore
+# ruff: noqa: F405 F403
+import sys
+from .cpp_linter import *
+
+__doc__ = cpp_linter.__doc__
+if hasattr(cpp_linter, "__all__"):
+    __all__ = list(filter(lambda x: x != "main", cpp_linter.__all__))
+
+
+def main():
+    """The main entrypoint for the python frontend. See our rust docs for more info on
+    the backend (implemented in rust)"""
+    sys.exit(cpp_linter.main(sys.argv))

cpp-linter-lib/src/cli/structs.rs renamed to cpp-linter/src/cli/structs.rs

@@ -33,7 +33,7 @@ classifiers = [
 dynamic = ["version"]
 
 [project.scripts]
-cpp-linter = "cpp_linter.entry_point:main"
+cpp-linter = "cpp_linter:main"
 
 [project.urls]
 source =  "https://github.com/cpp-linter/cpp-linter"

cpp-linter-lib/src/common_fs/file_filter.rs renamed to cpp-linter/src/common_fs/file_filter.rs

@@ -0,0 +1,22 @@
+use pyo3::prelude::*;
+use tokio::runtime::Builder;
+
+use ::cpp_linter::run::run_main;
+
+/// A wrapper for the ``::cpp_linter::run::run_main()```
+#[pyfunction]
+fn main(args: Vec<String>) -> PyResult<i32> {
+    Builder::new_multi_thread()
+        .enable_all()
+        .build()
+        .unwrap()
+        .block_on(async { Ok(run_main(args).await) })
+}
+
+/// The python binding for the cpp_linter package. It only exposes a ``main()`` function
+/// that is used as the entrypoint script.
+#[pymodule]
+fn cpp_linter(m: &Bound<'_, PyModule>) -> PyResult<()> {
+    m.add_function(wrap_pyfunction!(main, m)?)?;
+    Ok(())
+}