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

Skip analysis of non-solution files #132

Open
sanderploegsma opened this issue Feb 9, 2024 · 0 comments
Open

Skip analysis of non-solution files #132

sanderploegsma opened this issue Feb 9, 2024 · 0 comments
Labels
x:action/improve Improve existing functionality/content x:knowledge/intermediate Quite a bit of Exercism knowledge required x:module/analyzer Work on Analyzers x:size/medium Medium amount of work x:type/coding Write code that is not student-facing content (e.g. test-runners, generators, but not exercises)

Comments

@sanderploegsma
Copy link
Contributor

Some exercises consist of more than one file in the src/main/java folder, and some of them are designed to be read-only files. These are marked as such in the exercise's .meta/config.json file, because they should be listed in the files.editor list.

For example, the configuration for the wizards-and-warriors-2 exercise lists the following files as read-only:

  • src/main/java/Character.java
  • src/main/java/Destination.java
  • src/main/java/TravelMethod.java

The goal of this issue is to make sure that read-only files are never processed by the analyzer.

In most cases processing these files may not introduce any issues, but just in case one of them contains code that triggers an analyzer comment we should skip them by default. If not, a student may receive feedback on a file that they did not write and cannot edit, which is just confusing.

@sanderploegsma sanderploegsma added x:action/improve Improve existing functionality/content x:knowledge/intermediate Quite a bit of Exercism knowledge required x:module/analyzer Work on Analyzers x:type/coding Write code that is not student-facing content (e.g. test-runners, generators, but not exercises) x:size/medium Medium amount of work labels Feb 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
x:action/improve Improve existing functionality/content x:knowledge/intermediate Quite a bit of Exercism knowledge required x:module/analyzer Work on Analyzers x:size/medium Medium amount of work x:type/coding Write code that is not student-facing content (e.g. test-runners, generators, but not exercises)
Projects
None yet
Development

No branches or pull requests

1 participant