Feature 473. Functional rule list

.git-blame-ignore-revs

@@ -0,0 +1,6 @@
+# This file lists commits that will be ignored when assigning blame.
+
+# Reformatting src/
+b006cec23dc9b059239789f7d6ab51e242fef404
+# Reformatting test/
+2fd31caeab8d8d664de69360ad88311d7e115d5c

.github/workflows/api-and-component.yml

@@ -1,4 +1,4 @@
-name: API and Component Tests
+name: API, Component and Hook Tests
 on:
   push:
     branches:
@@ -8,7 +8,7 @@ on:
       - master
 jobs:
   test:
-    name: Test API and Components
+    name: Test API, Components and Hooks
     strategy:
       matrix:
         node-version: [18.16.1, 20.4.0]
@@ -25,4 +25,6 @@ jobs:
         run: npm run test:component
       - name: Run API Tests
         run: npm run test:api
+      - name: Run Hook Tests
+        run: npm run test:hook
 

.github/workflows/lint.yml

@@ -0,0 +1,29 @@
+name: Prettier Code Check
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  prettier-check:
+    name: Prettier Code Check
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run Prettier
+        run: npm run prettier:check || echo "::warning::Prettier found formatting issues. Please run 'npm run prettier:write' to fix them."

.prettierrc.json

@@ -1,8 +1,11 @@
 {
-    "printWidth": 80,
-    "trailingComma": "all",
-    "tabWidth": 4,
-    "semi": false,
-    "singleQuote": true,
-    "arrowParens": "avoid"
+  "bracketSpacing": true,
+  "jsxBracketSameLine": false,
+  "printWidth": 150,
+  "trailingComma": "all",
+  "tabWidth": 4,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": true,
+  "arrowParens": "avoid"
 }

.storybook/main.js

@@ -1,4 +1,6 @@
 module.exports = {
+  staticDirs: ['../public', '../test/static'],
+
   stories: [
     "../src/**/*.mdx",
     "../src/**/*.stories.@(js|jsx|ts|tsx)"
@@ -8,6 +10,7 @@ module.exports = {
     "@storybook/addon-links",
     "@storybook/addon-essentials",
     "@storybook/addon-interactions",
+    "storybook-dark-mode"
   ],
 
   framework: {

.storybook/preview.js

@@ -6,5 +6,8 @@ export const parameters = {
       date: /Date$/,
     },
   },
+  darkMode: {
+    stylePreview: true
+  }
 }
 import '../src/component-library/outputtailwind.css'

README.md

@@ -85,6 +85,14 @@ The `pages/api` directory is mapped to `/api/*`. Files in this directory are tre
 
 This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
 
+### Configuration
+
+To ensure that `git blame` accurately reflects contribution, please run
+
+```bash
+git config blame.ignoreRevsFile .git-blame-ignore-revs
+```
+
 ## Architecture
 
 ![Clean Architecture Workflow](https://snipboard.io/2s0eDc.jpg)

components.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "https://ui.shadcn.com/schema.json",
+  "style": "default",
+  "rsc": true,
+  "tsx": true,
+  "tailwind": {
+    "config": "tailwind.config.js",
+    "css": "src/component-library/tailwind.css",
+    "baseColor": "slate",
+    "cssVariables": false,
+    "prefix": ""
+  },
+  "aliases": {
+    "components": "@/component-library",
+    "utils": "@/component-library/utils"
+  }
+}

jest.config.js

@@ -1,7 +1,8 @@
 module.exports = {
-    projects: [ 
+    projects: [
       '<rootDir>/test/api/jest.api.config.js',
       '<rootDir>/test/component/jest.component.config.js',
+      '<rootDir>/test/hook/jest.hook.config.js',
       '<rootDir>/test/gateway/jest.gateway.config.js',
       '<rootDir>/test/sdk/jest.sdk.config.js',
     ],