How do you share scripts among multiple projects in one solution?

Solution 1:

Here is what I would recommend:

Right click the solution and create a New Solution Folder called Common Javascript Files (or whatever you feel like calling it.

Right click on the Solution, click Open Folder in Windows Explorer, or navigate there manually for other versions of Visual Studio :(

In the solution directory, create a directory with the same name as the solution folder (solution folders do not normally match directories at the source code level but this will for sanity sake).

In this new directory, add files that need to be shared between solutions.

In Visual Studio, click the solution folder and select Add - Existing Item.

In the file selection dialog, navigate to the directory previous created, select the file(s) added to the directory and click Add.

In each Project that needs a shared file, right click on the project (or directory within the project) and click Add - Existing Item.

Navigate to the shared Directory, Select the files and click the drop down arrow then click Add As Link.

Now the files in the projects are essentially short cuts to the files in the Solution Folder. But they are treated as actual files in the project (this includes .CS or Visual Basic files, they will be compiled as files that actually exist in the project).

PROS

• Files are truly shared across projects at Design time
• Only the files needed for each project can be added, it's not all or nothing
• Does not require any configuration in IIS (virtual directory etc)
• If the solution is in TFS Source control, you can add the Directory to the TFS Source and the shared files will be source controlled.
• Editing a file by selecting it in the Project, will edit the actual file.
• Deleting a Linked file does not delete the file.
• This is not limited to JS files, linked files can be ANY file you might need (Images, Css, Xml, CS, CSHTML, etc)

CONS

• Each deployment gets it's own file.
• There is a small learning curve when understanding that Solution Folders are not Directories that exist in a Solution Directory.

Solution 2:

The best thing to do, imo, is to roll your own CDN... Basically just create another site in IIS and give it it's own binding, e.g. "http://cdn.somedomain.com"

Then store all of your css/js/fonts/shared images etc on the CDN site and link to them from your other sites.

Doing so solves 2 problems,

1. All of your stuff is shared when it needs to be and you only have to manage 1 revision per file.
2. Your users browsers can cache them in 1 single location instead of downloading copies of your stuff for every site that uses them..

I added this answer because I see a lot of people referrencing creating virtual directories. While that does indeed share the files, it creates multiple download paths for them which is an extreme waste of bandwidth. Why make your users download jquery.js (1 * number of sites) when you can allow them to download it once on (cdn.somedomain.com).

Also when I say waste of bandwidth, I'm not just talking about server bandwidth, I'm talking about mobile users on data plans... As an example, I hit our companies HR site (insuance etc) on my phone the other day and it consumed 25mb right out the gate, downloaded jquery and a bunch of stuff 5 times each... On a 2gb a month data plan, websites that do that really annoy me.