This issue will be used as a thread to discuss the possible changes to venvPath setting.

Current implementation

Regolith config.json file has currently 4 depth levels.

1. Root - defined by the Bedrock-OSS/project-config-standard
2. "regolith" - the root of the regolith configuration
3. "profiles" - a list of profiles. A profile is a single task that you can trigger with regolith run command
4. "filters" - a filter is a single action within the profile (it can be a python, js or shell script)

Currently the venvPath is a property of a profile. Adding that configuration to the file will cause creation of a single python environment for all filters in the profile. Skipping that property will (the default behavior) creates separate venv for every filter in .regolith/cache/<filter path>/venv.

venvPath can be either relative or absolute path. If user choose to put relative path in there it will create the virtual environment in a path relative to .regolith/venvs/.

Problems

1. Where in the config.json should we put the venvPath property

1.1. It should be the property for entire project (inside "regolith") 1.2 It should be the property of a profile (regolith -> profiles -> [profile name]). This is the current solution. 1.3 It should be the proprety of a filter (regolith -> profiles -> -> filters -> [filter name]).

2. If the path is relative, what should be the root

2.1. .regolith/venvs/<user path> - This is the current solution 2.2. .regolith/cache/<user path> - The problem of this solution is that we already use .regolith/cache/<filter name> for caching filters. If someone choose to name the venv the same as the filter it could create some collisions. 2.3 .regolith/cache/venvs/<user path> - with this solution i suggest moving the filter cache from .regolith/cache/<filter name> to .regolith/cache/filters/<filter name>.

3. What should be the default behavior

3.1. Separate venv for every filter - This is the current solution 3.2. Separate venv for every profile 3.3. Everything should use single venv

4. Should we allow absolute paths

4.1. Yes 4.2. No

What do we want to do here?

Could not install dependency github.com/Bedrock-OSS/regolith-filters//texture_list: error downloading 'https://github.com/Bedrock-OSS/regolith-filters.git': git must be available and on the PATH

1. regolith init in a repo
2. Create a resource pack (but not a behavior pack)
3. regolith run should work
4. Commit and push changes
5. Clone the repo
6. regolith install-all
7. regolith run

Expected: No warnings

Actual: [WARN] resource folder "./packs/BP" does not exist

Notes: If regolith init added a .gitkeep file to RP and BP we wouldn't have this problem as they'd be copied over in the clone :)

• [x] Fix the "Suggest changes to this page." links
• [x] Fix the Search bar
• [x] Mention winget in the documentatino
• [x] Mention regolith-update.ps1 script in the documentation

First commit added basic user_config reader:

• project.app_data_storage - replaces the useAppData property form the config.json file
• user.name - replaces the name property in config file created by 'regolith init'
• resolvers - is a list of URLs to 'resolver.json' files. This property is only partially implemented. Currently it only uses the first item from the list or the default value if the 'config.toml' doesn't specify any.

This idea is a result of a discussion about #191 and #190 on discord.

The exec command will be able to run filters on the source files of the project. The filters that are intended for this purpose will need to specify that in their filter.json file using new property - canModifySource (the name of the property is yet to be decided).

The user will be able to force non-exec filters to be used that way by using the --force flag.

Hello everyone,

I've recently tried to install regolith using go install github.com/Bedrock-OSS/regolith, which didn't work as the module name was bedrock-oss.github.com/regolith. The old module name is sadly not importable from anywhere outside the project, including from go install as Go is looking for the source code using that URL.

This PR replaces the module name with the right one for the project: github.com/Bedrock-OSS/regolith

Hope this helps and looking forward to further contributing on this project, Kevin

These problems are most likely closely related to each other so I put 3 in one issue:

Discord discussion starts with this message: https://discord.com/channels/494194063730278411/896876881410936853/984897287425781811

(1) Generating files from custom filter fails

• [x] reproduce
• [x] fix

(2) Permissions problems

• [ ] reproduce
• [ ] fix

(3) Infinite filter data nesting

• [x] reproduce
• won't fix. This is an issue of a filter.

While having windows explorer open with packs/data/gametests folder, I ran regolith, which failed with error:

