Skip to content

Folder comments? #17

@dave-green-uk

Description

@dave-green-uk

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions