chore: Add feat/jsdoc-require-returns-type eslint rule

[Pathan-Amaankhan]

What

• This PR adds feat/jsdoc-require-returns-type & @typescript-eslint/explicit-function-return-type eslint rule.

Related Issue(s):

• https://github.com/rtCamp/headless/issues/250

Testing Instructions

• Run npm install && npm run lint.

Additional Info

• As this PR fixes the codebase, we won't be getting any eslint errors.

Checklist

• I have read the Contribution Guidelines.
• My code is tested to the best of my abilities.
• My code passes all lints (ESLint, tsc, prettier etc.).
• My code has detailed inline documentation.
• I have added unit tests to verify the code works as intended.
• I have updated the project documentation as needed.
• I have added a changeset for this PR using npm run changeset.

[changeset-bot]

⚠️ No Changeset found

Latest commit: e470423

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[justlevine]

I'm approving based on the CI passing.

I still think it's counterintuitive to be doing ESLint types before we fix/enforce our TS types 🤷

Pinging @ayushnirwal in case he has something to add.

[justlevine]

(its a chore: because no production code has changed ).

[justlevine]

(better to enforce return types vs TS - on hold)

[ayushnirwal]

Use require-returns to enforce descriptions. (as a warning)
Use explicit-function-return-type to enforce return types in TS (as an error)

[Pathan-Amaankhan]

Hi @ayushnirwal,
Have added @typescript-eslint/explicit-function-return-type eslint rule & fixed all the eslint issues.

cc: @justlevine

[ayushnirwal]

Suggested change

	'jsdoc/require-returns-type': [ 'warn' ],
	'jsdoc/require-returns': [ 'warn' ],

[Pathan-Amaankhan]

@ayushnirwal So, should I also revert the types added to return?

[ayushnirwal]

Yes, you can remove types from @returns tag in JSDOC

[justlevine]

No need for me to review this again. Once @ayushnirwal approves this and a changeset is added, lmk and I'll merge.

[ayushnirwal]

This PR is mergable after this and merge conflicts are resolved. Also, changeset too.