node-csproj-util/README.md

Edit Visual Studio project files using Node.js

# node-csproj-util

## Edit Visual Studio project files using Node.js

This library allows you to add files to be included in a .csproj and .sln file. For example, any templates created by Node.js code generators can be included in compilation of the Visual Studio solution.

## Installation

        npm install node-csproj-util

## Usage

### Reading from a .sln file
```javascript
    var { Solution } = require('node-csproj-util');
    
    (async function() {
        const sln = new Solution('examples/TestSolution/TestSolution.sln');
        await sln.read();
        console.log(sln.projects);
        ...
    })();
```

### Reading from a .proj file

Project in a solution:
```javascript
        ...
        const proj = sln.projects[0];
        await proj.read();
        ...
```
Directly loading a project:
```javascript
        ...
        const proj = new Project({ filePath: 'examples/TestSolution/TestProject/TestProject.csproj' });
        await proj.read();
        ...
```


### Adding files to project
```javascript
        ...
        // included in compilation
        proj.add('content/testClass.cs');
        // added as content
        proj.add('content/testImage.png');
        await proj.save();
        ...
```

### Adding to solution folders
```javascript
        ...
        // you can create or use an existing one
        const folder = sln.addFolder('MyFolder');
        sln.addToFolder(folder, proj);
        await sln.save();
        ...
```
You can create or use an existing one, since they are not actual folders, get them using the `Solution.projects` property.