https://github.com/Fuco1/flow-js2-mode

[UNMAINTAINED] Support for flow for js2-mode
https://github.com/Fuco1/flow-js2-mode

Last synced: about 1 month ago
JSON representation

[UNMAINTAINED] Support for flow for js2-mode

• Host: GitHub
• URL: https://github.com/Fuco1/flow-js2-mode
• Owner: Fuco1
• License: gpl-3.0
• Archived: true
• Created: 2017-11-14T10:14:43.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-27T18:23:59.000Z (over 1 year ago)
• Last Synced: 2024-05-01T22:56:54.871Z (5 months ago)
• Language: Emacs Lisp
• Homepage:
• Size: 52.7 KB
• Stars: 46
• Watchers: 10
• Forks: 3
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# UNMAINTAINED

Typescript won.  If you still use flow on some legacy project, you can keep using this package but it is no longer developed or maintained.

---

# flow-js2-mode

This package adds support for [Flow](https://flow.org/), a static typechecking extension for javascript, to [js2-mode](https://github.com/mooz/js2-mode), a popular javascript editing mode for Emacs.

It extends the `js2-mode` parser to understand Flow syntax and exposes it in its AST which you can use to build your own refactoring tools.  This understanding of syntax also allows us to add proper syntax highlighting.

This project is heavily WIP at the moment, things might break and change.  Please report all the issues, even minor ones so we can polish this as soon as possible.

# Usage

Enable `flow-js2-mode` in the `js2-mode` buffer.

# List of features (incomplete)

- [x] In object literals, `{foo: bar}` the type is parsed even thought it is not a type.  This breaks fontification and semantics of the object literals.  I don't see a way yet to distinguish if the `foo` is a key or a variable.

- [x] `import type {Config} from 'types/Config'` does not work.

- [x] Typing a destructured object does not work: `function send(res, {body, content}: Response)`

- [x] Parse `function` generic constructs.

  - [x] Does not work with multiple generic arguments (separated by commas)

  - [x] Does not work with typed generics such as `function `

- [x] key type specification in objects should work: `clients: { [client_id: string]: Client }`

- [ ] function types

  - [x] function types with unnamed arguments

  - [ ] function types with named arguments

  - [ ] function types in `const/var/let` assignments (todo: is this valid flow syntax?)

- [ ] `declare module` syntax

- [ ] `declare class` syntax

# Related projects

The [flow-minor-mode](https://github.com/an-sh/flow-minor-mode) project integrates flow features such as navigation to definition, eldoc support for printing types of expressions at point and similar into Emacs.  It is best to use it alongside this package.  In fact, it already is a dependency so you will get it automatically when you install this package.

# Acknowledgements

The work was started by @antifuchs in [this fork](https://github.com/antifuchs/rjsx-mode) and expanded by @Fuco1 in [this pull request](https://github.com/antifuchs/rjsx-mode/pull/1).  It was decided to move this into a separate pacakge as there was no direct relation with `rjsx-mode`.

Built on top of the powerful features of `js2-mode`.