NFS Team Development Extension & Instructions
🎯 What This Repository Provides
This is the **complete NFS develo## 🔧 Configuration
The extension comes ready-to-use with NFS Azure Artifacts feeds pre-configured!
Optional: Add Authentication for Live Updates
To get the latest snippets and instructions from Azure Artifacts feeds (optional):
Settings → Extensions → NFS Team Development Toolkit
{
"commonSnippets.organizationToken": "your-azure-devops-pat-token",
"commonSnippets.autoRefresh": true,tributed as a single VS Code extension. Install this extension and your team gets instant access to:
- ✅ **Complete development instructions** integrated with AI assistance
- 🔧 **Team-specific code snippets** (SQL, C#, TypeScript)
- 📚 **System architecture guides** accessible via Command Palette
- 🚀 **Onboarding automation** for new developers
## 📦 One Extension = Complete Team Productivity
## 🚀 New Machine Quick Start
### For New Developers (Full Automation)
1. **Install** the extension from VS Code Marketplace
2. **Open** an empty folder where you want your development workspace
3. **Run Command**: `Ctrl+Shift+P` → `NFS: Quick Setup (New Machine)`
4. **Choose**: "Full Setup (Clone All + Workspace)"
5. **Enter**: Your Azure DevOps organization URL when prompted
6. **Wait**: Extension clones all 7 repositories and creates workspace
7. **Done**: Complete NFS development environment ready!
### For Existing Setups
1. **Install** the extension from VS Code Marketplace
2. **Add your Azure DevOps PAT token** for organization feeds (optional, for latest snippets)
3. **Type** snippet prefixes in your code files (e.g., `sel`, `ins`, `upd` for SQL)
4. **Access guides** via Command Palette (`Ctrl+Shift+P` → `NFS:`)
## 📝 Adding & Editing Snippets
### File Structure
snippets/
├── sql.json # SQL snippets
├── csharp.json # C# snippets
├── javascript.json # JavaScript/TypeScript snippets
└── python.json # Add new languages as needed
### Snippet Format
Each snippet file uses VS Code's standard format:
```json
{
"Snippet Name": {
"prefix": "trigger",
"body": [
"Line 1 with ${1:placeholder}",
"Line 2 with ${2:another_placeholder}"
],
"description": "What this snippet does"
}
}
Adding a New Snippet
Example: Adding a Python function
- Open/create
snippets/python.json
- Add snippet:
{
"Python Function": {
"prefix": "pyfunc",
"body": [
"def ${1:function_name}(${2:parameters}):",
" \"\"\"${3:Description}\"\"\"",
" ${4:# Your code here}",
" return ${5:None}"
],
"description": "Python function with docstring"
}
}
- Register language in
package.json
(if new):
{"language": "python", "path": "./snippets/python.json"}
- Reload: Command Palette → "Refresh Common Snippets"
- Test: Type
pyfunc
in a Python file
Editing Existing Snippets
- Open the relevant
.json
file (e.g., snippets/sql.json
)
- Find and modify the snippet you want to change
- Save - changes are automatically loaded
Advanced Features
- Tab stops:
${1:placeholder}
→ ${2:next}
→ ${0:final}
- Choices:
${1|option1,option2,option3|}
- Variables:
$TM_FILENAME
, $CURRENT_YEAR
- Transformations:
${1/find/replace/flags}
Team Workflow
- Edit snippets in
snippets/*.json
files
- Commit changes:
git add snippets/ && git commit -m "Add new snippets"
- Push to repository
- Team gets updates automatically when they pull changes
Commands
🚀 New Machine Setup (Automation)
- NFS: Quick Setup (New Machine): One-command setup for new developers
- NFS: Clone All Repositories: Automatically clone all 7 NFS repositories
- NFS: Create Multi-Repository Workspace: Generate and open VS Code workspace
- NFS: Check Development Environment: Verify required tools are installed
Snippet Commands
- Show Available Snippets: Browse all snippets by language
- Show SQL Snippets: Quick access to SQL snippets
- Refresh Common Snippets: Reload after editing
- Manage Snippets: Snippet management interface
Documentation Commands
- NFS: Show Architecture Guide: View development guides (if configured)
- NFS: Show Debugging Methodology: View debugging best practices (if configured)
- NFS: Show Quick Reference: View command references (if configured)
- NFS: Show Onboarding Guide: Complete new developer checklist
Access via Command Palette (Ctrl+Shift+P
)
� Configuration
Connect to Your Team's Feed
Configure the extension to use your organization's snippet and documentation feeds:
Settings → Extensions → Common Snippet
{
"commonSnippets.feedUrls": [
"https://your-server.com/api/snippets/sql.json",
"https://your-server.com/api/snippets/javascript.json"
],
"commonSnippets.instructionUrls": [
"https://your-server.com/docs/architecture-guide.md",
"https://your-server.com/docs/debugging-guide.md"
],
"commonSnippets.autoRefresh": true,
"commonSnippets.refreshInterval": 60
}
Azure DevOps / Azure Artifacts Integration
For Azure DevOps organizations:
{
"commonSnippets.feedUrls": [
"https://pkgs.dev.azure.com/[YOUR_ORG]/[PROJECT_NAME]/_apis/packaging/feeds/snippets/packages/sql-snippets/versions/latest/content"
],
"commonSnippets.organizationToken": "[YOUR_AZURE_DEVOPS_PAT_TOKEN]"
}
Local Development
Use local files for development:
{
"commonSnippets.feedUrls": [
"file:///path/to/your/snippets/sql.json"
]
}
Examples
SQL (snippets/sql.json
)
{
"Inner Join": {
"prefix": "ij",
"body": [
"INNER JOIN ${1:table} ${2:alias}",
" ON ${3:condition}"
],
"description": "INNER JOIN clause"
}
}
C# (snippets/csharp.json
)
{
"API Controller": {
"prefix": "apicontroller",
"body": [
"[ApiController]",
"[Route(\"api/[controller]\")]",
"public class ${1:Name}Controller : ControllerBase",
"{",
" [HttpGet]",
" public ActionResult<${2:Model}> Get() => Ok();",
"}"
],
"description": "ASP.NET Core API Controller"
}
}
JavaScript (snippets/javascript.json
)
{
"React Hook": {
"prefix": "rhook",
"body": [
"export const use${1:Hook} = () => {",
" const [${2:state}, set${2/(.*)/${2:/capitalize}/}] = useState(${3:null});",
" return { ${2:state}, set${2/(.*)/${2:/capitalize}/} };",
"};"
],
"description": "Custom React Hook"
}
}
Getting Started
- Install from VS Code Marketplace
- Use built-in snippets immediately (SQL, C#, JavaScript)
- Configure team feeds in settings (optional)
- Add custom snippets to local
snippets/
directory
Troubleshooting
- Snippet not appearing? Check file type and use "Refresh Common Snippets"
- JSON errors? Use VS Code's built-in JSON validation
- After major changes? Restart VS Code
Features
- 🔄 Auto-loading snippets on startup
- 📁 Language-organized snippet files
- � Remote feed synchronization
- 🔐 Secure organization integration
- 📋 Configurable notifications
- 🏢 Team collaboration support
Security & Privacy
- ✅ Only connects to URLs you configure
- ✅ No default external connections
- ✅ Organization resources require authentication
- ✅ Local files supported for offline development
For support, contact your organization's IT administrator or extension provider.