From dd6ec7b110bc9fe4a1794f6bd71a98ffcdda7021 Mon Sep 17 00:00:00 2001 From: Alexandre Falessi Date: Tue, 1 Sep 2020 12:55:15 +0200 Subject: [PATCH] Add a section in the README on how to fix line break encoding issue --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 28e56055..655ac718 100644 --- a/README.md +++ b/README.md @@ -112,6 +112,26 @@ Then build automation-dashboard, that will compose all subviews. In order to test subviews and automation dashboard locally, it is required not to publish the subviews archives to main repository, but to local repository of machine. +### Line break issue: +If you are building automation dashboard or subviews using different OS over time you can face an encoding issue. It usually manifest with +a blank automation-dashboard page, when looking at the browser console a lot of warnings appear and some code can be recognized as error. + +When you look at the differences with the master branch using git, messages like +`The file will have its original line endings in your working directory +warning: LF will be replaced by CRLF in ...` can appear for each file having an issue. + +To fix the problem the encoding must be consistent in automation-dashboard and all the sub-projects. We will use Dos2Unix tool To achieve that. + +Example: To encode all the files of the project from windows to unix encoding use the following: +- Open a terminal on the unix machine (where the project is) +- Go to the automation-dashboard project directory +- Use `find . -type f -print0 | xargs -0 dos2unix -s` + +This command will convert all files that are not binary files. + +Dos2Unix tool can convert files with DOS or Mac line breaks to Unix line breaks and vice versa. +Go to http://dos2unix.sourceforge.net/dos2unix.htm for more informations about the tool. + ### What does grunt building do with subviews? With the following tasks, grunt injects subviews in the dashboard, depending on the requested VERSION :