Feature: Add a way to output lint result to a file

[PodgeHeavin]

🚀 Feature request

- [ ] new
- [ ] build
- [ ] serve
- [ ] test
- [ ] e2e
- [ ] generate
- [ ] add
- [ ] update
- [x ] lint
- [ ] xi18n
- [ ] run
- [ ] config
- [ ] help
- [ ] version
- [ ] doc

Description

ng lint --format=json > issues.json
Worked previously as describe here: #4959
Worked for outputting results to json or any format.

In Angular 7 there was the addition of color to the output of lint results. This has broken the above workaround for outputting to a file.

what was previously like:

[
    {
        "endPosition": {
            "character": 144,
            "line": 8,
            "position": 361
        },
        "failure": "Exceeds maximum line length of 140",
        "name": "C:/myProject/src/app/modeling.component.ts",
        "ruleName": "max-line-length",
        "ruleSeverity": "ERROR",
        "startPosition": {
            "character": 0,
            "line": 8,
            "position": 217
        }
    }
]

is now like so

�[37m[
    {
        "endPosition": {
            "character": 144,
            "line": 8,
            "position": 361
        },
        "failure": "Exceeds maximum line length of 140",
        "name": "C:/myProject/src/spp/modeling.component.ts",
        "ruleName": "max-line-length",
        "ruleSeverity": "ERROR",
        "startPosition": {
            "character": 0,
            "line": 8,
            "position": 217
        }
    }
]�[39m

Solution I would like

I would like an option added to ng lint to output to a file easily

Workaround

"ng lint --format=json | sed -r \"s/\\x1B\[([0-9]{1,2}(;[0-9]{1,2})?)?[mGK]//g\" > issues.json"
Which is ugly but works

[mgechev]

I'd approach similarly - just redirect stdout to a file. If you want to have a more "native" feel, I'd recommend you to implement a custom tslint formatter and update your configuration in tslint.json.

Although this feature seems useful in some specific scenarios, we need to be careful expanding the scope of the CLI with functionalities which have good pre-existing solutions.

I hope this helps! Thanks :)

[PodgeHeavin]

What is the point of the json ouput option if the cli is printing it unusable as actual json. Makes no sense to me. This was working in Angular 6 but has broken in Angular 7

[mgechev]

@alan-agius4 pointed out that this is a regression; reopening.

[alan-agius4]

@PodgeHeavin, I am unable to reproduce the issue.

Can you run ng --version?

You should have the following versions

@angular-devkit/build-angular     0.12.2
@angular-devkit/core              7.2.2

My result is

[
    {
        "endPosition": {
            "character": 26,
            "line": 8,
            "position": 214
        },
        "failure": "\" should be '",
        "fix": {
            "innerStart": 198,
            "innerLength": 16,
            "innerText": "'int-issue-json'"
        },
        "name": "/Users/alan/git/lint-issue-json/src/app/app.component.ts",
        "ruleName": "quotemark",
        "ruleSeverity": "ERROR",
        "startPosition": {
            "character": 10,
            "line": 8,
            "position": 198
        }
    },
    {
        "endPosition": {
            "character": 26,
            "line": 8,
            "position": 214
        },
        "failure": "Missing semicolon",
        "fix": {
            "innerStart": 214,
            "innerLength": 0,
            "innerText": ";"
        },
        "name": "/Users/alan/git/lint-issue-json/src/app/app.component.ts",
        "ruleName": "semicolon",
        "ruleSeverity": "ERROR",
        "startPosition": {
            "character": 26,
            "line": 8,
            "position": 214
        }
    }
]

[PodgeHeavin]

     _                      _                 ____ _     ___
    / \   _ __   __ _ _   _| | __ _ _ __     / ___| |   |_ _|
   / △ \ | '_ \ / _` | | | | |/ _` | '__|   | |   | |    | |
  / ___ \| | | | (_| | |_| | | (_| | |      | |___| |___ | |
 /_/   \_\_| |_|\__, |\__,_|_|\__,_|_|       \____|_____|___|
                |___/


Angular CLI: 7.1.4
Node: 8.11.3
OS: win32 x64
Angular: 7.1.4
... animations, cli, common, compiler, compiler-cli, core, forms
... language-service, platform-browser, platform-browser-dynamic
... router

Package                           Version
-----------------------------------------------------------
@angular-devkit/architect         0.11.4
@angular-devkit/build-angular     0.11.4
@angular-devkit/build-optimizer   0.11.4
@angular-devkit/build-webpack     0.11.4
@angular-devkit/core              7.1.4
@angular-devkit/schematics        7.1.4
@ngtools/webpack                  7.1.4
@schematics/angular               7.1.4
@schematics/update                0.11.4
rxjs                              6.3.3
typescript                        3.1.6
webpack                           4.23.1

[alan-agius4]

Kindly update to the latest version of packages mentioned above and see if you still encounter the issue.

[PodgeHeavin]

Issue persists.

The issue is only present in bash/linux but not in windows CMD.
I am running the commands from git bash window

     _                      _                 ____ _     ___
    / \   _ __   __ _ _   _| | __ _ _ __     / ___| |   |_ _|
   / △ \ | '_ \ / _` | | | | |/ _` | '__|   | |   | |    | |
  / ___ \| | | | (_| | |_| | | (_| | |      | |___| |___ | |
 /_/   \_\_| |_|\__, |\__,_|_|\__,_|_|       \____|_____|___|
                |___/


Angular CLI: 7.2.2
Node: 8.11.3
OS: win32 x64
Angular: 7.2.1
... animations, common, compiler, compiler-cli, core, forms
... platform-browser, platform-browser-dynamic, router

Package                           Version
-----------------------------------------------------------
@angular-devkit/architect         0.12.2
@angular-devkit/build-angular     0.12.2
@angular-devkit/build-optimizer   0.12.2
@angular-devkit/build-webpack     0.12.2
@angular-devkit/core              7.2.2
@angular-devkit/schematics        7.2.2
@angular/cli                      7.2.2
@angular/language-service         7.2.0
@ngtools/webpack                  7.2.2
@schematics/angular               7.2.2
@schematics/update                0.12.2
rxjs                              6.3.3
typescript                        3.2.4
webpack                           4.28.4

[alan-agius4]

Hi,If you want to redirect the stream output in git bash I suggest you use the FORCE_COLOR environment variable.

FORCE_COLOR=0 ng lint --format=json > issues.json

Let me know if this solved your issue.

Thanks.

[PodgeHeavin]

This has not fixed the issue unfortunately. What has changed from Angular 6 to Angular 7 to cause this? We have some of our code on Angular 6 and the command is working fine and a new project running with angular 7 and this is where we are seeing the issue. It is failing on git bash locally and all our linux build servers.

[alan-agius4]

I removed the colors for the info, Git Bash is known to have some issues with colors. Though using FORCE_COLOR=0 should have solved the issue.

[PodgeHeavin]

Thanks for this. Impressed with the turn around.

[mgechev]

@PodgeHeavin this should be part of 7.2.3 in an hour or so.

[angular-automatic-lock-bot]

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_{This action has been performed automatically by a bot.}