feat: added lint from stdin

[rkrmr33]

Checklist:

• My organization is added to USERS.md.

[rkrmr33]

feature preview

• new lint format:

  

• lint all argo manifests types with the --all-kinds flag:

  

• can change the lint output format, either simple or pretty (default):

  

• success message:

  

[simster7]

Only gave this a quick pass, but looks great so far! Will give a more detailed look later

[alexec]

Look great! Rather than say “error in object #1” can we say “error in WorkflowTemplate named foo”?

[rkrmr33]

Look great! Rather than say “error in object #1” can we save “error in WorkflowTemplate named foo”?

Hmm, the thing is, the objects don't always have a name to recognize them by, for example:

apiVersion: argoproj.io/v1alpha1
kind: Workflow
metadata:
  generateName: workflow-template-hello-world-
  labels:
    argo-e2e: "true"
spec:
  entrypoint: whalesay-template
  arguments:
    parameters:
      - name: message
        value: "hello world"

This doesn't have a name rather a generateName. WDYT we should do in that case?

[rkrmr33]

I've changed it so that it shows the object's name and type instead of index. If the object has a generateName, I just show the generateName instead.

[simster7]

Looking great, just some more minor changes

[alexec]

Look great! Rather than say “error in object #1” can we save “error in WorkflowTemplate named foo”?

Hmm, the thing is, the objects don't always have a name to recognize them by, for example:

apiVersion: argoproj.io/v1alpha1
kind: Workflow
metadata:
  generateName: workflow-template-hello-world-
  labels:
    argo-e2e: "true"
spec:
  entrypoint: whalesay-template
  arguments:
    parameters:
      - name: message
        value: "hello world"

This doesn't have a name rather a generateName. WDYT we should do in that case?

I think they must have either name or generateName. Could you use one or the other?

I think this is fantastic BTW. I just want to give argo lint a directory of files and it lints the lot, pods, services, workflows, cronworkflows, everything!

[alexec]

There’s a go library called go-color we should adopt for colourising terminal output.

[simster7]

LGTM. @alexec Any final comments?

[simster7]

@arckey Please make sure you make the DCO check happy. It seems that some commits are not signed: https://github.com/argoproj/argo-workflows/pull/5095/checks?check_run_id=1916767542

[alexec]

Questions:

• Have we taken this opportunity to unify the lining into a single command that can lint multiple file types?
• What happens with DUMB terminals? Can we use the go-color library to mitigate problems?
• Do we print lining errors as we encounter them? On just at the end? What happens with many files?

I don' think we need --all-kinds, I think this actually the case today. I think we should always try to lint everything we're given

I think --format should be --output/-o maybe?

Should we add argo lint examples/* to make sure all our examples lint?

[rkrmr33]

@arckey Please make sure you make the DCO check happy. It seems that some commits are not signed: https://github.com/argoproj/argo-workflows/pull/5095/checks?check_run_id=1916767542

sorry, did not have time to finish this today, will close everything tomorrow :)

[rkrmr33]

Questions:

• Have we taken this opportunity to unify the lining into a single command that can lint multiple file types?
• What happens with DUMB terminals? Can we use the go-color library to mitigate problems?
• Do we print lining errors as we encounter them? On just at the end? What happens with many files?

I don' think we need --all-kinds, I think this actually the case today. I think we should always try to lint everything we're given

I think --format should be --output/-o maybe?

Should we add argo lint examples/* to make sure all our examples lint?

1. Yes, we can now lint all of argo workflows' types with a single command, do you think that --all-kinds should be the default for the argo lint command? do we still want to allow users to lint only Workflow like they could before?
2. Sure, I can change it to --output/-o, makes sense.
3. Do you mean we should add some e2e test to check that?

about the above points:

1. Yes
2. I was not able to find go-color library, I know that one: https://github.com/fatih/color is pretty popular. And it has a --no-color flag. Do you think we should use it?
3. We aggregate all of the results from all of the files/stdin and then we process them and print a summary.

[alexec]

1. I think users just want to lint. So it'd be great if argo lint linted everything. argo template lint etc could just aliases to that command.
2. Forget about e2e tests. Avoid them if we can.
3. I just merged a PR to master than adds go-color to go.mod. See test/e2e/fixtures/print.go for example of usage.
4. I think it would be really valuable if we print errors as we encounter them. As a user, I might cancel the lint as soon as a see an error. If I'm linting a large directory, then it could take a while and I don't want to wait to see errors.

[alexec]

Oh argo-e2e has been renamed to workflows.argoproj.io/test

[alexec]

Oh, as e2e test automatically add it, you can probably remove it.

[rkrmr33]

• I think users just want to lint. So it'd be great if argo lint linted everything. argo template lint etc could just aliases to that command.
• Forget about e2e tests. Avoid them if we can.
• I just merged a PR to master than adds go-color to go.mod. See test/e2e/fixtures/print.go for example of usage.
• I think it would be really valuable if we print errors as we encounter them. As a user, I might cancel the lint as soon as a see an error. If I'm linting a large directory, then it could take a while and I don't want to wait to see errors.

1. Makes sense, will change.
2. So what did you mean with:

Should we add argo lint examples/* to make sure all our examples lint?

3. Great! will use that.
4. Sure, I can see what it takes to do that. Don't think it would be that difficult.

[alexec]

Should we add argo lint examples/* to make sure all our examples lint?

Examples should lint. How about adding argo lint examples/* to the make lint target?

[alexec]

Lets do this!

[rkrmr33]

@alexec Haven't made the last changes we discussed about, but I guess I can do that with a follow up PR 😉