x-fidelity 2.13.1 → 2.15.0

package/.xfi-config.json

@@ -0,0 +1,5 @@
+{
+    "sensitiveFileFalsePositives": [
+        "/README2.md"
+    ]
+}

package/CHANGELOG.md

@@ -1,3 +1,42 @@
+# [2.15.0](https://github.com/zotoio/x-fidelity/compare/v2.14.0...v2.15.0) (2024-09-08)
+
+
+### Bug Fixes
+
+* **execution:** fact functions and cleanup ([8bd2cfa](https://github.com/zotoio/x-fidelity/commit/8bd2cfa8c4ea6a587fdf4259d34e14e09189fc27))
+* Implement more robust error handling and logging ([f391052](https://github.com/zotoio/x-fidelity/commit/f391052b1b3fe8f56bb29deffaf567b2a32ce3d7))
+* Implement safe handling of circular JSON references in repoDependencyFacts.ts ([49d95da](https://github.com/zotoio/x-fidelity/commit/49d95da03f4552de4533a0e86d37d4e168bd038e))
+* **loading:** consistency with archetype ([47f52e4](https://github.com/zotoio/x-fidelity/commit/47f52e477c1e2ca69c49af767e9af5c8b76a7979))
+* Update import statement in repoFilesystemFacts.ts ([903326c](https://github.com/zotoio/x-fidelity/commit/903326cb1dc33da38d5a9fcf7a45f01c4f1f4876))
+
+
+### Features
+
+* Add JSON schema validation for .xfi-config.json file ([a7d0a75](https://github.com/zotoio/x-fidelity/commit/a7d0a755abe18ae07f8c1ef938b0eb2239af968b))
+* Add rule to check for 'nuit' and 'elevate' package imports in the same file ([70d0994](https://github.com/zotoio/x-fidelity/commit/70d09947ff9149da22047a0d2f9dc62448de9fd0))
+* Add support for .xfi-config.json file ([e9b60d3](https://github.com/zotoio/x-fidelity/commit/e9b60d31ac1037d6f40505deff5126f18409c269))
+* Add support for .xfi-config.json file with sensitiveFileFalsePositives ([5eda4f4](https://github.com/zotoio/x-fidelity/commit/5eda4f4df4d5df048d6342e890825064e78b93e0))
+* Add XFIConfig to ResultMetadata and define FileData and ValidationResult types ([ce71d90](https://github.com/zotoio/x-fidelity/commit/ce71d903c5211d1101bf49080a0fc3978b4cdaf2))
+* Centralize loading of .xfi-config.json and add it as a fact ([2cca682](https://github.com/zotoio/x-fidelity/commit/2cca68203f2cd04d6802e25e3647455279d009a2))
+* create 'bats' subdirectory and move BATS-related content ([1cc0bff](https://github.com/zotoio/x-fidelity/commit/1cc0bff7fec4d0d1b4c7ea60dd8fef027bc689f2))
+* improve and modernize the bats test ([586b546](https://github.com/zotoio/x-fidelity/commit/586b546e50de46d5afe4e2dcde34af7fe65bbdb7))
+* Improve repoDependencyAnalysis function ([a5638ca](https://github.com/zotoio/x-fidelity/commit/a5638cad789bc52533862dd91b9a964da785c666))
+* Rename XFIConfig to RepoXFIConfig ([f91574d](https://github.com/zotoio/x-fidelity/commit/f91574d7c9ab4a1e64a9b2b8fb34fb84929a87bd))
+* **repoconfig:** support for local control of false positive sensitive values ([db0b09a](https://github.com/zotoio/x-fidelity/commit/db0b09ae08dea2cc82a26a6a671615033805396b))
+* **testing:** cli blackbox testing ([a634258](https://github.com/zotoio/x-fidelity/commit/a6342584a4a7cdfd630437fd9894a02039d0099d))
+
+# [2.14.0](https://github.com/zotoio/x-fidelity/compare/v2.13.1...v2.14.0) (2024-08-29)
+
+
+### Bug Fixes
+
+* **exemptions:** exclude repos that do not have a remote configured ([c49c4c7](https://github.com/zotoio/x-fidelity/commit/c49c4c7284101822395a6f57b28b0cd302e5505e))
+
+
+### Features
+
+* Add exemptions feature to manage rule exceptions ([0a91ad8](https://github.com/zotoio/x-fidelity/commit/0a91ad8153651f971c3e34013233f91a0d960ec8))
+
 ## [2.13.1](https://github.com/zotoio/x-fidelity/compare/v2.13.0...v2.13.1) (2024-08-28)
 
 

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,28 @@
+# Contributor Code of Conduct
+
+## 1. **Purpose**
+This Code of Conduct outlines our expectations for participants within the community, as well as the steps to report unacceptable behavior. We are committed to providing a welcoming and inspiring community for all.
+
+## 2. **Scope**
+This Code of Conduct applies to all contributions to the repository, including issues, pull requests, code reviews, and any other community interaction.
+
+## 3. **Expected Behavior**
+- **Respectful Communication:** Be respectful and considerate in your communications. Constructive criticism is encouraged, but personal attacks, insults, or derogatory language are not tolerated.
+- **Inclusivity:** Contribute in ways that foster an inclusive environment, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+- **Collaboration:** Work collaboratively with others, and be open to learning from different perspectives. Welcome new contributors and be patient with questions or mistakes.
+- **Responsibility:** Take responsibility for your contributions and ensure they align with the project's goals and quality standards.
+
+## 4. **Unacceptable Behavior**
+- **Harassment:** Any form of harassment, including but not limited to offensive comments related to gender, gender identity, sexual orientation, disability, physical appearance, body size, race, religion.
+- **Discrimination:** Discriminatory or exclusionary behavior that undermines the community.
+- **Trolling:** Disruptive behavior, trolling, or spamming.
+- **Violence or Threats:** Violence or threats of violence against others.
+
+## 5. **Reporting Issues**
+If you experience or witness unacceptable behavior, please report it by contacting [Maintainer's Email Address]. All complaints will be reviewed and investigated, with the outcomes communicated as deemed appropriate.
+
+## 6. **Enforcement**
+Community members who violate this Code of Conduct may face consequences, including but not limited to a temporary or permanent ban from the repository, depending on the severity of the violation.
+
+## 7. **Attribution**
+This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).

package/CONTRIBUTING.md

@@ -0,0 +1,53 @@
+# Contributing to x-fidelity
+
+We welcome contributions to x-fidelity! This document provides guidelines for contributing to the project.
+
+## Getting Started
+
+1. Fork the repository on GitHub.
+2. Clone your fork locally.
+3. Install dependencies with `yarn install`.
+4. Create a new branch for your feature or bug fix.
+
+## Making Changes
+
+1. Make your changes in your feature branch.
+2. Add or update tests as necessary.
+3. Ensure all tests pass by running `yarn test`.
+4. Ensure the code lints properly by running `yarn lint`.
+
+## Commit Messages
+
+We use conventional commits to standardize our commit messages. Please use the `yarn commit` script to create your commit messages. This script will guide you through the process of creating a properly formatted commit message.
+
+To commit your changes:
+
+```
+git add .
+yarn commit
+```
+
+Follow the prompts to select the type of change, scope, and write a short description.
+
+## Submitting a Pull Request
+
+1. Push your changes to your fork on GitHub.
+2. Create a pull request from your fork to the main x-fidelity repository.
+3. In your pull request description, please provide:
+   - A clear and detailed explanation of the changes
+   - The motivation for the changes
+   - Any potential impacts on existing functionality
+   - Screenshots or code snippets if applicable
+
+## Pull Request Review Process
+
+1. Maintainers will review your pull request.
+2. They may ask for changes or clarifications.
+3. Make any requested changes in your feature branch and push the updates.
+4. Once approved, a maintainer will merge your pull request.
+
+## Code of Conduct
+
+Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
+
+Thank you for contributing to x-fidelity!