Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(stringify): header as comment #420

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat(stringify): header as comment #420

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions packages/csv-stringify/lib/api/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,9 @@ const stringifier = function(options, state, info){
[err, headers] = this.stringify(headers);
}
if(err) return err;
if(this.options.header_as_comment){
headers = this.options.comment + ' ' + headers;
}
push(headers);
},
__cast: function(value, context){
Expand Down
22 changes: 22 additions & 0 deletions packages/csv-stringify/lib/api/normalize_options.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,28 @@ const normalize_options = function(opts) {
}else{
// todo
}
// Normalize option `headers_as_comment`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you normalize both options, comment and header_as_comment separately where comment default to #.

if(!options.header_as_comment){
options.header_as_comment = false;
}else if(!options.comment?.length){
throw new CsvError('CSV_INVALID_OPTION_COMMENT', [
'Invalid option comment:',
'comment must be a non empty string or buffer when enable header_as_comment,',
`got ${JSON.stringify(options.comment)}`
], options);
}else{
if(Buffer.isBuffer(options.comment)){
options.comment = options.comment.toString();
}
if(typeof options.comment !== 'string'){
throw new CsvError('CSV_INVALID_OPTION_COMMENT', [
'Invalid option comment:',
'comment must be a buffer or a string when enable header_as_comment,',
`got ${JSON.stringify(options.comment)}`
], options);
}
options.header = true;
}
// Normalize option `columns`
const [errColumns, columns] = normalize_columns(options.columns);
if(errColumns !== undefined) return [errColumns];
Expand Down
8 changes: 8 additions & 0 deletions packages/csv-stringify/lib/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,14 @@ export interface Options extends stream.TransformOptions {
* Display the column names on the first line if the columns option is provided or discovered.
*/
header?: boolean
/**
* Display the column names on the first line as comment if the columns option is provided or discovered.
*/
header_as_comment?: boolean
/**
* Treat all the characters after this one as a comment, default to '' (disabled).
*/
comment?: string;
/**
* The quote characters, defaults to the ", an empty quote value will preserve the original field.
*/
Expand Down