chop-logic-components 1.0.3 → 1.0.4

package/README.md

@@ -6,46 +6,88 @@ Welcome to **Chop Logic Components**, a comprehensive React components library p
 
 Chop Logic is designed to speed up development by providing reusable, accessible, and highly customizable components. Whether you're building complex forms, creating dynamic layouts, or managing component logic with hooks, Chop Logic has the tools to make it easier.
 
-### Why Choose Chop Logic?
+All components are well documented using Storybook. Visit the [DEMO page](https://savourygin.github.io/chop-logic-components) and try them out.
 
-Here's what makes Chop Logic an excellent addition to your React project:
+## Getting Started
 
-- **Styled Components:** All components are styled using a consistent, modern design language and can easily adapt to your project's look and feel. Each component offers a flexible API, making them simple to extend and customize.
+To get started with Chop Logic, install it via npm or yarn:
 
-- **Custom Hooks:** Simplify your component logic by using the custom hooks provided. From managing form input to handling asynchronous data fetching, Chop Logic's hooks cover common scenarios that developers face daily.
+```bash
+npm install chop-logic-components
+# or
+yarn add chop-logic-components
+```
 
-- **Built for Reusability:** Every component and hook is designed with reusability in mind, reducing repetitive code and enabling faster development cycles.
+## Scripts
 
-- **Ease of Use:** Chop Logic follows best practices in API design, ensuring that components and hooks are easy to learn and work seamlessly with each other.
+### `format`
 
-- **Storybook Integration:** This library includes comprehensive Storybook documentation for each component and hook, allowing you to explore usage examples, try props in real-time, and see how each feature behaves in isolation.
+Runs [Prettier](https://prettier.io/) to automatically format TypeScript files (`.ts` and `.tsx`) in the project. This script will write changes directly to the files.
 
-## Key Features
+```bash
+npm run format
+```
 
-### Components
+### `lint`
 
-Chop Logic includes a wide range of styled components that are ready to use in your projects:
+Runs ESLint to analyze the TypeScript code for potential errors and enforce coding standards. It automatically fixes issues where possible and uses the .gitignore file to ignore certain paths.
 
-- **Inputs:** Beautifully styled input controllers with customization options.
-- **Containers:** Easily customizable container elements like text grids, forms, and tabs.
-- **Modals:** Flexible modal windows and accessible tooltips, perfect for enhancing user interactions.
-- **More Components Coming Soon!**
+```bash
+npm run lint
+```
 
-### Hooks
+### `check-types`
 
-In addition to UI components, Chop Logic offers a collection of custom hooks to help you manage complex logic:
+Runs the TypeScript compiler (tsc) to perform type checking without generating output files. This script helps ensure that the code adheres to TypeScript's type safety.
 
-- **useModalFocusTrap:** A hook that traps focus within an open modal, ensuring accessibility compliance.
-- **useKeyPress:** Easily manage keyboard interactions and trigger actions based on keypress events.
-- **useContainerDimensions:** Get the dimensions of any HTML element to dynamically adjust your UI.
-- **More Hooks Coming Soon!**
+```bash
+npm run check-types
+```
 
-## Getting Started
+### `build`
 
-To get started with Chop Logic, install it via npm or yarn:
+Compiles the TypeScript code into JavaScript using the TypeScript compiler (tsc) and then builds the project using Vite.
 
 ```bash
-npm install chop-logic-components
-# or
-yarn add chop-logic-components
+npm run build
+```
+
+### `test`
+
+Runs unit tests using Vitest, a fast testing framework designed for Vite projects.
+
+```bash
+npm run test
+```
+
+### `test:ci`
+
+Runs the tests in continuous integration (CI) mode with Vitest, providing a streamlined output suitable for automated environments.
+
+```bash
+npm run test:ci
+```
+
+### `storybook`
+
+Starts a local instance of Storybook for developing UI components. The Storybook interface will be available at http://localhost:6006.
+
+```bash
+npm run storybook
+```
+
+### `build-storybook`
+
+Builds the static version of the Storybook for deployment, outputting the files to the storybook-static directory. The --quiet flag suppresses the build logs.
+
+```bash
+npm run build-storybook
+```
+
+### `prepare`
+
+Runs the build script and then installs Husky hooks for managing Git hooks in the project.
+
+```bash
+npm run prepare
 ```

package/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "git+https://github.com/SavouryGin/chop-logic-components.git"
   },
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "React UI components library for Chop Logic project",
   "type": "module",
   "main": "dist/index.cjs.js",
@@ -20,7 +20,6 @@
     "build": "tsc && vite build",
     "test": "vitest",
     "test:ci": "vitest run",
-    "coverage": "vitest run --coverage",
     "storybook": "storybook dev -p 6006",
     "build-storybook": "storybook build  -- -o storybook-static --quiet",
     "prepare": "npm run build && husky install"
@@ -42,7 +41,7 @@
   "bugs": {
     "url": "https://github.com/SavouryGin/chop-logic-components/issues"
   },
-  "homepage": "https://github.com/SavouryGin/chop-logic-components#readme",
+  "homepage": "https://savourygin.github.io/chop-logic-components",
   "devDependencies": {
     "@chromatic-com/storybook": "^2.0.2",
     "@commitlint/cli": "^19.3.0",