Roadmap to Sprout v1.0
The roadmap to grow the sprout
Key Objectives
All objectives are get from feedback, suggestions and personal knowledge. You can discuss about the v1.0 directly in the issue on GitHub.
⌛Minimize Dependencies - IN PROGRESS
Reduce the number of external dependencies to mitigate frequent update cycles, making Sprout more stable and lightweight.
✅ Enhanced Documentation - DONE
Provide comprehensive, easy-to-understand documentation that covers all functionalities, use cases, and examples to improve the developer experience.
This feature are implemented on v0.5.0, documentations can be found here:
You are on the official documentation site 🎉
⌛Conventional Function Naming - IN PROGRESS
Establish clear, consistent naming conventions for functions to enhance code readability and maintainability. Unlike Sprig, where function naming varies between camelCase, and snake_case, and similar functions lack consistent prefixing, Sprout will introduce a standardized approach to function naming. This will make the library more intuitive and reduce the learning curve for new users.
⌛Reduce memory fingerprint - IN PROGRESS
Aim to minimize memory allocations as much as possible to alleviate the burden on the garbage collector in large-scale applications. By optimizing the way memory is used within the framework, we ensure that Sprout is not only efficient in its functionality but also in its resource consumption. This approach contributes to overall better performance and scalability of applications using Sprout.
⌛Native Error Handling - IN PROGRESS
Introduce built-in error handling mechanisms for all functions to ensure that errors are managed gracefully and efficiently.
An RFC is currently open for feedback and discussion. You can view and participate in the RFC here.
⌛Advanced Error Handling Strategy - DISCONTINUED
Implement a custom error handling framework utilising channels for improved error reporting and handling on the Go side, reducing the risk of template crashes.
This feature has been discontinued due to its complexity, which benefits less than 1% of users. If truly necessary, a custom handler can be implemented to achieve the same functionality.
⌛Expanded Function Set - IN PROGRESS
Add a broader array of functions without imposing limitations, enabling users to accomplish more tasks directly within the framework.
✅ Customizable Function Loading - DONE
Allow users to customize which functions to load into their runtime environment, preventing unnecessary resource consumption and enhancing performance.
This feature are implemented on v0.5.0, documentations can be found here:
✅ Function Aliasing - DONE
Enable the creation of aliases for functions outside of the library, providing flexibility and convenience in how functions are accessed and utilized.
This feature are implemented on v0.3.0, documentation can be found here :
Compatibility between spring and sprout
A compatibility table between sprig v3.2.3 and sprout v1.0
✅ Implemented - The implementation will be available through v1
⌛To rework - This function are present but aren't reworked with Sprout vision
⚠️ Deprecated - This function are deprecated and not be migrated to sprout
✖️ Will not be implemented - This function will not be migrated to sprout v1
❌ Dont exist - This function don't exist on this version
🤷♂️ TBD : To Be Determinate for v1
This page will be updated each time function are re-implemented correctly in Sprout v1
| Function | Sprig v3.2.3 | Spout v1.0 (to define) |
|---|---|---|
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
|
Functions added to Sprout v1
A list of functions wanted for v1 based on issues, pull requests from sprig, feedback on sprout. All functions listed here will be implemented for the v1.
| Functions | Description |
|---|---|
| Convert a struct to a YAML String |
| Convert YAML String to a struct |
| Flatten nested list be one level |
| Convert any to a boolean |
| Convert any to a |
| Dont trigger default go value as false |
| Convert to a |
| Dig into a map without crashes in format |
| A collection of functions for network ip manipulation |
| Manipulation of template logic, implemented by helm team |
| A collection of function to manipulate gzip and tar archive |
| Allow to set the seed of the on a rand pipeline |
| Collection of function to found and retrieve submatches and named submatches |
| Support of SHA512 |
Last updated