svger-cli 1.0.6 → 1.0.7

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,79 @@
+# Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We value open and honest communication, inspired by the Linux kernel community's emphasis on technical excellence and direct feedback, while maintaining respect and professionalism.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not only for us as individuals, but for the overall community
+* Using inclusive language and avoiding assumptions about others' backgrounds or abilities
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity

package/CONTRIBUTING.md

@@ -0,0 +1,146 @@
+# Contributing to svger-cli
+
+Thank you for your interest in contributing to svger-cli! We welcome contributions from the community to help improve and grow this zero-dependency enterprise SVG processing framework. This document outlines the guidelines and processes for contributing.
+
+## Table of Contents
+
+- [Code of Conduct](#code-of-conduct)
+- [How to Contribute](#how-to-contribute)
+- [Development Setup](#development-setup)
+- [Reporting Issues](#reporting-issues)
+- [Submitting Pull Requests](#submitting-pull-requests)
+- [Code Style and Standards](#code-style-and-standards)
+- [Testing](#testing)
+- [Commit Guidelines](#commit-guidelines)
+- [License](#license)
+
+## Code of Conduct
+
+This project adheres to a [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to the maintainers.
+
+## How to Contribute
+
+There are many ways to contribute to svger-cli:
+
+- **Report bugs** and request features via GitHub Issues
+- **Improve documentation** by fixing typos or adding examples
+- **Write code** by submitting pull requests
+- **Review pull requests** from other contributors
+- **Help others** in discussions and issue threads
+- **Add framework support** for new UI libraries
+- **Optimize performance** and reduce bundle size
+
+## Development Setup
+
+1. **Fork and Clone**: Fork the repository on GitHub and clone your fork locally.
+
+   ```bash
+   git clone https://github.com/your-username/svger-cli.git
+   cd svger-cli
+   ```
+
+2. **Install Dev Dependencies**: Install TypeScript and development tools.
+
+   ```bash
+   npm install
+   ```
+
+3. **Build the Project**: Compile TypeScript to JavaScript.
+
+   ```bash
+   npm run build
+   ```
+
+4. **Test the CLI**: Run the built CLI to ensure it works.
+
+   ```bash
+   node dist/cli.js --help
+   ```
+
+## Reporting Issues
+
+When reporting issues, please include:
+
+- A clear and descriptive title
+- Steps to reproduce the issue
+- Expected behavior
+- Actual behavior
+- Environment details (OS, Node.js version, etc.)
+- Any relevant SVG files or error messages
+- Framework you're targeting (React, Vue, etc.)
+
+Use GitHub Issues for bug reports and feature requests.
+
+## Submitting Pull Requests
+
+1. **Create a Branch**: Create a feature branch from `main`.
+
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+2. **Make Changes**: Implement your changes, following the code style guidelines.
+
+3. **Test Manually**: Since automated tests are not yet implemented, thoroughly test your changes manually.
+
+4. **Update Documentation**: Update README.md or other docs if necessary.
+
+5. **Commit Changes**: Use clear commit messages (see [Commit Guidelines](#commit-guidelines)).
+
+6. **Push and Create PR**: Push your branch and create a pull request on GitHub.
+
+   - Provide a clear description of the changes
+   - Reference any related issues
+   - Include before/after screenshots for UI changes
+   - Test with multiple frameworks if applicable
+
+## Code Style and Standards
+
+- **Language**: TypeScript is the primary language
+- **Zero Dependencies**: Maintain zero runtime dependencies - use only native Node.js APIs
+- **Modular Architecture**: Follow the service-oriented architecture in `src/`
+- **Naming**: Use descriptive names for variables, functions, and classes
+- **Comments**: Add JSDoc comments for public APIs
+- **Error Handling**: Use the centralized error handler for consistent error management
+- **Performance**: Optimize for speed and memory usage
+
+Build and test your changes:
+
+```bash
+npm run build
+node dist/cli.js [your-test-command]
+```
+
+## Testing
+
+Currently, the project relies on manual testing. Future contributions that add automated testing infrastructure are highly encouraged.
+
+When testing:
+
+- Test with various SVG files (simple and complex)
+- Test all supported frameworks
+- Test edge cases like malformed SVGs
+- Verify performance doesn't regress
+
+## Commit Guidelines
+
+- Use the imperative mood in commit messages (e.g., "Add feature" not "Added feature")
+- Keep the first line under 50 characters
+- Provide a detailed description in the body if needed
+- Reference issue numbers when applicable (e.g., "Fix #123")
+
+Example:
+
+```
+Add Vue.js framework support
+
+- Implement Vue composition API template
+- Add Vue-specific prop handling
+- Update framework detection logic
+
+Closes #456
+```
+
+## License
+
+By contributing to this project, you agree that your contributions will be licensed under the [MIT License](LICENSE).

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 navidrezadoost
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.