diff --git a/docs/roadmap-to-sprout-v1.0.md b/docs/roadmap-to-sprout-v1.0.md index 2c6a316..1f9975e 100644 --- a/docs/roadmap-to-sprout-v1.0.md +++ b/docs/roadmap-to-sprout-v1.0.md @@ -11,7 +11,7 @@ description: The roadmap to grow the sprout All objectives are get from feedback, suggestions and personal knowledge. You can discuss about the v1.0 directly [in the issue on GitHub](https://github.com/go-sprout/sprout/issues/1). {% endhint %} -### :white\_check\_mark: **Minimize Dependencies - ****DONE** +### :white\_check\_mark: Minimize Dependencies - **DONE** Reduce the number of external dependencies to mitigate frequent update cycles, making Sprout more stable and lightweight. @@ -19,17 +19,17 @@ Reduce the number of external dependencies to mitigate frequent update cycles, m Dependencies have been minimized and optimized across all registries. {% endhint %} -### :white\_check\_mark: **Enhanced Documentation - ****DONE** +### :white\_check\_mark: Enhanced Documentation - **DONE** Provide comprehensive, easy-to-understand documentation that covers all functionalities, use cases, and examples to improve the developer experience. {% hint style="success" %} -This feature are implemented on v0.5.0, documentations can be found here: +This feature are implemented on v0.5.0, documentations can be found here: You are on the official documentation site :tada: {% endhint %} -### :white\_check\_mark: **Conventional Function Naming - ****DONE** +### :white\_check\_mark: Conventional Function Naming - **DONE** 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. @@ -39,11 +39,11 @@ This convention are defined and available here: [templating-conventions.md](introduction/templating-conventions.md "mention") {% endhint %} -### :white\_check\_mark: **Reduce memory fingerprint - ****DONE** +### :white\_check\_mark: Reduce memory fingerprint - **DONE** 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. -### :white\_check\_mark: **Native Error Handling - ****DONE** +### :white\_check\_mark: Native Error Handling - **DONE** Follow default go template error handling mechanisms for all functions to ensure that errors are managed gracefully and efficiently. @@ -53,48 +53,40 @@ This feature are implemented on v0.6.0, documentation can be found here: [safe-functions.md](features/safe-functions.md "mention") {% endhint %} -### :hourglass:**Expanded Function Set - ****IN PROGRESS** +### :white\_check\_mark: Expanded Function Set - **DONE** Add a broader array of functions without imposing limitations, enabling users to accomplish more tasks directly within the framework. -### :white\_check\_mark: **Customizable Function Loading - ****DONE** +### :white\_check\_mark: Customizable Function Loading - **DONE** Allow users to customize which functions to load into their runtime environment, preventing unnecessary resource consumption and enhancing performance. {% hint style="success" %} -This feature are implemented on v0.5.0, documentations can be found here: +This feature are implemented on v0.5.0, documentations can be found here: -[loader-system-registry.md](features/loader-system-registry.md "mention") +[loader-system-registry.md](features/loader-system-registry.md "mention") [how-to-create-a-registry.md](advanced/how-to-create-a-registry.md "mention") {% endhint %} -### :white\_check\_mark: **Function Aliasing - ****DONE** +### :white\_check\_mark: 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. {% hint style="success" %} -This feature are implemented on v0.3.0, documentation can be found here : +This feature are implemented on v0.3.0, documentation can be found here : [function-aliases.md](features/function-aliases.md "mention") {% endhint %} -### :white\_check\_mark: **Function Notices - ****DONE** +### :white\_check\_mark: Function Notices - **DONE** -When you are a middle-app (between sprout and the user how write the template), you need to be careful when you upgrade a template library due to potential breaking changes or deprecated functions. \ +When you are a middle-app (between sprout and the user how write the template), you need to be careful when you upgrade a template library due to potential breaking changes or deprecated functions.\ The solution are to embed a notice system in the template library to warn the end-user of a deprecation and let x versions between the deprecation notice and the replacement / removal of the function. {% hint style="success" %} -This feature are implemented on v0.6.0, documentation can be found here : \ -[Broken link](broken-reference "mention") -{% endhint %} - -### :hourglass:**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. - -{% hint style="danger" %} -This feature has been discontinued due to its complexity, which benefits less than 1% of users. If truly necessary, a [custom handler](advanced/how-to-create-a-handler.md) can be implemented to achieve the same functionality. +This feature are implemented on v0.6.0, documentation can be found here :\ +[broken-reference](broken-reference/ "mention") {% endhint %} ## Compatibility between spring and sprout @@ -111,5 +103,4 @@ This page will be updated each time function are re-implemented correctly in Spr 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. -
DONEFunctionsDescription
truetoYamlConvert a struct to a YAML String
truefromYamlConvert YAML String to a struct
truetoBoolConvert any to a boolean
truetoDurationConvert any to a time.Duration
truedefault,empty,coalesceDont trigger default go value as false
truedigDig into a map without crashes in format book.author.name
truesha512sumSupport of SHA512
truemd5sumSupport of md5 hash
truehasFieldDetect if a field are present in an object using reflect. Source
truetoDurationconvert a value to a time.Duration
truetoCamelCase, toPascalCase, toKebakCase, toDotCase, topathCase, toConstantCase,toSnakeCase,toTitleCaseA batch of functions to change casing of a string to aby casing you want.
truecapitalize, uncapitalizeCapitalize / Uncapitalize a string (Upper/lower only the first character)
trueflattenFlatten nested list be one level
trueregexpFindSubmatch, regexpAllSubmatches,regexpFindNamedSubmatch, regexpAllNamedSubmatchesCollection of function to found and retrieve submatches and named submatches
falsecidrhost,cidrnetmask,cidrsubnet,cidrsubnetsA collection of functions for network ip manipulation
truetoLocalDateConvert to a time.Time with a timezone support
- +
DONEFunctionsDescription
truetoYamlConvert a struct to a YAML String
truefromYamlConvert YAML String to a struct
truetoBoolConvert any to a boolean
truetoDurationConvert any to a time.Duration
truedefault,empty,coalesceDont trigger default go value as false
truedigDig into a map without crashes in format book.author.name
truesha512sumSupport of SHA512
truemd5sumSupport of md5 hash
truehasFieldDetect if a field are present in an object using reflect. Source
truetoDurationconvert a value to a time.Duration
truetoCamelCase, toPascalCase, toKebakCase, toDotCase, topathCase, toConstantCase,toSnakeCase,toTitleCaseA batch of functions to change casing of a string to aby casing you want.
truecapitalize, uncapitalizeCapitalize / Uncapitalize a string (Upper/lower only the first character)
trueflattenFlatten nested list be one level
trueregexpFindSubmatch, regexpAllSubmatches,regexpFindNamedSubmatch, regexpAllNamedSubmatchesCollection of function to found and retrieve submatches and named submatches
truecidr, ip, macA collection of functions for network ip manipulation
truetoLocalDateConvert to a time.Time with a timezone support