emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update dart module README

Browse source
This commit is contained in:
Eric Dallo 2020-07-23 15:36:01 -03:00
parent 15f0bccde5
commit 205aed59bc
No known key found for this signature in database
GPG key ID: 54B592E05C6FBE46
1 changed files with 18 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

23
modules/lang/dart/README.org
View file

@ -15,18 +15,19 @@
- [[#configuration][Configuration]] - [[#configuration][Configuration]]
- [[#dart--flutter][Dart & Flutter]] - [[#dart--flutter][Dart & Flutter]]
- [[#android][Android]] - [[#android][Android]]
- [[#flutter-mobile-development-on-desktop][Flutter mobile development on desktop]]
- [[#troubleshooting][Troubleshooting]] - [[#troubleshooting][Troubleshooting]]
* Description * Description
[[https://dart.dev/][Dart]] is a client-optimized language by Google for fast apps on any platform. [[https://dart.dev/][Dart]] is a client-optimized language by Google for fast apps on any platform.
It is fast and optimized for UI, Famous for the [[https://flutter.io/][Flutter]] framework, also It is fast and optimized for UI, famous for the [[https://flutter.io/][Flutter]] framework, also
made by Google. Both Flutter and Dart are free and open-source. made by Google. Both Flutter and Dart are free and open-source.
This module wraps ~dart-mode~, with LSP code completion for =.dart= files, This module wraps ~dart-mode~, with [[https://microsoft.github.io/language-server-protocol/][LSP]] features like code completion for =.dart= files,
syntax highlighting, etc. syntax highlighting, debugging, closing labels, etc.
** Maintainers ** Maintainers
This module has no dedicated maintainers. + [[https://github.com/ericdallo][@ericdallo]]
** Module Flags ** Module Flags
+ =+lsp= Enable LSP server integration. + =+lsp= Enable LSP server integration.
@ -64,6 +65,10 @@ please refer to the official website at: https://dart.dev/get-dart
brew tap dart-lang/dart brew tap dart-lang/dart
brew install dart brew install dart
#+END_SRC #+END_SRC
+ *On NixOS*:
#+BEGIN_SRC shell
nix-env -iA nixpkgs.dart
#+END_SRC
** Installing Flutter SDK ** Installing Flutter SDK
Due to complications with permissions, it is suggested not to use AUR or any Due to complications with permissions, it is suggested not to use AUR or any
@ -80,6 +85,11 @@ flutter doctor # for Dependency check and further instructions
* Features * Features
+ Syntax highlighting and formatting for ~.dart~ files provided by LSP + Syntax highlighting and formatting for ~.dart~ files provided by LSP
+ Auto import
+ Widget guide lines for Flutter
+ Closing labels for constructors
+ Run tests interactively
+ Outline support via ~lsp-treemacs~
+ Emacs functions for running and debugging Flutter projects + Emacs functions for running and debugging Flutter projects
* Configuration * Configuration
@ -90,13 +100,16 @@ install directory and ~flutter-sdk-path~ to you flutter SDK folder, to make sure
LSP can find the language server included with the Dart SDK. LSP can find the language server included with the Dart SDK.
Alternatively, these variables shouldn't be necessary if you just include Dart Alternatively, these variables shouldn't be necessary if you just include Dart
and Flutter on your `PATH` variable. and Flutter on your ~PATH~ variable.
** Android ** Android
You will also need to setup your system for Android development if you intend to You will also need to setup your system for Android development if you intend to
use Flutter to develop mobile applications. Refer to your distributions package use Flutter to develop mobile applications. Refer to your distributions package
manager for details. In most distributions the ~/opt/android-sdk~ directory is manager for details. In most distributions the ~/opt/android-sdk~ directory is
used, and you might have to change some permissions in this directory since it's used, and you might have to change some permissions in this directory since it's
owned by root. The [[https://wiki.archlinux.org/index.php/Android][Arch Linux wiki has a great guide on this here.]] owned by root. The [[https://wiki.archlinux.org/index.php/Android][Arch Linux wiki has a great guide on this here.]]
** Flutter mobile development on desktop
[[https://github.com/go-flutter-desktop/go-flutter][Hover]] is an application that can run Flutter mobile apps on your desktop, this
makes the mobile development a lot easier without the need to setup an Android emulator.
* Troubleshooting * Troubleshooting
See the configuration section for information on the binaries for Dart and See the configuration section for information on the binaries for Dart and