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

Design/Implement a way to ignore files/folders when merging #12

Open
koreanwglasses opened this issue Mar 26, 2019 · 3 comments
Open

Design/Implement a way to ignore files/folders when merging #12

koreanwglasses opened this issue Mar 26, 2019 · 3 comments
Assignees
Labels
enhancement New feature or request

Comments

@koreanwglasses
Copy link
Collaborator

Something similar to gitignore, it would live in either the project folder the user has, or would be in the folder with the stages.

@koreanwglasses koreanwglasses added the enhancement New feature or request label Mar 26, 2019
@sjhuang26
Copy link
Contributor

I will work on this.

@sjhuang26
Copy link
Contributor

So here's the plan:

  • Create a plain-text file called "ignored" in the root of the curriculum folder written in a style similar to gitignore (each line contains one exclusion pattern)
  • Read the contents of the file into an array in the initialization step
  • In the merge() functions, use a library to do the exclusion pattern checking: something like https://www.npmjs.com/package/glob.

Concerns:

  • Naming of the config file? Does a config file already exist for curriculum? Maybe it's best to have one centralized config file.
  • Would this ignored-files config be part of the EnvironmentManager object?

@koreanwglasses
Copy link
Collaborator Author

The plan sounds good.

We should have an option for an ignore file in every folder (with relative paths of course).

The ignored files can be part of warp drive for a few reasons:

  • Warp Drive is already reading from the filesystem, and only needs to look at the ignore files when merging
  • There is no need to handle them specially with EnvironmentManager, which is mostly focused on keeping links between the user's project and the project meta. That being said, this precise roles of each part of the model is not set in stone yet.

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

No branches or pull requests

2 participants