-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathparseCSV_llm_generated_specification.html
139 lines (139 loc) · 4.25 KB
/
parseCSV_llm_generated_specification.html
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
<!DOCTYPE html>
<html lang="en-US">
<head>
<title>CL-web-components</title>
<link rel="stylesheet" href="/css/site.css">
</head>
<body>
<nav>
<ul>
<li><a href="/">Home</a></li>
<li><a href="index.html">README</a></li>
<li><a href="LICENSE">LICENSE</a></li>
<li><a href="user_manual.html">User Manual</a></li>
<li><a href="INSTALL.html">INSTALL</a></li>
<li><a href="about.html">About</a></li>
<li><a href="search.html">Search</a></li>
<li><a href="https://github.com/caltechlibrary/CL-web-components">GitHub</a></li>
</ul>
</nav>
<section>
<h1 id="function-specifications">Function Specifications</h1>
<h2 id="parsecsvrow">1. <code>parseCSVRow</code></h2>
<ul>
<li><strong>Purpose</strong>: Parses a single row of CSV data into an
array of columns.</li>
<li><strong>Input</strong>:
<ul>
<li><code>csvRowString</code> (string): A single row of CSV data as a
string.</li>
</ul></li>
<li><strong>Output</strong>:
<ul>
<li>An array of strings, where each string represents a column in the
CSV row.</li>
</ul></li>
<li><strong>Behavior</strong>:
<ul>
<li>Handles quoted fields, allowing commas within quotes.</li>
<li>Trims whitespace from each column.</li>
<li>Ignores commas within quoted fields.</li>
</ul></li>
<li><strong>Example</strong>:
<ul>
<li>Input: <code>"John,Doe,123"</code></li>
<li>Output: <code>["John", "Doe", "123"]</code></li>
</ul></li>
</ul>
<h2 id="parsecsv">2. <code>parseCSV</code></h2>
<ul>
<li><strong>Purpose</strong>: Parses a full CSV string into a 2D array
of rows and columns.</li>
<li><strong>Input</strong>:
<ul>
<li><code>csvString</code> (string): The entire CSV data as a
string.</li>
</ul></li>
<li><strong>Output</strong>:
<ul>
<li>A 2D array of strings, where each sub-array represents a row of
columns.</li>
</ul></li>
<li><strong>Behavior</strong>:
<ul>
<li>Splits the CSV string into rows based on newline characters.</li>
<li>Uses <code>parseCSVRow</code> to parse each row.</li>
<li>Ensures all rows have the same number of columns by padding with
empty strings if necessary.</li>
</ul></li>
<li><strong>Example</strong>:
<ul>
<li>Input: <code>"John,Doe\nJane,Smith"</code></li>
<li>Output: <code>[["John", "Doe"], ["Jane", "Smith"]]</code></li>
</ul></li>
</ul>
<h2 id="stringifycsvrow">3. <code>stringifyCSVRow</code></h2>
<ul>
<li><strong>Purpose</strong>: Converts an array of strings into a
CSV-encoded string.</li>
<li><strong>Input</strong>:
<ul>
<li><code>array</code> (array of strings): An array representing a
single row of CSV data.</li>
</ul></li>
<li><strong>Output</strong>:
<ul>
<li>A CSV-encoded string.</li>
</ul></li>
<li><strong>Behavior</strong>:
<ul>
<li>Encloses fields containing commas, newlines, or double quotes in
double quotes.</li>
<li>Escapes double quotes within fields by doubling them.</li>
</ul></li>
<li><strong>Example</strong>:
<ul>
<li>Input: <code>["John", "Doe", "123"]</code></li>
<li>Output: <code>"John,Doe,123"</code></li>
</ul></li>
</ul>
<h2 id="stringifycsv">4. <code>stringifyCSV</code></h2>
<ul>
<li><strong>Purpose</strong>: Converts a 2D array of strings into a
CSV-encoded string.</li>
<li><strong>Input</strong>:
<ul>
<li><code>data</code> (2D array of strings): A 2D array representing
rows and columns of CSV data.</li>
</ul></li>
<li><strong>Output</strong>:
<ul>
<li>A CSV-encoded string.</li>
</ul></li>
<li><strong>Behavior</strong>:
<ul>
<li>Uses <code>stringifyCSVRow</code> to convert each row into a
CSV-encoded string.</li>
<li>Joins the rows with newline characters.</li>
</ul></li>
<li><strong>Example</strong>:
<ul>
<li>Input: <code>[["John", "Doe"], ["Jane", "Smith"]]</code></li>
<li>Output: <code>"John,Doe\nJane,Smith"</code></li>
</ul></li>
</ul>
<h2 id="general-requirements">General Requirements</h2>
<ul>
<li>The generated code should maintain the same functionality and
behavior as the original JavaScript code.</li>
<li>The code should handle edge cases, such as empty strings, fields
with special characters, and varying numbers of columns per row.</li>
<li>The code should be written in a clear and maintainable manner, with
appropriate comments and documentation.</li>
</ul>
<p>This specification can be used to guide an LLM in generating
functionally equivalent code in another programming language or to
rewrite the JavaScript code with the same functionality.</p>
</section>
</body>
</html>