1abcf913aa
emacs-straight/org-mode@e22b4eb7aa introduced a breaking change that made it impossible to rely on .dir-locals.el to change org-mode buffers in $EMACSDIR to doom-docs-org-mode (without infinite recursion), so we used file-local variables in7e400ab. emacs-straight/org-mode@215de6176b reverted that change, so we can use .dir-locals.el again, and this is my preference, since it requires less boilerplate across our hundreds of org files. Ref: emacs-straight/org-mode@215de6176b Ref: emacs-straight/org-mode@e22b4eb7aa Revert:7e400abdc0
77 lines
2.2 KiB
Org Mode
77 lines
2.2 KiB
Org Mode
#+title: :lang solidity
|
|
#+subtitle: Do you need a blockchain? No.
|
|
#+created: May 19, 2018
|
|
#+since: 21.12.0 (#599)
|
|
|
|
* Description :unfold:
|
|
This module adds [[https://github.com/ethereum/solidity][Solidity]] support to Doom Emacs.
|
|
|
|
- Syntax-checking ([[doom-package:][flycheck]])
|
|
- Code completion ([[doom-package:][company-solidity]])
|
|
- Gas estimation (~C-c C-g~)
|
|
|
|
** Maintainers
|
|
*This module needs a maintainer.* [[doom-contrib-maintainer:][Become a maintainer?]]
|
|
|
|
** Module flags
|
|
/This module has no flags./
|
|
|
|
** Packages
|
|
- [[doom-package:][company-solidity]] if [[doom-module:][:completion company]]
|
|
- [[doom-package:][solidity-flycheck]] if [[doom-module:][:checkers syntax]]
|
|
- [[doom-package:][solidity-mode]]
|
|
|
|
** Hacks
|
|
/No hacks documented for this module./
|
|
|
|
** TODO Changelog
|
|
# This section will be machine generated. Don't edit it by hand.
|
|
/This module does not have a changelog yet./
|
|
|
|
* Installation
|
|
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
|
|
|
This module requires one or both linters for syntax checking:
|
|
- [[https://github.com/ethereum/solc-js][Solc]]
|
|
- [[http://solium.readthedocs.io/en/latest/user-guide.html#installation][Solium]]
|
|
|
|
If both are enabled *Solc* is run first, then *Solium* if *Solc* catches no
|
|
errors.
|
|
|
|
** Solc
|
|
#+begin_src sh
|
|
npm install -g solc
|
|
#+end_src
|
|
|
|
** Solium
|
|
#+begin_src sh
|
|
npm install -g solium
|
|
#+end_src
|
|
|
|
By default *solium* looks for =.soliumrc.json= in the project directory, but you
|
|
can set it to your own =.soliumrc.json= with:
|
|
#+begin_src emacs-lisp
|
|
;; in $DOOMDIR/config.el
|
|
(setq flycheck-solidity-solium-soliumrcfile "~/.soliumrc.json")
|
|
#+end_src
|
|
|
|
* TODO Usage
|
|
#+begin_quote
|
|
🔨 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
|
|
#+end_quote
|
|
|
|
* TODO Configuration
|
|
#+begin_quote
|
|
🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
|
|
#+end_quote
|
|
|
|
* Troubleshooting
|
|
/There are no known problems with this module./ [[doom-report:][Report one?]]
|
|
|
|
* Frequently asked questions
|
|
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
|
|
|
|
* TODO Appendix
|
|
#+begin_quote
|
|
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
|
|
#+end_quote
|