unfoldingWord / findr

Open Components for Find and Replace
https://findrjs.netlify.app/
MIT License
0 stars 0 forks source link

Consider globally renaming `fnr` to `findr` #10

Open theNerd247 opened 1 year ago

theNerd247 commented 1 year ago

The name of the library is findr and I've noticed as I browse through the code asking myself: "what's fnr?". I am now realizing that this may just be a shorthand for findr? If this is a case I would like to suggest replacing fnr occurrences in code and documentation with findr and may even go as far as renaming the packages themselves.

Consider the following two import statements:

  1. current import

    import { fnr } from "@findr/text"
  2. with fnr changed

    import { findr } from "@findr/text"

I would say (2) above is more readable as fnr feels like a typo. Further, I would say that if one sees the function findr in their (potentially large) codebase they would immediately know what it is and which package it's associated with where as fnr requires an extra step for the developer's brain.

From a personal perspective I'm finding myself typing findr-text instead of fnr-text when running package commands

theNerd247 commented 1 year ago

Green light on changing the package names

theNerd247 commented 1 year ago

depends on #5 being resolved first.