You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@avro.apache.org by mg...@apache.org on 2022/03/24 19:58:38 UTC
[avro] branch branch-1.11 updated: AVRO-3450: Document editor support for IDL (#1603)
This is an automated email from the ASF dual-hosted git repository.
mgrigorov pushed a commit to branch branch-1.11
in repository https://gitbox.apache.org/repos/asf/avro.git
The following commit(s) were added to refs/heads/branch-1.11 by this push:
new cf62b38 AVRO-3450: Document editor support for IDL (#1603)
cf62b38 is described below
commit cf62b38f13cdf878c6615e03e5a58ec6d43d4678
Author: Oscar Westra van Holthe - Kind <op...@users.noreply.github.com>
AuthorDate: Thu Mar 24 20:54:12 2022 +0100
AVRO-3450: Document editor support for IDL (#1603)
* AVRO-3450: Document editor support for IDL
* Update doc/content/en/docs/next/IDL Language/_index.md
Co-authored-by: Martin Grigorov <ma...@users.noreply.github.com>
* Update doc/content/en/docs/next/IDL Language/_index.md
Co-authored-by: Martin Grigorov <ma...@users.noreply.github.com>
Co-authored-by: Martin Grigorov <ma...@users.noreply.github.com>
(cherry picked from commit 04bac0f9b63353b9e2b3eb88185ab7c7f8b84a13)
---
doc/content/en/docs/next/IDL Language/_index.md | 57 +++++++++++++++++++++++++
1 file changed, 57 insertions(+)
diff --git a/doc/content/en/docs/next/IDL Language/_index.md b/doc/content/en/docs/next/IDL Language/_index.md
index 0c83407..6ca0deb 100644
--- a/doc/content/en/docs/next/IDL Language/_index.md
+++ b/doc/content/en/docs/next/IDL Language/_index.md
@@ -374,3 +374,60 @@ protocol Simple {
}
```
Additional examples may be found in the Avro source tree under the `src/test/idl/input` directory.
+
+## IDE support
+
+There are several editors and IDEs that support Avro IDL files, usually via plugins.
+
+### JetBrains
+
+Apache Avro IDL Schema Support 203.1.2 was released in 9 December 2021.
+
+Features:
+* Syntax Highlighting
+* Code Completion
+* Code Formatting
+* Error Highlighting
+* Inspections & quick fixes
+* JSON schemas for .avpr and .avsc files
+
+It's available via the [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/15728-apache-avro-idl-schema-support)
+and on [GitHub](https://github.com/opwvhk/avro-schema-support).
+
+The plugin supports almost the all JetBrains products: IntelliJ IDEA, PyCharm, WebStorm, Android Studio, AppCode, GoLand, Rider, CLion, RubyMine, PhpStorm, DataGrip, DataSpell, MPS, Code With Me Guest and JetBrains Client.
+
+Only JetBrains Gateway does not support this plugin directly. But the backend (JetBrains) IDE that it connects to does.
+
+### Eclipse
+
+Avroclipse 0.0.11 was released on 4 December 2019.
+
+Features:
+* Syntax Highlighting
+* Error Highlighting
+* Code Completion
+
+It is available on the [Eclipse Marketplace](https://marketplace.eclipse.org/content/avroclipse)
+and [GitHub](https://github.com/dvdkruk/avroclipse).
+
+### Visual Studio Code
+
+avro-idl 0.5.0 was released on 16 June 2021. It provides syntax highlighting.
+
+It is available on the [VisualStudio Marketplace](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.avro)
+and [GitHub](https://github.com/Jason3S/vscode-avro-ext)
+
+### Atom.io
+
+atom-language-avro 0.0.13 was released on 14 August 2015. It provides syntax highlighting.
+
+It is available as [Atom.io package](https://atom.io/packages/atom-language-avro)
+and [GitHub](https://github.com/jonesetc/atom-language-avro)
+
+### Vim
+
+A `.avdl` detecting plugin by Gurpreet Atwal on [GitHub](https://github.com/gurpreetatwal/vim-avro) (Last change in December 2016)
+
+[avro-idl.vim](https://github.com/apache/avro/blob/master/share/editors/avro-idl.vim) in the Avro repository `share/editors` directory (last change in September 2010)
+
+Both provide syntax highlighting.