diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..25b815b --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,29 @@ +version: 2 + +updates: + - package-ecosystem: 'npm' + directory: '/' + schedule: + interval: 'monthly' + open-pull-requests-limit: 3 + groups: + npm-dependencies: + patterns: + - '*' + labels: + - 'dependencies' + commit-message: + prefix: 'deps' + + - package-ecosystem: 'github-actions' + directory: '/' + schedule: + interval: 'monthly' + groups: + github-actions: + patterns: + - '*' + labels: + - 'dependencies' + commit-message: + prefix: 'deps' diff --git a/README.md b/README.md index 2d0ab6e..f5457d8 100644 --- a/README.md +++ b/README.md @@ -10,80 +10,46 @@ Frilingo helps developers understand code, error messages, comments, documentati ### Translate Selected Text -Translate selected text directly inside VSCode. - -```text -Select text -↓ -Run command -↓ -Receive translated result -``` - -### Generate Code Comments - -Generate clear and readable code comments from selected code. - -```ts -const count = map.entry(word).orInsert(0); -``` - -```ts -// Return the existing value for the key. -// Insert 0 when the key does not exist. -const count = map.entry(word).orInsert(0); -``` - -### Local LLM Support - -Frilingo works with local models through Ollama. +Translate the current editor selection using a local Ollama model. -Supported models include: +### Translate Comments and Annotations -- EXAONE -- Qwen -- DeepSeek -- Any Ollama-compatible model +Quickly translate documentation, comments, and annotations without leaving the editor. -### Korean-First Workflow +### Local AI Models -Frilingo is designed for developers who frequently work with: - -- English documentation -- Compiler errors -- Open source projects -- Technical discussions - -## Roadmap +Use local models through Ollama. -### v0.1 +Examples: -- Translate selected text -- Ollama integration -- EXAONE support +- gemma3:4b +- qwen3:4b +- llama3.1 -### v0.2 +### Ollama Integration -- Activity Bar panel -- Translation history +Manage local models directly from VS Code. -### v0.3 +- Start Ollama +- List installed models +- Pull recommended models +- Check runtime status -- Comment generation +## Requirements -### v0.4 +### Install Ollama -- Multi-language support +Download and install Ollama: -### v1.0 +https://ollama.com/download -- Marketplace release +### Pull a Model -## Requirements +Example: -- VSCode -- Node.js 22+ -- Ollama +```bash +ollama pull gemma3:4b +``` ## Development @@ -93,23 +59,40 @@ Install dependencies: npm install ``` -Run extension host: +Run type checking: ```bash -F5 +npm run check-types ``` -Build project: +Run lint: ```bash -npm run compile +npm run lint ``` -## Contributing +Run smoke test: + +```bash +npm run test:ollama +``` + +## Roadmap + +- [x] Ollama integration +- [x] Selection translation +- [x] Model management +- [ ] Hover translation +- [ ] Inline replacement +- [ ] Multiple language support +- [ ] Translation caching +- [ ] User settings + +## Known Issues -Contributions are welcome. +Some reasoning-oriented models may generate explanations instead of direct translations. -Please read the contributing guide before submitting a pull request. +For translation-focused workflows, models such as gemma3 are recommended. ## License