fastn.com/rfcs/0005-ftd-space.ftd at a9556dca9f792eac4544ccf8f93692ac057c60d8 · fastn-stack/fastn.com · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
-- import: fastn.com/rfcs/lib

-- lib.rfc: RFC-5: Introducing `ftd.space` and `ftd.empty` Variables to `ftd`
id: 0005-ftd-space
status: pending

The purpose of this RFC is to propose the introduction of two new variables,
`ftd.space` and `ftd.empty`, to the `ftd` library. These variables will
facilitate the insertion of space characters and empty strings.


-- lib.motivation:

The addition of `ftd.space` and `ftd.empty` variables simplifies the process of
adding space character and empty space. By providing these predefined variables
for common formatting needs, makes `ftd` becomes more user-friendly when working
with spacing and empty content.

The `ftd.empty` can be used as default value of string type variable. This
variable can later on append other strings on some events.

-- end: lib.motivation


-- lib.detailed-design:

`ftd` will now contains two predefined variables. These will be included in
`default bag` in interpreter.

-- ds.h2: Variables Definition

-- ds.h3: `ftd.space`

The `ftd.space` variable is defined to return a space character as a string.

-- ds.h3: `ftd.empty`

The `ftd.empty` variable is defined to return an empty string.

-- ds.h2: Usage

The `ftd.space` variable can be used as the text for `ftd.text` element to
insert a space character and the `ftd.empty` variable can be used to insert an
empty string into the output. Here's an example of its usage:

-- ds.code:
lang: ftd

\-- ftd.text: $ftd.space
\-- ftd.text: $ftd.empty

-- end: lib.detailed-design


-- lib.alternatives:

-- ds.h2: Rejected: Adding the `ftd.space` function to `ftd`

The earlier proposal was the addition of the `ftd.space` function to the `ftd`
library. This function aims to generate strings containing a specified number of
space characters.

-- ds.code:
lang: js

ftd.space = function(arg) {
    let __arg__ = {
        a: 0,
        ...arg
    };
    if (__arg__.a <= 0) {
        return '';
    }

    return ' '.repeat(__arg__.a);
}

-- ds.markdown:

We rejected this because this has barely any use besides for the above two
mentioned cases. There's hardly any chance to use it for adding more than one
space.


-- end: lib.alternatives


-- lib.teaching-notes:

The introduction of `ftd.space` and `ftd.empty` variables can be effectively
integrated into educational material for `ftd` users.

-- end: lib.teaching-notes


-- lib.unresolved-questions:

As of now, there are no unresolved questions or issues related to the proposal
of introducing `ftd.space` and `ftd.empty` variables to the ftd library.

-- end: lib.unresolved-questions


-- end: lib.rfc