Navigation Menu

Skip to content

Instantly share code, notes, and snippets.

@sapegin
Created May 30, 2023 08:23
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save sapegin/a46ab46cdd4d6b5045027d120b9c967d to your computer and use it in GitHub Desktop.
Save sapegin/a46ab46cdd4d6b5045027d120b9c967d to your computer and use it in GitHub Desktop.
// How do you avoid name clashes between functions, variables, components, and types?
// OK
const crocodiles = getCrocodiles({ color: 'green' })
// ???
const isCrocodile = isCrocodile(crocodiles[0])
// OK
const user: User = { name: 'Chuck Norris' }
// ???
function User(props: { user: User }) => <p>{props.user.name}</p>
@rauschma
Copy link

I guess here I'd prefer to rename the type while importing it and keep the component name to avoid leaking the problem

Note that I only use XView if it really only is a view for values of type X. If it does more, I change the name.

@darekkay
Copy link

I agree with Axel that it's the variables and components that should usually be renamed when a clash happens. For variables, one can sometimes integrate the function result into the business logic, e.g.:

const shouldNotTouch = isCrocodile(animal);

@kosminen
Copy link

kosminen commented Jun 1, 2023

(As I replied in a Mastodon thread, and as @rauschma asked me to reply to here, too) I would probably describe the results more in the names. Something like:

// Well, I assume we are fetching all the green crocodiles.
const greenCrocodiles = getCrocodiles({ color: 'green' })

// Yet again, it seems we are checking if the first item in the array is a crocodile.
const isFirstItemCrocodile = isCrocodile(crocodiles[0])

// Assuming that this is composing a user object to add to a database or whatever.
const userToAdd: User = { name: 'Chuck Norris' }

// Assuming this is a component to show user data. As a single paragraph I
// wouldn’t make it a component, but with that exact example I would probably name
// it something like UserParagraph :)
function UserProfile(props: { user: User }) => <p>{props.user.name}</p>

But well, context matters. Hope these examples were communicated through.

@sapegin
Copy link
Author

sapegin commented Jun 15, 2023

Thanks everyone for the great suggestions! @rauschma @darekkay @kosminen

I took many (combined with my own experience) for my book's chapter on naming:

https://github.com/sapegin/washingcode-book/blob/master/manuscript/Naming_is_hard.md#tips-to-avoid-name-clashes

@vitalets
Copy link

My suggestions:

// add "action" to function name, general pattern when storing variable from getter function: const xxx = getXxx()
const isCrocodile = getIsCrocodile(crocodiles[0]);

// name types / interfaces with "I":
const user: IUser = { name: 'Chuck Norris' }
function User(props: { user: IUser }) => <p>{props.user.name}</p>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment