joshuakgoldberg / prettier-plugin-curly Goto Github PK

Bug Report Checklist

• I have tried restarting my IDE and the issue persists.
• I have pulled the latest main branch of the repository.
• I have searched for related issues and found none that matched my issue.

Overview

Tracking JoshuaKGoldberg/create-typescript-app#734 in this repository.

Additional Info

npx create-typescript-app --mode migrate --author JoshuaKGoldberg --description "Prettier plugin to enforce consistent brace style for all control statements. 🧹" --email [email protected] --funding JoshuaKGoldberg --owner JoshuaKGoldberg --repository prettier-plugin-curly --title prettier-plugin-curly

Bug Report Checklist

• I have tried restarting my IDE and the issue persists.
• I have pulled the latest main branch of the repository.
• I have searched for related issues and found none that matched my issue.

Expected

if (2) 1
else 2

Actual

Is being printed as ...

if (2) { 1;
else 1; }

Additional Info

No response

Bug Report Checklist

• I have tried restarting my IDE and the issue persists.
• I have pulled the latest main branch of the repository.
• I have searched for related issues and found none that matched my issue.

Expected

"prettier-plugin-curly": "0.1.3":

This code...

if(document.body)
  //Important comment which will be lost!
  document.body.append('')

should be transformed to

if(document.body) {
  //Important comment which will be lost!
  document.body.append('')
}

Actual

I get

if(document.body) {
  document.body.append('')
}

Additional Info

Same with block comments: /* comment */

Bug Report Checklist

• I have tried restarting my IDE and the issue persists.
• I have pulled the latest main branch of the repository.
• I have searched for related issues and found none that matched my issue.

Expected

Input:

let foo = new Set<string>();
if ('bar') {
} else
    foo.add('I am at the wrong position');

expected output

let foo = new Set<string>();
if ('bar') {
} else {
   foo.add('I am at the wrong position');
}

Actual

let foo = new Set<string>();
if ('bar') {
} else foo.add('I am at the wrong position');

Bug Report Checklist

• I have tried restarting my IDE and the issue persists.
• I have pulled the latest main branch of the repository.
• I have searched for related issues and found none that matched my issue.

Expected

I expected to be able to run pnpm format with prettier-plugin-curly on literate-ts.

Actual

$ npx prettier src/ts-checker.ts
src/ts-checker.ts
[error] src/ts-checker.ts: SyntaxError: ',' expected. (85:5)
[error]   83 |       const start = m.index + 1;
[error]   84 |       const end = start + m[1].length;
[error] > 85 |       errors.push({line: lastCodeLine, start, end, message});
[error]      |     ^
[error]   86 |     }
[error]   87 |   });
[error]   88 |   return errors;

Additional Info

Here's the file in question, no syntax errors in sight:
https://github.com/danvk/literate-ts/blob/5d04101f895285d838cb4cdccadc8941c86b0771/src/ts-checker.ts#L85

This was quite confusing because there's nothing in the error message indicating that the error is coming from prettier-plugin-curly, rather than prettier itself.

Bug Report Checklist

• I have tried restarting my IDE and the issue persists.
• I have pulled the latest main branch of the repository.
• I have searched for related issues and found none that matched my issue.

Expected

Works fine with other prettier plugins like prettier-plugin-organize-imports.

Actual

Can not use this with prettier-plugin-organize-imports.

Additional Info

Maybe the reason is you are overriding preprocess?

Some links may be useful

• The problem is similar to that encountered by prettier-plugin-tailwindcss.
• Maybe we can try something like https://github.com/tailwindlabs/prettier-plugin-tailwindcss/blob/360cb773a31d12da96ea90fa1f32ea9072a98aaf/src/index.js#L27-L82
• Suggestion from prettier.

Bug Report Checklist

• I have tried restarting my IDE and the issue persists.
• I have pulled the latest main branch of the repository.
• I have searched for related issues and found none that matched my issue.

Overview

A PR was already opened in #28.

Additional Info

No response

Bug Report Checklist

• I have tried restarting my IDE and the issue persists.
• I have pulled the latest main branch of the repository.
• I have searched for related issues and found none that matched my issue.

Expected

Should parse and format

const a =1
const a=1

Actual

Cannot parse and breaks formatting

Additional Info

We should use prettier's parser. import from prettier/parser-babel

PR later

Bug Report Checklist

• I have tried restarting my IDE and the issue persists.
• I have pulled the latest main branch of the repository.
• I have searched for related issues and found none that matched my issue.

Expected

Given code like:

for (; i < lines.length && lines[i] !== until; i++);

I'd expect no changes, as the ; indicates the for's body is an intentionally empty statement

Actual

It gets changed to:

for (; i < lines.length && lines[i] !== until; i++) {}

Additional Info

Seen when verifying #309 works on @danvk's https://github.com/danvk/literate-ts/blob/5d04101f895285d838cb4cdccadc8941c86b0771/src/ts-checker.ts#L85 as referenced by #284.

Thanks again @danvk for using the plugin & filing the issue! 😄

Bug Report Checklist

• I have tried restarting my IDE and the issue persists.
• I have pulled the latest main branch of the repository.
• I have searched for related issues and found none that matched my issue.

Expected

Comments should survive "as they are"

//pre comment
if (true)
    //pre branch comment
    console.log('hurray')
//post comment

should get

//pre comment
if (true) {
    //pre branch comment
    console.log('hurray')
}
//post comment

Actual

Formatting results in:

//pre comment

//pre comment
if (true) {
    //pre branch comment
    console.log('hurray');
}
//post comment
//post comment

Additional Info

ref #179

Bug Report Checklist

• I have tried restarting my IDE and the issue persists.
• I have pulled the latest main branch of the repository.
• I have searched for related issues and found none that matched my issue.

Expected

No error in console when installing packages including this package.

Actual

Additional Info

Remove this line -