Add warning about default configuration file name changing (2.0) #194

Closed
HugoGiraudel opened this Issue Aug 28, 2014 · 1 comment

Comments

Projects
None yet
2 participants
@HugoGiraudel
Member

HugoGiraudel commented Aug 28, 2014

Whenever view.json is being used as a default configuration file (so when the --config option is not being passed), we need to display a message in the console to warn against name change in version 2.0.

This way, we are informing the user about the change in 2.0, rather than breaking things all of the sudden. I know Sass has done it during the past, and it has proven to work pretty well.

I suggest:

Starting SassDoc v2.0, the default configuration file will be named .sassdoc.json or .sassdoc.yml, rather than view.json. Please consider using the --config option right now to specify your own file.

@valeriangalliat

This comment has been minimized.

Show comment
Hide comment
@valeriangalliat

valeriangalliat Aug 28, 2014

Member

Done with e124d2f.

Note I changed the name to .sassdocrc since both JSON and YAML formats are handled properly with the YAML parser - like ESLint, the .sassdocrc will handle both this way.

Member

valeriangalliat commented Aug 28, 2014

Done with e124d2f.

Note I changed the name to .sassdocrc since both JSON and YAML formats are handled properly with the YAML parser - like ESLint, the .sassdocrc will handle both this way.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment