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

Add linter #216

Open
Martinsos opened this issue Jul 4, 2024 · 2 comments
Open

Add linter #216

Martinsos opened this issue Jul 4, 2024 · 2 comments

Comments

@Martinsos
Copy link
Member

No description provided.

@shemzz
Copy link
Contributor

shemzz commented Oct 11, 2024

Hello @Martinsos,
I want to work on this PR. Adding a linter to the project will improve code quality and maintainability, help catch potential errors, enforce coding standards, and ensure consistency across the codebase.

I suggest using ESLint for JavaScript/TypeScript files, as it is widely adopted and has a rich ecosystem of plugins and configurations.

I will create a configuration file (.eslintrc.js) with recommended settings and rules that align with the project's coding style. This will include:

  • Basic rules for code quality (e.g., no unused variables, consistent indentation).
  • Integration with Prettier to ensure formatting consistency.

I will add the necessary dependencies to the project using npm or yarn:

  • eslint
  • eslint-config-prettier (to disable conflicting rules)
  • eslint-plugin-prettier (to run Prettier as an ESLint rule)

I will update the README or relevant documentation to include instructions on how to run the linter and any additional setup required.

  1. Run Linter: Finally, I will run the linter on the existing codebase and address any issues that arise.

I believe this addition will greatly benefit the project by maintaining high code quality and consistency. Please let me know if you have any suggestions or if there are specific rules you would like to include.

@Martinsos
Copy link
Member Author

Sure @shemzz give it a try! One thing to note, and sorry for assuming too much possibly, but the message above sounds like it was generated by LLM / AI. I don't mind you assisting yourself with the AI, but I do care about you being able to verifying the results it produces, confirming they are the best choice, that it all makes sense, ... . What I am trying to say is, if result is mostly/purely produced by AI and goes beyond your own knowledge, then I will not be inclined to accept the PR as it demands quite some work from us. If instead the PR will be guided by your own experience and research, then I don't mind if it was AI assisted.

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

No branches or pull requests

2 participants