Skip to content

Commit 6516d68

Browse files
committed
feat(app): run prettier on files + pre-commit
1 parent 48bc457 commit 6516d68

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+882
-678
lines changed

.prettierignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
package-lock.json

.prettierrc

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
2-
"printWidth": 100,
3-
"tabWidth": 4,
4-
"singleQuote": true,
5-
"parser": "typescript"
2+
"printWidth": 100,
3+
"tabWidth": 4,
4+
"singleQuote": true,
5+
"bracketSpacing": true,
6+
"semi": true
67
}

README.md

+36-39
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,66 @@
11
<p align="center">
22
<img src="https://avatars3.githubusercontent.com/u/23202313" alt="Compodoc: The missing documentation tool for your Angular application" width="226">
3-
<br>
4-
<a href="https://travis-ci.org/compodoc/compodoc"><img src="https://img.shields.io/travis/compodoc/compodoc/develop.svg?label=Linux%20build" alt="Linux Build Status"></a>
5-
<a href="https://ci.appveyor.com/project/vogloblinsky/compodoc/branch/develop"><img src="https://img.shields.io/appveyor/ci/vogloblinsky/compodoc/develop.svg?label=Windows%20build" alt="Windows Build Status"></a>
3+
<br/>
4+
<a href="https://travis-ci.org/compodoc/compodoc"><img src="https://img.shields.io/travis/compodoc/compodoc/develop.svg?label=Linux%20build" alt="Linux Build Status"/></a>
5+
<a href="https://ci.appveyor.com/project/vogloblinsky/compodoc/branch/develop"><img src="https://img.shields.io/appveyor/ci/vogloblinsky/compodoc/develop.svg?label=Windows%20build" alt="Windows Build Status"/></a>
66
<a href="https://codecov.io/gh/compodoc/compodoc"><img src="https://codecov.io/gh/compodoc/compodoc/branch/develop/graph/badge.svg" alt="Codecov"/></a>
7-
<a href="https://www.npmjs.com/package/@compodoc/compodoc"><img src="https://badge.fury.io/js/%40compodoc%2Fcompodoc.svg" alt="npm badge"></a>
8-
<a href="https://david-dm.org/compodoc/compodoc"><img src="https://david-dm.org/compodoc/compodoc.svg" alt="npm dependencies"></a>
9-
<a href="https://david-dm.org/compodoc/compodoc?type=dev"><img src="https://david-dm.org/compodoc/compodoc/dev-status.svg" alt="npm devDependencies"></a>
10-
<a href="https://npmcharts.com/compare/@compodoc/compodoc?minimal=true"><img src="https://img.shields.io/npm/dm/@compodoc/compodoc.svg?style=flat" alt="NPM Downloads"></a>
11-
<a href="https://opensource.org/licenses/MIT"><img src="http://img.shields.io/badge/license-MIT-brightgreen.svg" alt="MIT badge"></a>
12-
<a href="#backers" alt="sponsors on Open Collective"><img src="https://opencollective.com/compodoc/backers/badge.svg" /></a> <a href="#sponsors" alt="Sponsors on Open Collective"><img src="https://opencollective.com/compodoc/sponsors/badge.svg" />
7+
<a href="https://www.npmjs.com/package/@compodoc/compodoc"><img src="https://badge.fury.io/js/%40compodoc%2Fcompodoc.svg" alt="npm badge"/></a>
8+
<a href="https://david-dm.org/compodoc/compodoc"><img src="https://david-dm.org/compodoc/compodoc.svg" alt="npm dependencies"/></a>
9+
<a href="https://david-dm.org/compodoc/compodoc?type=dev"><img src="https://david-dm.org/compodoc/compodoc/dev-status.svg" alt="npm devDependencies"/></a>
10+
<a href="https://npmcharts.com/compare/@compodoc/compodoc?minimal=true"><img src="https://img.shields.io/npm/dm/@compodoc/compodoc.svg?style=flat" alt="NPM Downloads"/></a>
11+
<a href="https://opensource.org/licenses/MIT"><img src="http://img.shields.io/badge/license-MIT-brightgreen.svg" alt="MIT badge"/></a>
12+
<a href="#backers" alt="sponsors on Open Collective"><img src="https://opencollective.com/compodoc/backers/badge.svg" /></a> <a href="#sponsors" alt="Sponsors on Open Collective"><img src="https://opencollective.com/compodoc/sponsors/badge.svg" /></a>
1313
</p>
1414
<p align="center">
15-
<img src="https://saucelabs.com/browser-matrix/compodoc.svg" alt="saucelabs badge">
15+
<img src="https://saucelabs.com/browser-matrix/compodoc.svg" alt="saucelabs badge"/>
1616
</p>
1717
<p align="center">
18-
<a href="https://gitter.im/compodoc/compodoc" target="_blank"><img src="https://badges.gitter.im/Join%20Chat.svg" alt="Gitter badge"></a><br><br>
18+
<a href="https://gitter.im/compodoc/compodoc" target="_blank"><img src="https://badges.gitter.im/Join%20Chat.svg" alt="Gitter badge"/></a><br><br>
1919
</p>
2020

