sig#779 - Coding Style: file and folder naming not consistent

[oyo]

Current Behavior

Source code files and folders are not named consistent - especially starting character upper and lower case is mixed.

Expected Behavior

We expect a clear and consistent naming scheme for our codebase.

Steps To Reproduce

Check the structure of the src/ folder. There are two steps:

First goal is to develop a style guide for our Typescript and React repositories inspired by best practices used in the community. Some popular guides can be found here
https://github.com/airbnb/javascript/tree/master/react
https://google.github.io/styleguide/tsguide.html
https://docs.aws.amazon.com/prescriptive-guidance/latest/best-practices-cdk-typescript-iac/typescript-best-practices.html
https://www.linkedin.com/pulse/react-js-naming-convention-kristiyan-velkov/

After we identified an appropriate style guide rename files and folders not following that style.

[MaximilianHauer]

assigning this to @manojava-gk as he asked for new tickets and @lavanya-bmw is still busy with other stuff

[manojava-gk]

@oyo here is my analysis on case consistency issue in the portal app.

Current folder structure and the case usage inside it

src

• alll the folder names are in small - fine

@types

  • both folder and files are in small case - fine

  assets

  • both folder and files are in small case - fine

  components

  • folder names are in small case - fine

  • files are in PascalCase - fine

    actions

    • folder names are in PascalCase - fine
    • each folder includes an index file - fine

    overlays

    • folder names are in PascalCase - fine
    • each folder includes index file - fine
    • css files either Pascal or small case - not fine

    pages

    • top level folder names are in PascalCase - fine
    • nested folder names are either Pascal or small case - not fine
    • each folder includes index file - fine
    • css files either Pascal or small case - not fine
    • components are hosted either in top level or inside a components folder or component specific folder - not fine

    shared

    • folder names are either in PascalCase or small - not fine
    • nested folder names are either Pascal or small case - not fine
    • css files either Pascal or small case - not fine
    • components are hosted either in top level or inside a components folder or component specific folder - not fine

    styles

    • files are in small case - fine

  features

  • folder names are in camelcase - fine
  • nested folders and files are in camelcase - fine

  hooks

  • files are in camelcase - fine

  services

  • files are in PascalCase - fine

  types

  • files are in PascalCase - fine

  utils

  • files are either in Pascal or camelcase - not fine

[evegufy]

@oyo can this issue get closed?

[oyo]

@oyo can this issue get closed?

@evegufy today I merged PR #1351 which fixed most of the inconsistencies. From my pov we can close the issue now.