Skip to content

Start2Run/TypeScript2Famix

Repository files navigation


Logo

Typescript-to-FAMIX

This is a parser that harvest a typescript project and generates a FAMIX mse file
View Code »

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

This is a parser that harvest a typescript project and generates a FAMIX mse file

Getting Started

Prerequisites

npm install --save-dev ts-morph

Installation

Install as usual via npm:

npm install --save-dev typescript2famix

Usage

If you clone the code then you can build it using the command

npm run build

To create the the .mse file run the following command where the argument is the path of the typescript project for wich we want to create the FAMIX model.

node ./out/sample.js "D:\Repos\TypeScript2Famix\resources"

A file sample.mse will be created as result of the command execution.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Start2Run - @Start2Run

Project Link: https://github.com/Start2Run/TypeScript2Famix

Acknowledgements

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published