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

Use ESLint + Prettier to enforce coding guidelines in Node version #10

Open
boyum opened this issue Nov 22, 2021 · 3 comments
Open

Use ESLint + Prettier to enforce coding guidelines in Node version #10

boyum opened this issue Nov 22, 2021 · 3 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@boyum
Copy link
Collaborator

boyum commented Nov 22, 2021

With this being an open source initiative, I miss coding guidelines. These can be set with ESLint and Prettier (one or both), and can be enforced by GH Actions.

@tplive
Copy link
Collaborator

tplive commented Nov 29, 2021

My OCD approves! 😅 I suggest adding one coding_styleguide.md to each implementation, a simple list of bulletpoints with simple instructions, for instance;

  • Use Prettier to format code in your IDE. The .prettierrc configuration will help you.
  • Spaces, not tabs
  • 4-space indents
  • Start and end curly braces on own lines, not indented
  • Use trailing commas
  • Do not use semicolons

Please feel free to add and adjust as per your own preferences, @boyum ! :)

Also, there is Googles style guidelines for a lot of different languages

@tplive tplive added enhancement New feature or request help wanted Extra attention is needed labels Nov 29, 2021
@boyum
Copy link
Collaborator Author

boyum commented Nov 29, 2021

NO SEMICOLONS? You've seen the last collaboration.

@tplive
Copy link
Collaborator

tplive commented Nov 29, 2021

That was pretty fragile... 🤣

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants