docs(:lang): update READMEs to new format
This commit is contained in:
parent
ca7579a1e9
commit
20cac97c08
61 changed files with 4261 additions and 2634 deletions
|
@ -1,47 +1,48 @@
|
|||
#+TITLE: lang/dart
|
||||
#+DATE: February 16, 2020
|
||||
#+SINCE: v3.0.0
|
||||
#+STARTUP: inlineimages nofold
|
||||
← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::lang dart][Issues]] ↖ [[doom-module-source:lang/dart][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
|
||||
--------------------------------------------------------------------------------
|
||||
#+TITLE: :lang dart
|
||||
#+SUBTITLE: Paint ui and not much else
|
||||
#+CREATED: February 16, 2020
|
||||
#+SINCE: 21.12.0
|
||||
|
||||
* Table of Contents :TOC_3:noexport:
|
||||
- [[#description][Description]]
|
||||
- [[#maintainers][Maintainers]]
|
||||
- [[#module-flags][Module Flags]]
|
||||
- [[#plugins][Plugins]]
|
||||
- [[#prerequisites][Prerequisites]]
|
||||
- [[#installing-dart-sdk][Installing Dart SDK]]
|
||||
- [[#installing-flutter-sdk][Installing Flutter SDK]]
|
||||
- [[#features][Features]]
|
||||
- [[#configuration][Configuration]]
|
||||
- [[#dart--flutter][Dart & Flutter]]
|
||||
- [[#android][Android]]
|
||||
- [[#flutter-mobile-development-on-desktop][Flutter mobile development on desktop]]
|
||||
- [[#troubleshooting][Troubleshooting]]
|
||||
* Description :unfold:
|
||||
[[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 made by
|
||||
Google. Both Flutter and Dart are free and open-source.
|
||||
|
||||
* Description
|
||||
[[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
|
||||
made by Google. Both Flutter and Dart are free and open-source.
|
||||
|
||||
This module wraps ~dart-mode~, with [[https://microsoft.github.io/language-server-protocol/][LSP]] features like code completion for =.dart= files,
|
||||
syntax highlighting, debugging, closing labels, etc.
|
||||
This module wraps ~dart-mode~, with [[https://microsoft.github.io/language-server-protocol/][LSP]] features like code completion for
|
||||
=.dart= files, syntax highlighting, debugging, closing labels, etc.
|
||||
|
||||
** Maintainers
|
||||
+ [[https://github.com/ericdallo][@ericdallo]]
|
||||
- [[doom-user:][@ericdallo]]
|
||||
|
||||
** Module Flags
|
||||
+ =+lsp= Enable LSP server integration.
|
||||
+ =+flutter= Adds ~flutter~ integration and some sane defaults for Flutter
|
||||
development along with ~hover~ for desktop development.
|
||||
[[doom-contrib-maintainer:][Become a maintainer?]]
|
||||
|
||||
** Plugins
|
||||
+ [[https://github.com/bradyt/dart-mode][dart-mode]]
|
||||
+ [[https://github.com/amake/flutter.el][flutter.el]]
|
||||
+ [[https://github.com/ericdallo/hover.el][hover.el]]
|
||||
** Module flags
|
||||
- +flutter ::
|
||||
Enable ~flutter~ integration and some sane defaults for Flutter development
|
||||
along with ~hover~ for desktop development.
|
||||
- +lsp ::
|
||||
Enable LSP support for ~dart-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
|
||||
(supports flutter).
|
||||
|
||||
* Prerequisites
|
||||
Make sure that the Dart SDK is on your ~PATH~, and if using Flutter, make sure
|
||||
the Flutter binary is on your ~PATH~ as well.
|
||||
** Packages
|
||||
- [[doom-package:][dart-mode]]
|
||||
- [[doom-package:][flutter.el]]
|
||||
- [[doom-package:][hover.el]]
|
||||
|
||||
** 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.]]
|
||||
|
||||
Make sure that the Dart SDK is on your =$PATH=, and if using Flutter, make sure
|
||||
the Flutter binary is on your =$PATH= as well.
|
||||
|
||||
** Installing Dart SDK
|
||||
Before starting note that Flutter SDK will have a version of Dart. Therefore,
|
||||
|
@ -52,23 +53,23 @@ The stable version of the SDK is in most major distributions repositories.
|
|||
If you find it necessary to install any other version or build from source,
|
||||
please refer to the official website at: https://dart.dev/get-dart
|
||||
|
||||
+ *On Debian (also Ubuntu and its derivations):*
|
||||
#+BEGIN_SRC shell
|
||||
sudo apt-get install dart
|
||||
#+END_SRC
|
||||
+ *On Arch Linux (and derivations like Manjaro):*
|
||||
#+BEGIN_SRC shell
|
||||
sudo pacman -S dart
|
||||
#+END_SRC
|
||||
+ *On macOS*:
|
||||
#+BEGIN_SRC shell
|
||||
- *On Debian (also Ubuntu and its derivations):*
|
||||
#+begin_src sh
|
||||
apt-get install dart
|
||||
#+end_src
|
||||
- *On Arch Linux (and derivations like Manjaro):*
|
||||
#+begin_src sh
|
||||
pacman -S dart
|
||||
#+end_src
|
||||
- *On macOS*:
|
||||
#+begin_src sh
|
||||
brew tap dart-lang/dart
|
||||
brew install dart
|
||||
#+END_SRC
|
||||
+ *On NixOS*:
|
||||
#+BEGIN_SRC shell
|
||||
#+end_src
|
||||
- *On NixOS*:
|
||||
#+begin_src sh
|
||||
nix-env -iA nixpkgs.dart
|
||||
#+END_SRC
|
||||
#+end_src
|
||||
|
||||
** Installing Flutter SDK
|
||||
Due to complications with permissions, it is suggested not to use AUR or any
|
||||
|
@ -77,22 +78,30 @@ automatic installation tools for Flutter SDK.
|
|||
On any system just run the following commands to install Flutter, once you have
|
||||
met dependencies named on [[https://flutter.dev/docs/get-started/install/][the site]]:
|
||||
|
||||
#+BEGIN_SRC shell
|
||||
#+begin_src sh
|
||||
git clone https://github.com/flutter/flutter --branch stable # to download Flutter
|
||||
export PATH="$PATH:$(pwd)/flutter/bin" # to add it to PATH
|
||||
flutter doctor # for Dependency check and further instructions
|
||||
#+END_SRC
|
||||
#+end_src
|
||||
|
||||
* Features
|
||||
+ 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
|
||||
* TODO Usage
|
||||
#+begin_quote
|
||||
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
- 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 [[doom-package:][lsp-treemacs]].
|
||||
- Emacs functions for running and debugging Flutter projects.
|
||||
|
||||
* TODO Configuration
|
||||
#+begin_quote
|
||||
🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
* Configuration
|
||||
** Dart & Flutter
|
||||
On Linux, the installers for Dart and Flutter use the ~/opt~ directory, and this
|
||||
module assumes that. However, you may set ~lsp-dart-sdk-dir~ to your Dart
|
||||
|
@ -101,18 +110,31 @@ LSP can find the language server included with the Dart SDK.
|
|||
|
||||
Alternatively, these variables shouldn't be necessary if you just include Dart
|
||||
and Flutter on your ~PATH~ variable.
|
||||
|
||||
** Android
|
||||
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
|
||||
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
|
||||
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.
|
||||
makes the mobile development a lot easier without the need to setup an Android
|
||||
emulator.
|
||||
|
||||
* Troubleshooting
|
||||
[[doom-report:][Report an issue?]]
|
||||
|
||||
See the configuration section for information on the binaries for Dart and
|
||||
Flutter. On new installs to the ~/opt~ directory, you will likely need to edit
|
||||
the permissions of the ~/opt/dart-sdk~ and ~/opt/flutter~ directories (not to
|
||||
Flutter. On new installs to the =/opt= directory, you will likely need to edit
|
||||
the permissions of the =/opt/dart-sdk= and =/opt/flutter= directories (not to
|
||||
mention the Android SDK, as discussed above).
|
||||
|
||||
* 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
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue