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 #19

Closed
ZoeBijl opened this issue Apr 29, 2016 · 10 comments
Closed

Enforce beautify standards and validate code to catch mistakes #19

ZoeBijl opened this issue Apr 29, 2016 · 10 comments
Labels
enhancement Any addition or improvement that doesn't fix a code bug or prose inaccuracy

Comments

@ZoeBijl
Copy link
Contributor

ZoeBijl commented Apr 29, 2016

From @MichielBijl on January 13, 2016 0:8

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.

Copied from original issue: w3c/aria#202

@ZoeBijl ZoeBijl added enhancement Any addition or improvement that doesn't fix a code bug or prose inaccuracy APG labels Apr 29, 2016
@ZoeBijl
Copy link
Contributor Author

ZoeBijl commented Apr 29, 2016

Related issues: w3c/aria#88, w3c/aria#95, and w3c/aria#131

@ZoeBijl
Copy link
Contributor Author

ZoeBijl commented Apr 29, 2016

From @jnurthen on January 13, 2016 1:29

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
Contributor Author

ZoeBijl commented Apr 29, 2016

Good point. Still, if you go through the code in w3c/aria#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
Copy link
Contributor Author

ZoeBijl commented Apr 29, 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
Contributor Author

ZoeBijl commented Apr 29, 2016

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

@ZoeBijl
Copy link
Contributor Author

ZoeBijl commented Apr 29, 2016

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

@ZoeBijl
Copy link
Contributor Author

ZoeBijl commented Apr 29, 2016

From @handcoding on April 7, 2016 16:47

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
Contributor Author

ZoeBijl commented Apr 29, 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
Contributor Author

ZoeBijl commented Jun 17, 2016

@handcoding: I have set indent_size to 4 in 20cfaa5

I still need to indent the entire document to this new format, but haven't come around to that.

@mcking65
Copy link
Contributor

Closing this issue based on discussion in August 15, 2016 meeting and the work that is happening in issue #12.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Any addition or improvement that doesn't fix a code bug or prose inaccuracy
Projects
None yet
Development

No branches or pull requests

2 participants