[INFO]  Moving files to target directory.
[ERROR] Failed to run profile "dev"
[+]: Exporting project failed.
[+]: Failed to clear filter data path "./packs/data".
[+]: remove ./packs/data\gametests: The process cannot access the file because it is being used by another process.

This caused packs/data folder to become empty (except for empty gametests folder), while the data files were still in .regolith/tmp/data.

Thinking, that the issue will fix itself, I ran it again and regolith removed .regolith/tmp and copied empty data folder there, which resulted in loosing data folder completely (fortunately I still had the changes on git).

Since any error regarding clearing filter data or moving filter data back to the packs folder results in potential data loss, I suggest adding some kind of safeguard to it as well as clear message to the user.

Suggestion

After error, that might result in potential data loss, we should display a clear message to the user like

The data folder might potentially be corrupted, please copy them from .regolith/tmp/data to packs/data manually.

Additionally we could save a json file inside .regolith folder with information about it and in case a user wouldn't notice this message, we would block any further executions of regolith with message

The data folder might potentially be corrupted, please copy them from .regolith/tmp/data to packs/data manually. 
If you already did it, run regolith again with --force flag

The --force flag would remove that json file or modify it to clear the information and run regolith normally.

After running regolith install with these filters, folders are created called templater & functioner

        "filters": [
          {
            "url": "github.com/Hatchibombotar/useful-regolith-filters//templater"
          },
          {
            "url": "github.com/Hatchibombotar/useful-regolith-filters//functioner"
          }
        ]

Right now, we have some things set per-filter. This could get annoying, since I guess usually these settings will be the same. Example: dataPath.

The solution is to allow profile-specific data to be set in the top level. The properties inside individual profiles therefore only overrides these values.

This is a really nice flow I used in Echo:NPC.

After setting up the exportData key on a remote filter.json the data will never export unless a per-existing data folder is included before runtime. filter data created during tmp runtime without per-existing filter data folder won't get exported.

Add config that let user specify where to look for the executable for a filter type.

• python.command - Python (default python)
• python.install_command - Python (default pip)
• deno.command - Deno (default deno)
• dotnet.command - .NET (default dotnet)
• java.command - Java (default java)
• nim.command - Nim (default nim)
• nim.install_command - Nim (default nimble)
• node.command - Node JS (default node)
• node.install_command - Node JS (default npm)

Both of the variables are the same. FILTER_DIR should be an absolute path to the cache directory, where currently ran filter is. Try:

process.env["ROOT_DIR"] == process.env["FILTER_DIR"] //true

Currently you need to either run terminal as admin or run it somewhere, where it can create files. Otherwise it will fail.

Solution would be to save to a temporary file.

In order of priority:

1. winget OS: Windows Requires a custom publisher app for GoReleaser, which should just make a PR to https://github.com/microsoft/winget-pkgs https://docs.microsoft.com/en-us/windows/package-manager/package/repository Example PR: https://github.com/microsoft/winget-pkgs/pull/4738

2. apt OS: Linux https://askubuntu.com/questions/16446/how-to-get-my-software-into-ubuntu The easiest way would be to push to launchpad PPA https://help.launchpad.net/Packaging/PPA Requires a custom publisher app for GoReleaser, which should push the binaries with a secret key to PPA

3. scoop (optional) OS: Windows Seems like require an initial PR like this one https://github.com/ScoopInstaller/Main/pull/558 After that either you get some access to modify your file or they update it themselves (no clue) https://github.com/ScoopInstaller/Main/blob/master/bucket/lazydocker.json GoReleaser already has support for scoop https://goreleaser.com/customization/scoop/

4. chocolatey (optional) OS: Windows Requires to just run a command from GoReleaser to publish the package with secret key https://docs.chocolatey.org/en-us/create/create-packages-quick-start

5. homebrew (optional) OS: MacOS GoReleaser already has support for homebrew https://goreleaser.com/customization/homebrew/

The --selected-filters flag would let you provide a pattern used for selecting which filters should be executed from the profile.

Examples:

• 1 - first filter
• ..3 - first 3 filters
• 2..4 - filters 2,3,4
• 2,4,1 - filters 2,4,1 (in that order (?))