Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/GregTrevellick/SolutionOpenPopUp
A Visual Studio extension to open a pop-up dialog containing the contents of a specific text file in a solution, when the solution is opened.
https://github.com/GregTrevellick/SolutionOpenPopUp
gotcha visual-studio visual-studio-extension
Last synced: 2 months ago
JSON representation
A Visual Studio extension to open a pop-up dialog containing the contents of a specific text file in a solution, when the solution is opened.
- Host: GitHub
- URL: https://github.com/GregTrevellick/SolutionOpenPopUp
- Owner: GregTrevellick
- License: mit
- Created: 2017-07-21T20:58:56.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T06:38:36.000Z (almost 2 years ago)
- Last Synced: 2024-04-28T02:39:15.349Z (5 months ago)
- Topics: gotcha, visual-studio, visual-studio-extension
- Language: C#
- Homepage: https://goo.gl/aGVjJ8
- Size: 999 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[AppVeyorProjectUrl]: https://ci.appveyor.com/project/GregTrevellick/solutionopenpopup
[AppVeyorProjectBuildStatusBadgeSvg]: https://ci.appveyor.com/api/projects/status/ap87wkdaam6jkgui?svg=true
[GitHubRepoURL]: https://github.com/GregTrevellick/SolutionOpenPopUp
[GitHubRepoIssuesURL]: https://github.com/GregTrevellick/SolutionOpenPopUp/issues
[GitHubRepoPullRequestsURL]: https://github.com/GregTrevellick/SolutionOpenPopUp/pulls
[VersionNumberBadgeURL]: https://vsmarketplacebadge.apphb.com/version/GregTrevellick.SolutionOpenPopUp.svg
[VisualStudioURL]: https://www.visualstudio.com/
[VSMarketplaceUrl]: https://marketplace.visualstudio.com/items?itemName=GregTrevellick.SolutionOpenPopUp
[VSMarketplaceReviewsUrl]: https://marketplace.visualstudio.com/items?itemName=GregTrevellick.SolutionOpenPopUp#review-details
[CharityWareURL]: https://github.com/GregTrevellick/MiscellaneousArtefacts/wiki/Charity-Ware
[WhyURL]: https://github.com/GregTrevellick/MiscellaneousArtefacts/wiki/Why
# Solution Open Pop Up
[](https://github.com/GregTrevellick/ReadMeSynchronizer)
[](https://bettercodehub.com/results/GregTrevellick/SolutionOpenPopUp)
[](https://www.codacy.com/project/gtrevellick/SolutionOpenPopUp/dashboard?utm_source=github.com&utm_medium=referral&utm_content=GregTrevellick/SolutionOpenPopUp&utm_campaign=Badge_Grade_Dashboard)
[](https://www.codefactor.io/repository/github/GregTrevellick/SolutionOpenPopUp)
[](https://github.com/GregTrevellick/SolutionOpenPopUp)
[](https://github.com/GregTrevellick/SolutionOpenPopUp)
[](https://github.com/GregTrevellick/SolutionOpenPopUp/issues)
[](https://github.com/GregTrevellick/SolutionOpenPopUp/pulls)
[](https://github.com/GregTrevellick?tab=followers)
[](https://github.com/GregTrevellick/SolutionOpenPopUp)
[](https://github.com/GregTrevellick/SolutionOpenPopUp/watchers)
[](https://sonarcloud.io/dashboard?id=SolutionOpenPopUp)
[](https://sonarcloud.io/component_measures?id=SolutionOpenPopUp&metric=bugs)
[](https://sonarcloud.io/component_measures?id=SolutionOpenPopUp&metric=code_smells)
[](https://sonarcloud.io/component_measures?id=SolutionOpenPopUp&metric=Coverage)
[](https://sonarcloud.io/component_measures?id=SolutionOpenPopUp&metric=duplicated_lines)
[](https://sonarcloud.io/component_measures?id=SolutionOpenPopUp&metric=ncloc)
[](https://sonarcloud.io/component_measures?id=SolutionOpenPopUp&metric=reliability_rating)
[](https://sonarcloud.io/component_measures?id=SolutionOpenPopUp&metric=security_rating)
[](https://sonarcloud.io/component_measures?id=SolutionOpenPopUp&metric=sqale_index)
[](https://sonarcloud.io/component_measures?id=SolutionOpenPopUp&metric=sqale_rating)
[](https://sonarcloud.io/component_measures?id=SolutionOpenPopUp&metric=vulnerabilities)
[](https://ci.appveyor.com/project/GregTrevellick/SolutionOpenPopUp)
[](https://ci.appveyor.com/project/GregTrevellick/SolutionOpenPopUp/build/tests)
[](https://gregtrevellick.visualstudio.com/SolutionOpenPopUp/_build/latest?definitionId=20)
[](https://houndci.com/)
[](https://www.accesslint.com)
[](https://imgbot.net/)
[](https://renovatebot.com/)
[](https://github.com/GregTrevellick/MiscellaneousArtefacts/wiki/Charity-Ware)
[](/LICENSE.txt)
[](https://github.com/GregTrevellick/SolutionOpenPopUp/subscription)
[](https://marketplace.visualstudio.com/items?itemName=GregTrevellick.SolutionOpenPopUp)
[](https://marketplace.visualstudio.com/items?itemName=GregTrevellick.SolutionOpenPopUp)
[](https://marketplace.visualstudio.com/items?itemName=GregTrevellick.SolutionOpenPopUp)
[](https://marketplace.visualstudio.com/items?itemName=GregTrevellick.SolutionOpenPopUp)
[][VSMarketplaceUrl]
Download this extension from the [VS Marketplace][VSMarketplaceUrl].
---------------------------------------
Display the contents of certain text files in a solution folder in a pop-up when the solution is opened.
If a file called SolutionOpenPopUp.txt and/or ReadMe.txt exists in the root folder of the solution, the contents are shown in a pop-up when the solution is open - a handy way to share solution-specific gotchas, non-critical team messages, etc with colleagues and contributors.
- *If you LIKE this ***FREE*** extension please give a star rating below, it only takes a few seconds*.
- *If you LOVE this ***FREE*** extension please [help others][CharityWareURL].*
## Use-Cases
Use this extension anytime you want to see, or you want others to see, certain information when a solution is opened. As you cannot gaurantee other users will have this extension installed you should not rely on this extension to convey critical information.
For example:
- You're new to a company, have made some notes on a .Net solution, and it would be useful to see the notes each time you open the solution.
- You are planning to upgrade a solution to VS2017 in the next quarter, and you want to give the developers a heads up whenever they open the solution.
- The solution has some 'gotchas' (e.g. compilation, runtime or unit test related) which interested parties would benefit from seeing whenever they open up the code.
- The solution is simply a proof of concept and you wish to convey this to others.
- Your solution has its' own "ReadMe" file which all developers should view when they open the solution.
- You want to share a joke-of-the-day or coder-of-the-week announcement with colleagues.
[Why build this extension?][WhyURL]
## Features
- Option to show/hide the content of SolutionOpenPopUp.txt in root folder of the solution in a pop-up when the solution is open.
- Option to show/hide the content of ReadMe.txt in root folder of the solution in a pop-up when the solution is open.
- Excessively long lines of text are truncated according to a user-defined value.
- User-defined limit for maximum number of lines to be shown in pop-up.
- If maximum lines limit is exceeded and multiple files are being displayed, the content of each file is truncated pro-rata.
- Option to show/hide source file names in the pop-up.
## Contribute
Contributions to this project are welcome by raising an [Issue][GitHubRepoIssuesURL] or submitting a [Pull Request][GitHubRepoPullRequestsURL].
## License
[MIT](/LICENSE.txt)
## Credits
The following authors / articles deserve special mention for their help whilst creating this extension:
[Ben](https://stackoverflow.com/questions/36035176/build-vs-2015-extension-on-build-server-without-vs-installed/43934701#43934701)
[Mads Kristensen](https://channel9.msdn.com/Events/Build/2016/B886)
[Joshua Thompson](http://schmalls.com/2015/01/19/adventures-in-visual-studio-extension-development-part-2)
[Slaks.Blog](http://blog.slaks.net/2013-11-10/extending-visual-studio-part-2-core-concepts/)
[][VSMarketplaceUrl]