Define and clean up folder/files names

[ageddesi]

At the moment the files and folders are using different naming conventions and case types.

• - Define the standards
• - Update the contribution guide to include these standards
• - Update existing folders and files to be inline.

[fms12]

can you assign me this

[ageddesi]

Hi @fms12 Feel free to start the discussion on this post about what standards we should follow and once we all agree you can do the work involved.

[fms12]

@ageddesi we can add modules name like that "chat-module" and for files, we can just like that "CurrencyRouters"

[amanksdotdev]

I can work on this if it is not assigned to anyone.
After going through the codebase I would suggest keeping kebab-case as the naming convention for both files and folders as this is a nodejs project.

[ageddesi]

Does anyone know of a good coding standards doc we can reference for node projects.

[fms12]

https://nodejs.dev/en/learn/ you can use this one also.

[amanksdotdev]

@ageddesi https://stackoverflow.com/questions/18927298/node-js-project-naming-conventions-for-files-folders the first two answers.

[sherlyfebrianti96]

Hi, is it okay if i do this task since no updates for 5 days?

I would like to propose this :

• Using kebab-case for the folders, and keep the naming simple
  • e.g :
    • time_zones -> timezones
    • phone-numbers -> phones
• Using kebab-case for the filenames
• Restructuring the files
  • Before :
    • Modules
      • Address/animal/etc (not-standardized yet)
        • api
          • file-routes.ts (not-standardized yet)
        • const
          • file.ts (not-standardized yet)
        • test
          • file.test.ts (not-standardized yet)
        • utils
          • file.ts (not-standardized yet)
  • After :
    • Modules
      • address/animal/timezones (kebab-case)
        • address/animal/timezones.routes.ts (kebab-case) -> This is for APIs
        • address/animal/timezones.types.ts (kebab-case) -> This is for Interfaces/Types
        • utils (kebab-case)
          • util-name-1.ts (kebab-case)
          • util-name-2.ts (kebab-case)
        • test
          • address/animal/timezones
          • utils
            • util-name-1.test.ts (kebab-case)
            • util-name-2.test.ts (kebab-case)

So in general, this is how to identify the code :

• *.routes.ts is for the APIs
• *.types.ts is for the Interfaces and Types
• utils/*.ts is for all the utilities
• The test folder should have the same structure with current directory
  • and */\.test.ts is for all test files

[ageddesi]

Hi @sherlyfebrianti96 I am happy with the changes you have mentioned and what we have discussed in Discord. Please feel free to take this ticket on 👍

[sherlyfebrianti96]

Update :

The Interfaces/Types will be treated the same as utils folder.
So it will be :

• Modules
  • address/animal/timezones (kebab-case)
    • address/animal/timezones.routes.ts (kebab-case) -> This is for APIs
    • models (kebab-case)
      • address/animal/timezones.types.ts (kebab-case) -> This is for Interfaces/Types
    • utils (kebab-case)
      • util-name-1.ts (kebab-case)
      • util-name-2.ts (kebab-case)
    • test
      • address/animal/timezones
      • utils
        • util-name-1.test.ts (kebab-case)
        • util-name-2.test.ts (kebab-case)

[sherlyfebrianti96]

Update the contribution guide to include the new standards : #222