add some comments

TODO.md

@@ -0,0 +1,4 @@
+make details
+rework UX add to make it more readable
+make image work on .projects
+refactor the code

package.json

@@ -1,7 +1,7 @@
 {
   "name": "side-project",
   "private": true,
-  "version": "0.0.1",
+  "version": "0.0.11",
   "type": "module",
   "scripts": {
     "dev": "vite",

src-tauri/src/main.rs

@@ -32,6 +32,10 @@ impl fmt::Display for Project {
     }
 }
 
+/**
+ * Stores the projects vector in the data.json file
+ * @ return Result<(), Box<dyn std::error::Error>> (should return Ok or an error)
+ */
 fn store_projects(
     projects: &Vec<Project>,
     file_path: &str,
@@ -48,6 +52,10 @@ fn store_projects(
     Ok(())
 }
 
+/**
+ * Reads the data.json file and returns a vector of Project structs
+ * @ return Result<Vec<Project>, Box<dyn std::error::Error>> (should return a vector of Project structs or an error)
+ */
 fn read_projects(file_path: &str) -> Result<Vec<Project>, Box<dyn std::error::Error>> {
     let file = File::open(file_path);
 
@@ -77,15 +85,28 @@ fn read_projects(file_path: &str) -> Result<Vec<Project>, Box<dyn std::error::Er
     Ok(projects)
 }
 
+/**
+ * Returns the path to the user's home directory
+ * @ return String (should return the path to the user's home directory)
+ */
 fn get_home_dir() -> String {
     return env::var("HOME").expect("Failed to get the user's home directory.");
 }
+
+/**
+ * Returns the path to the data.json file
+ * @ return String (should return the path to the data.json file)
+ */
 fn get_file_path() -> String {
     let home_dir = get_home_dir();
     let file_path = format!("{}/.projects/data.json", home_dir);
     file_path
 }
 
+/**
+ * Extracts the filename from a path and returns it as a String
+ * @ return Result<String, Box<dyn Error>> (should return a String as file.extension or an error)
+ */
 fn extract_filename(path: &str) -> Result<String, Box<dyn Error>> {
     let path = Path::new(path);
     let filename_osstr = path.file_name().ok_or("No file name present in path")?;
@@ -95,6 +116,11 @@ fn extract_filename(path: &str) -> Result<String, Box<dyn Error>> {
     Ok(filename_str.to_string())
 }
 
+/**
+ * Copies the logo to the .projects folder
+ * @ return Result<PathBuf, Box<dyn Error>> (should return the path to the logo or an error)
+ */
+ */
 fn copy_logo(project: &Project) -> Result<PathBuf, Box<dyn Error>> {
     let logo_path = match &project.logo {
         Some(path) => path,
@@ -114,7 +140,10 @@ fn copy_logo(project: &Project) -> Result<PathBuf, Box<dyn Error>> {
 }
 
 #[tauri::command]
-
+/**
+ * Returns the project with the given id
+ * @ return Option<Project> (should return the project with the given id or None if the project is not found)
+ */
 fn get_project(id: u32) -> Option<Project> {
     let projects = get_projects();
 
@@ -128,6 +157,9 @@ fn get_project(id: u32) -> Option<Project> {
 }
 
 #[tauri::command]
+/**
+ * Deletes the project with the given id
+ */
 async fn delete_project(id: u32) {
     let mut projects = get_projects();
     projects.retain(|project| project.id != id);
@@ -138,6 +170,10 @@ async fn delete_project(id: u32) {
 }
 
 #[tauri::command]
+/**
+ * Returns a vector of all projects
+ * @ return Vec<Project> (should return a vector of all projects)
+ */
 fn get_projects() -> Vec<Project> {
     let file_path = get_file_path();
     match read_projects(&file_path) {
@@ -149,6 +185,10 @@ fn get_projects() -> Vec<Project> {
     }
 }
 
+/**
+ * Adds a project to the data.json file
+ * @ return Result<bool, String> (should return true if the project was added successfully or an error)
+ */
 #[tauri::command]
 fn add_project(mut project: Project) -> Result<bool, String> {
     let mut projects = get_projects();
@@ -168,6 +208,9 @@ fn add_project(mut project: Project) -> Result<bool, String> {
     }
 }
 
+/**
+ * Runs the Tauri application
+ */
 fn main() {
     tauri::Builder::default()
         .invoke_handler(tauri::generate_handler![

src/App.svelte

@@ -1,4 +1,8 @@
 <script lang="ts">
+  // this component is the main component of the app
+  // it contains the sidebar and the routes
+  // it also contains the router
+  // the router is used to navigate between the routes
   import SideBar from "./lib/SideBar.svelte";
   import { Router, Route } from "svelte-routing";
 

src/lib/Add.svelte

@@ -22,9 +22,14 @@
     logo: "",
   };
 
+  // this is used to get the options for the status (object to select array)
   let options = Object.values(Status) as string[];
   project.status = options[0];
 
+  /**
+   * @description this function is used to add a logo to the project
+   * @returns {Promise<void>}
+   */
   async function addLogo() {
     const selected = await open({
       multiple: false,
@@ -40,6 +45,10 @@
     }
   }
 
+  /**
+   * @description this function is used to save the data to the database
+   * @returns {Promise<void>}
+   */
   async function saveData() {
     try {
       if (!project.name || !project.description || !project.status) {

src/lib/Deleted.svelte

@@ -5,14 +5,20 @@
   const dispatch = createEventDispatcher();
 
   export let id: number;
+  /**
+   * @description this function is used to delete a project
+   * @returns {Promise<void>}
+   */
   async function deleteProject() {
-    console.log("here");
     await parseTauriCommand("delete_project", { id });
-    console.log("pass after delete");
     dispatch("deleted");
   }
+  /**
+   * @description this function is used to handle the keydown event for accesibility
+   * @param {KeyboardEvent} event
+   * @returns {void}
+   */
   function handleKeydown(event: KeyboardEvent) {
-    // Activate on Enter or Space keys
     if (event.key === "Enter" || event.key === " ") {
       deleteProject();
     }

src/lib/List.svelte

@@ -12,6 +12,11 @@
 
   let list: Project[] = [];
 
+  /**
+   * @description this function is used to get the list from tauri and set it to the list variable
+   * @returns {Promise<void>}
+   *
+   */
   async function getList() {
     try {
       list = await parseTauriCommand<Project[]>("get_projects");
@@ -20,12 +25,21 @@
       console.error(error);
     }
   }
+
+  /**
+   * @description this function is used to update the list after a project is deleted
+   */
   async function updateProject() {
     await getList();
   }
 
   onMount(getList);
 
+  /**
+   * @description this function is used to compute the time between now and the creation of the project
+   * @param item {Project} the project to compute the time for
+   * @returns {number} the time between now and the creation of the project (days)
+   */
   function computeTime(item: Project): number {
     if (item.status !== Status.Active && item.status !== Status.Inactive)
       return 0;
@@ -35,6 +49,10 @@
     return diff;
   }
 
+  /**
+   * @description this function is used to notify the user if a project is not updated for more than 7 days
+   * @returns {void}
+   */
   function notify() {
     if ($hasInitialized === false) {
       list.forEach((item) => {

src/lib/Routes.svelte

@@ -1,4 +1,6 @@
 <script lang="ts">
+  // this component contains the routes of the app
+
   import { Route } from "svelte-routing";
   import Add from "./Add.svelte";
   import Details from "./Details.svelte";

src/lib/SideBar.svelte

@@ -1,4 +1,7 @@
 <script lang="ts">
+  // this component is the sidebar of the app
+  // it contains the links to the routes
+  // it also contains the icons for the links
   import { Link } from "svelte-routing";
   import IoIosAdd from "svelte-icons/io/IoIosAdd.svelte";
   import IoMdHome from "svelte-icons/io/IoMdHome.svelte";

src/lib/StatusIcon.svelte

@@ -1,4 +1,5 @@
 <script lang="ts">
+  // this component is used to display the status of a project
   import { Status } from "/src/project";
   import IoMdPause from "svelte-icons/io/IoMdPause.svelte";
   import IoMdCheckmark from "svelte-icons/io/IoMdCheckmark.svelte";