Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jcs-elpa/project-abbrev
Customize your own abbreviation expansion in the project.
https://github.com/jcs-elpa/project-abbrev
abbreviations emacs expression productivity
Last synced: 3 months ago
JSON representation
Customize your own abbreviation expansion in the project.
- Host: GitHub
- URL: https://github.com/jcs-elpa/project-abbrev
- Owner: jcs-elpa
- License: gpl-3.0
- Created: 2018-06-03T09:16:55.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-21T09:40:39.000Z (7 months ago)
- Last Synced: 2024-07-21T10:48:02.617Z (7 months ago)
- Topics: abbreviations, emacs, expression, productivity
- Language: Emacs Lisp
- Homepage:
- Size: 270 KB
- Stars: 10
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://melpa.org/#/project-abbrev)
[](https://stable.melpa.org/#/project-abbrev)
# project-abbrev
> Customize your own abbreviation expansion in the project.
[](https://github.com/jcs-elpa/project-abbrev/actions/workflows/test.yml)
## 🧪 Configuration
Name your own customize abbreviation config file. The default name
is `project-abbrev.config`.
```el
(setq project-abbrev-config-file "project-abbrev.config")
```
## ⌨️ Key Bindings
Complete the current word that point currently on.
```el
(define-key global-map (kbd "C-") #'project-abbrev-complete-word)
```
## 🏚️ Config Example
This is example of the `project-abbrev.config` file. Notice this can be customize
in any programming language or even just a text file as long as you follow this format.
```ini
#
# Customize all the expand shortcut here.
#
# Java
sysout=System.out.println();
syserr=System.err.println();
```
## 🛠️ Contribute
[](http://makeapullrequest.com)
[](https://github.com/bbatsov/emacs-lisp-style-guide)
[](https://www.paypal.me/jcs090218)
[](https://www.patreon.com/jcs090218)
If you would like to contribute to this project, you may either
clone and make pull requests to this repository. Or you can
clone the project and establish your own branch of this tool.
Any methods are welcome!
### 🔬 Development
To run the test locally, you will need the following tools:
- [Eask](https://emacs-eask.github.io/)
- [Make](https://www.gnu.org/software/make/) (optional)
Install all dependencies and development dependencies:
```sh
$ eask install-deps --dev
```
To test the package's installation:
```sh
$ eask package
$ eask install
```
To test compilation:
```sh
$ eask compile
```
**🪧 The following steps are optional, but we recommend you follow these lint results!**
The built-in `checkdoc` linter:
```sh
$ eask lint checkdoc
```
The standard `package` linter:
```sh
$ eask lint package
```
*📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.*
## ⚜️ License
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
See [`LICENSE`](./LICENSE.txt) for details.