chore: auto format some TypeScript files #286
Conversation
![datadog-datadog-prod-us1[bot]](https://avatars.githubusercontent.com/u/365230?s=60&v=4){kind=small}
| console.log( | ||
| "Instrumenting Lambda Functions in TypeScript stack with Datadog" | ||
| ); | ||
| console.log("Instrumenting Lambda Functions in TypeScript stack with Datadog"); |
There was a problem hiding this comment.
🟠 Code Quality Violation
Unexpected console statement. (...read more)
Debugging with console is not considered a bad practice, but it's easy to forget about console statements and leave them in production code. There is no need to pollute production builds with debugging statements.
|
Isn't it possible to format them with a plugin? Instead of relying on a formatter that is only installed in your computer? |
|
@duncanista Right now the format check only covers See the format check failure on the demo commit: https://github.com/DataDog/datadog-cdk-constructs/actions/runs/10605642445/job/29394854056 |
lym953
force-pushed
the
yiming.luo/auto-format
branch
2 times, most recently
from
2cb24c9 to
983592b
Compare
| @@ -67,7 +67,7 @@ const project = new awscdk.AwsCdkConstructLibrary({ | |||
| "CONTRIBUTING.md", | |||
| ], | |||
| scripts: { | |||
| "check-formatting": "prettier --check src/**", | |||
| "check-formatting": "prettier --check src/** integration_tests/**/*.ts examples/**/*.ts", | |||
There was a problem hiding this comment.
I tried to find a more succinct way to get all .ts files in the repo, but couldn't find one. For example, I tried **/*.ts and */**/*.ts, but both fail to find some files in integration_tests or in examples.
|
@lym953 ok, thanks for the detailed explanation and the comment on what work and what didn't, approving, feel free to take the right decision! |
lym953
force-pushed
the
yiming.luo/auto-format
branch
from
983592b to
46a3573
Compare
|
/merge |
|
🚂 MergeQueue: pull request added to the queue The median merge time in Use |
dd-devflow
bot
added
mergequeue-status: queued
mergequeue-status: in_progress
and removed
mergequeue-status: queued
labels
dd-devflow
bot
added
mergequeue-status: done
and removed
mergequeue-status: in_progress
labels
What does this PR do?
Auto format some TypeScript files
Motivation
The next PR (#285) will touch lots of files, and saving those files on VS Code on my laptop will auto-format those files, mixing formatting changes and other changes in the same PR, so I want to separate out the formatting changes to this PR to make changes easier to review.
I can also disable "format on save" on my IDE, but I think it's a good thing to keep code in good format.
Testing Guidelines
npx projen build, no errorAdditional Notes
Types of Changes
Check all that apply