Code Monkey home page Code Monkey logo

elm-dev's Introduction

Elm Dev

Elm Dev is a version of the Elm compiler that is made to support editing tools.

Not to be confused with Elm itself which lives here: https://elm-lang.org/

This package is for toolmakers, so if you're just starting out using Elm, you likely don't need this tool directly.

Install via npm install -g elm-dev if you want to play with it. It's currently experimental, but will likely be stable soon.

Currently this is a command line tool with the following commands that print or output JSON.

  • warnings - List missing type signatures and unused values.
  • entrypoints - Detect what .elm files are the potential roots of a project. This will also report any ports relevant to a specific entrypoint as well as the type signatures of those ports.
  • docs - Generate docs.json for any package, or any local .elm file.
  • imports - Given a list of modules, report all files and packages that they collectively depends on. This is useful for
  • usage - Given a module, return all usages of that module in a given project.
  • explain - Given a fully qualified type name, provide it's full definition.

Each command may instead report compilation errors if the file or project fails to compile.

Roadmap

The above functionality is a first pass on what would be useful for elm-dev to report and has been published to allow downstream projects to try stuff out.

In the medium term, the intention is to support the language-server protocol and to adjust functionaltiy based on downstream projects.

elm-dev's People

Contributors

agu-z avatar apanatshka avatar brianhicks avatar dandandan avatar deadfoxygrandpa avatar dobesv avatar evancz avatar hdgarrood avatar imeckler avatar jfmengels avatar joeyeremondi avatar johnpmayer avatar jsl avatar jvoigtlaender avatar laszlopandy avatar maxsnew avatar mdgriffith avatar mgold avatar michaelbjames avatar ngunn avatar perplexes avatar process-bot avatar pseudonom avatar sheeo avatar supermario avatar techtangents avatar timthelion avatar vbychkovsky avatar wolfadex avatar xash avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

elm-dev's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.