Skip to content

GregTrevellick/SolutionOpenPopUp

Repository files navigation

Solution Open Pop Up

Read Me Synchronizer BetterCodeHub compliance Codacy Badge CodeFactor GitHub top language Github language count GitHub issues GitHub pull requests GitHub followers GitHub stars GitHub watchers Sonar&metric=alert_status Sonar&metric=bugs Sonar&metric=code_smells Sonar&metric=coverage Sonar&metric=duplicated_lines_density Sonar&metric=ncloc Sonar&metric=reliability_rating Sonar&metric=security_rating Sonar&metric=sqale_index Sonar&metric=sqale_rating Sonar&metric=vulnerabilities Appveyor Build status Appveyor unit tests Azure Build Status Hound Access Lint github ImgBot Renovate Bot github Charity Ware License Subscribe

Visual Studio Marketplace version Visual Studio Marketplace downloads Visual Studio Marketplace ratings Visual Studio Marketplace version

Download this extension from the VS Marketplace.


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.

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?

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 or submitting a Pull Request.

License

MIT

Credits

The following authors / articles deserve special mention for their help whilst creating this extension:

Ben

Mads Kristensen

Joshua Thompson

Slaks.Blog

About

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.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published