@tixionn/core 1.0.1 → 1.0.2

package/README.md

@@ -0,0 +1,172 @@
+# @tixionn/core
+
+> Core utilities and shared package for Tixion
+
+[![npm version](https://img.shields.io/npm/v/@tixionn/core.svg)](https://www.npmjs.com/package/@tixionn/core)
+[![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](https://opensource.org/licenses/ISC)
+[![Publish Package to npm](https://github.com/tixionn/core/actions/workflows/publish.yml/badge.svg)](https://github.com/tixionn/core/actions/workflows/publish.yml)
+
+## 📦 Installation
+
+Install the package using your preferred package manager:
+
+```bash
+# npm
+npm install @tixionn/core
+
+# pnpm
+pnpm add @tixionn/core
+
+# yarn
+yarn add @tixionn/core
+```
+
+## 🚀 Features
+
+- **Shared Prettier Configuration** - Consistent code formatting across all Tixion projects
+- **Import Sorting** - Automatic import organization with `@trivago/prettier-plugin-sort-imports`
+- **Zero Config** - Works out of the box with sensible defaults
+- **TypeScript Ready** - Full TypeScript support
+
+## 📖 Usage
+
+### Prettier Configuration
+
+This package exports a shared Prettier configuration that can be used across your projects.
+
+#### Option 1: Using `package.json`
+
+Add this to your `package.json`:
+
+```json
+{
+  "prettier": "@tixionn/core/prettier"
+}
+```
+
+#### Option 2: Using `.prettierrc.js`
+
+Create a `.prettierrc.js` file:
+
+```javascript
+module.exports = require('@tixionn/core/prettier');
+```
+
+#### Option 3: Using `.prettierrc.mjs`
+
+Create a `.prettierrc.mjs` file:
+
+```javascript
+import config from '@tixionn/core/prettier';
+
+export default config;
+```
+
+### Configuration Details
+
+The Prettier configuration includes:
+
+- **No trailing commas** - Clean object and array syntax
+- **4-space indentation** - Using tabs for consistency
+- **No semicolons** - Cleaner JavaScript/TypeScript code
+- **Single quotes** - For strings and JSX
+- **Arrow function parens** - Avoid unnecessary parentheses
+- **Organized imports** - Automatic sorting and grouping
+
+Import order:
+
+1. Third-party modules
+2. `@/` prefixed imports (aliases)
+3. Parent directory imports (`../`)
+4. Current directory imports (`./`)
+
+## 🛠️ Development
+
+### Prerequisites
+
+- Node.js 20 or higher
+- pnpm (recommended)
+
+### Local Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/tixionn/core.git
+
+# Navigate to the directory
+cd core
+
+# Install dependencies
+pnpm install
+```
+
+### Publishing
+
+The package is automatically published to npm when changes are pushed to the `main` branch via GitHub Actions.
+
+To manually publish:
+
+```bash
+npm version patch  # or minor/major
+git push --tags
+npm publish
+```
+
+## 📝 Configuration Reference
+
+The full Prettier configuration:
+
+```javascript
+{
+  trailingComma: "none",
+  tabWidth: 4,
+  useTabs: true,
+  semi: false,
+  singleQuote: true,
+  jsxSingleQuote: true,
+  arrowParens: "avoid",
+  importOrderSeparation: true,
+  importOrderSortSpecifiers: true,
+  importOrderCaseInsensitive: true,
+  importOrder: [
+    "<THIRD_PARTY_MODULES>",
+    "^@/(.*)$",
+    "^../(.*)$",
+    "^./(.*)$"
+  ]
+}
+```
+
+## 🤝 Contributing
+
+Contributions are welcome! Please follow these steps:
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## 📄 License
+
+This project is licensed under the ISC License.
+
+## 👤 Author
+
+**Raju**
+
+- Email: contact@tixion.com
+
+## 🔗 Links
+
+- [npm Package](https://www.npmjs.com/package/@tixionn/core)
+- [GitHub Repository](https://github.com/tixionn/core)
+- [Issue Tracker](https://github.com/tixionn/core/issues)
+
+## 📊 Package Stats
+
+This package is part of the Tixion ecosystem, providing shared configurations and utilities for consistent development experience across all Tixion projects.
+
+---
+
+Made with ❤️ by the Tixion team

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tixionn/core",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Core utilities and shared package for Tixion",
   "type": "commonjs",
   "publishConfig": {

package/.github/workflows/publish.yml

@@ -1,19 +0,0 @@
-name: Publish to npm
-
-on:
-  push:
-    branches:
-      - main
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          registry-url: 'https://registry.npmjs.org'
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}