Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jcs-elpa/indent-control
Generic control the indentation level for each mode.
https://github.com/jcs-elpa/indent-control
emacs indent
Last synced: 3 months ago
JSON representation
Generic control the indentation level for each mode.
- Host: GitHub
- URL: https://github.com/jcs-elpa/indent-control
- Owner: jcs-elpa
- License: gpl-3.0
- Created: 2019-07-30T03:47:28.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-21T10:05:00.000Z (7 months ago)
- Last Synced: 2024-07-21T11:23:21.662Z (7 months ago)
- Topics: emacs, indent
- Language: Emacs Lisp
- Homepage:
- Size: 87.9 KB
- Stars: 17
- Watchers: 4
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://jcs-emacs.github.io/jcs-elpa/#/indent-control)
[](https://melpa.org/#/indent-control)
[](https://stable.melpa.org/#/indent-control)
# indent-control
> Management for indentation level.
[](https://github.com/jcs-elpa/indent-control/actions/workflows/test.yml)
Interface that combine all the indentation variables from each major mode
to one giant list.
## 🏆 Features
* Decouple from user knowing each major mode's indentation level variable. (if have)
* Keep the indentation level across buffers. If you changed the indentation level
in `buffer A` and switch to `buffer B` with the same major mode; they will have
the same indentation level.
## 🔨 Usage
You can tweak variable `indent-control-records ` to set the initial
indentation level for each major mode.
```elisp
(setq indent-control-records
'((actionscript-mode . 4)
(c-mode . 4)
(c++-mode . 4)
(csharp-mode . 4)
...
(sql-mode . 1)
(typescript-mode . 4)
(web-mode . 2)
(yaml-mode . 2)))
```
### Change indentation level
These functions will change the current indentation level for the major mode
that you currently on.
* `indent-control-inc`
* `indent-control-dec`
You can tweak variable `indent-control-delta` to change the size of the one
indentation level. The default value is `2`.
### Make indentation work across all modes
Is easy to make indentation level inherit last time modified in Emacs.
Just enable the global minor mode `indent-control-mode` then it will
automatically records all changes from the indentation level.
This minor mode is already get called in `prog-mode-hook`, but with some
major modes that they do not use inherit `prog-mode` will not work!
You would have to manually called it in each mode's startup hook.
For instance `actionscript-mode` doesn't inherit `prog-mode` so you would
have to do the following.
```elisp
(defun my-actionscript-mode-hook ()
"My actionscript mode hook."
(indent-control-continue-with-record))
(add-hook 'actionscript-mode-hook #'my-actionscript-mode-hook)
```
## 🛠️ 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.