Merge pull request #36 from boldare/chore/husky-and-commitlint

chore: husky and commitlint configuration

.commitlintrc.js

@@ -0,0 +1,8 @@
+module.exports = {
+  extends: [
+    '@commitlint/config-conventional',
+  ],
+  rules: {
+    'header-max-length': [0, 'always', 120],
+  }
+};

.github/CODE_OF_CONDUCT.md

@@ -1,4 +1,3 @@
-
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge
@@ -18,23 +17,23 @@ diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:
 
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
   and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall
+- Focusing on what is best not just for us as individuals, but for the overall
   community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or advances of
+- The use of sexualized language or imagery, and sexual attention or advances of
   any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email address,
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
   without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Enforcement Responsibilities

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,7 +1,9 @@
 ## PR Type
+
 What kind of change does this PR introduce?
 
 <!-- Please check the one that applies to this PR using "x". -->
+
 ```
 [ ] Bugfix
 [ ] Feature
@@ -14,21 +16,20 @@ What kind of change does this PR introduce?
 ```
 
 ## What is the current behavior?
+
 <!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
 
 Issue Number: N/A
 
-
 ## What is the new behavior?
 
-
 ## Does this PR introduce a breaking change?
+
 ```
 [ ] Yes
 [ ] No
 ```
 
 <!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->
 
-
 ## Other information

.husky/commit-msg

@@ -0,0 +1 @@
+npx --no -- commitlint --edit $1

.husky/pre-commit

@@ -0,0 +1 @@
+npm run lint

.prettierignore

@@ -3,3 +3,4 @@
 /coverage
 /.nx/cache
 .angular
+*.md

README.md

@@ -11,7 +11,6 @@
  <a href="https://github.com/boldare/ai-assistant" target="_blank">github</a>
 </p>
 
-
 # 🤖 AI Assistant
 
 Introducing the NestJS library, designed to harness the power of OpenAI's Assistant, enabling developers to create highly efficient, scalable, and rapid AI assistants and chatbots. This library is tailored for seamless integration into the NestJS ecosystem, offering an intuitive API, WebSockets, and tools that streamline the development of AI-driven interactions. Whether you're building a customer service bot, a virtual assistant, or an interactive chatbot for engaging user experiences, our library empowers you to leverage cutting-edge AI capabilities with minimal effort.
@@ -96,10 +95,10 @@ export const assistantParams: AssistantCreateParams = {
 
 // Additional configuration for our assistant
 export const assistantConfig: AssistantConfigParams = {
-  id: process.env['ASSISTANT_ID'], // OpenAI API Key
-  params: assistantParams, // AssistantCreateParams
+  id: process.env['ASSISTANT_ID'],          // OpenAI API Key
+  params: assistantParams,                  // AssistantCreateParams
   filesDir: './apps/api/src/app/knowledge', // Path to the directory with files (the final path is "fileDir" + "single file")
-  files: ['file1.txt', 'file2.json'], // List of file names (or paths if you didn't fill in the above parameter)
+  files: ['file1.txt', 'file2.json'],       // List of file names (or paths if you didn't fill in the above parameter)
 };
 ```
 

apps/spa/src/test-setup.ts

@@ -1,4 +1,4 @@
-// @ts-ignore
+// @ts-expect-error: Jest global setup
 globalThis.ngJest = {
   testEnvironmentOptions: {
     errorOnUnknownElements: true,

libs/ai-assistant/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boldare/ai-assistant",
-  "version": "0.0.2-dev.2",
+  "version": "0.0.2-dev.3",
   "dependencies": {
     "tslib": "^2.3.0",
     "openai": "^4.26.1",