2121
<p align="center">The missing documentation tool for your Angular application.<br><br></p>
2222

2323
<p align="center">
24-
<img src="https://raw.githubusercontent.com/compodoc/compodoc/master/screenshots/main-view.gif" alt="Compodoc: The missing documentation tool for your Angular application">
24+
<img src="https://raw.githubusercontent.com/compodoc/compodoc/master/screenshots/main-view.gif" alt="Compodoc: The missing documentation tool for your Angular application"/>
2525
</p>
2626

27-
2827
# Live Demo
2928

3029
A live demo is available — **[see it in action][demo]** !
3130

3231
The demo features documentation generated for a simple [TodoMVC application].
3332

3433
[demo]: https://compodoc.github.io/compodoc-demo-todomvc-angular/
35-
[TodoMVC application]: https://github.com/compodoc/compodoc-demo-todomvc-angular
34+
[todomvc application]: https://github.com/compodoc/compodoc-demo-todomvc-angular
3635

3736
# Features
3837

39-
- **Clean, simple design** — Navigate the documentation on the left side, read it on the right.
38+
- **Clean, simple design** — Navigate the documentation on the left side, read it on the right.
4039

41-
- **Beautiful themes** — Seven themes are available from well known documentation tools like [Gitbook], [Read the Docs] and projects like [Vagrant], [Laravel], [Postmark] and [Stripe].
40+
- **Beautiful themes** — Seven themes are available from well known documentation tools like [Gitbook], [Read the Docs] and projects like [Vagrant], [Laravel], [Postmark] and [Stripe].
4241

43-
- **Search** — Includes a powerful search engine ([lunr.js]) for easily finding what you're looking for.
42+
- **Search** — Includes a powerful search engine ([lunr.js]) for easily finding what you're looking for.
4443

45-
- **Automatic table of contents** — API table of contents is generated using elements found during files parsing.
44+
- **Automatic table of contents** — API table of contents is generated using elements found during files parsing.
4645

47-
- **JSDoc light support** — Support for `@param`, `@returns`, `@link`, `@ignore` and `@example` tags.
46+
- **JSDoc light support** — Support for `@param`, `@returns`, `@link`, `@ignore` and `@example` tags.
4847

49-
- **Documentation coverage** — Get the documentation coverage report of your project.
48+
- **Documentation coverage** — Get the documentation coverage report of your project.
5049

51-
- **Angular CLI-friendly** — Supports [Angular CLI] projects out-of-the-box.
50+
- **Angular CLI-friendly** — Supports [Angular CLI] projects out-of-the-box.
5251

53-
- **Offline** — No server needed, no sources uploaded online, documentation generated entirely offline.
52+
- **Offline** — No server needed, no sources uploaded online, documentation generated entirely offline.
5453

