mirror/puter
1
0
Fork 0
mirror of https://github.com/HeyPuter/puter.git synced 2026-02-21 22:19:23 -06:00
Code Issues Packages Projects Releases Wiki Activity

dev: tweak comment writer to fix some problems

Browse Source
This commit is contained in:
KernelDeimos
2024-12-02 10:56:57 -05:00
parent 857718538b
commit 7e4ae19aff
1 changed files with 36 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
tools/comment-writer/main.js
View File

@@ -1,4 +1,4 @@
// METADATA // {"ai-params":{"service":"xai"}}
// METADATA // {"ai-params":{"service":"claude"},"comment-verbosity": "high","ai-commented":{"service":"claude"}}
const enq = require('enquirer');
const wrap = require('word-wrap');
const dedent = require('dedent');
@@ -157,6 +157,27 @@ const js_processor = new JavascriptFileProcessor(context, {
};
}
},
{
name: 'if',
pattern: /^\s*if\s*\(.*\)\s*{/,
handler: () => {
return { type: 'if' };
}
},
{
name: 'while',
pattern: /^\s*while\s*\(.*\)\s*{/,
handler: () => {
return { type: 'while' };
}
},
{
name: 'for',
pattern: /^\s*for\s*\(.*\)\s*{/,
handler: () => {
return { type: 'for' };
}
},
{
name: 'method',
pattern: /^\s*async .*\(.*\).*{/,
@@ -174,6 +195,12 @@ const js_processor = new JavascriptFileProcessor(context, {
pattern: /^\s*[A-Za-z_\$]+.*\(\).*{/,
handler: (match) => {
const [ , name ] = match;
if ( name === 'if' ) {
return { type: 'if' };
}
if ( name === 'while' ) {
return { type: 'while' };
}
return {
type: 'method',
name,
@@ -559,6 +586,14 @@ const main = async () => {
`);
}
if ( def.type === 'if' || def.type === 'while' || def.type === 'for' ) {
if ( metadata['comment-verbosity'] !== 'high' ) continue;
instruction = dedent(`
Since the comment is going above a control structure, please write a short concise comment.
The comment should be only one or two lines long, and should use line comments.
`);
}
if ( def.type === 'method' ) {
instruction = dedent(`
Since the comment is going above a method, please write a JSDoc style comment.