pyproject.toml: cylc lint settings

[wxtim]

Closes #5052

Check List

• I have read CONTRIBUTING.md and added my name as a Code Contributor.
• Contains logically grouped changes (else tidy your branch by rebase).
• Does not contain off-topic changes (use other PRs for other changes).
• Applied any dependency changes to both setup.cfg and conda-environment.yml - tomli used, because it will become the standard library's interface.
  • It has no dependencies
  • Uses MIT licence
• Tests are included (or explain why tests are not needed).
• CHANGES.md entry included if this is a change that can affect users
• Cylc-Doc pull request opened if required at pyproject.toml: cylc lint settings cylc-doc#531.

[wxtim]

Waiting for reviewers to check that I've not gone off at teh deep end prior to writing a documentation PR

[MetRonnie]

Partial review

[MetRonnie]

1 doctest failure

[MetRonnie]

Partial review

[MetRonnie]

Tested, working 👍

Please could you add a minimal example pyproject.toml example to the PR

[MetRonnie]

Oops, tests/f/cylc-lint/01.lint-toml.t failing

[oliver-sanders]

I got some surprising behaviour trying to ignore a code:

[cylc-lint]              
    max-line-length = 20    
    ignore = ['S008']  

$ cylc lint
CylcError: S008 is a not a known linter code.

And there appears to be a missing example in the CLI docs, otherwise fine.

[MetRonnie]

I'm not sure what "Collapse metadata in checks dicts" means.

The reference arg is missing a docstring entry

[oliver-sanders]

Is 130 the default max_line_len?

[wxtim]

Yes, is that a sensible number - I wanted to make it a long but not insane length. I could instead make it v.v. big.

Setting a default meant that the problems you'd been having with it not appearing in the lists of rules went away.

[MetRonnie]

ignore = ['S008'] is now recognised but does not work

[MetRonnie]

The main function is not set up to handle workflow IDs, however. It is treating the ID as a relative path. Also I get traceback following this

$ cylc lint foo
2022-09-13T14:49:30+01:00 WARNING - Path foo does not exist.
Traceback (most recent call last):
  File "~/.conda/envs/cylc8/bin/cylc", line 33, in <module>
    sys.exit(load_entry_point('cylc-flow', 'console_scripts', 'cylc')())
  File "~/github/cylc-flow/cylc/flow/scripts/cylc.py", line 657, in main
    execute_cmd(command, *cmd_args)
  File "~/github/cylc-flow/cylc/flow/scripts/cylc.py", line 284, in execute_cmd
    entry_point.resolve()(*args)
  File "~/github/cylc-flow/cylc/flow/terminal.py", line 229, in wrapper
    wrapped_function(*wrapped_args, **wrapped_kwargs)
  File "~/github/cylc-flow/cylc/flow/scripts/lint.py", line 718, in main
    f'Checked {target} against {check_names} rules and '
UnboundLocalError: local variable 'check_names' referenced before assignment

[wxtim]

ignore = ['S008'] is now recognised but does not work

I can't replicate this - can you send me the toml file you are using - It took me a wee while to remember that my section heading was cylc-lint and not cylc_lint or cylclint. What do you think of testing for any of those?

[MetRonnie]

Just using

[cylc-lint]
    ignore = ['S008']

and having a line longer than the default 130

[MetRonnie]

It took me a wee while to remember that my section heading was cylc-lint and not cylc_lint or cylclint. What do you think of testing for any of those?

I think it's too much work to try and anticipate users' typos

[wxtim]

It took me a wee while to remember that my section heading was cylc-lint and not cylc_lint or cylclint. What do you think of testing for any of those?

I think it's too much work to try and anticipate users' typos

I see - I think I've fixed it

[MetRonnie]

Everythging seems to be working apart from ignoring S008. I suggest adding a test for that too

[wxtim]

Everythging seems to be working apart from ignoring S008. I suggest adding a test for that too

Reverted to draft - not priority this afternboon

[MetRonnie]

Thanks!