Rule to enforce rest naming convention

[alko89]

Would it be possible to expand the module to use it to enforce rest naming conventions for endpoints?

https://restfulapi.net/resource-naming/

Essentially to check the Controller, Get, Post, Put, Delete.. decorators if a proper naming was used for the endpoint:

This PASSES

@Controller('tests')
class TestClass {
    @Get()
    public getAll() {
    }
}

This FAILS, because the resource is not plural

@Controller('test')
class TestClass {
    @Get()
    public getAll() {
    }
}

This PASSES

@Controller('tests')
class TestClass {
    @Get('some-param/:someParam')
    public getByParam(@Param('someParam') param) {
    }
}

This FAILS, because camel case was used to name the resource

@Controller('tests')
class TestClass {
    @Get('getByParam/:someParam')
    public getByParam(@Param('someParam') param) {
    }
}

[spotlesscoder]

it should be configurable to use camelCase or dash or underscore

[darraghoriordan]

This is a fairly complex rule that I wouldn't really enforce in my projects. Unlikely to implement this myself.

Happy to accept PR for it though.

[spotlesscoder]

Can you give us a hint what the necessary steps would be to implement this?

[darraghoriordan]

There is a naming convention rule in the main eslint ruleset you could use for inspiration.

There are a couple of examples in this project of how to detect a nestjs controller and the nestjs api method decorators.

you would have to combine these in some way