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

Improve comment added to generated fixture file / boilerplate #7

Closed
hal-gh opened this issue Oct 10, 2013 · 2 comments
Closed

Improve comment added to generated fixture file / boilerplate #7

hal-gh opened this issue Oct 10, 2013 · 2 comments

Comments

@hal-gh
Copy link

hal-gh commented Oct 10, 2013

The boilerplate schema file generates a file that contains a comment such as the following:

/*
 *  File: PlanetStructures.js
 *  Generated by: Mongoose-Fixture (v0.1.3)
 *
 */

While the auto-generated config and schema files are self-explanatory from the file names they are created with, there is no way to tell from the contents of the fixtures files, meaning that when one is pasted and shared online, it is not immediately clear which of the 3 types of files it is.

For example:
#5 (comment)

Ideally, the comments for all 3 boilerplates would be amended to be consistent and thus all would include the purpose of the file in the comment, but the fixtures boilerplate is the most important.

I would have submitted a patch for this, but as it's such a trivial change and you may have a preference about how the comment is expressed, I will leave it at this issue/ticket. I hope that's ok! :)

Thanks a lot!

@mgan59
Copy link
Owner

mgan59 commented Oct 10, 2013

thanks for the suggestion. will add something.

@mgan59
Copy link
Owner

mgan59 commented Oct 11, 2013

Added to each boilerplate the following line Type:<value>

Type: <DataFixture || Config || Schema>

@mgan59 mgan59 closed this as completed Oct 11, 2013
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