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

Folder comments? #17

Open
davegreenwp opened this issue Apr 23, 2015 · 1 comment
Open

Folder comments? #17

davegreenwp opened this issue Apr 23, 2015 · 1 comment

Comments

@davegreenwp
Copy link

Hello!

First of all, I absolutely love this tool. So, so useful.

I was wondering whether you'd consider building in support for folder comments? Originally I was thinking you could just have it parse a dotfile in each folder but that would be messy, then I thought it would be easier to just use the package.json?

{
    "frontend": {
    "name": "YOUR PROJECT NAME",
    "stylesheets": "RELATIVE/PATH/TO/STYLESHEETS/FOLDER",
    "javascripts": "RELATIVE/PATH/TO/JAVASCRIPTS/FOLDER",
    "folder_comments": [
            "relative_path_to_folder": "Hello! This is a folder!",
            "assets_scss_vendor_jquery-ui": "jQuery UI styles go here!",
        ]
    }
}

Just an idea! I think it's useful to be able to add comments to certain folders where the developer might be confused about which folder is actually the best place to put a new partial, etc.

Cheers!
Dave

@brunowego
Copy link

+1

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

No branches or pull requests

2 participants