@softfix/code-standards v1.0.0

@softfix/code-standards

🚀 Enforce Consistent Code Standards Across Projects

This package ensures consistent naming conventions for files, functions, variables, and interfaces in React, Next.js, Node.js, and TypeScript projects.

📦 Installation

npm install --save-dev @softfix/code-standards

🚀 Usage

Run Pre-commit Checks Manually

npx softfix-precommit

This command performs the following checks:

• File Names: Must be lowercase and kebab-case (e.g., my-component.tsx).
• Functions: Must use camelCase (e.g., fetchData).
• Variables: Must use camelCase or UPPER_CASE.
• Interfaces: Must use PascalCase and start with I (e.g., IUserProfile).

✅ If any rule is violated, the pre-commit will fail and show the list of issues.

🧩 Examples

✅ File Names

• Correct: user-profile.ts, order-list.component.tsx
• Incorrect: UserProfile.ts, order_list.tsx

✅ Function Names

// ✅ Correct
function getUserDetails() {}

// 🚫 Incorrect
function GetUserDetails() {}
function get_user_details() {}

✅ Variable Names

// ✅ Correct
const userName = 'John';
const API_KEY = '12345';

// 🚫 Incorrect
const UserName = 'John';
const apiKey = '12345';

✅ Interface Names

// ✅ Correct
interface IUser {
  id: number;
  name: string;
}

// 🚫 Incorrect
interface user {
  id: number;
  name: string;
}
interface UserInterface {} // Should start with 'I'

🛠️ Why Use This Package?

✅ Automates code standard checks for faster development workflows ✅ Reduces code review time and improves code quality ✅ Seamlessly enforces company-wide coding standards ✅ Keeps naming conventions consistent across all projects ✅ Easily integrates with existing development pipelines and tools ✅ Prevents common naming mistakes before code is committed ✅ Saves time by catching issues early in the development cycle ✅ Enhances team collaboration through standardized code practices ✅ Provides clear, actionable feedback for quick fixes ✅ Supports scalable codebases by maintaining clean and organized code ✅ Works out of the box with minimal configuration ✅ Increases project maintainability and reduces technical debt

💻 Keep your codebase clean, consistent, and error-free with @softfix/code-standards!