@js-empire/emperor-ui 1.3.11 → 1.3.13

package/.cursor/rules/code-conventions.mdc

@@ -0,0 +1,50 @@
+---
+name: code-conventions
+description: This rule is for Cursor to follow code conventions we have.
+---
+
+# Overview
+
+Whenever you write a code, follow these rules:
+
+## Conventions
+
+Follow all the codebase conventions like how functions and variables are written, where to place everything, ...etc. Follow the SOLID coding principles in all code.
+
+## Imports & Exports
+
+Every module (or directory) should have an "index.ts" file that exports all the files and sub modules inside it using ('export \* from "./file-or-dir-name";'), where every file should export all its functions and variables to be exported. Never use relative imports but rather use the absolute ones for better readability and easier importation.
+
+## Utilities
+
+All types, constants, enums, hooks, utility functions, and configs should be defined in their relative packages or modules. Utility functions should always have a short description (function annotation or documentation) that summarizes what is does and what it needs.
+
+## Complexity
+
+Try to always find the easiest, simplest, and most efficient solution with the least amount of code rather than the most complex one.
+
+## File Size
+
+Every file should never be more than 300 lines of code. Whenever a code exceeds 250 to 300 lines, try to optimize it or split it into multiple files following the codebase conventions.
+
+## Single Responsibility
+
+Each function should only have one purpose and each component file should only exports one component.
+
+## Naming
+
+The exported component must have the same name as its file's name. Follow these rules for naming:
+
+- Files: kebab-case
+- Directories: kebab-case
+- Types & Interfaces: PascalCase
+- Constants: PascalCase
+- Hooks: useCamelCase
+- Pages and Layouts' Components: PascalCase
+- Enums:
+  - Enum name: PascalCase
+  - Enum key: UPPER_SNAKE_CASE
+
+## Parameters
+
+All parameters across the project should be implemented as one object that has the parameters in it so we can modify them easily in the future, like this: `({ param1, param2 = false }:{ param1: string, param2?: boolean })`. Never define them as multiple parameters like this: `(param1: string, param2?: boolean)`. That applies to functions, arrow functions, components, hooks, and anything takes parameters.

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+pnpm run format
+git add .
+pnpm run lint
+pnpm run build

package/.prettierrc

@@ -0,0 +1,10 @@
+{
+  "semi": true,
+  "singleQuote": false,
+  "printWidth": 80,
+  "tabWidth": 2,
+  "useTabs": false,
+  "endOfLine": "lf",
+  "bracketSpacing": true,
+  "trailingComma": "all"
+}

package/.storybook/main.ts

@@ -0,0 +1,24 @@
+import type { StorybookConfig } from "@storybook/react-vite";
+import path from "path";
+import tsconfigPaths from "vite-tsconfig-paths";
+
+const config: StorybookConfig = {
+  stories: ["../src/**/*.mdx", "../src/**/*.stories.@(js|jsx|mjs|ts|tsx)"],
+  addons: [],
+  framework: {
+    name: "@storybook/react-vite",
+    options: {},
+  },
+  viteFinal: async (config) => {
+    config.plugins?.push(
+      /** @see https://github.com/aleclarson/vite-tsconfig-paths */
+      tsconfigPaths({
+        projects: [path.resolve("..", "tsconfig.json")],
+      }),
+    );
+
+    return config;
+  },
+};
+
+export default config;

package/.storybook/preview.ts

@@ -0,0 +1,19 @@
+import type { Preview } from "@storybook/react-vite";
+import "../src/styles/globals.css";
+
+const preview: Preview = {
+  parameters: {
+    controls: {
+      matchers: {
+        color: /(background|color)$/i,
+        date: /Date$/i,
+      },
+    },
+
+    a11y: {
+      test: "todo",
+    },
+  },
+};
+
+export default preview;

package/.storybook/vitest.setup.ts

@@ -0,0 +1,7 @@
+import * as a11yAddonAnnotations from "@storybook/addon-a11y/preview";
+import { setProjectAnnotations } from "@storybook/react-vite";
+import * as projectAnnotations from "./preview";
+
+// This is an important step to apply the right configuration when testing your stories.
+// More info at: https://storybook.js.org/docs/api/portable-stories/portable-stories-vitest#setprojectannotations
+setProjectAnnotations([a11yAddonAnnotations, projectAnnotations]);

package/.vscode/extensions.json

@@ -0,0 +1 @@
+{}