Config file and option suggestions

[jscs-dev]

Config file and option suggestions

[mdevils]

Hi!

1. I will think about it.
2. I think It's possible :)
3. I didn't get your point. Options dont have default values at all. Option can be defined in config (and then the value must be validated) or not defined. Options, which are not in config, are not used.

[mdevils]

Thank you for your feedback! 👍

[gustavohenke]

The 3rd point is related to this:
My config file:

{
    ...,
    "require_line_feed_at_file_end": false
}

Which gives me:

AssertionError: require_line_feed_at_file_end option requires true value or should be removed
    at Object.module.exports.configure (C:\Users\gustavo\AppData\Roaming\npm\node_modules\jscs\lib\rules\require-line-feed-at-file-end.js:12:9)

Also some other options give me the same exception.

[mdevils]

Oh, I see, It is probably Usability or Understanding problem.

For every option there is rule validator. If you need to "check line feed at file end", you are adding this option. There is no behavior for "false" value. If you want to ensure that there is no line feed at the end - there must be another option (like "disallow_line_feed_at_file_end").

That is why for "require_line_feed_at_file_end" there is only one valid value for now - true.

In other words, there is no default configuration of JSCS behavior. You can require something using some options or disallow something using another set of options, and there is nothing like "ignore rule" because there are no default rules :) Adding option to config = adding rule.

This is how it works. Probably it's not simple or trivial.

[gustavohenke]

OK, thanks for the explanation.
I hope to give some pull requests soon :)

[mdevils]

Thank you!

[deepsweet]

+1 for the 1 & 2 :)

[mdevils]

Camel-case option names will be available in next release.

Rename the config file to .jscsrc

This suggestion was declined as we have valid json unlike jshint. Many tools use correct extensions (like .travis.yml).

Thank you for your feedback.

[gustavohenke]

OK, thanks ;)

[deepsweet]

so maybe convert config to YAML? there is a good parser js-yaml.

[mdevils]

@deepsweet, in YAML C-style naming is preferable. I switched to camelCase to make configuration valid in case of further API usage. So we can have JSON/API compatible naming for the same options.