acatl / grunt-readmejs

grunt task to generate README.md from documented code
0 stars 0 forks source link

move index.js files to top #1

Open acatl opened 10 years ago

acatl commented 10 years ago

when crawling the files group, they are sorted alphabetically, moving index.js file at which ever place. I would be helpful to move the index.js (if found) to the top of each group, so its the first thing on the output.

tkane2000 commented 10 years ago

more details from acatl: the idea is that lib/_.js then you will get all *.js but index will be somewhere alphabetically sorted index.js would be better at top this can be an option also indexTop: true by default the change is to detect the file and move it to top the catch is to only move it to top of within its own group <<<< say someone does /_/.js so they will get a list under that group with all the files of all the folders and we want to move index files at top of each folder not at the top of all the expanded glob list so /lib/index.js /lib/other.js /lib/folder/index.js /lib/folder/foo.js