open-index/open-npm huggingface dataset:
npm package: @opswap/sdk
Description: 🛠 An SDK for building applications on top of BSCswap.
Latest version: 1.0.16

# BSCswap SDK

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
[![Actions Status](https://github.com/bscswap/bscswap-sdk/workflows/CI/badge.svg)](https://github.com/bscswap/bscswap-sdk)
[![npm version](https://img.shields.io/npm/v/@bscswap/sdk/latest.svg)](https://www.npmjs.com/package/@bscswap/sdk/v/latest)
[![npm bundle size (scoped version)](https://img.shields.io/bundlephobia/minzip/@bscswap/sdk/latest.svg)](https://bundlephobia.com/result?p=@bscswap/sdk@latest)

Common library used accross for BSCswap Frontend implementation [https://github.com/bscswap/bscswap-interface](https://github.com/bscswap/bscswap-interface).

In-depth documentation on this SDK is available at [uniswap.org](https://uniswap.org/docs/v2/SDK/getting-started/).

## Running tests

To run the tests, follow these steps. You must have at least node v10 and [yarn](https://yarnpkg.com/) installed.

First clone the repository:

```sh
git clone https://github.com/bscswap/bscswap-sdk.git
```

Move into the uniswap-sdk working directory

```sh
cd bscswap-sdk/
```

Install dependencies

```sh
yarn install
```

Run tests

```sh
yarn test
```

You should see output like the following:

```sh
yarn run v1.22.4
$ tsdx test
 PASS  test/constants.test.ts
 PASS  test/pair.test.ts
 PASS  test/fraction.test.ts
 PASS  test/miscellaneous.test.ts
 PASS  test/entities.test.ts
 PASS  test/trade.test.ts

Test Suites: 1 skipped, 6 passed, 6 of 7 total
Tests:       3 skipped, 82 passed, 85 total
Snapshots:   0 total
Time:        5.091s
Ran all test suites.
✨  Done in 6.61s.
```
npm package: @opsystech/bbrun
Description: Run your Bitbucket Pipelines locally
Author: mserranom@gmail.com
Latest version: 0.10.11

# Bitbucket Pipelines Runner

Harel changes

`bbrun` is a command line tool to execute [Bitbucket Pipelines](https://confluence.atlassian.com/bitbucket/configure-bitbucket-pipelines-yml-792298910.html) locally.

[![Build Status](https://github.com/mserranom/bbrun/workflows/Node%20CI/badge.svg)](https://github.com/mserranom/bbrun/actions?query=workflow%3A%22Node+CI%22)[![npm version](https://badge.fury.io/js/bbrun.svg)](https://badge.fury.io/js/bbrun)

## Install

Install `bbrun` with `npm`:

```bash
$ npm install -g bbrun
```

## Usage

`bbrun` can execute any step defined in your `bitbucket-pipelines.yml` template:

```yaml
pipelines:
  default:
    - step:
          name: hello
          image: ubuntu2
          script:
            - echo "hello world!"
```

Run `bbrun` straight from your project path:

```bash
$ bbrun hello
running "build" in "atlassian/default-image" image...
hello world!
```

Check the [examples](https://github.com/mserranom/bbrun/tree/master/examples) and its [tests](https://github.com/mserranom/bbrun/blob/master/examples/examples.test.js) to learn different use cases.

### Options

```
  Usage
    $ bbrun <step> <options>

  Options
      --template (-t), pipeline template, defaults to "bitbucket-pipelines.yml"
      --env (-e),  define environment variables for execution
      --dry-run (-d),  performs dry run, printing the docker command
      --interactive (-i), starts an interactive bash session in the container
      --ignore-folder (-f), adds the folder as an empty volume (useful for forcing pipeline to install packages etc)
      --help, prints this very guide

  Examples:
    Execute all steps in the default pipeline from bitbucket-pipelines.yml
      $ bbrun
      $ bbrun --template bitbucket-template.yml
      $ bbrun --pipeline default
    Execute a single step by its name
      $ bbrun test
      $ bbrun "Integration Tests"
    Execute steps from different pipelines
      $ bbrun test --pipeline branches:master
    Define an environment variable
      $ bbrun test --env EDITOR=vim
      $ bbrun test --env "EDITOR=vim, USER=root"
```

## Caveats

- Not all Bitbucket features are covered, check [open issues](https://github.com/mserranom/bbrun/issues) for an overview of the roadmap.
- [Private images](https://confluence.atlassian.com/bitbucket/use-docker-images-as-build-environments-792298897.html) are supported, but the user has to login in the Docker Registry before executing `bbrun` (thus credentials in the file are ignored).

## Build and Test

```bash
npm install && npm test
```

To execute the tests under [examples](https://github.com/mserranom/bbrun/tree/master/examples) (which are not run by CI yet):

```bash
npm run test-examples
```

### Install locally

```bash
$ npm install && npm link
```