https://github.com/mgechev/semver-dsl

Tiny internal DSL which allows invocation of different functionality depending on SemVer match.
https://github.com/mgechev/semver-dsl

dsl semver

Last synced: 2 months ago
JSON representation

Tiny internal DSL which allows invocation of different functionality depending on SemVer match.

• Host: GitHub
• URL: https://github.com/mgechev/semver-dsl
• Owner: mgechev
• License: mit
• Created: 2017-02-19T06:42:24.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-06-24T09:12:04.000Z (over 6 years ago)
• Last Synced: 2024-10-10T17:40:20.247Z (3 months ago)
• Topics: dsl, semver
• Language: TypeScript
• Homepage:
• Size: 11.7 KB
• Stars: 11
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/mgechev/semver-dsl.svg?branch=master)](https://travis-ci.org/mgechev/semver-dsl)

# SemVer DSL

A simple internal DSL which allows you to invoke different functionality depending on version match. Used in codelyzer for keeping the code compatible across different versions of the Angular compiler.

# Demo

```bash

$ npm i semver-dsl --save

```

```ts

import {SemVerDSL} from 'semver-dsl';

const base = () => {};

const elseIf1 = () => {};

const elseIf2 = () => {};

const else = () => console.log('I will be invoked!');

SemVerDSL('3.0.0')

  .gt('3.2.1', base)

  .elseIf.gt('3.0.1', elseIf1)

  .elseIf.between('3.0.1', '3.1.8', elseIf2)

  .else(else);

```

In the example above will be invoked `else`.

# API

- `SemDSL(version: string)` - factory which accepts a version and returns an object.

- `gte(version: string, callback?: Function): ISemContextualDSL` - returns an object with `elseIf` and `else` properties.

- `lte(version: string, callback?: Function): ISemContextualDSL` - returns an object with `elseIf` and `else` properties.

- `gt(version: string, callback?: Function): ISemContextualDSL` - returns an object with `elseIf` and `else` properties.

- `lt(version: string, callback?: Function): ISemContextualDSL` - returns an object with `elseIf` and `else` properties.

- `eq(version: string, callback?: Function): ISemContextualDSL` - returns an object with `elseIf` and `else` properties.

- `neq(version: string, callback?: Function): ISemContextualDSL` - returns an object with `elseIf` and `else` properties.

- `between(v1: string, v2: string, callback?: Function): ISemContextualDSL` - returns an object with `elseIf` properties.

- `elseIf` - returns an object of type `ISemVerDSL` bound to the previous predicate.

- `else` - invokes given callback if all of the previous conditions have failed.

```ts

export interface ISemVerDSL {

  gte(version: string, callback: Function): ISemContextualDSL;

  lte(version: string, callback: Function): ISemContextualDSL;

  gt(version: string, callback: Function): ISemContextualDSL;

  lt(version: string, callback: Function): ISemContextualDSL;

  eq(version: string, callback: Function): ISemContextualDSL;

  neq(version: string, callback: Function): ISemContextualDSL;

  between(v1: string, v2: string, callback: Function): ISemContextualDSL;

}

```

```ts

export interface ISemVerContextBoundDSL {

  elseIf: ISemVerDSL;

  else(callback: Function): void;

}

```

# License

MIT