search

trevordevore / levure

Application development framework for LiveCode
MIT License
32 stars 14 forks source link

Change "filename" and "folder" keys for helpers #127

Open macMikey opened 5 years ago

macMikey commented 5 years ago

The current behavior is confusing. For helpers, "filename" is a path the to the folder containing the files for a helper, and "folder" is a path pointing to a folder that contains the folders that contain helpers. Change "filename" to "folder", and "folder" to "folder of folders" or something else that is more meaningful to n00bs (and me)

trevordevore commented 5 years ago

The general rule in the app.yml file is that if you are pointing to a single object then use filename and if you are pointing to a folder of objects use folder. I think of a helper as being similar to an app bundle or framework on macOS. It should be thought of as a single object that happens to be made up of many files behind the scenes. Maybe it can be thought of as being a package.

I don't think that changing filename to folder for helpers is the right approach because in all of the other sections folder is used because it is a folder of behaviors, libraries, etc. I would consider using package filename as for helpers though. That seems more descriptive.

macMikey commented 5 years ago

something more descriptive would be less confusing. filename implies something completely different from folder. Perhaps the way to address it is to allow either folder (if it actually points to a folder) or filename in the context of filename. The current behavior is going to bite people.

trevordevore commented 5 years ago

I do not want to use folder to point to an individual helper as it is already used in another context. That would be confusing as well. What if path was a synonym for filename and is what we used in the docs? A path can be either a filename or folder so it would be appropriate.

macMikey commented 5 years ago

I'm cool with path. I would leave filename in place, and just add path.