{"id":13646521,"url":"https://github.com/emacs-eclim/emacs-eclim","last_synced_at":"2025-04-21T21:30:52.476Z","repository":{"id":137917258,"uuid":"65601693","full_name":"emacs-eclim/emacs-eclim","owner":"emacs-eclim","description":"This project brings some of the great eclipse features to emacs developers. It is based on the eclim project, which provides eclipse features for vim. Development from senny/emacs-eclim has moved here.","archived":false,"fork":false,"pushed_at":"2020-05-07T15:31:10.000Z","size":1033,"stargazers_count":165,"open_issues_count":18,"forks_count":29,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-11-09T20:37:38.285Z","etag":null,"topics":["eclim","eclim-mode","emacs","java"],"latest_commit_sha":null,"homepage":"http://www.emacswiki.org/emacs/EmacsEclim","language":"Emacs Lisp","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/emacs-eclim.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2016-08-13T05:50:12.000Z","updated_at":"2024-08-08T15:16:32.000Z","dependencies_parsed_at":"2024-01-14T10:00:48.218Z","dependency_job_id":"98b856c8-0d2f-4dfe-b42f-a38b9d6e777a","html_url":"https://github.com/emacs-eclim/emacs-eclim","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emacs-eclim%2Femacs-eclim","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emacs-eclim%2Femacs-eclim/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emacs-eclim%2Femacs-eclim/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emacs-eclim%2Femacs-eclim/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/emacs-eclim","download_url":"https://codeload.github.com/emacs-eclim/emacs-eclim/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250136634,"owners_count":21380870,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["eclim","eclim-mode","emacs","java"],"created_at":"2024-08-02T01:02:58.033Z","updated_at":"2025-04-21T21:30:52.211Z","avatar_url":"https://github.com/emacs-eclim.png","language":"Emacs Lisp","funding_links":[],"categories":["Emacs Lisp"],"sub_categories":[],"readme":"[![License GPL 3][badge-license]](http://www.gnu.org/licenses/gpl-3.0.txt)\n[![Build Status](https://travis-ci.org/emacs-eclim/emacs-eclim.svg?branch=master)](https://travis-ci.org/emacs-eclim/emacs-eclim)\n[![Coverage Status](https://coveralls.io/repos/github/emacs-eclim/emacs-eclim/badge.svg?branch=master)](https://coveralls.io/github/emacs-eclim/emacs-eclim?branch=master)\n[![MELPA](http://melpa.org/packages/eclim-badge.svg)](http://melpa.org/#/eclim)\n[![MELPA Stable](http://stable.melpa.org/packages/eclim-badge.svg)](http://stable.melpa.org/#/eclim)\n[![Open Source Helpers](https://www.codetriage.com/emacs-eclim/emacs-eclim/badges/users.svg)](https://www.codetriage.com/emacs-eclim/emacs-eclim)\n\n# No Longer Maintained\n\nThis package is no longer maintained.\n\nA better Java programming environment can be set up using [lsp-java](https://github.com/emacs-lsp/lsp-java). Please consider using it instead.\n\n# Overview\n\n[![Join the chat at https://gitter.im/emacs-eclim/emacs-eclim](https://badges.gitter.im/emacs-eclim/emacs-eclim.svg)](https://gitter.im/emacs-eclim/emacs-eclim?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\n[Eclim](http://eclim.org) is an Eclipse plugin which exposes Eclipse\nfeatures through a server interface. When this server is started, the\ncommand line utility `eclim` can be used to issue requests to that\nserver.\n\nThe eclim package uses the Eclim Server to integrate Eclipse with\nEmacs. This project wants to bring some of the invaluable features\nfrom Eclipse to Emacs. Please note, the eclim package **is limited to\nmostly Java support at this time.**\n\nIt is also possible to start and stop the eclim daemon from Emacs using the\n`eclimd` package.\n\nYou can ask questions or discuss new features on the Gitter channel\n(see badge above), and at\nour\n[Google Group](https://groups.google.com/forum/#!forum/emacs-eclim)\n\n## Package renamed\n\nThis package was originally called *emacs-eclim*, and was renamed to\n*eclim* on August 15, 2016 because `use-package` could not load it from\nthe [MELPA][melpa] package archive.\n\n# A note about Eclim versions\n\nPrior to version 1.7.3, Eclim used a proprietary protocol for\ncommunication with the Eclim Server. If you are running one of these\nolder versions, you need version 0.1 of this package.\n\nEclim versions 1.7.3 and later however, serves responses using a\nstandard JSON format. These are supported by versions 0.2\nand later of this package.\n\nThe eclim package versions are tagged with the appropriate version\nnumber. You can see and download previous\nreleases [here](https://github.com/emacs-eclim/emacs-eclim/tags).\n\n# Installation\n\nemacs-eclim requires Emacs version 24.5 or later.\n\n1. [Download and install](http://eclim.org/install.html) eclim.\n1. Install emacs-eclim. You have two options:\n   * Installation from the [MELPA][melpa] package archive. Just\n     [add the archive to `package-archives`](https://melpa.org/#/getting-started)\n     if you haven't already, and then install the \"eclim\" package with the\n     `package-install` command.\n   * Manual installation from GitHub.\n       1. (`git clone git://github.com/emacs-eclim/emacs-eclim.git`)\n       1. Add `(add-to-list 'load-path \"/path/to/emacs-eclim/\")` to your startup\n          script.\n       1. Make sure all dependencies are available, see\n          [`eclim-pkg.el`](eclim-pkg.el).\n1. Add the following code to your emacs startup script:\n\n    ```emacs-lisp\n    (require 'eclim)\n    (setq eclimd-autostart t)\n\n    (defun my-java-mode-hook ()\n        (eclim-mode t))\n\n    (add-hook 'java-mode-hook 'my-java-mode-hook)\n    ```\n    Or, if you prefer to enable eclim-mode globally:\n\n    ```emacs-lisp\n    (require 'eclim)\n    (setq eclimd-autostart t)\n    (global-eclim-mode)\n    ```\n\n    If you wish to start\n    the [Eclim Server](http://eclim.org/#how-do-i-get-install-it)\n    outside of Emacs, then set `eclimd-autostart` to `nil`.\n\nNow every time you open a file that belongs to a Eclipse project eclim mode is\nenabled.\n\n# Configuration\n\n## Eclipse installation\n\nEmacs-eclim tries its best to locate your Eclipse installation. If you\nhave Eclipse installed in a non-standard location (i.e.\n`~/nonStandard/eclipse` or `/opt/eclipse`) you may specify the paths\nmanually by adding this to your startup script:\n\n```emacs-lisp\n(custom-set-variables\n  '(eclim-eclipse-dirs '(\"~/nonStandard/eclipse\"))\n  '(eclim-executable \"~/nonStandard/eclipse/eclim\"))\n```\n\n## Displaying compilation error messages in the echo area\n\nWhen the cursor is positioned on an error marker in a code buffer,\nemacs-eclim uses the local help feature in emacs to display the\ncorresponding error message in the echo area. You can either invoke\n`(display-local-help)` manually or activate automatic display of local\nhelp by adding the following to .emacs:\n\n```emacs-lisp\n(setq help-at-pt-display-when-idle t)\n(setq help-at-pt-timer-delay 0.1)\n(help-at-pt-set-timer)\n```\n\n## Configuring auto-complete-mode\n\nIf you wish to use [auto-complete-mode] with emacs-eclim, add the\nfollowing to your .emacs:\n\n```emacs-lisp\n;; regular auto-complete initialization\n(require 'auto-complete-config)\n(ac-config-default)\n\n;; add the emacs-eclim source\n(require 'ac-emacs-eclim-source)\n(ac-emacs-eclim-config)\n```\n\n## Configuring company-mode\n\nEmacs-eclim can integrate with [company-mode] to provide pop-up\ndialogs for auto-completion. To activate this, you need to add the\nfollowing to your .emacs:\n\n```emacs-lisp\n(require 'company)\n(require 'company-emacs-eclim)\n(company-emacs-eclim-setup)\n(global-company-mode t)\n```\n\nEmacs-eclim completions in company are case sensitive by default. To\nmake completions case insensitive set\n`company-emacs-eclim-ignore-case` to `t`.\n\nIf you installed Eclim from [MELPA](melpa) you will have to install\n`company-emacs-eclim` as well. Add the archive to package-archives if\nyou haven't already, and then install the `company-emacs-eclim`\npackage with the `package-install` command.\n\n## Configuring eclimd module\n\nWhen `emacs-eclim` is configured correctly, you don't need to modify the\nconfiguration for the `eclimd` package. Still, in the customization group\n`eclimd` there are a few variables you can tweak.\n\n# Usage\n\nTo use `eclim-mode`'s features `eclimd` must to be running (`M-x eclimd-start`\nor set `eclimd-autostart` to `t`) and the files you are editing have to be\norganized in a Eclipse project (`M-x eclim-project-create`).\n\n* [Projects](http://wiki.github.com/emacs-eclim/emacs-eclim/projects)\n* [Code Completion](http://wiki.github.com/emacs-eclim/emacs-eclim/code-completion)\n* [Java](http://wiki.github.com/emacs-eclim/emacs-eclim/java)\n* [Ant](http://wiki.github.com/emacs-eclim/emacs-eclim/ant)\n* [Maven](http://wiki.github.com/emacs-eclim/emacs-eclim/maven)\n* [Problems and Errors](http://wiki.github.com/emacs-eclim/emacs-eclim/problems-and-errors)\n\n## Starting eclimd\n\nSince most of eclim's commands require eclimd, you should ensure eclimd is\nrunning when you need it. Here are your options:\n\n* Variable `eclimd-autostart`: Enables automatic starting of eclimd whenever\n  `eclim-mode` is enabled or when `global-eclim-mode` needs it.\n* Use the commands `start-eclimd` and `stop-eclimd`.\n* Start `eclimd` manually using Eclipse or a shell. If you always want to start\n  eclimd like this you should add `(setq eclimd-autostart nil)` to your startup\n  script to prevent accidental starting of eclimd from within Emacs.\n\n# Compiling this package\n\nThis package uses [Cask](https://github.com/cask/cask) to compile and\ntest the project. Please install it prior to compiling the files.\nPackage dependencies are installed using the `make init` command in a\nshell. Once dependencies have been installed, use `make compile` to\ncompile the files.\n\n# Press\n\nRead more about emacs-eclim:\n\n* [Enterprise Java Development in Emacs](http://www.skybert.net/emacs/java/), \\[Torstein Krause Johansen\\]\n* [The Ballad of Emacs-Eclim](http://fredrik.appelberg.me/2012/02/02/the-ballad-of-emacs-eclim/), \\[Fredrik Appelberg\\]\n* [Emacs and Java](http://blog.senny.ch/blog/2012/10/13/emacs-and-java-journey-of-a-hard-friendship/), \\[Yves Senn\\]\n* [Java Autocompletion for Emacs](http://root42.blogspot.ch/2012/08/java-autocompletion-for-emacs.html), \\[root42\\]\n* [Eclim: Eclipse Meets Vim And Emacs](http://faruk.akgul.org/blog/eclim-eclipse-meets-vim-emacs/), \\[Faruk Akgul\\]\n\n# Contributing\n\nHave a quick look at our [Contribution Guidelines](doc/CONTRIBUTING.md)\nand hack away.\n\n[company-mode]:https://github.com/company-mode/company-mode\n[auto-complete-mode]:https://github.com/auto-complete/auto-complete\n[melpa]:https://melpa.org/#/\n[repo]:https://github.com/emacs-eclim/emacs-eclim\n\n[badge-license]: https://img.shields.io/badge/license-GPL_3-green.svg\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femacs-eclim%2Femacs-eclim","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Femacs-eclim%2Femacs-eclim","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femacs-eclim%2Femacs-eclim/lists"}