Code style preferences and guidelines

[puffo]

While we extend and cleanup some areas of the codebase, we should start to discuss some of our coding style preferences to prepare for some kind of contributions.md file in future.

This issue can be a place for us to discuss our preferences.

Ongoing List of Standards:

Function signatures

1. When creating a function that adheres to a TS type, avoid restating the already defined parameter types in the new function.
2. When creating a function where the context for input parameters is clear, use shorts name for those parameters.

General

1. Avoid leaving TODOs in the codebase. Rather generate a Github issue with a decent description.

[puffo]

We define MapTrack in process.ts:

export type MapTrack = (nft: NFT, apiTrack: any, nftFactory?: NftFactory | undefined, trackId?: string) => ProcessedTrack;

But then we also re-specify the types when implementing it. e.g. nina.ts

const mapTrack: MapTrack = (
  nft: NFT,
  apiTrack: any,
  contract?: NftFactory,
  trackId?: string,
): ProcessedTrack => { // ...

What do we think about cleaning things up a bit and leaning on the TS types instead?

const mapTrack: MapTrack = (
  nft,
  apiTrack,
  contract?,
  trackId?,
) => { // ...

An example of what this cleanup looks is here: e0f4be1

[musnit]

ye sounds great

[musnit]

the linked changes look good too

[puffo]

When creating a function where the context for its parameters is self evident, prefer short names instead of being overly specific.

Style recommendation based on discussion in https://github.com/spinamp/spindexer/pull/76/files#r965095193

[puffo]

We don't make use of TODOs in the codebase, prefer github issues or just tackle the problem if it isn't a major change!

Source:
https://github.com/spinamp/spindexer/pull/76/files#r965104227