https://github.com/sigma-andex/purescript-typescript-importer

WIP typescript <≡> purescript importer
https://github.com/sigma-andex/purescript-typescript-importer

purescript typescript

Last synced: about 2 months ago
JSON representation

WIP typescript <≡> purescript importer

• Host: GitHub
• URL: https://github.com/sigma-andex/purescript-typescript-importer
• Owner: sigma-andex
• License: mit-0
• Created: 2021-10-16T14:32:55.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-02-11T21:48:24.000Z (almost 3 years ago)
• Last Synced: 2024-07-30T20:07:34.809Z (5 months ago)
• Topics: purescript, typescript
• Language: PureScript
• Homepage:
• Size: 277 KB
• Stars: 9
• Watchers: 4
• Forks: 2
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# purescript-typescript-importer

Experiment of writing a typescript importer for purescript. Very early stage and ongoing development, don't use it yet!

The current state of typescript support can be seen in the testfiles folder. In [`testfiles/original`](./testfiles/original/) are the typescript input files and in [`testfiles/golden`](./testfiles/golden/) the expected output of the typescript support that is currently passing.

## Goals & non-goals

The goal of this project is to create a tool that generates useful and working purescript ffis from typescript type definitions. It is not meant to create a fully-fledged typescript to purescript transpiler, as I don't see much added value to this and it's also a whole different story scope-wise.

It is also (currently) not a goal to go the other way around, i.e. from purescript to typescript.

## Typescript <≡> Purescript type correspondence

See [Typescript <≡> Purescript type correspondence](docs/type-correspondence.md).

## Usage

WIP, run it using spago, pass arguments using --exec-args

```bash

# list modules with typescript type definitions

spago run --exec-args "list"

# import module

spago run --exec-args "import "

```

## Maintainers

- [sigma-andex](https://github.com/sigma-andex/)