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

Adds the tsContentHeader and tsContentFooter settings #398

Merged
merged 2 commits into from
Dec 7, 2023

Conversation

cmaster11
Copy link
Collaborator

@cmaster11 cmaster11 commented Dec 7, 2023

Adds the tsContentHeader and tsContentFooter settings.

They let you prepend/append some code to every generated interface. This can be useful when you generate documentation automatically and you want to import full code blocks in your docs by defining begin/end markers of the various blocks.

E.g.

tsContentHeader: type => `// [block "${type.interfaceOrTypeName}" begin]`,
tsContentFooter: type => `// [block "${type.interfaceOrTypeName}" end]`
// [block "Other" begin]
export interface Other {
  other?: string;
}
// [block "Other" end]

…ou prepend/append some code to every generated interface. This can be useful when you generate documentation automatically and you want to import full code blocks in your docs by defining begin/end markers of the various blocks.

E.g.

```
// [block "Other" begin]
export interface Other {
  other?: string;
}
// [block "Other" end]
```
Copy link

codecov bot commented Dec 7, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (8b4fb10) 98.67% compared to head (fa34f6a) 98.68%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #398   +/-   ##
=======================================
  Coverage   98.67%   98.68%           
=======================================
  Files           9        9           
  Lines         528      532    +4     
  Branches      204      206    +2     
=======================================
+ Hits          521      525    +4     
  Misses          7        7           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@mrjono1 mrjono1 merged commit 5689d01 into mrjono1:master Dec 7, 2023
4 checks passed
@cmaster11 cmaster11 deleted the headerfooter branch December 7, 2023 03:43
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

Successfully merging this pull request may close these issues.

2 participants