nlook Essay Writing Extension

VSCode extension for nlook essay writing service with Google OAuth authentication and markdown file management.

Features

🔐 Authentication

• Google OAuth integration
• Secure token management
• Login/logout commands

📝 Markdown File Management

• Save current markdown file to nlook
• Batch save all markdown files
• Real-time file status indicators
• Smart file decorators showing save status

🎯 File Status Indicators

• 💾 Green: Ready to save to nlook
• ✅ Blue: Saved and up to date
• 🔄 Orange: Saved but modified (needs re-saving)

🚀 Project Management

• Register entire projects
• Automatic tagging with repository name
• Progress tracking during uploads
• Error handling with Korean messages

Installation

From VSCode Marketplace

1. Open VSCode
2. Go to Extensions (Ctrl+Shift+X)
3. Search for "nlook Essay Writing Extension"
4. Click Install

From VSIX File

code --install-extension nlook-vscode-0.0.7.vsix

Usage

Getting Started

1. Login: Use Command Palette (Ctrl+Shift+P) → "nlook: Login to nlook"
2. Save Files: Right-click on markdown files → "Save to nlook"
3. Monitor Status: File icons show save status automatically

Available Commands

• nlook.login - Login with Google account
• nlook.logout - Logout from nlook
• nlook.status - Show authentication status
• nlook.saveCurrentFile - Save current markdown file
• nlook.saveAllMarkdownFiles - Save all markdown files
• nlook.registerProject - Register entire project

Context Menus

• Right-click on markdown files in Explorer → "Save to nlook"
• Right-click in editor → "Save to nlook"

Requirements

• VSCode 1.74.0 or higher
• Active internet connection for authentication
• nlook account (sign up at nlook.me)

Development

Prerequisites

• Node.js (v16 or higher)
• npm or yarn
• Visual Studio Code

Setup

1. Clone the repository and navigate to the extension directory:

   cd vscode-extension
   

2. Install dependencies:

   npm install
   

3. Open the project in VSCode:

   code .
   

Building

• Development build: npm run compile
• Watch mode: npm run watch
• Production build: npm run package

Testing

1. Press F5 to open a new Extension Development Host window
2. Test the extension commands and functionality
3. Run unit tests: npm test

Linting

npm run lint

Project Structure

vscode-extension/
├── src/
│   ├── extension.ts          # Main extension entry point
│   ├── auth/                 # Authentication modules
│   ├── commands/             # Command implementations
│   ├── types/                # TypeScript type definitions
│   └── utils/                # Utility functions
├── package.json              # Extension manifest
├── tsconfig.json            # TypeScript configuration
├── webpack.config.js        # Build configuration
└── eslint.config.js         # Linting configuration

Architecture

This extension follows VSCode's best practices:

• Activation: Lazy activation on first command use
• Security: Secure token storage using VSCode SecretStorage
• Performance: Minimal resource usage when inactive
• User Experience: Clear status indication and error handling

OAuth Configuration

The extension uses the same Google OAuth configuration as the main nlook service for consistency and security. Make sure the OAuth client is properly configured to allow the VSCode extension callback URLs.

Contributing

1. Follow the TypeScript and ESLint configurations
2. Write tests for new functionality
3. Update documentation as needed
4. Ensure all builds pass before submitting

License

MIT License - see the main nlook repository for details.