Dfact Extension

A VS Code and Cursor extension for Dfact project management and deployment.

Features

• Authentication: Secure login/logout functionality with browser-based authentication
• Project Management: Create and manage projects with Applications and Services
• Build Templates: Choose from various build templates and frameworks
• Deployment: Deploy applications with environment-specific configurations
• Log Management: Fetch and view deployment logs
• Dictionary Editor: Edit configuration dictionaries through a web interface

Supported Editors

This extension is compatible with both:

• VS Code (v1.91.0+)
• Cursor (v1.0.0+)

Installation

For VS Code

1. Open VS Code
2. Go to Extensions (Ctrl+Shift+X)
3. Search for "Dfact Extension"
4. Click Install

For Cursor

1. Open Cursor
2. Go to Extensions (Ctrl+Shift+X)
3. Search for "Dfact Extension"
4. Click Install

Usage

Authentication

1. Click on the Dfact icon in the activity bar
2. Click "Login" to authenticate
3. Follow the browser-based authentication flow
4. Your tokens will be securely stored

Creating Projects

1. Right-click on a folder in the explorer
2. Select "Create Projects" to create a new project structure
3. Choose your build template and framework
4. Configure your application preferences

Deployment

1. Right-click on your application folder
2. Select "Deploy" to deploy your application
3. Choose your target environment
4. Monitor deployment progress

Viewing Logs

1. Right-click on your service folder
2. Select "Fetch Logs" to retrieve deployment logs
3. Logs will be saved locally for review

Commands

The extension provides several commands accessible through the command palette:

• Authentication.login - Login to Dfact
• Authentication.logout - Logout from Dfact
• Authentication.testToken - Test your authentication token
• extension.createApp - Create a new application
• extension.createAppService - Create a new application service
• extension.chooseBuild - Choose a build template
• extension.triggerBuild - Trigger a build
• extension.openGrid - Open dictionary editor
• extension.saveBuild - Save build configuration
• extension.choosePreference - Choose application preferences
• extension.fetchLogs - Fetch deployment logs
• extension.deploy - Deploy application

Configuration

The extension uses secure storage for authentication tokens and maintains state for:

• Read-only files
• Workshop folder names
• User preferences

Development

Building the Extension

npm install
npm run compile

Running Tests

npm test

Development Mode

npm run watch

Compatibility Notes

• The extension automatically detects whether it's running in VS Code or Cursor
• All VS Code APIs used are compatible with Cursor
• Webview resources use the appropriate URI scheme for each editor
• Authentication flow works identically in both editors

Troubleshooting

Authentication Issues

• Ensure you have a valid Dfact account
• Check that your browser allows popups for the authentication flow
• Try logging out and logging back in

Build Issues

• Verify that you have selected a valid framework and template
• Check that your project structure follows the expected format
• Ensure you have the necessary permissions for your organization

Deployment Issues

• Verify that your application is properly configured
• Check that your target environment is available
• Review deployment logs for specific error messages

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests if applicable
5. Submit a pull request

License

This extension is provided as-is for learning purposes.

Support

For issues and questions, please check the extension's documentation or contact the development team.