GithubHelp home page GithubHelp logo

vscode-theia-comparator's Introduction

Eclipse Theia vs VS Code API Comparator

API Compatibility API Compatibility

Overview

The repository contains the source code to generate a status report regarding the compatibility between the Eclipse Theia framework, and the VS Code Extension API.

Prerequisites

The environment variable GITHUB_TOKEN must be defined with a valid GitHub token. The tool grabs files remotely, and checks the latest versions using the GraphQL GitHub API.

Creating the Report

  1. Build the tool:

    $ yarn
    
  2. Generate the report:

    $ yarn run generate
    

    Example output:

    $ node lib/index.js
    ๐Ÿ” Searching on github the Theia versions...
    ๐Ÿ—‚  The Theia versions to compare will be master, v1.21.0, v1.20.0
    ๐Ÿ—ƒ  Grabbing content...โœ”๏ธ 
    ๐Ÿ” Searching on github the VSCode versions...
    ๐Ÿ—‚  The VSCode versions to compare will be main, 1.63.2, 1.62.3, 1.61.2, 1.60.2
    ๐Ÿ—ƒ  Grabbing content...โœ”๏ธ 
    โš™๏ธ  Analyzing /home/user/Git/vscode-theia-comparator/lib/vscode-main.d.ts...
    โš™๏ธ  Analyzing /home/user/Git/vscode-theia-comparator/lib/vscode-1.63.2.d.ts...
    โš™๏ธ  Analyzing /home/user/Git/vscode-theia-comparator/lib/vscode-1.62.3.d.ts...
    โš™๏ธ  Analyzing /home/user/Git/vscode-theia-comparator/lib/vscode-1.61.2.d.ts...
    โš™๏ธ  Analyzing /home/user/Git/vscode-theia-comparator/lib/vscode-1.60.2.d.ts...
    โš™๏ธ  Analyzing /home/user/Git/vscode-theia-comparator/conf/vscode-theia.d.ts...
    โš™๏ธ  Analyzing /home/user/Git/vscode-theia-comparator/lib/theia-master.d.ts...
    โš™๏ธ  Analyzing /home/user/Git/vscode-theia-comparator/conf/vscode-theia.d.ts...
    โš™๏ธ  Analyzing /home/user/Git/vscode-theia-comparator/lib/theia-v1.21.0.d.ts...
    โš™๏ธ  Analyzing /home/user/Git/vscode-theia-comparator/conf/vscode-theia.d.ts...
    โš™๏ธ  Analyzing /home/user/Git/vscode-theia-comparator/lib/theia-v1.20.0.d.ts...
    โš™๏ธ  Parsing additional information from infos.yml...
    โš™๏ธ  Generating HTML report...
    โœ๏ธ  HTML status written at /home/user/Git/vscode-theia-comparator/out/status.html
    โš™๏ธ  Generating filtered HTML report...
    โœ๏ธ  Filtered HTML status written at /home/user/Git/vscode-theia-comparator/out/filtered-status.html
    

Provide additional information

The generator can add notes for any namespace, element or sub element. Notes are read from conf/infos.yml. An example on how these are configured is given in conf/infos.example.yml.

vscode-theia-comparator's People

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.