How to disable rules

[rpungello]

How do you use the --disable-rule option?

Running npx dclint --disable-rule no-unbound-port-interfaces docker-compose.yml results in "Not enough non-option arguments: got 0, need at least 1"

[janitor-of-code]

There seems to be a mismatch between the yargs implementation and the docs on how options and files are sorted.
Does it work if you put the file(s) first?

npx dclint docker-compose.yml --disable-rule no-unbound-port-interfaces

// line 14 cli.ts
    .usage('Usage: $0 <files..> [options]')

[janitor-of-code]

From a glance: -- would put the file(s) in argv._ not in argv.files
i.e. the implementation would need to change to be able to use --

[janitor-of-code]

see src/cli/cli.ts:

yargs.positional('files', {
  describe: 'Files to check',
  type: 'string',
  array: true,
  demandOption: true,
});
//...
const cliArguments = argv as unknown as CLIConfig;
//...
let lintResults = linter.lintFiles(cliArguments.files, cliArguments.recursive);

As it stands I think the current implementation is smarter since the separation works without the --

though I'm just a passer-by

[rpungello]

Ah, I think that may be the issue. I saw the yargs docs mention that args._ would get the final value, but didn't make the connection that this package was using argv.files for the filenames, not argv._.

So the question still remains: how is disable-rule supposed to be used in the GitHub action?

[zavoloklom]

@rpungello Hi!

npx dclint docker-compose.yml --disable-rule no-unbound-port-interfaces this command seems correct

Could you give me your github-action config?

So the question still remains: how is disable-rule supposed to be used in the GitHub action?

I assume it should be smthg like

- uses: docker-compose-linter/[email protected]
  with:
    path: ./docker-compose.yml
    disable-rule: no-unbound-port-interfaces

EDITED: I get it. Created a fix, now it should work. But still would be great to see an example and if you can test it again.

[rpungello]

This seems to have done the trick, thanks! And yes, that's basically all I had in the github action yaml file: a path and the disable-rule key.