About

@looplex/common plays an important role in our platform engineering mission. It's useful at both browser and server environments. Rest assured knowing that it is embedded on the runtime you are using.

Features

• Modern Build Tool
• Native Assertion Module
• Native Test Runner
• Native Watch Mode
• Built-in Software Composition Analysis (SCA)
• Built-in Static Application Security Testing (SAST)
• Enforced Coding Standard
• Enforced Conventional Commits
• Enforced Semantic Release

Usage

@looplex/common is available and ready for use on all Looplex enviornment. But if, for some reason, you want to leverage it as a standalone, the easiest way to install is by running:

npm install @looplex/common

Standards and Rules

| Context | Specification | |:---------------------------------------|:--------------------------------------------------------------------:| | Storing and Sharing Date and Time | ISO 8601 Z | | Storing and Sharing Country Codes | ISO 3166 | | Storing and Sharing Language Codes | ISO 639-1 | | Storing and Sharing Currency Codes | ISO 4217 | | Runtime Charset | UTF-8 (65001) | | Runtime Language Code | en-US (1033) |

Contributing

We welcome contributions! Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo, make changes and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

This GitHub repository adheres to the principles of GitHub Flow as outlined in the official GitHub documentation. We ensure that all changes are made through branch-based workflows, enabling collaborative development and efficient code review before integration into the main branch.

gitGraph
    commit id:"fix(api): export endpoint should be consistent with output clause"
    branch feature/amazing
    checkout feature/amazing
    commit id:"feat(amazing): implement mvp"
    checkout main
    merge feature/amazing
    branch hotfix/cicd
    checkout hotfix/cicd
    commit id:"fix(cicd): automatic deployment"
    checkout main
    merge hotfix/cicd
    branch feature/incredible
    checkout feature/incredible
    commit id:"feat(incredible): implement mvp"
    checkout main
    merge feature/incredible

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/amazing)
3. Commit your Changes (npm run commit)
4. Push to the Branch (git push origin feature/amazing)
5. Open a Pull Request

Maintainers

As soon as the maintainers are satisfied with the feature set to be released, they should:

1. Evaluate the quality of the package through the bundle-analyzer report.
2. Run npm run release.
3. Confirm if the package is available in npm as the latest version.
4. Notify the maintainers of project embedding this library for faster adoption.

License

This project is licensed under the Looplex Limited Public License. Feel free to edit and distribute this template as you like.

See LICENSE.md for more information.

Acknowledgments

• Special thanks to CEO Angelo Caldeira for enabling this initiative and to our CTO Fabio Nagao who created the framework of this library.
• Shoutout to looplex contributors for their outstanding effort on releasing open source software.

Useful links

• README logos -- logos repository with the same pattern we are using.
• Simple Icons -- shields.io badges icons and colors.
• JSDoc Reference for great DX without enforcing a transpilation.
• OWASP Application Security Tools