TrackableEntities / EntityFrameworkCore.Scaffolding.Handlebars

Scaffold EF Core models using Handlebars templates.
MIT License
208 stars 53 forks source link

Including table and column description metadata #103

Closed MarkAtRamp51 closed 4 years ago

MarkAtRamp51 commented 4 years ago

Including Table and Column Descriptions

Two new handlebars tokens were added to allow for the use of {{comment}} on table templates and {{property-comment}} on property templates. This can be useful to incorporate into xml doc comments to pull database descriptions into intellisense.

Apologies for the commit history, the more i tried to clean it up, the worse it became. I need some more practice there I guess. The Author should be MarkAtRamp51.

ErikEJ commented 4 years ago

FYI, the latest daily build of EF Core Power Tools now always scaffolds entity and property comments as summary XML

MarkAtRamp51 commented 4 years ago

Awesome. Thanks. Will this get merged?

tonysneed commented 4 years ago

Going to check this out soon. Thanks so much for the PR!

tonysneed commented 4 years ago

Used this script to add table and column comments in T-SQL.

-- Add a comment to a table Customer
EXEC sys.sp_addextendedproperty @name=N'MS_Description', @value=N'hello table Customer' ,@level0type=N'SCHEMA', @level0name=N'dbo', @level1type=N'TABLE', @level1name=N'Customer'

-- Adding a comment to a column CompanyName for the table Customer
EXEC sys.sp_addextendedproperty @name=N'MS_Description', @value=N'hello CompanyName' ,@level0type=N'SCHEMA', @level0name=N'dbo', @level1type=N'TABLE', @level1name=N'Customer', @level2type=N'COLUMN', @level2name=N'CompanyName'
tonysneed commented 4 years ago

@MarkAtRamp51 Are you able to make the changes I requested?

MarkAtRamp51 commented 4 years ago

@tonysneed I am, and I want to. I just haven't been able to get to it yet. I'll see if I can get them over to you by monday.

MarkAtRamp51 commented 4 years ago

@tonysneed I think I have your requested changes in there. I tried to squash a few times and had some major troubles. I think pulling master in added some more complexity to it, resulting in a lot more commits to try and squash. Let me know if you have any advice. Sorry, I've never used rebase too much.

tonysneed commented 4 years ago

@MarkAtRamp51 A lot of commits have beed added to the master branch since you created your PR. And in the meantime I have also created Contributing Guidelines for this repo, which have step-by-step instructions and video tutorial for following GitHub's fork and pull model of collaboration.

So at this point I would suggest you rename your fork (so as to preserve your work), then re-fork this repo. Then your will have a master branch with the latest commits. At this point, carefully follow steps in the Contributing Guidelines. Begin by cloning your fork and creating a local feature branch. Then commit your updates and create a new pull request to replace this one.

At that point, I will review and approve your new PR. If there are new commits that I have pushed to master, you can apply Step 15 to sync your fork. If your branch has multiple commits, you can try interactive rebase to squash them.

MarkAtRamp51 commented 4 years ago

Ok. I'll work on it.