Projects
--(
Node.js Tools allows you to create projects using the Visual Studio project system. Project files (.njsproj) reference all the source and content files associated with your project, showing them all in the Solution Explorer window and enabling NTVS to most efficiently work with your files.
Like all Visual Studio languages, Node.js project files are referenced from a solution. Solutions can contain multiple projects, including those of different types, and projects can include references to each other.
By default, Node.js Tools shows all files. This means that files in the directory of the project are shown regardless of being in the .njsproj project file. They are shown as 'greyed out' but can be edited from within Node.js Tools. If you wish to add the item to the project, right click on the item in Solution Explorer and select 'Include in Project'.
Projects include a startup file, which will run when you start with debugging (F5) or execute with you run without (Shift-F5). This file is bolded in Solution Explorer. You can change the startup file by right-clicking and selecting "Set as Startup File" on the file you want to start with.
To create a new Node.js project you use the normal File->New Project command from Visual Studio. The Node.js project types are listed under the "JavaScript" and "TypeScript" language which will either be under "Installed Templates" or "Installed Templates\Other Languages" depending upon your settings.
--)
Node.js Tools for Visual Studio includes starter projects covering the most common scenarios. The primary differences in these starter projects are the files they include and the project settings. If you plan to publish to Azure we recommend starting with an Azure variety template. Don't worry just because you are using an Azure project type doesn't mean you must do everything in Azure. Also don't worry if you've started with the wrong project type as it is easy to change project settings without starting over. For those of you working with existing code there is also the from existing code wizard. If you wish to convert to an Azure project please view the documentation for [wiki:"converting to an Azure project type" AzureWebSiteWebDeploy#converting-to-an-azure-project-type].
This is a basic application that is a good starting point for any non-web Node.js project. With the default settings, your project will run and be debugged with the Node.js interpreter. After creation, you can add new modules and packages, edit files with intellisense, and interactively debug code.
This project will run and debug in the web browser. This is a good starting point for any web based Node.js application. After creation, you can add new modules and packages, edit files with intellisense, and interactively debug code.
This project is based on the standard Node.js Express template. This project will run and debug in the web browser. After creation you can add new apps to the project, add new packages and modules, edit page templates, and interactively debug code.
This is the basic web application pre-configured to run in Windows Azure.
This is a basic Node.js Express 3 Application pre-configured to run in Windows Azure.
This is a starter Node.js Express 3 Application pre-configured to run in Windows Azure.
This is a basic Node.js Express 4 Application pre-configured to run in Windows Azure.
Create Project from Existing Files ----------------------------------If you already have existing Node.js code, you can easily start working with it NTVS. There is no need to copy the code around. To get started, open up File->New Project and navigate to "From Existing Node.js Code":
This will display the following wizard, where you can choose the path containing your existing code, a filter to include specific file types, and any search paths that your project requires.
On the next page, you can choose the file to run when you press F5. (Only files in the root of the folder tree are shown, so if the one you want is not there, don't choose anything for now and set it later.) There is also the option to exclude the node_modules folder. Excluding the node_modules folder from the project system is the preferred method.
On the final page, you can select the location to save the project file. Choosing another location does not move or copy the original source files, so if you want a copy you should make one before starting the wizard.
Click Finish and your project will be created. If you want to move the .njsproj file somewhere else at this point, select it in Solution Explorer and choose 'File->Save As'. Moving the .njsproj this way will update the file references, so we don't have to copy any code files around, but adds, deletes, and renames will affect the original files.
Visual Studio contains two separate editors for .js files. By default, when you open a .js file from a Node.js Project, we will launch using the Node.js Editor. If you wish to open the file with the client side JavaScript editor, change the Build Action of the item from 'Compile' to 'Content'. Changing the action type to content will also stop us from analysing your client side code as server side Node.js code. For stopping analysis on directories, please view the section on [wiki:"ignoring directories for analysis" Projects#ignoring-directories-for-analysis].
It may be useful to ignore certain directories, such as client side JavaScript, from analysis. There are many reasons to do this but the biggest two are:
- the particular directory is large and takes a great deal of time to analyse.
- The directory contains client side code that doesn't need to be analysed.
There is a property in the .njsproj file that can be used to ignore directories. The following code can be added to the project file under a PropertyGroup:
<PropertyGroup>
<!-- Specifies the directories which are ignored. Any paths which contain these directory names
will be ignored. The directory name must completely match and no wild cards are allowed
-->
<AnalysisIgnoredDirectories>bower_components;dir_not_included</AnalysisIgnoredDirectories>
</PropertyGroup>This property takes precedence over other settings. This includes whether you included the file in your project or not. If you specify a directory here as ignore it will not be analysed.
--(
Linked files appear in Solution Explorer as normal files with a shortcut icon overlayed on top of them. Linked files can exist either at the top-level of the project or embedded within an arbitrary folder structure.
--)
Linked files are specified in the .njsproj file using the normal <Compile Include="..."> tag. They can be implicit linked files if they use a relative path outside of the directory structure or they can be explicit link files by specifying their path within Solution Explorer:
<Compile Include="..\test2.js">
<Link>X\test2.js</Link>
</Compile>
Linked files specified in a project file will be ignored under the following conditions:
- The linked file contains Link metadata and the path specified in the Include attribute lives within the project directory, or
- The linked file duplicates a file which exists within the project hierarchy, or
- The linked file contains Link metadata and the Link path is a relative path outside of the project hierarchy, or
- The link path is rooted
To add an existing item as a link, use the Project->Add Existing Item menu (or the context menu), select a file, and choose "Add as Link" from the drop down on the Add button. As long as there are no conflicting files, this will create a link in the folder selected in Solution Explorer. If there is already a file with the same name, or if a link to the file is already in the project, the link will not be added.
Because you can't add a link to a file that is already within the project hierarchy, such a file will be added to the project in the correct location as a normal file instead of a link.
To convert a file into a link, use File->Save As to save the file to a location outside of the project hierarchy. It will be automatically converted to a link. Similarly, a link can be converted back by using File->Save As to save the file somewhere within the project hierarchy. The file will appear in Solution Explorer in the same location it exists on disk; files in a project must match their actual location.
If you move a linked file in Solution Explorer, the link will be moved but the actual file is unaffected. Similarly, deleting a link will remove the link without affecting the file. Linked files cannot be renamed.