powertools-lambda-typescript icon indicating copy to clipboard operation
powertools-lambda-typescript copied to clipboard

Maintenance: evaluate `biome` for linting and format

Open dreamorosi opened this issue 1 year ago • 1 comments

Summary

As of now the project uses a combination of eslint and prettier to lint and format code.

This works well enough, however there are newer alternatives like biome that boast high compatibility with our current tools (97%) and could allow us to handle both tasks with a single tool/dependency.

This issue tracks the efforts to test the tool on our repo, configure it in a way that causes the least amount of disruption, and potentially adopt it.

Why is this needed?

The main driver behind this issue is reducing maintainer fatigue. The combination of those two tools requires 9 dev dependencies which need to be kept up to date (Dependabot spam) and understood.

Additionally, there might be a chance to improve performance in our CI by both reducing the time for these operations (probably marginal at our repo size) as well as the time to set up the CI environment due to having less dependencies to fetch & install.

Which area does this relate to?

Automation

Solution

No response

Acknowledgment

Future readers

Please react with 👍 and your use case to help us understand customer demand.

dreamorosi avatar Jan 26 '24 10:01 dreamorosi

After some initial tests, which were promising, I found at least one rule we use extensively that is not supported by biome: typescript-eslint/explicit-function-return-type.

I requested the feature, which was added to the backlog, and I am now looking at options to help with prioritization.

dreamorosi avatar Apr 04 '24 08:04 dreamorosi

+1 for explicit-function-return-type

RayanMoarkech avatar Jul 03 '24 14:07 RayanMoarkech

⚠️ COMMENT VISIBILITY WARNING ⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.

github-actions[bot] avatar Jul 29 '24 08:07 github-actions[bot]

This is now released under v2.7.0 version!

github-actions[bot] avatar Aug 08 '24 13:08 github-actions[bot]