{"id":13340485,"url":"https://github.com/GregTrevellick/SolutionOpenPopUp","last_synced_at":"2025-03-11T18:31:22.946Z","repository":{"id":38105587,"uuid":"97986091","full_name":"GregTrevellick/SolutionOpenPopUp","owner":"GregTrevellick","description":"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.","archived":false,"fork":false,"pushed_at":"2022-12-08T06:38:36.000Z","size":1023,"stargazers_count":0,"open_issues_count":8,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-24T06:27:54.983Z","etag":null,"topics":["gotcha","visual-studio","visual-studio-extension"],"latest_commit_sha":null,"homepage":"https://goo.gl/aGVjJ8","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GregTrevellick.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-07-21T20:58:56.000Z","updated_at":"2020-06-14T20:25:58.000Z","dependencies_parsed_at":"2023-01-24T16:45:14.929Z","dependency_job_id":null,"html_url":"https://github.com/GregTrevellick/SolutionOpenPopUp","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GregTrevellick%2FSolutionOpenPopUp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GregTrevellick%2FSolutionOpenPopUp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GregTrevellick%2FSolutionOpenPopUp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GregTrevellick%2FSolutionOpenPopUp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GregTrevellick","download_url":"https://codeload.github.com/GregTrevellick/SolutionOpenPopUp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243090324,"owners_count":20234776,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gotcha","visual-studio","visual-studio-extension"],"created_at":"2024-07-29T19:23:00.768Z","updated_at":"2025-03-11T18:31:22.552Z","avatar_url":"https://github.com/GregTrevellick.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"[AppVeyorProjectUrl]: https://ci.appveyor.com/project/GregTrevellick/solutionopenpopup\n[AppVeyorProjectBuildStatusBadgeSvg]: https://ci.appveyor.com/api/projects/status/ap87wkdaam6jkgui?svg=true\n[GitHubRepoURL]: https://github.com/GregTrevellick/SolutionOpenPopUp\n[GitHubRepoIssuesURL]: https://github.com/GregTrevellick/SolutionOpenPopUp/issues\n[GitHubRepoPullRequestsURL]: https://github.com/GregTrevellick/SolutionOpenPopUp/pulls\n[VersionNumberBadgeURL]: https://vsmarketplacebadge.apphb.com/version/GregTrevellick.SolutionOpenPopUp.svg\n[VisualStudioURL]: https://www.visualstudio.com/\n[VSMarketplaceUrl]: https://marketplace.visualstudio.com/items?itemName=GregTrevellick.SolutionOpenPopUp\n[VSMarketplaceReviewsUrl]: https://marketplace.visualstudio.com/items?itemName=GregTrevellick.SolutionOpenPopUp#review-details\n[CharityWareURL]: https://github.com/GregTrevellick/MiscellaneousArtefacts/wiki/Charity-Ware\n[WhyURL]: https://github.com/GregTrevellick/MiscellaneousArtefacts/wiki/Why\n  \n# Solution Open Pop Up\n\n\u003c!--BadgesSTART--\u003e\n\u003c!-- Powered by https://github.com/GregTrevellick/ReadMeSynchronizer --\u003e\n[![Read Me Synchronizer](https://img.shields.io/badge/-powered%20by%20ReadMeSynchronizer-brightgreen.svg)](https://github.com/GregTrevellick/ReadMeSynchronizer)\n[![BetterCodeHub compliance](https://bettercodehub.com/edge/badge/GregTrevellick/SolutionOpenPopUp?branch=master)](https://bettercodehub.com/results/GregTrevellick/SolutionOpenPopUp)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/23dfefe3b5014fd8b8462b47a3f38c1c)](https://www.codacy.com/project/gtrevellick/SolutionOpenPopUp/dashboard?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=GregTrevellick/SolutionOpenPopUp\u0026amp;utm_campaign=Badge_Grade_Dashboard)\n [![CodeFactor](https://www.codefactor.io/repository/github/GregTrevellick/SolutionOpenPopUp/badge)](https://www.codefactor.io/repository/github/GregTrevellick/SolutionOpenPopUp)\n    [![GitHub top language](https://img.shields.io/github/languages/top/GregTrevellick/SolutionOpenPopUp.svg)](https://github.com/GregTrevellick/SolutionOpenPopUp)\n[![Github language count](https://img.shields.io/github/languages/count/GregTrevellick/SolutionOpenPopUp.svg)](https://github.com/GregTrevellick/SolutionOpenPopUp)\n [![GitHub issues](https://img.shields.io/github/issues-raw/GregTrevellick/SolutionOpenPopUp.svg)](https://github.com/GregTrevellick/SolutionOpenPopUp/issues)\n[![GitHub pull requests](https://img.shields.io/github/issues-pr-raw/GregTrevellick/SolutionOpenPopUp.svg)](https://github.com/GregTrevellick/SolutionOpenPopUp/pulls)\n[![GitHub followers](https://img.shields.io/github/followers/GregTrevellick.svg)](https://github.com/GregTrevellick?tab=followers)\n[![GitHub stars](https://img.shields.io/github/stars/GregTrevellick/SolutionOpenPopUp.svg)](https://github.com/GregTrevellick/SolutionOpenPopUp)\n[![GitHub watchers](https://img.shields.io/github/watchers/GregTrevellick/SolutionOpenPopUp.svg)](https://github.com/GregTrevellick/SolutionOpenPopUp/watchers)\n[![Sonar\u0026metric=alert_status](https://sonarcloud.io/api/project_badges/measure?project=SolutionOpenPopUp\u0026metric=alert_status)](https://sonarcloud.io/dashboard?id=SolutionOpenPopUp)\n[![Sonar\u0026metric=bugs](https://sonarcloud.io/api/project_badges/measure?project=SolutionOpenPopUp\u0026metric=bugs)](https://sonarcloud.io/component_measures?id=SolutionOpenPopUp\u0026metric=bugs)\n[![Sonar\u0026metric=code_smells](https://sonarcloud.io/api/project_badges/measure?project=SolutionOpenPopUp\u0026metric=code_smells)](https://sonarcloud.io/component_measures?id=SolutionOpenPopUp\u0026metric=code_smells)\n[![Sonar\u0026metric=coverage](https://sonarcloud.io/api/project_badges/measure?project=SolutionOpenPopUp\u0026metric=coverage)](https://sonarcloud.io/component_measures?id=SolutionOpenPopUp\u0026metric=Coverage)\n[![Sonar\u0026metric=duplicated_lines_density](https://sonarcloud.io/api/project_badges/measure?project=SolutionOpenPopUp\u0026metric=duplicated_lines_density)](https://sonarcloud.io/component_measures?id=SolutionOpenPopUp\u0026metric=duplicated_lines)\n[![Sonar\u0026metric=ncloc](https://sonarcloud.io/api/project_badges/measure?project=SolutionOpenPopUp\u0026metric=ncloc)](https://sonarcloud.io/component_measures?id=SolutionOpenPopUp\u0026metric=ncloc)\n[![Sonar\u0026metric=reliability_rating](https://sonarcloud.io/api/project_badges/measure?project=SolutionOpenPopUp\u0026metric=reliability_rating)](https://sonarcloud.io/component_measures?id=SolutionOpenPopUp\u0026metric=reliability_rating)\n[![Sonar\u0026metric=security_rating](https://sonarcloud.io/api/project_badges/measure?project=SolutionOpenPopUp\u0026metric=security_rating)](https://sonarcloud.io/component_measures?id=SolutionOpenPopUp\u0026metric=security_rating)\n[![Sonar\u0026metric=sqale_index](https://sonarcloud.io/api/project_badges/measure?project=SolutionOpenPopUp\u0026metric=sqale_index)](https://sonarcloud.io/component_measures?id=SolutionOpenPopUp\u0026metric=sqale_index)\n[![Sonar\u0026metric=sqale_rating](https://sonarcloud.io/api/project_badges/measure?project=SolutionOpenPopUp\u0026metric=sqale_rating)](https://sonarcloud.io/component_measures?id=SolutionOpenPopUp\u0026metric=sqale_rating)\n[![Sonar\u0026metric=vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=SolutionOpenPopUp\u0026metric=vulnerabilities)](https://sonarcloud.io/component_measures?id=SolutionOpenPopUp\u0026metric=vulnerabilities)\n[![Appveyor Build status](https://ci.appveyor.com/api/projects/status/89c8gp1t0rua9fiw?svg=true)](https://ci.appveyor.com/project/GregTrevellick/SolutionOpenPopUp)\n[![Appveyor unit tests](https://img.shields.io/appveyor/tests/GregTrevellick/SolutionOpenPopUp.svg)](https://ci.appveyor.com/project/GregTrevellick/SolutionOpenPopUp/build/tests)\n[![Azure Build Status](https://gregtrevellick.visualstudio.com/SolutionOpenPopUp/_apis/build/status/SolutionOpenPopUp)](https://gregtrevellick.visualstudio.com/SolutionOpenPopUp/_build/latest?definitionId=20)\n[![Hound](https://img.shields.io/badge/hound_ci-checked-brightgreen.svg)](https://houndci.com/)\n[![Access Lint github](https://img.shields.io/badge/a11y-checked-brightgreen.svg)](https://www.accesslint.com)\n[![ImgBot](https://img.shields.io/badge/images-optimized-brightgreen.svg)](https://imgbot.net/)\n[![Renovate Bot github](https://img.shields.io/badge/renovatebot-checked-brightgreen.svg)](https://renovatebot.com/)\n[![Charity Ware](https://img.shields.io/badge/charity%20ware-thank%20you-brightgreen.svg)](https://github.com/GregTrevellick/MiscellaneousArtefacts/wiki/Charity-Ware)\n[![License](https://img.shields.io/github/license/gittools/gitlink.svg)](/LICENSE.txt)\n[![Subscribe](https://img.shields.io/badge/subscribe%20to%20receive%20notificatons-grey.svg)](https://github.com/GregTrevellick/SolutionOpenPopUp/subscription)\n \n[![Visual Studio Marketplace version](https://img.shields.io/badge/-SolutionOpenPopUp-%23e2165e.svg)](https://marketplace.visualstudio.com/items?itemName=GregTrevellick.SolutionOpenPopUp)\n[![Visual Studio Marketplace downloads](https://vsmarketplacebadge.apphb.com/installs/GregTrevellick.SolutionOpenPopUp.svg)](https://marketplace.visualstudio.com/items?itemName=GregTrevellick.SolutionOpenPopUp)\n[![Visual Studio Marketplace ratings](https://vsmarketplacebadge.apphb.com/rating/GregTrevellick.SolutionOpenPopUp.svg)](https://marketplace.visualstudio.com/items?itemName=GregTrevellick.SolutionOpenPopUp)\n[![Visual Studio Marketplace version](https://vsmarketplacebadge.apphb.com/version/GregTrevellick.SolutionOpenPopUp.svg)](https://marketplace.visualstudio.com/items?itemName=GregTrevellick.SolutionOpenPopUp)\n\n\n\n\u003c!--BadgesEND--\u003e\n\n[![](SolutionOpenPopUp/Resources/VsixExtensionPreview_175x175.png)][VSMarketplaceUrl]\n\nDownload this extension from the [VS Marketplace][VSMarketplaceUrl].\n\n---------------------------------------\n\n\u003c!--COPY START FOR VS GALLERY--\u003e\n\nDisplay the contents of certain text files in a solution folder in a pop-up when the solution is opened.\n\nIf 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. \n\n - *If you LIKE this ***FREE*** extension please give a star rating below, it only takes a few seconds*.\n\n - *If you LOVE this ***FREE*** extension please [help others][CharityWareURL].*\n\n![](SolutionOpenPopUp/Resources/ReadMe_AnimatedDemo.gif)\n\n\n## Use-Cases\n\nUse 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.\n\n![](SolutionOpenPopUp/Resources/ReadMeScreenShot_PopUpSolutionOpen.png)\n\n![](SolutionOpenPopUp/Resources/ReadMeScreenShot_PopUpBasic.png)\n\nFor example:\n\n - 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.\n\n - 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.\n\n - 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.  \n\n - The solution is simply a proof of concept and you wish to convey this to others.\n \n - Your solution has its' own \"ReadMe\" file which all developers should view when they open the solution.\n \n - You want to share a joke-of-the-day or coder-of-the-week announcement with colleagues.\n\n[Why build this extension?][WhyURL] \n\n## Features\n\n![](SolutionOpenPopUp/Resources/ReadMeScreenShot_OptionsGeneral.png)\n\n- Option to show/hide the content of SolutionOpenPopUp.txt in root folder of the solution in a pop-up when the solution is open.\n\n- Option to show/hide the content of ReadMe.txt in root folder of the solution in a pop-up when the solution is open.\n\n- Excessively long lines of text are truncated according to a user-defined value.\n\n- User-defined limit for maximum number of lines to be shown in pop-up.\n\n- If maximum lines limit is exceeded and multiple files are being displayed, the content of each file is truncated pro-rata.\n\n- Option to show/hide source file names in the pop-up.\n\n![](SolutionOpenPopUp/Resources/ReadMeScreenShot_PopUpWithFooter.png)\n\n\u003c!--COPY END FOR VS GALLERY--\u003e\n\n## Contribute\n\nContributions to this project are welcome by raising an [Issue][GitHubRepoIssuesURL] or submitting a [Pull Request][GitHubRepoPullRequestsURL].\n\n## License\n\n[MIT](/LICENSE.txt)\n\n## Credits\n\nThe following authors / articles deserve special mention for their help whilst creating this extension:\n\n[Ben](https://stackoverflow.com/questions/36035176/build-vs-2015-extension-on-build-server-without-vs-installed/43934701#43934701)\n\n[Mads Kristensen](https://channel9.msdn.com/Events/Build/2016/B886)\n\n[Joshua Thompson](http://schmalls.com/2015/01/19/adventures-in-visual-studio-extension-development-part-2)\n\n[Slaks.Blog](http://blog.slaks.net/2013-11-10/extending-visual-studio-part-2-core-concepts/)\n\n[![](./chart.png)][VSMarketplaceUrl]\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FGregTrevellick%2FSolutionOpenPopUp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FGregTrevellick%2FSolutionOpenPopUp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FGregTrevellick%2FSolutionOpenPopUp/lists"}