1.0.1 • Published 1 year ago

@kmsoln/web-package-last v1.0.1

Weekly downloads
-
License
ISC
Repository
github
Last release
1 year ago

@kmsoln/web-package

@kmsoln/web-package is an extra library for Lodash that provides additional utility functions to enhance and extend the functionality of Lodash in JavaScript projects.

Features

  • Enhanced Utility Functions: Adds extra functionalities to the already powerful Lodash library.
  • Seamless Integration: Built to work directly with Lodash, making it easy to integrate into your existing Lodash-based projects.
  • Web-Friendly: Optimized for modern web development workflows with tools like Webpack.

Installation

You can install the package via npm:

npm install @kmsoln/web-package

Peer Dependency

This library depends on Lodash. Ensure you have it installed:

npm install lodash

Usage

Import the Library

To use the library, first import it into your JavaScript project alongside Lodash:

import _ from 'lodash';
import extra from '@kmsoln/web-package';
// Example usage
const result = extra.customFunction(_.someLodashFunction());
console.log(result);

Example Functionality

import extra from '@kmsoln/web-package';

// Example: Custom utility function
const enhancedResult = extra.newUtility([1, 2, 3], value => value * 2);
console.log(enhancedResult); // [2, 4, 6]

Scripts

The package comes with some predefined scripts:

• Build the library:

npm run build

• Run tests (currently no tests are defined):

npm test

Development

Clone the Repository

git clone https://github.com/kmsoln/kmsoln-webpack.git
cd my-repo

Install Dependencies

npm install

Start Development Server

To run a development server for testing:

npm run start

Dependencies

Runtime Dependencies

• lodash: A modern JavaScript utility library delivering modularity, performance, and extras.

• babel-loader: For using Babel with Webpack.

Development Dependencies

• webpack: A module bundler.

• webpack-cli: CLI for Webpack.

• webpack-dev-server: A development server for Webpack.

File Structure

project-root/ ├── src/ # Source files │ ├── index.js # Entry point for the library │ ├── utilities.js # Additional utilities │ └── ... ├── dist/ # Compiled output ├── test/ # Test files (if applicable) ├── package.json # Package configuration ├── webpack.config.js # Webpack configuration └── README.md # This file

Contributing

Contributions are welcome! Please follow these steps: 1. Fork the repository. 2. Create a new branch for your feature or bug fix. 3. Commit your changes with clear messages. 4. Open a pull request.

License

This project is licensed under the ISC License.

Author

Karim Ahmed Soliman

Keywords

•	Lodash
•	Lodash Extra
•	Lodash Utility
•	Web Package
•	JavaScript Utilities
•	Lodash Enhancement
•	Helper Functions

Instructions for Usage:

  1. Replace placeholders like your-username, your-repo-name, and your-email@example.com with actual details.
  2. Include specific examples of extra functionality your library provides in the Usage and Example Functionality sections.
  3. Update the File Structure if applicable.