Object Literal Property must match one of the following formats: strictCamelCase

Question

Object Literal Property must match one of the following formats: strictCamelCase

Closed this issue 3 months ago · 8 comments

Hello. A lot of npm packages accept only snake_case fields in object parameters.
It will be cool to ignore this rule if we use such npm packages or external APIs.

await openai.beta.threads.runs.create(threadId, {
	assistant_id: assistantId,
})

Object Literal Property name `assistant_id` must match one of the following formats: strictCamelCase (@typescript-eslint/naming-convention)XO[@typescript-eslint/naming-convention](https://typescript-eslint.io/rules/naming-convention)
(property) RunCreateParams.assistant_id: string

Answer 1 · 2024-02-29T14:36:52.000Z

The convention in JS is camel-case. You can use ESLint ignore comments for cases like this.

Answer 2 · 2024-02-29T14:37:52.000Z

A lot of npm packages accept only snake_case fields in object parameters.

This is not correct. The only packages that require it are bad web API wrapper packages.

Answer 3 · 2024-03-08T16:55:36.000Z

This is not correct. The only packages that require it are bad web API wrapper packages.

May I look at some examples of pretty large codebases with xo and a lot of npm packages?

Here is my example

Answer 4 · 2024-03-08T17:02:37.000Z

bad web API wrapper packages.

Stripe example

Answer 5 · 2024-03-08T17:03:43.000Z

@sindresorhus Have you ever used xo in your projects?

Answer 6 · 2024-03-08T17:12:01.000Z

I use XO in 1000+ projects.

Answer 7 · 2024-03-08T17:16:15.000Z

Stripe example

They only use snake-case because the programmatic API is generated from their API docs.

Answer 8 · 2024-03-08T17:16:42.000Z

You don't have to ESLint ignore each line, you can apply it to a block or a whole file. You could even allow snake_case for the whole project if you want.