feat: create plugin path alongside repo cache

mitre · Aug 23, 2024 · 51e4419 · 51e4419
1 parent be480c3
commit 51e4419
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/hipcheck/src/cache.rs b/hipcheck/src/cache.rs
@@ -220,6 +220,8 @@ pub struct HcCache {
 impl HcCache {
 	pub fn new(path: &Path) -> Self {
 		let clones_path = pathbuf![path, "clones"];
+		// TODO: use this path for managing/interacting with hc plugins
+		let _plugins_path = pathbuf![path, "plugins"];
 		let entries: Vec<CacheEntry> = HcCacheIterator::new(clones_path.as_path()).collect();
 		HcCache {
 			path: clones_path,

diff --git a/site/content/docs/guide/concepts/index.md b/site/content/docs/guide/concepts/index.md
@@ -64,8 +64,9 @@ priority). Each directory serves a specific purpose:
 - The Config directory: stores Hipcheck's configuration files.
 - The Data directory: stores Hipcheck's helper scripts needed for running
   additional external tools Hipcheck relies on.
-- The Cache directory: stores local clones of repositories Hipcheck is
-  analyzing.
+- The Cache directory:
+  - stores local clones of repositories Hipcheck is analyzing
+  - stores Hipcheck plugins
 
 Of these, the Cache directory is one that has a tendency to grow as your
 use of Hipcheck continues. Some Git repositories, especially those for