Base Component Naming

Say I have a project called React Report Maker and it has a report component. Components should be super generic right? So I should probably just call the containing file report.js right? Wrong.

Generic components are great but if they are truly generic we should expect they will be reused in multiple applications. If you are an awesome developer you will have multiple workspaces open simultaneously in your VS Code, Eclipse, or other IDE. If your awesome, reusable report.js is included in multiple workspaces, this is when you stub your toe.

Instead, adopt a project short name convention. React Report Maker could be abbreviated RRM. You might have a JIRA project which you can name RRM and this can be associated with Bitbucket Repos using RRM and you can create branches like rrm-* which Atlassian will be smart enough to realize is a reference to JIRA project when it’s referenced in Bitbucket commit messages, branch names, or Slack messages, etc.

Since you are going to be using this project short name when talking to people, and in every other app, it becomes a perfect prefix to your reusable component. That’s right, your reusable component should be named in a non-reusable way. It’s bad to call things report.js. It’s good to call things like rrm-report.js This way when I search across my workspace for a file, I can easily and correctly find the correct report.js I care about instead of bringing up like 10 and guessing or having to dig deeper to be sure which one it is. Protip: ctrl + p in VS Code does this, and it’s great.

Now, you bring up a good point. What about the one, true, best-practice-example of report.js? Within RRM, report.js might have to be tweaked for use. Within ABC, DEF, or GHI, those report.js might be slightly different. So you want to implement base-report.js which is your cleanest go-to version of the report component for your next project. Oh wait! We already answered the question! For the use case of reference code I prefer the convention of calling something base. base-report.js is the generic form of report. When I implement base-report within some application I rename the component folder, html, js, and other stuff if needed, by replacing basewith the project abbrevation, such as rrm.

I also do this within the component itself. So BaseController is a generic reference class, and RmmController is the BaseController implementation within RMM. You could be extra cool and upload BaseController to NPM then install it and extend it as an abstract class into RmmController, but sometimes that’s a little complicated, indirect, time-consuming, or simply not allowed at your company. So copying, pasting, and modifying the reference code is sometimes better, simpler, quicker, etc, and that’s what I usually end up doing.

Tagged with: , , ,

Leave a Reply

Your email address will not be published. Required fields are marked *