1x00x-lodash-project

Lodash Project

A utility library providing a comprehensive collection of functions for working with arrays, objects, strings, and more. Built to be a modern, lightweight alternative to Lodash with essential utility functions.

Description

Lodash Project is an npm package that offers a wide range of utility functions to simplify JavaScript development. Whether you need to manipulate arrays, objects, or strings, this package provides efficient, well-tested functions to handle common programming tasks.

Installation

Install the package using npm:

npm install 1x00x-lodash-project

Or using yarn:

yarn add 1x00x-lodash-project

Usage Examples

Array Functions

const _ = require('lodash-project');

// Flatten arrays
const flattened = _.flatten([1, [2, [3, 4]]]);
// => [1, 2, 3, 4]

// Chunk array into smaller arrays
const chunked = _.chunk([1, 2, 3, 4, 5], 2);
// => [[1, 2], [3, 4], [5]]

// Remove duplicates
const unique = _.uniq([1, 2, 2, 3, 3, 3]);
// => [1, 2, 3]

Object Functions

// Merge objects
const merged = _.merge({a: 1}, {b: 2});
// => {a: 1, b: 2}

// Pick specific properties
const picked = _.pick({a: 1, b: 2, c: 3}, ['a', 'c']);
// => {a: 1, c: 3}

// Get nested values safely
const value = _.get({user: {name: 'John'}}, 'user.name');
// => 'John'

String Functions

// Capitalize strings
const capitalized = _.capitalize('hello');
// => 'Hello'

// Convert to camelCase
const camelCase = _.camelCase('hello-world-test');
// => 'helloWorldTest'

// Repeat string
const repeated = _.repeat('abc', 3);
// => 'abcabcabc'

Contribution Guidelines

We welcome contributions from the community! Here's how you can contribute:

Getting Started

1. Fork the repository
2. Clone your fork:

   git clone https://github.com/yourusername/lodash-project.git
   

3. Create a new branch for your feature:

   git checkout -b feature/your-feature-name
   

Making Changes

1. Ensure your code follows the existing code style
2. Write clear, descriptive commit messages
3. Add or update tests for your changes
4. Run tests to ensure nothing is broken:

   npm test
   

Submitting a Pull Request

1. Push your changes to your fork
2. Submit a pull request with a clear description of your changes
3. Reference any related issues
4. Wait for review and address any feedback

Code Standards

• Use meaningful variable names
• Add comments for complex logic
• Follow ES6+ standards
• Ensure all functions are properly documented
• Add unit tests for new features

Reporting Issues

If you find a bug, please create an issue with:

• A clear description of the bug
• Steps to reproduce
• Expected vs actual behavior
• Your environment details

Thank you for contributing!