Data

Tools

Indexes

Applications

Experiments

Open Source Science

ts-bc-detector

A tool that detects Breaking changes between 2 versions of a Typescript project

https://github.com/maimunar/ts-bc-detector

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (6.8%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

A tool that detects Breaking changes between 2 versions of a Typescript project

Basic Info
  • Host: GitHub
  • Owner: Maimunar
  • Language: TypeScript
  • Default Branch: master
  • Size: 888 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created 10 months ago · Last pushed 9 months ago
Metadata Files
Readme Citation

README.md

Typescript Breaking Change Detector

A tool that detects Breaking changes between 2 versions of a Typescript project

The rules at rules.md given are based on the defined BCs in https://github.com/Maimunar/typescript-breaking-changes

How to run

  1. Build the project - pnpm build
  2. Link it - npm link while in the directory
  3. Run bc-detector <INPUT> where INPUT is a directory that holds folders v1 and v2 resembling the 2 repository versions you want to test.

CLI Options

  • -i - Ignore specific directories
  • -d - Run in debug mode - mostly useful for tool development and troubleshooting

Implementation

The src folder holds the whole structure: - model takes care of the modeled AST of TS based on parser - rules handles all language requirements, based on the BCs repository linked above and done per API element. A summary of the rules can be found in rules

detectionEvaluation handles an academic accuracy evaluation.

Owner

  • Name: Aleksandar Ivanov
  • Login: Maimunar
  • Kind: user
  • Location: Eindhoven, the Netherlands

ICT & Software Engineering Student @ Fontys | Software Developer @ ARION

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: Typescript Breaking Changes Detector
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Aleksandar
    family-names: Ivanov
repository-code: 'https://github.com/Maimunar/ts-bc-detector'

GitHub Events

Total
  • Push event: 16
Last Year
  • Push event: 16