Ramblurr / intellij-beancount

Beancount editing support for Jetbrains IDEs

Beancount plugin

This is a plugin that adds support for Beancount to JetBrains IDEs.

Features:

• Syntax highlighting
• Completion: account names, currencies, directives
• Formatting

Roadmap:

• date completion
• bean-check execution
• bean-doctor execution
• inspection: transactions balance to 0

Contributing

When importing the plugin source into intellij, use the gradle importer and be sure to uncheck the create separate module per source set option, otherwise the generated parser/lexer code will go into src/ instead of gen/

Developer notes

Many thanks to the plugin developers who came before and whose code served as defacto documentation for the IntelliJ SDK. Their trail blazing makes this possible.

• go-lang-idea-plugin
• intellij-elixir
• elm-plugin

That said, the Intellij docs are getting better. Here are a few crucial resources for grokking the Intellij SDK.

Grammar and Parsing

Don't remember the grammar/parsing lectures from your compilers course?

• The language of languages
• Pratt Parsers: Expression Parsing Made Easy
• Grammar-Kit
• JFlex manual

IDE features

• Custom Language Plugin
• What the Psi?
• Custom Project types
• Testing plugins
• More testing

Misc

• Other dev notes by Terence Parr

Copyright and License

Bean icon made by Smashicons from www.flaticon.com is licensed by CC 3.0 BY

Copyright (C) 2018 Casey Link

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 http://www.gnu.org/licenses.

Additional permission under GNU GPL version 3 section 7

If you modify this Program, or any covered work, by linking or combining it with Intellij IDEA Community Edition (or a modified version of that library), containing parts covered by the terms of Apache v2.0, the licensors of this Program grant you additional permission to convey the resulting work. Corresponding Source for a non-source form of such a combination shall include the source code for the parts of Intellij IDEA Community Edition used as well as that of the covered work.