Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more doc for ERB-Lint #1655

Merged
merged 2 commits into from Feb 3, 2019
Merged

Add more doc for ERB-Lint #1655

merged 2 commits into from Feb 3, 2019

Conversation

kennyadsl
Copy link
Contributor

@kennyadsl kennyadsl commented Dec 1, 2018

馃憢 Hey there,

This PR completes @aldesantis and @gylaz work done into #1641 to allow linting ERB files by adding some documentation around this new addition.

Since I have no access to the houndci/linters repo, in the PR I assumed that:

  • ERB linting is done with this tool
  • linter code is located into lib/linters/erb_lint
  • default config is located into config/erb.yml

Let me know if I should change something.

Also, I think you should add an ERB help page (similar to this one) and update the supported-linters page as well. Let me know if I can be of help here.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
I have no access to houndci/linters repo but I'm assume files
are in that position to reflect other linters.
@salbertson
Copy link
Member

Thanks @kennyadsl. 馃檶 I added you to linters.

Also, I think you should add an ERB help page (similar to this one) and update the supported-linters page as well. Let me know if I can be of help here.

If you write it up I'll copy/past right into a new Intercom page, that would be great.

@kennyadsl
Copy link
Contributor Author

kennyadsl commented Dec 1, 2018

Page:

https://intercom.help/hound/configuration/erb

Markdown (See it raw to copy/paste):

ERB

Review ERB with Hound

Hound uses erb-lint (0.0.28).

Please notice that this linter is disable by default. To enable ERB style
checking, add the following to your .hound.yml

erblint:
  enabled: false

By default, erb-lint default configuration is used. You can change the
way erb-lint is configured by simply creating a proper config file into
your project and reference it in your .hound.yml

erblint:
  enabled: true
  config_file: .erb-lint.yml

Note: this is changed from having erb keys to erblint due to an internal hound change that now needs linters names instead of languages (see comments below).

@salbertson
Copy link
Member

@kennyadsl
Copy link
Contributor Author

@salbertson after reading this @gylaz comment I think we should change the erb key into the houndci.yml file to erb_lint

@kennyadsl
Copy link
Contributor Author

Ah just noticed that it's already done! We are all good!

@kennyadsl
Copy link
Contributor Author

@salbertson @gylaz I think this is ready to merge, or you do have other comments?

@kennyadsl
Copy link
Contributor Author

ping @salbertson @gylaz 馃檪

@gylaz gylaz merged commit 63fba14 into houndci:master Feb 3, 2019
@gylaz
Copy link
Member

gylaz commented Feb 3, 2019

@kennyadsl Thank you, merged!

@kennyadsl kennyadsl deleted the erb-lint-doc branch March 19, 2019 17:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants