feat: exclude underscore from TS key enum rendering

[Ishan-Saini]

Description

• Added _ to the exclusion list inside TS key enum renderer.
• Added tests for EnumRenderer.

Related issue(s)
Resolves #609

[github-actions]

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

[Ishan-Saini]

Hey @jonaslagoni , I am not sure if this falls under the chore: specification.
Also, let me know if something needs to be changed.

[coveralls]

Pull Request Test Coverage Report for Build 1811933408

• 1 of 1 (100.0%) changed or added relevant line in 1 file are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage remained the same at 93.542%

---

Totals
Change from base Build 1811568139:	0.0%
Covered Lines:	2459
Relevant Lines:	2505

---

💛 - Coveralls

[jonaslagoni]

Hey @jonaslagoni , I am not sure if this falls under the chore: specification.
Also, let me know if something needs to be changed.

You can use feat here 🙂

I can see we did not create a test for the EnumRenderer... Do you mind creating a test file for it under test/generators/typescript/renderers/EnumRenderer.spec.ts? 🙏

For test cases, all you need to test is normalizeKey:

• should correctly convert underscore character.
  • Given something_something you expect SOMETHING_SOMETHING to be returned.
• should correctly convert space character.
  • Given something something you expect SOMETHING_SOMETHING to be returned.

Feel free to add more cases if you feel like it 🙂

[Ishan-Saini]

I can see we did not create a test for the EnumRenderer... Do you mind creating a test file for it under test/generators/typescript/renderers/EnumRenderer.spec.ts? pray

I am new to testing but I'll still try to get it done asap. 😅

[jonaslagoni]

I am new to testing but I'd still try to get it done asap.

No worries!

I can give you the core testing setup if you want that, that way you only need to add the tests for the function, let me know 🙂

Otherwise ping me if you get stuck 👍

[Ishan-Saini]

I can give you the core testing setup if you want that, that way you only need to add the tests for the function, let me know slightly_smiling_face

I'll try to get it done myself first.
Will let you know if I get stuck :)

[Ishan-Saini]

I can give you the core testing setup if you want that, that way you only need to add the tests for the function, let me know slightly_smiling_face

Hey @jonaslagoni , Could you please provide the core testing setup 😬?
A bit stuck, I think the setup would help me get started.

[jonaslagoni]

A bit stuck, I think the setup would help me get started.

For sure!

Here you go @Ishan-Saini (test/generators/typescript/renderers/EnumRenderer.spec.ts):

import { TypeScriptGenerator } from '../../../../src/generators';
import { EnumRenderer } from '../../../../src/generators/typescript/renderers/EnumRenderer';
import { CommonInputModel, CommonModel } from '../../../../src/models';

describe('TypeScriptRenderer', () => {
  let renderer: EnumRenderer;
  beforeEach(() => {
    renderer = new EnumRenderer(TypeScriptGenerator.defaultOptions, new TypeScriptGenerator(), [], new CommonModel(), new CommonInputModel());
  });

  describe('normalizeKey()', () => {
    test('should correctly format " " to correct key', () => {
      
    });
    test('should correctly format "_" to correct key', () => {
      
    });
  });
});

[Ishan-Saini]

@jonaslagoni
Thank you for providing the setup, it really cleared a lot of things for me. I have pushed the changes, let me know if something is wrong.

[jonaslagoni]

Small change.

Also, I see you updated package-lock.json, do you mind reverting it to the current one? Just copy-paste it from masterand commit it 🙂

It is a known "problem" with never versions of node, but our CI uses older versions, so we need to keep it to their liking (for now).

[Ishan-Saini]

Also, I see you updated package-lock.json, do you mind reverting it to the current one? Just copy-paste it from masterand commit it slightly_smiling_face

It is a known "problem" with never versions of node, but our CI uses older versions, so we need to keep it to their liking (for now).

Oh okay, I will keep that in mind :)

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[jonaslagoni]

LGTM 🎉

[jonaslagoni]

/rtm

[asyncapi-bot]

🎉 This PR is included in version 0.47.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[asyncapi-bot]

🎉 This PR is included in version 1.0.0-next.23 🎉

The release is available on:

• npm package (@next dist-tag)
• GitHub release

Your semantic-release bot 📦🚀