Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zephir-lang/zephir-mode

A GNU Emacs major mode for editing Zephir code
https://github.com/zephir-lang/zephir-mode

editor-plugin emacs emacs-mode emacs-package major-mode zephir zephir-language

Last synced: 1 day ago
JSON representation

A GNU Emacs major mode for editing Zephir code

Awesome Lists containing this project

README

        

* Zephir Mode for GNU Emacs

[[https://melpa.org/#/zephir-mode][https://melpa.org/packages/zephir-mode-badge.svg]]
[[https://stable.melpa.org/#/zephir-mode][https://stable.melpa.org/packages/zephir-mode-badge.svg]]
[[https://github.com/zephir-lang/zephir-mode/actions][https://github.com/zephir-lang/zephir-mode/workflows/build/badge.svg]]
[[https://codecov.io/gh/zephir-lang/zephir-mode][https://codecov.io/gh/zephir-lang/zephir-mode/branch/master/graph/badge.svg]]
[[https://www.gnu.org/licenses/gpl-3.0.txt][https://img.shields.io/badge/license-GPL_3-green.svg]]

A [[https://www.gnu.org/software/emacs/][GNU Emacs]] major mode for editing [[https://zephir-lang.com/][Zephir]] code. Provides syntax highlighting,
indentation, movement, navigation support and Imenu.

Zephir is a high level programming language that eases the creation and
maintainability of extensions for PHP. Zephir extensions are exported to C code
that can be compiled and optimized by major C compilers such as
gcc/clang/vc++. Functionality is exposed to the PHP language.

** Features

- Basic syntax definition
- Indentation of expressions and statements
- Syntax highlighting
- Movement
- Imenu

** Installation

Known to work with GNU Emacs 25.1 and later. Zephir Mode may work with older
versions of Emacs, or with other flavours of Emacs (e.g. XEmacs) but this is
/not/ guaranteed. Bug reports for problems related to using Zephir Mode with
older versions of Emacs will most like not be addressed. To get this mode with
support for GNU Emacs less than 25.1 use [[https://github.com/zephir-lang/zephir-mode/tags][previous releases]].

The master of all the material is the Git repository at
https://github.com/zephir-lang/zephir-mode.

NOTE: The ~master~ branch will always contain the latest unstable version.
If you wish to check older versions or formal, tagged release, please switch
to the relevant [[https://github.com/zephir-lang/zephir-mode/tags][tag]].

The recommended way is to use, [[https://stable.melpa.org/][MELPA Stable]] or [[https://melpa.org/][MELPA]]. If either is in your
=package-archives=, do:

#+begin_src
M-x package-install RET zephir-mode RET
#+end_src

To learn on how to use any other installation methods refer to relevant
documentation.

** Usage

*** Interactive Commands

| Command (For the ~M-x~ prompt.) | Description |
|---------------------------------+-------------------------------------------------------|
| ~zephir-mode~ | Switches to Zephir Mode. |
| ~zephir-mode-version~ | Display string describing the version of Zephir Mode. |

To see full list of Zephir related commands use command as follows:
#+begin_src
M-x apropos-command RET ^zephir- RET
#+end_src

By default any file that matches the glob ~*.zep~ is automatically opened in
~zephir-mode~.

** Customization

To see and customize all Zephir related options, use command as follows:

#+begin_src
M-x customize-group RET zephir RET
#+end_src

** Support

Feel free to ask question or make suggestions in our [[https://github.com/zephir-lang/zephir-mode/issues][issue tracker]].

** Changes

To see what has changed in recent versions of Zephir Mode see [[https://github.com/zephir-lang/zephir-mode/blob/master/NEWS][NEWS file]].

** License

Zephir Mode is open source software licensed under the
[[https://github.com/zephir-lang/zephir-mode/blob/master/LICENSE][GNU General Public Licence version 3]].
Copyright © 2017-2020 Free Software Foundation, Inc.

*** Note On Copyright Years

In copyright notices where the copyright holder is the Free Software Foundation,
Inc, then where a range of years appears, this is an inclusive range that
applies to every year in the range. For example: 2005-2008 represents the years
2005, 2006, 2007, and 2008.