Maintained by: Alex Chaffee and Cuong Tran
#GIT ANNOTATE CODE#
Original code by: Dave Thomas – Pragmatic Programmers, LLC SpatialAdapter: /pdeffendol/spatial_adapter Object Daddy: /flogic/object_daddyįabrication: /paulelliott/fabrication Note that this code will blow away the initial/final comment block in your models if it looks like it was previously added by annotate models, so you don't want to add additional text to an automatically created comment block.īACK UP YOUR MODELS BEFORE USING THIS TOOL! LINKSįactory Girl: /thoughtbot/factory_girl
If you prefer to sort alphabetically so that the results of annotation are consistent regardless of what order migrations are executed in, use –sort.
#GIT ANNOTATE FULL#
trace If unable to annotate a file, print the full stack trace, not just the exception message.īy default, columns will be sorted in database order (i.e. force Force new annotations even if there are no changes. f, Render Schema Infomation as plain/RDoc/Markdown Doing so shows you who made changes, when those changes were made, and what changeset those changes belong to, for the specific line of code you are looking at. e, -exclude Do not annotate fixtures, test files, or both You get to it by right clicking somewhere in the code, then selecting Source, then Annotate. R, -require path Additional files to require before loading models sort Sort columns alphabetically, rather than in creation order ignore-model-subdirects Ignore subdirectories of the models directory model-dir dir Annotate model files stored in dir rather than app/models s, -simple-indexes Concat the column's related indexes in the annotation i, -show-indexes List the table's database indexes in the annotation m, -show-migration Include the migration version number in the annotation v, -version Show the current version of this gem r, -routes Annotate routes.rb with the output of 'rake routes' p, -position Place the annotations at the top (before) or the bottom (after) of the model file d, -delete Remove annotations from all model files
If you want to always skip annotations on a particular model, add this string anywhere in the file: # -*- SkipSchemaAnnotations rake file that will ensure annotation happens after migration (but only in development mode), and provide configuration options you can use to tailor the output.
#GIT ANNOTATE INSTALL#
To automatically annotate after running 'rake db:migrate', ensure you've added annotate_models to your Rails project's Gemfile, and run this: rails g annotate_models: install To annotate just your models: annotate -exclude tests,fixtures To annotate your models and tests: annotate -exclude fixtures To annotate all your models, tests, fixtures, etc.: cd /path/to/app (If you used the Gemfile install, prefix the below commands with `bundle exec`.) Into environment gems from Github checkout: git clone git:///ctran/annotate_models.git annotate_models Into environment gems From : gem install annotate Into Gemfile from Github: gem ' annotate ', :git => ' git:///ctran/annotate_models.git ' The schema comment looks like this: # = Schema Info the (spec|test)/factories/_factory.rb files Thoughtbot's factory_girl factories, i.e. Add a comment summarizing the current schema to the top or bottom of each of your…
0 kommentar(er)
