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

✨ Configurable Indexing though config file #184

Open
uberroot4 opened this issue Nov 7, 2023 · 0 comments
Open

✨ Configurable Indexing though config file #184

uberroot4 opened this issue Nov 7, 2023 · 0 comments
Labels
backend bsc enhancement New feature or request

Comments

@uberroot4
Copy link
Member

uberroot4 commented Nov 7, 2023

Not everyone needs every kind of data so it should be possible to specify in the config file which data should be indexed and which not through a whitelist or blacklist.

Proposed idea for CLI:

  • binocular should be the command, as it is right now
  • binocular index should execute the indexing process
    • Here it should be possible to provide a config file and/or provide config arguments
    • e.g. Enable/Disable offline building
    • Enable/Disable CI, ITS, etc
  • binocular webserver should only execute the backend, no indexing in this case
    • For this, the frontend must run on another port which then accesses the backend
  • Allow indexer to use a ignore section in the config file to exclude certain files and folder from indexing
    • e.g. sometimes, especially in education, node_modules is committed, which might break indexing binocular in memory-/space-limited environments. In such cases, it should be possible to exclude the committed folder from indexing
    • We check, per default, for files like this git log --name-status -- '*.db' '*.log' '*/.idea' '*.iml' '*node_modules*' '*target*' '*dist*' '*.DS_Store*' '*__MACOSX*', hence we could consider already adding these in the config file as an example
@uberroot4 uberroot4 added enhancement New feature or request backend bsc labels Nov 7, 2023
@MaximilianZenz MaximilianZenz changed the title ➕ Configurable Indexing though config file ✨ Configurable Indexing though config file Mar 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend bsc enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant