The goal and roadmap of version 0.3

[sotvokun]

The most happy thing in 2021 is to release the version 0.3 of docscript. This update is a big change for this project, because the most code are refactored. New code have more readability, and easy to maintain, but the most important change is easy to extend, like add a new syntax (special form). About more change, you could to read the changelog

Though the version 0.3 released, but it is not perfect - no test system, and some necessary built-in procedures - these deficiencies will be filled in this version. But some features and bugs like that the function returned by another cannot hold the arguments who create it, will be added and fixed in the next version.

> [define gen-func [lambda (x) [lambda (y) [+ x y]]]]
> [[gen-func 3] 2] ; except 5
error: unbound symbol: x

Goal

The goal of this version is to improve the readability and maintainability, and to ensure the built-in procedure is enough to deal with various situations. And the most important goal is to ensure this refactoring is sufficient to handle the new features in the future.

Roadmap

The cycle of the development of version 0.3 is 3 months.

Dec, 2021

• Add some useful and necessary built-in procedures

• Make the name in code more easy to comprehend

• Use .clang-format file to make all code have the same style

Jan, 2022

• Optimize the implementations and interfaces of Environment, DataType and Value
• Optimize the implementation and interface of StringStream
• Optimize the implementations and interfaces of Parser and Interpreter
• Optimize the implementation and interface of Scanner
• Add more comment in the code

Feb, 2022：

• Import the test system
• Write the test case for Scanner, Parser and Interpreter
• Write the test case for the built-in procedures
• Write the quick tour tutorial of docscript.

---

很高兴能在 2021 年内发布 0.3 版本，这次版本更新对于整个项目而言是一次重大的改变，因为相比之前的版本，代码已经完全重构了。新的代码更加易读，并且更容易维护，最重要的是可以更加方便的进行扩展，增加的新的语法（Special Form）。关于更多更新的内容，欢迎去查看 changelog。

虽然 0.3 版本已经发布，但它依旧有许多问题，例如缺少测试系统，缺少一些必要的内置函数，这些问题都将会在 0.3 版本解决。除此以外的功能性缺失问题，将会在下个版本进行解决，例如由函数返回的函数无法携带其生成者的参数。

> [define gen-func [lambda (x) [lambda (y) [+ x y]]]]
> [[gen-func 3] 2] ; except 5
error: unbound symbol: x

目标

进一步提升代码的可读性和可维护性，同时保证内置函数基本可用。确保本次重构足以应对之后的新功能的扩展与开发。

路线图

0.3 版本预计开发周期预计为 3 个月。

2021年12月：

• 增加一些必要且实用的内置函数
• 优化代码中的名字
• 编写 .clang-format 文件，统一代码格式

2022年1月：

• 调整与优化 Environment, DataType, Value 的接口与实现
• 调整与优化 StringStream 的接口与实现
• 调整与优化 Parser, Interpreter 的接口与实现
• 调整与优化 Scanner 的接口与实现
• 为代码添加更多注释

2022年2月：

• 引入测试系统
• 编写 Scanner, Parser 与 Interpreter 的测试用例
• 编写内置函数的测试用例
• 编写 docscript 的快速入门教程