Locale Analyzer

Requirements

• This application may run on previous versions of NodeJS but has been developed and tested with version: ~v10.0.0
  • If this is different from the current version of NodeJS on your machine, you can use the NVM tool to install another:
    • Mac - https://github.com/creationix/nvm
    • Windows - https://github.com/coreybutler/nvm-windows
• While it may run with other repository structures the one found in the mocks/sample_repo is what this was developed against.

Objectives

Create a CSV / Spreadsheet file that meets the following requirements:

• All properties found in the cartridges of repository should be listed as rows in the spreadsheet
• Properties should be grouped by locale group and then cartridge their found in
• Any cartridges that have a name that looks like: app_foo_core should have all properties found in all files
• All locales found in the site meta data of the repository should be listed as columns in the spreadsheet
• Each property row, will contain a column and that contains the original cartridge that the property was found in
• Properties should be sorted alpha-numerically within their locale group
• Locale Groups should be sorted alphanumerically

Example

Give the sample repository in the mocks/sample_repo directory, the following CSV will be generated:

Cartridge,Locale Group,Property,Defined In,default,en,ca,fr,it,ja,ca_EN,ja_JP
app_foo_core,form,foo,app_foo_core,bar,,,,,,,
app_foo_core,localegroupa,sunny.day,cartridge_c,,,,,,,,
app_foo_core,localegroupb,starry.night,cartridge_b,,,,,,,,
app_foo_core,localegroupc,green.grass,cartridge_c,,,,,,,,
cartridge_a,localegroupa,sunny.day,cartridge_c,Sunny Day,Sunny Day EN,,Journée ensoleillée,Giorno soleggiato,,Sunny Day CA EN,晴れた日
cartridge_c,localegroupa,sunny.day,cartridge_c,,,,,Wrong Italian,,,
cartridge_c,localegroupc,green.grass,cartridge_c,Green Grass,,,L'herbe verte,Erba verde,,,緑の草
cartridge_b,localegroupb,starry.night,cartridge_b,Stary Night,Light Moon,,,,,Darky Moon,星が輝く夜

The above CSV will be generated from the following JSON:

{
    "app_foo_core":{
       "form":{
          "foo":{
             "default":"bar"
          }
       }
    },
    "cartridge_a":{
       "localegroupa":{
          "sunny.day":{
             "ca_EN":"Sunny Day CA EN",
             "default":"Sunny Day",
             "en":"Sunny Day EN",
             "fr":"Journée ensoleillée",
             "it":"Giorno soleggiato",
             "ja_JP":"晴れた日"
          }
       }
    },
    "cartridge_b":{
       "localegroupb":{
          "starry.night":{
             "ca_EN":"Darky Moon",
             "default":"Stary Night",
             "en":"Light Moon",
             "ja_JP":"星が輝く夜"
          }
       }
    },
    "cartridge_c":{
       "localegroupa":{
          "sunny.day":{
             "it":"Wrong Italian"
          }
       },
       "localegroupc":{
          "green.grass":{
             "default":"Green Grass",
             "fr":"L'herbe verte",
             "it":"Erba verde",
             "ja_JP":"緑の草"
          }
       }
    }
 }

Getting Started

Install the necessary node_modules:

npm install

Copy config.sample.json to config.json and update the relevant values:

config.json should contain the real values to be used when generating a report from a code base.

cp config.sample.json config.json

Test the application:

Testing the applicatino will not write any files out but will test the code repo found in the mocks folder and ensure the helpers.js file generates the correct output given the data in the mocks folder.

npm test

Lint the application:

Ensure all of the JavaScript code adheres to the eslint rules defined in .eslintrc. Files found in the .eslintignore file will be ignored.

npm run lint

Generate Documentation:

Generate the JSDocs from the JavaScript files in this repo.

npm run docs

Generate Coverage Report:

Generate a "code coverage" report of the JavaScript files of this repo. The total coverage should always remain above 80%

npm run cover

Run the application:

Run the application and generate output stored in the output folder based on the configuration found in the config.json file.

npm start

Configuration

This application can be configured using a config.json file in the root of the repository.

The following are some notes for each attribute and what they do:

{
  "cartridgsToExclude": [ // Which cartridges should be excluded from anlysis
      "should_be_ignored"
  ],
  "cartridgeSortOrder": [ // How are cartridges sorted, in regards to the "Cartridge Path". Cartridges on the left of the path should be at the top of the list
      "app_foo_core",
      "cartridge_a",
      "cartridge_c",
      "cartridge_b"
  ],
  "repo": "./mocks/sample_repo/", // Code Repository to analyze
  "propertyGlobPattern": "cartridges/**/cartridge/templates/resources/**/*.properties", // A "Glob" pattern for the locale property files
  "primaryLanguage": "en", // The Primary language of the application, this will be sorted first after "default"
  "csvOutput": "./output/results.csv" // Where should the CSV output go
}