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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enforce beautify standards and validate code to catch mistakes #202

Closed
ZoeBijl opened this issue Jan 13, 2016 · 9 comments
Closed

Enforce beautify standards and validate code to catch mistakes #202

ZoeBijl opened this issue Jan 13, 2016 · 9 comments

Comments

@ZoeBijl
Copy link

ZoeBijl commented Jan 13, 2016

As noted by Karl Groves: we should enforce beautify standards and require that all PR's pass the validity checks.

As this only affects the practices, I propose we add a separate README.md in there (as to not litter the main README).

@jnurthen noted that because we need to write stuff that is ARIA 1.1/2.0 it might not validate. Still, validating the code to catch other error should be mandatory.

@ZoeBijl
Copy link
Author

ZoeBijl commented Jan 13, 2016

Related issues: #88, #95, and #131

@ZoeBijl ZoeBijl changed the title Enforce beautify standards and require PR's pass the validity checks Enforce beautify standards and require PR's pass validity checks Jan 13, 2016
@jnurthen
Copy link
Member

What do you mean by validate? We have requirements to use aria 1.1 features which may not be implemented in any validator.

@ZoeBijl
Copy link
Author

ZoeBijl commented Jan 13, 2016

Good point. Still, if you go through the code in #174 you'll see a lot of errors not related to aria (1.1). All current examples now actually validate in the nu validator.

But we should allow for errors and warnings related to ARIA 1.1/2.0.

@ZoeBijl ZoeBijl changed the title Enforce beautify standards and require PR's pass validity checks Enforce beautify standards and validate code to catch mistakes Jan 13, 2016
@ZoeBijl
Copy link
Author

ZoeBijl commented Jan 13, 2016

@jnurthen I started on a README and EditorConfig file. I've included an exception for warnings/errors related to future ARIA stuff. Does this seem fair to you?

@ZoeBijl
Copy link
Author

ZoeBijl commented Jan 16, 2016

I have added research on the use of js-beautify.

@ZoeBijl
Copy link
Author

ZoeBijl commented Jan 25, 2016

Part of this was an EditorConfig file, that is now provided.

@handcoding
Copy link

For @MichielBijl and others—

On the subject of the EditorConfig file, can I make a request for an indent_size that’s larger than 2?

For those of us with spatial-acuity issues (like me), an indent size of only 2 can make it hard to tell which lines of code share the same indention level. Would anyone be open to an indent size of, like, 4-ish?

@ZoeBijl
Copy link
Author

ZoeBijl commented Apr 8, 2016

@handcoding sorry, I wasn't aware of that. I don't mind the 4 spaces indent. I prefer 2 spaces, but if 4 spaces is easier to read for more people; I'm fine with it.

@ZoeBijl
Copy link
Author

ZoeBijl commented Apr 29, 2016

This issue was moved to w3c/aria-practices#19

@ZoeBijl ZoeBijl closed this as completed Apr 29, 2016
pkra pushed a commit that referenced this issue May 20, 2024
pkra pushed a commit that referenced this issue May 20, 2024
pkra pushed a commit that referenced this issue May 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants