issue #282: fix formatting, vscode extension suggestions & settings

.prettierignore

@@ -1,3 +1,3 @@
 node_modules
 .next
-build
+build

.prettierrc

@@ -6,4 +6,4 @@
   "trailingComma": "all",
   "printWidth": 80,
   "endOfLine": "lf"
-}
+}

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "esbenp.prettier-vscode",
+    "davidanson.vscode-markdownlint",
+    "bierner.markdown-mermaid"
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,13 @@
+{
+  "[javascript]": {
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[typescript]": {
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "prettier.trailingComma": "all",
+  "javascript.updateImportsOnFileMove.enabled": "always",
+  "typescript.updateImportsOnFileMove.enabled": "always"
+}

LICENSE

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

README.md

@@ -12,7 +12,6 @@ This project is a **Next.js v14.2.15** application using **TypeScript**, **Mater
 - [State Management](#state-management)
 - [Contribution Guidelines](#contribution-guidelines)
 
-
 ## Getting Started
 
 ### Prerequisites
@@ -25,7 +24,7 @@ Make sure you have the following installed on your machine:
 ### Installation
 
 1. Clone the repository:
-   
+
    `git clone https://github.com/your-username/your-repo.git`
 
 2. Navigate to the project directory:
@@ -46,12 +45,11 @@ Make sure you have the following installed on your machine:
 
 The application should now be running at [http://localhost:3000](http://localhost:3000).
 
-
 ## Folder Structure
 
 This project follows a modular file structure based on Next.js v14's `src/app` directory layout. Here's an overview:
 
-```
+```bash
 src/
 ├── app/
 │   ├── some-page/
@@ -71,7 +69,6 @@ src/
     └── useStore.ts         # Zustand store for state management
 ```
 
-
 ## Running the Project
 
 To start the development server:
@@ -88,7 +85,6 @@ To start the production build:
 
 `npm run start`
 
-
 ## Testing
 
 We use **Jest** and **React Testing Library** to test components and application logic.
@@ -101,7 +97,6 @@ npm run test
 
 Tests are located in the `__tests__` directories adjacent to the components or pages they test.
 
-
 ## Theming
 
 This project uses **Material UI** for theming. The theme is configured in the `src/app/theme.ts` file.
@@ -166,7 +161,7 @@ Example store setup:
 
 ```typescript
 // src/store/useStore.ts
-import create from 'zustand';
+import create from "zustand";
 
 interface StoreState {
   counter: number;
@@ -181,7 +176,6 @@ const useStore = create<StoreState>((set) => ({
 export default useStore;
 ```
 
-
 ## Contribution Guidelines
 
 We encourage all contributors to follow the guidelines outlined in our [CONTRIBUTING.md](https://github.com/ai-cfia/.github/blob/main/profile/CONTRIBUTING.md) document.
@@ -190,38 +184,42 @@ We encourage all contributors to follow the guidelines outlined in our [CONTRIBU
 
 1. Fork the repository by clicking on the 'Fork' button on the top-right of the repository page.
 2. Clone the forked repository to your local machine:
+
    ```bash
    git clone https://github.com/your-username/your-repo.git
    ```
 
 ### Working on an Issue
 
 1. Always create a new branch for the feature or bugfix you're working on:
+
    ```bash
    git checkout -b feature/your-feature-name
    ```
 
 2. Make your changes, ensuring they adhere to the [CONTRIBUTING.md](https://github.com/ai-cfia/.github/blob/main/profile/CONTRIBUTING.md) guidelines.
 3. Run the test suite to verify:
+
    ```bash
    npm run test
    ```
 
 4. Once your changes are complete, commit and push them to your fork:
+
    ```bash
    git add .
    git commit -m "Description of your feature/bugfix"
    git push origin feature/your-feature-name
    ```
 
 5. Open a Pull Request (PR) from your feature branch, providing a clear description of the changes.
+
 ### Code Style
 
 - Follow the ESLint and Prettier configurations provided.
 - Write unit tests for your code.
 - Ensure the app runs without errors before submitting.
 
-
 ## License
 
 This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

jest.config.ts

@@ -1,22 +1,22 @@
-import type { Config } from 'jest'
-import nextJest from 'next/jest.js'
- 
+import type { Config } from "jest";
+import nextJest from "next/jest.js";
+
 const createJestConfig = nextJest({
   // Provide the path to your Next.js app to load next.config.js and .env files in your test environment
-  dir: './',
-})
- 
+  dir: "./",
+});
+
 // Add any custom config to be passed to Jest
 const config: Config = {
-  coverageProvider: 'v8',
-  testEnvironment: 'jsdom',
+  coverageProvider: "v8",
+  testEnvironment: "jsdom",
   // Add more setup options before each test is run
   // setupFilesAfterEnv: ['<rootDir>/jest.setup.ts'],
   moduleNameMapper: {
-    '^@/(.*)$': '<rootDir>/$1',
+    "^@/(.*)$": "<rootDir>/$1",
   },
-  setupFilesAfterEnv: ['<rootDir>/jest.setup.ts']
-}
- 
+  setupFilesAfterEnv: ["<rootDir>/jest.setup.ts"],
+};
+
 // createJestConfig is exported this way to ensure that next/jest can load the Next.js config which is async
-export default createJestConfig(config)
+export default createJestConfig(config);

jest.setup.ts

@@ -1 +1 @@
-import '@testing-library/jest-dom'
+import "@testing-library/jest-dom";