55-
- **Open-source and on npm** — Use it directly in your project using [npm] and a single script—that's it!
54+
- **Open-source and on npm** — Use it directly in your project using [npm] and a single script—that's it!
5655

57-
[Gitbook]: https://www.gitbook.com
58-
[Read the Docs]: https://readthedocs.org/
59-
[Vagrant]: https://www.vagrantup.com/docs/
60-
[Laravel]: https://laravel.com/docs/5.3
61-
[Postmark]: https://developer.postmarkapp.com/
62-
[Stripe]: https://stripe.com/docs/api
56+
[gitbook]: https://www.gitbook.com
57+
[read the docs]: https://readthedocs.org/
58+
[vagrant]: https://www.vagrantup.com/docs/
59+
[laravel]: https://laravel.com/docs/5.3
60+
[postmark]: https://developer.postmarkapp.com/
61+
[stripe]: https://stripe.com/docs/api
6362
[lunr.js]: https://lunrjs.com/
64-
[Angular CLI]: https://cli.angular.io/
63+
[angular cli]: https://cli.angular.io/
6564
[npm]: https://www.npmjs.com/
6665

6766
# Documentation
@@ -94,13 +93,13 @@ Read up on our guidelines for [contributing](https://github.com/compodoc/compodo
9493

9594
This project exists thanks to all these people.
9695

97-
|[<img alt="vogloblinsky" src="https://avatars3.githubusercontent.com/u/2841805?v=4&s=117" width="117">](https://github.com/vogloblinsky)|[<img alt="manekinekko" src="https://avatars3.githubusercontent.com/u/1699357?v=4&s=117" width="117">](https://github.com/manekinekko)|[<img alt="mattlewis92" src="https://avatars1.githubusercontent.com/u/6425649?v=4&s=117" width="117">](https://github.com/mattlewis92)|[<img alt="JonasMH" src="https://avatars0.githubusercontent.com/u/1939229?v=4&s=117" width="117">](https://github.com/JonasMH)|[<img alt="rprotsyk" src="https://avatars0.githubusercontent.com/u/104502?v=4&s=117" width="117">](https://github.com/rprotsyk)|[<img alt="daniele-zurico" src="https://avatars0.githubusercontent.com/u/3193095?v=4&s=117" width="117">](https://github.com/daniele-zurico)|[<img alt="profimedica" src="https://avatars0.githubusercontent.com/u/2903499?v=4&s=117" width="117">](https://github.com/profimedica)|[<img alt="guilhermevrs" src="https://avatars0.githubusercontent.com/u/1570567?v=4&s=117" width="117">](https://github.com/guilhermevrs)|
98-
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
99-
|[vogloblinsky](https://github.com/vogloblinsky)|[manekinekko](https://github.com/manekinekko)|[mattlewis92](https://github.com/mattlewis92)|[JonasMH](https://github.com/JonasMH)|[rprotsyk](https://github.com/rprotsyk)|[daniele-zurico](https://github.com/daniele-zurico)|[profimedica](https://github.com/profimedica)|[guilhermevrs](https://github.com/guilhermevrs)|
96+
| [<img alt="vogloblinsky" src="https://avatars3.githubusercontent.com/u/2841805?v=4&s=117" width="117"/>](https://github.com/vogloblinsky) | [<img alt="manekinekko" src="https://avatars3.githubusercontent.com/u/1699357?v=4&s=117" width="117"/>](https://github.com/manekinekko) | [<img alt="mattlewis92" src="https://avatars1.githubusercontent.com/u/6425649?v=4&s=117" width="117"/>](https://github.com/mattlewis92) | [<img alt="JonasMH" src="https://avatars0.githubusercontent.com/u/1939229?v=4&s=117" width="117"/>](https://github.com/JonasMH) | [<img alt="rprotsyk" src="https://avatars0.githubusercontent.com/u/104502?v=4&s=117" width="117"/>](https://github.com/rprotsyk) | [<img alt="daniele-zurico" src="https://avatars0.githubusercontent.com/u/3193095?v=4&s=117" width="117"/>](https://github.com/daniele-zurico) | [<img alt="profimedica" src="https://avatars0.githubusercontent.com/u/2903499?v=4&s=117" width="117"/>](https://github.com/profimedica) | [<img alt="guilhermevrs" src="https://avatars0.githubusercontent.com/u/1570567?v=4&s=117" width="117"/>](https://github.com/guilhermevrs) |
97+
| :---------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------: |
98+
| [vogloblinsky](https://github.com/vogloblinsky) | [manekinekko](https://github.com/manekinekko) | [mattlewis92](https://github.com/mattlewis92) | [JonasMH](https://github.com/JonasMH) | [rprotsyk](https://github.com/rprotsyk) | [daniele-zurico](https://github.com/daniele-zurico) | [profimedica](https://github.com/profimedica) | [guilhermevrs](https://github.com/guilhermevrs) |
10099

101-
|[<img alt="vogloblinsky" src="https://avatars3.githubusercontent.com/u/32763448?v=4&s=117" width="117">](https://github.com/dp-1a)|[<img alt="guilhermevrs" src="https://avatars0.githubusercontent.com/u/14924373?v=4&s=117" width="117">](https://github.com/ValentinGot)|[<img alt="Blakesalot" src="https://avatars1.githubusercontent.com/u/10159693?s=460&v=4" width="117">](https://github.com/Blakesalot)|[<img alt="Brigitte Hofmeister" src="https://avatars1.githubusercontent.com/u/16089658?s=460&v=4" width="117">](https://github.com/bhofmei)|[<img alt="lichangfeng" src="https://avatars2.githubusercontent.com/u/8101989?s=460&v=4" width="117">](https://github.com/lichangfeng)|
102-
|:-:|:-:|:-:|:-:|:-:|
103-
|[dp-1a](https://github.com/dp-1a)|[ValentinGot](https://github.com/ValentinGot)|[Blake Simmon](https://github.com/Blakesalot)|[Brigitte Hofmeister](https://github.com/bhofmei)|[lichangfeng](https://github.com/lichangfeng)|
100+
| [<img alt="vogloblinsky" src="https://avatars3.githubusercontent.com/u/32763448?v=4&s=117" width="117"/>](https://github.com/dp-1a) | [<img alt="guilhermevrs" src="https://avatars0.githubusercontent.com/u/14924373?v=4&s=117" width="117"/>](https://github.com/ValentinGot) | [<img alt="Blakesalot" src="https://avatars1.githubusercontent.com/u/10159693?s=460&v=4" width="117"/>](https://github.com/Blakesalot) | [<img alt="Brigitte Hofmeister" src="https://avatars1.githubusercontent.com/u/16089658?s=460&v=4" width="117"/>](https://github.com/bhofmei) | [<img alt="lichangfeng" src="https://avatars2.githubusercontent.com/u/8101989?s=460&v=4" width="117"/>](https://github.com/lichangfeng) |
101+
| :---------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------: |
102+
| [dp-1a](https://github.com/dp-1a) | [ValentinGot](https://github.com/ValentinGot) | [Blake Simmon](https://github.com/Blakesalot) | [Brigitte Hofmeister](https://github.com/bhofmei) | [lichangfeng](https://github.com/lichangfeng) |
104103

105104
# License
106105

@@ -109,9 +108,7 @@ Everything in this repository is [licensed under the MIT License][license] unles
109108
Copyright (c) 2016 – 2019 [Vincent Ogloblinsky]
110109

111110
[license]: https://github.com/compodoc/compodoc/blob/master/LICENSE
112-
[Vincent Ogloblinsky]: https://www.vincentogloblinsky.com
113-
114-
111+
[vincent ogloblinsky]: https://www.vincentogloblinsky.com
115112
[support-url]: https://opencollective.com/compodoc#support
116113
[backers-image]: https://opencollective.com/compodoc/backers.svg
117114
[sponsors-image]: https://opencollective.com/compodoc/sponsors.svg

0 commit comments

Comments
 (0)