open-index/open-npm huggingface dataset:
npm package: @jpaddeo/jpaco
Description: Comando (CLI) asistente para la creación de commits de git
Author: Juan Pablo Addeo
Latest version: 1.0.0

# `@jpaddeo/jpaco`

CLI para hacer commits lindos [NPM](https://www.npmjs.com/@jpaddeo/jpaco)

![jpaco-demo](https://github.com/jpaddeo/jpaco/blob/main/.github/assets/jpaco.gif)

---

`@jpaddeo/jpaco` flow:

- Seleccioná el/los archivo/s a commitear
- Seleccioná el tipo de commit a realizar (basados en [conventional commits](https://www.conventionalcommits.org/) )
- Ingresá el scope asociado a el/los archivo/s 
- Ingresá el mensaje asociado al commit
- Confirmá y...listo ✅!
npm package: @jpantana/test-project
Description: my first open-source project
Author: jpantana
Latest version: 3.0.0

![Shields.io NPM Badge](https://img.shields.io/npm/v/@jpantana/test-project)

# Test Project

Are you tired of doing mental math? This test project will add two numbers
together for you!

## Getting Started

### Installation

\```bash yarn install @patrady/test-project \```

### Usage

\```ts import { add } from "@patrady/test-project";

const total = add(1, 2);

console.log(total); // 3 \```
npm package: @jpapini/commitlint-config
Description: Custom commitlint configuration.
Author: Julien Papini
Latest version: 1.5.6

# Commitlint configuration

Custom commitlint configuration that extends `@commitlint/config-conventional`.

## How to use

1. Install the package and its required peer dependencies:

```bash
pnpm add -D @jpapini/commitlint-config @commitlint/cli
```

2. Edit your `package.json` file to include the following:

```json
{
    "scripts": {
        "lint:commit": "commitlint --from=main"
    },
    "commitlint": {
        "extends": "@jpapini/commitlint-config"
    }
}
```

## Author

- Julien Papini <julien.papini@gmail.com>
npm package: @jpapini/deepkit-type-plugins
Description: Plugins for using Deepkit type with Vite.js and Esbuild.
Author: Julien Papini
Latest version: 1.1.0

# Deepkit type plugins

Plugins for using Deepkit type with Vite.js and Esbuild.

## How to use

1. Install the package and its required peer dependencies:

```bash
pnpm add -D @jpapini/deepkit-type-plugins
```

## Author

- Julien Papini <julien.papini@gmail.com>
npm package: @jpapini/eslint-config
Description: Custom ESLint configuration for JavaScript and TypeScript projects.
Author: Julien Papini
Latest version: 1.21.5

# ESLint configuration

Custom ESLint configuration for JavaScript and TypeScript projects.

Additional configurations are available for:

- Node.js projects: `createBaseEslintConfig`
- React projects: `createReactEslintConfig`

## How to use

1. Install the package and its required peer dependencies:

```bash
pnpm add -D @jpapini/eslint-config eslint
```

1. Edit your `package.json` file to include the following:

```json
{
    "scripts": {
        "lint:eslint": "eslint --flag unstable_config_lookup_from_file --cache --cache-location node_modules/.cache/eslint/.eslintcache .",
        "format:eslint": "eslint --flag unstable_config_lookup_from_file --cache --cache-location node_modules/.cache/eslint/.eslintcache --fix ."
    }
}
```

3. Create a `eslint.config.js` file with the following content:

```javascript
import url from 'node:url';

import { createBaseEslintConfig } from '@jpapini/eslint-config';

export default createBaseEslintConfig(url.fileURLToPath(new URL('.', import.meta.url)));
```

## Author

- Julien Papini <julien.papini@gmail.com>
npm package: @jpapini/eslint-config-jest
Description: Shared ESLint Jest configuration for JavaScript projects.
Author: Julien Papini
Latest version: 0.4.1

# Tools - ESLint Jest configuration <!-- omit in toc -->

Shared ESLint Jest configuration for JavaScript projects.

## Table of contents <!-- omit in toc -->

-   [How to install](#how-to-install)
-   [Author](#author)

## Requirements

This package requires the following ESLint base configuration: `@jpapini/eslint-config`.

## How to install

Run the following command to install the required dependencies:

```shell
$ <yarn|npm|pnpm> add -D @jpapini/eslint-config-jest jest
```

Add the following fields to your `package.json`:

```json
{
    "eslintConfig": {
        "extends": ["@jpapini/eslint-config", "@jpapini/eslint-config-jest"]
    }
}
```

Don't forget to create a `.eslintignore` file to ignore unnecessary files.

## Author

-   Julien Papini <julien.papini@gmail.com>
npm package: @jpapini/eslint-config-next
Description: Shared ESLint Next.js configuration for JavaScript projects.
Author: Julien Papini
Latest version: 0.4.1

# Tools - ESLint Next.js configuration <!-- omit in toc -->

Shared ESLint Next.js configuration for JavaScript projects.

## Table of contents <!-- omit in toc -->

-   [How to install](#how-to-install)
-   [Author](#author)

## Requirements

This package requires the following ESLint base configuration: `@jpapini/eslint-config`.

## How to install

Run the following command to install the required dependencies:

```shell
$ <yarn|npm|pnpm> add -D @jpapini/eslint-config-next
$ <yarn|npm|pnpm> add next
```

Add the following fields to your `package.json`:

```json
{
    "eslintConfig": {
        "extends": ["@jpapini/eslint-config", "@jpapini/eslint-config-next"]
    }
}
```

Don't forget to create a `.eslintignore` file to ignore unnecessary files.

## Author

-   Julien Papini <julien.papini@gmail.com>
npm package: @jpapini/eslint-config-prettier
Description: Shared ESLint Prettier configuration for JavaScript projects.
Author: Julien Papini
Latest version: 0.4.1

# Tools - ESLint Prettier configuration <!-- omit in toc -->

Shared ESLint Prettier configuration for JavaScript projects.

## Table of contents <!-- omit in toc -->

-   [How to install](#how-to-install)
-   [Author](#author)

## How to install

Run the following command to install the required dependencies:

```shell
$ <yarn|npm|pnpm> add -D @jpapini/eslint-config-prettier prettier
```

Add the following fields to your `package.json`:

```json
{
    "eslintConfig": {
        "extends": [..., "@jpapini/eslint-config-prettier"]
    }
}
```

Don't forget to create a `.eslintignore` file to ignore unnecessary files.

## Author

-   Julien Papini <julien.papini@gmail.com>
npm package: @jpapini/eslint-config-react
Description: Shared ESLint React.js configuration for JavaScript projects.
Author: Julien Papini
Latest version: 0.4.1

# Tools - ESLint React.js configuration <!-- omit in toc -->

Shared ESLint React.js configuration for JavaScript projects.

## Table of contents <!-- omit in toc -->

-   [How to install](#how-to-install)
-   [Author](#author)

## Requirements

This package requires the following ESLint base configuration: `@jpapini/eslint-config`.

## How to install

Run the following command to install the required dependencies:

```shell
$ <yarn|npm|pnpm> add -D @jpapini/eslint-config-react
$ <yarn|npm|pnpm> add react react-dom
```

Add the following fields to your `package.json`:

```json
{
    "eslintConfig": {
        "extends": ["@jpapini/eslint-config", "@jpapini/eslint-config-react"]
    }
}
```

Don't forget to create a `.eslintignore` file to ignore unnecessary files.

## Author

-   Julien Papini <julien.papini@gmail.com>
npm package: @jpapini/eslint-config-remotion
Description: Shared ESLint Remotion configuration for JavaScript projects.
Author: Julien Papini
Latest version: 0.4.1

# Tools - ESLint Remotion configuration <!-- omit in toc -->

Shared ESLint Remotion configuration for JavaScript projects.

## Table of contents <!-- omit in toc -->

-   [How to install](#how-to-install)
-   [Author](#author)

## Requirements

This package requires the following ESLint base configuration: `@jpapini/eslint-config`.

## How to install

Run the following command to install the required dependencies:

```shell
$ <yarn|npm|pnpm> add -D @jpapini/eslint-config-remotion
$ <yarn|npm|pnpm> add remotion
```

Add the following fields to your `package.json`:

```json
{
    "eslintConfig": {
        "extends": ["@jpapini/eslint-config", "@jpapini/eslint-config-remotion"]
    }
}
```

Don't forget to create a `.eslintignore` file to ignore unnecessary files.

## Author

-   Julien Papini <julien.papini@gmail.com>
npm package: @jpapini/eslint-config-typescript
Description: Shared ESLint TypeScript configuration for JavaScript projects.
Author: Julien Papini
Latest version: 0.4.1

# Tools - ESLint TypeScript configuration <!-- omit in toc -->

Shared ESLint TypeScript configuration for JavaScript projects.

## Table of contents <!-- omit in toc -->

-   [How to install](#how-to-install)
-   [Author](#author)

## Requirements

This package requires the following ESLint base configuration: `@jpapini/eslint-config`.

## How to install

Run the following command to install the required dependencies:

```shell
$ <yarn|npm|pnpm> add -D @jpapini/eslint-config-typescript typescript
```

Add the following fields to your `package.json`:

```json
{
    "eslintConfig": {
        "extends": ["@jpapini/eslint-config", "@jpapini/eslint-config-typescript"]
    }
}
```

Don't forget to create a `.eslintignore` file to ignore unnecessary files.

## Author

-   Julien Papini <julien.papini@gmail.com>
npm package: @jpapini/git-hooks
Description: Git hooks configuration.
Author: Julien Papini
Latest version: 1.5.10

# Git hooks configuration

Git hooks configuration.

## How to use

1. Install the package and its required peer dependencies:

```bash
pnpm add -D @jpapini/git-hooks
```

## Author

- Julien Papini <julien.papini@gmail.com>
npm package: @jpapini/http-server
Description: Wrapper around http-server for handling .env files.
Author: Julien Papini
Latest version: 1.5.6

# Http server

Wrapper around http-server for handling .env files.

## How to use

1. Install the package and its required peer dependencies:

```bash
pnpm add -D @jpapini/http-server
```

2. Create a `.env` file with the following content:

```env
PUBLIC_URL=http://localhost:8080/
```

## Author

- Julien Papini <julien.papini@gmail.com>
npm package: @jpapini/jest-config
Description: Jest configuration and utilities for JavaScript and TypeScript projects.
Author: Julien Papini
Latest version: 1.8.6

# Jest configuration

Jest configuration and utilities for JavaScript and TypeScript projects.

## How to use

1. Install the package and its required peer dependencies:

```bash
pnpm add -D @jpapini/jest-config @swc/core @swc/jest jest @types/jest
```

2. Create a `jest.config.js` file with the following content:

For ESM projects:

```javascript
import { createRequire } from 'node:module';
import url from 'node:url';

import { createJestConfig, pathsToModuleNameMapper } from '@jpapini/jest-config';

const require = createRequire(import.meta.url);
const { compilerOptions } = require('./tsconfig.json');

export default createJestConfig({
    rootDir: url.fileURLToPath(new URL('.', import.meta.url)),
    moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths, { prefix: '<rootDir>/' }),
});
```

or for CJS projects:

```javascript
const path = require('node:path');

const { createJestConfig, pathsToModuleNameMapper } = require('@jpapini/jest-config');

const { compilerOptions } = require('./tsconfig.json');

module.exports = createJestConfig({
    rootDir: path.resolve(__dirname),
    moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths, { prefix: '<rootDir>/' }),
});
```

3. Edit your `package.json` file to include the following:

```json
{
    "scripts": {
        "test": "jest --color --passWithNoTests",
        "test:watch": "pnpm run test --watch",
        "test:cov": "pnpm run test --coverage"
    }
}
```

## Author

- Julien Papini <julien.papini@gmail.com>
npm package: @jpapini/lint-staged-config
Description: Lint-staged configuration for linting and formatting staged files.
Author: Julien Papini
Latest version: 1.5.10

# Lint-staged configuration

Lint-staged configuration for linting and formatting staged files.

## How to use

1. Install the package and its required peer dependencies:

```bash
pnpm add -D @jpapini/lint-staged-config lint-staged
```

## Author

- Julien Papini <julien.papini@gmail.com>
npm package: @jpapini/logger
Description: Custom logger using consola for pretty output.
Author: Julien Papini
Latest version: 1.5.6

# Logger

Custom logger using consola for pretty output.

## How to use

1. Install the package and its required peer dependencies:

```bash
pnpm add @jpapini/logger
```

2. Import the logger and use it in your project:

```typescript
import { logger } from '@jpapini/logger';

logger.info('Hello, world!');
```

## Author

- Julien Papini <julien.papini@gmail.com>
npm package: @jpapini/nest-utils
Description: Shared Nest.js utilities.
Author: Julien Papini
Latest version: 1.6.5

# Nest.js utilities

Shared Nest.js utilities.

## How to use

1. Install the package and its required peer dependencies:

```bash
pnpm add @jpapini/nest-utils @nestjs/common
```

## Author

- Julien Papini <julien.papini@gmail.com>
npm package: @jpapini/npm-package-json-lint-config
Description: Shared npm-package-json-lint configuration for JavaScript projects.
Author: Julien Papini
Latest version: 0.4.1

# Tools - npm-package-json-lint configuration <!-- omit in toc -->

Shared npm-package-json-lint configuration for JavaScript projects.

## Table of contents <!-- omit in toc -->

-   [How to install](#how-to-install)
    -   [Rules](#rules)
-   [How to use](#how-to-use)
-   [Author](#author)

## How to install

Run the following command to install the required dependencies:

```shell
$ <yarn|npm|pnpm> add -D @jpapini/npm-package-json-lint-config npm-package-json-lint
```

Add the following fields to your `package.json`:

```json
{
    "scripts": {
        "lint:pkglint": "npmPkgJsonLint ."
    },
    "npmpackagejsonlint": {
        "extends": "@jpapini/npm-package-json-lint-config"
    }
}
```

### Rules

| Rule name                                                    | Description                                                      |
| ------------------------------------------------------------ | ---------------------------------------------------------------- |
| @jpapini/npm-package-json-lint-config                        | Rules for private single repo project (e.g. React application).  |
| @jpapini/npm-package-json-lint-config/single-public          | Rules for public single repo project (under MIT license).        |
| @jpapini/npm-package-json-lint-config/single-private-package | Rules for private single repo package (e.g. Single NPM package). |
| @jpapini/npm-package-json-lint-config/single-public-package  | Rules for public single repo package (under MIT license).        |
| @jpapini/npm-package-json-lint-config/monorepo-private       | Rules for private monorepo project (e.g. Multiple NPM packages). |
| @jpapini/npm-package-json-lint-config/monorepo-public        | Rules for public monorepo project (under MIT license).           |

## How to use

Run `pnpm run lint:pkglint` for linting `package.json` files.

## Author

-   Julien Papini <julien.papini@gmail.com>
npm package: @jpapini/prettier-config
Description: Custom Prettier configuration for JavaScript and TypeScript projects.
Author: Julien Papini
Latest version: 1.5.7

# Prettier configuration

Custom Prettier configuration for JavaScript and TypeScript projects.

## How to use

1. Install the package and its required peer dependencies:

```bash
pnpm add -D @jpapini/prettier-config prettier
```

2. Edit your `package.json` file to include the following:

```json
{
    "scripts": {
        "lint:prettier": "prettier --cache --cache-location node_modules/.cache/prettier/.prettiercache -u -c '**/*' '!**/pnpm-lock.yaml'",
        "format:prettier": "prettier --cache --cache-location node_modules/.cache/prettier/.prettiercache -u -w '**/*' '!**/pnpm-lock.yaml'"
    },
    "prettier": "@jpapini/prettier-config"
}
```

## Author

- Julien Papini <julien.papini@gmail.com>
npm package: @jpapini/prettier-config-prisma
Description: Shared Prettier configuration with Prisma plugin for JavaScript projects.
Author: Julien Papini
Latest version: 0.4.1

# Tools - Prettier Prisma configuration <!-- omit in toc -->

Shared Prettier configuration with Prisma plugin for JavaScript projects.

## Table of contents <!-- omit in toc -->

-   [How to install](#how-to-install)
-   [How to use](#how-to-use)
-   [Author](#author)

## How to install

Run the following command to install the required dependencies:

```shell
$ <yarn|npm|pnpm> add -D @jpapini/prettier-config-prisma prettier
```

Add the following fields to your `package.json`:

```json
{
    "scripts": {
        "lint:prettier": "prettier --check -u '**/*'",
        "format:prettier": "prettier --write -u '**/*'"
    },
    "prettier": "@jpapini/prettier-config-prisma"
}
```

Don't forget to create a `.prettierignore` file to ignore unnecessary files.

## How to use

Run `pnpm run lint:prettier` for linting files.

Run `pnpm run format:prettier` for formatting files.

## Author

-   Julien Papini <julien.papini@gmail.com>
npm package: @jpapini/prettier-plugin-packagejson
Description: Custom Prettier plugin for formatting package.json files.
Author: Julien Papini
Latest version: 1.0.2

# Prettier plugin for package.json files

Custom Prettier plugin for formatting package.json files.

## How to use

1. Install the package and its required peer dependencies:

```bash
pnpm add -D @jpapini/prettier-plugin-packagejson
```

## Author

- Julien Papini <julien.papini@gmail.com>
npm package: @jpapini/renovate-config
Description: Shared Renovate configuration for JavaScript projects.
Author: Julien Papini
Latest version: 0.4.1

# Tools - Renovate configuration <!-- omit in toc -->

Shared Renovate configuration for JavaScript projects.

## Table of contents <!-- omit in toc -->

-   [How to install](#how-to-install)
-   [Author](#author)

## How to install

Create a `.github/renovate.json` with the following contents:

```json
{
    "extends": ["github>jpapini/tools-javascript//packages/renovate-config/default"]
}
```

## Author

-   Julien Papini <julien.papini@gmail.com>
npm package: @jpapini/stylelint-config
Description: Custom Stylelint configuration for Tailwind CSS projects.
Author: Julien Papini
Latest version: 1.5.8

# Stylelint configuration

Custom Stylelint configuration for Tailwind CSS projects.

## How to use

1. Install the package and its required peer dependencies:

```bash
pnpm add -D @jpapini/stylelint-config stylelint
```

2. Edit your `package.json` file to include the following:

```json
{
    "scripts": {
        "lint:stylelint": "stylelint --cache --cache-location node_modules/.cache/stylelint/.stylelintcache --allow-empty-input '**/*.css'",
        "format:stylelint": "stylelint --cache --cache-location node_modules/.cache/stylelint/.stylelintcache --allow-empty-input --fix '**/*.css'"
    },
    "stylelint": {
        "extends": "@jpapini/stylelint-config"
    }
}
```

3. Add a `.stylelintignore` file with the following content:

```text
### Jetbrains IDEs ###
.idea

### Visual Studio Code ###
.vscode

### Dependencies ###
node_modules
.pnpm-store

### Cache ###
.turbo

### Compiled outputs ###
dist
generated

### Tests ###
coverage

### Temporary ###
old
```

## Author

- Julien Papini <julien.papini@gmail.com>
npm package: @jpapini/tools-utils
Description: Shared utilities for JavaScript tools.
Author: Julien Papini
Latest version: 0.4.1

# Tools - Tools utilities <!-- omit in toc -->

Shared utilities for JavaScript tools.

## Table of contents <!-- omit in toc -->

-   [How to install](#how-to-install)
-   [Author](#author)

## How to install

Run the following command to install the required dependencies:

```shell
$ <yarn|npm|pnpm> add -D @jpapini/tools-utils
```

## Author

-   Julien Papini <julien.papini@gmail.com>
npm package: @jpapini/tsup-config
Description: Custom tsup configuration for TypeScript libraries.
Author: Julien Papini
Latest version: 1.5.4

# tsup configuration

Custom tsup configuration for TypeScript libraries.

## How to use

1. Install the package and its required peer dependencies:

```bash
pnpm add -D @jpapini/tsup-config tsup
```

2. Create a `tsup.config.js` file with the following content:

```javascript
import { fileURLToPath } from 'node:url';

import { createLibraryConfiguration } from '@jpapini/tsup-config';

export default createLibraryConfiguration(fileURLToPath(new URL('.', import.meta.url)));
```

3. Edit the `package.json` file to add the following scripts:

```json
{
    "scripts": {
        "build": "tsup"
    }
}
```

## Author

- Julien Papini <julien.papini@gmail.com>
npm package: @jpapini/type-check
Description: This package provides a set of utilities to check the type of values.
Author: Julien Papini
Latest version: 1.6.4

# Type-check utils

This package provides a set of utilities to check the type of values.

## How to use

1. Install the package and its required peer dependencies:

```bash
pnpm add @jpapini/type-check
```

2. Use the functions in your code:

```typescript
import { isString } from '@jpapini/type-check';

console.log(isString('hello')); // true
console.log(isString(42)); // false
```

## Author

- Julien Papini <julien.papini@gmail.com>
npm package: @jpapini/typescript-config
Description: Custom Typescript configurations.
Author: Julien Papini
Latest version: 1.5.6

# Typescript configurations

Custom Typescript configurations.

Available configurations:

- Node.js projects: `@jpapini/typescript-config/tsconfig.node.json`
- React.js projects: `@jpapini/typescript-config/tsconfig.react.json`
- Nest.js projects: `@jpapini/typescript-config/tsconfig.nest.json`

## How to use

1. Install the package and its required peer dependencies:

```bash
pnpm add -D @jpapini/typescript-config typescript @types/node
```

2. Create a `tsconfig.json` file in the root of your project and extend the desired configuration:

```json
{
    "$schema": "https://json.schemastore.org/tsconfig",
    "extends": "@jpapini/typescript-config/tsconfig.node.json",
    "compilerOptions": {
        "baseUrl": ".",
        "paths": {
            "~/*": ["src/*"]
        }
    },
    "include": ["src/**/*", "dts/**/*"],
    "exclude": ["node_modules", "dist"]
}
```

## Author

- Julien Papini <julien.papini@gmail.com>
npm package: @jpapini/unplugin-deepkit-type
Description: Unplugin for using Deepkit type with various build tools.
Author: Julien Papini
Latest version: 1.0.2

# Deepkit type unplugin

Unplugin for using Deepkit type with various build tools.

## How to use

1. Install the package and its required peer dependencies:

```bash
pnpm add -D @jpapini/unplugin-deepkit-type @deepkit/type-compiler
```

## Author

- Julien Papini <julien.papini@gmail.com>
npm package: @jpapini/vite-config
Description: Custom Vite.js configuration for TypeScript libraries.
Author: Julien Papini
Latest version: 1.1.11

# Vite.js configuration

Custom Vite.js configuration for TypeScript libraries.

## How to use

1. Install the package and its required peer dependencies:

```bash
pnpm add -D @jpapini/vite-config vite
```

2. Create a `vite.config.js` file with the following content:

```javascript
import url from 'node:url';

import { createLibraryViteConfig } from '@jpapini/vite-config';

export default createLibraryViteConfig({
    rootDir: url.fileURLToPath(new URL('.', import.meta.url)),
});
```

3. Edit the `package.json` file to add the following scripts:

```json
{
    "scripts": {
        "build": "vite build"
    }
}
```

## Author

-   Julien Papini <julien.papini@gmail.com>
npm package: @jpapini/webpack-config
Description: Custom Webpack configuration for bundling projects.
Author: Julien Papini
Latest version: 2.8.2

# Webpack configuration

Custom Webpack configuration for bundling projects.

Available configurations:

- React.js projects: `createReactAppWebpackConfig`
- Nest.js projects: `createNestAppWebpackConfig`

## How to use

1. Install the package and its required peer dependencies:

```bash
pnpm add -D @jpapini/webpack-config @swc/core webpack webpack-cli webpack-dev-server
```

2. Create a `webpack.config.js` file with the following content:

For ESM projects:

```javascript
import url from 'node:url';
import { createNestAppWebpackConfig } from '@jpapini/webpack-config';

export default createNestAppWebpackConfig(url.fileURLToPath(new URL('.', import.meta.url)));
```

Or for CommonJS projects:

```javascript
const path = require('node:path');

const { createNestAppWebpackConfig } = require('@jpapini/webpack-config');

module.exports = createNestAppWebpackConfig(path.resolve(__dirname));
```

3. Edit the `package.json` file to add the following scripts:

```json
{
    "scripts": {
        "dev": "webpack watch",
        "build": "webpack build"
    }
}
```

## Author

- Julien Papini <julien.papini@gmail.com>
npm package: @jpatcharapun/stargb-sdk
Description: 🛠 An SDK for building applications on top of Pancakeswap. but use in StarGB
Latest version: 2.4.3

# Pancakeswap SDK

Forked from the [Uniswap SDK](https://github.com/Uniswap/uniswap-v2-sdk/commit/a88048e9c4198a5bdaea00883ca00c8c8e582605).

You can refer to the Uniswap SDK documentation [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/pancakeswap/pancake-swap-sdk.git
```

Move into the pancakeswap-sdk working directory

```sh
cd pancakeswap-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: @jpaulobneto/lerna-pkg-a
Description: > TODO: description
Author: João Paulo Barbosa
Latest version: 1.0.0

# `@jpaulobneto/lerna-pkg-a`

> TODO: description

## Usage

```
const lernaPkgA = require('@jpaulobneto/lerna-pkg-a');

// TODO: DEMONSTRATE API
```
npm package: @jpaulobneto/lerna-pkg-b
Description: > TODO: description
Author: João Paulo Barbosa
Latest version: 1.0.0

# `@jpaulobneto/lerna-pkg-b`

> TODO: description

## Usage

```
const lernaPkgB = require('@jpaulobneto/lerna-pkg-b');

// TODO: DEMONSTRATE API
```
npm package: @jpaulobneto/lerna-pkg-c
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: João Paulo Barbosa
Latest version: 1.0.0

# `@jpaulobneto/lerna-pkg-c`

> TODO: description

## Usage

```
const lernaPkgC = require('@jpaulobneto/lerna-pkg-c');

// TODO: DEMONSTRATE API
```
npm package: @jpaulobneto/monorepo-a-pkg-2
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: João Paulo Barbosa
Latest version: 1.1.0

# `@jpaulobneto/monorepo-a-pkg-2`

> TODO: description

## Usage

```
const monorepoAPkg2 = require('@jpaulobneto/monorepo-a-pkg-2');

// TODO: DEMONSTRATE API
```
npm package: @jpaulobneto/monorepo-c-pkg-sub1
Description: > TODO: description
Author: João Paulo Barbosa
Latest version: 0.1.0

# `@jpaulobneto/monorepo-c-pkg-sub1`

> TODO: description

## Usage

```
const monorepoCPkgSub1 = require('@jpaulobneto/monorepo-c-pkg-sub1');

// TODO: DEMONSTRATE API
```
npm package: @jpaulobneto/monorepo-c-pkg-sub2
Description: > TODO: description
Author: João Paulo Barbosa
Latest version: 0.1.0

# `@jpaulobneto/monorepo-c-pkg-sub2`

> TODO: description

## Usage

```
const monorepoCPkgSub2 = require('@jpaulobneto/monorepo-c-pkg-sub2');

// TODO: DEMONSTRATE API
```
npm package: @jpavel/uzip-esm
Description: An ESM build of Photopea's UZIP.js
Author: Ivan Kutskir
Latest version: 1.0.1

# uzip-esm

An ESM build of Photopea's [UZIP.js](https://github.com/photopea/UZIP.js/)

## Installation

```sh
npm i @jpavel/uzip-esm
```

## Usage

```js
import UZIP from '@jpavel/uzip-esm';

// Use UZIP.parse(), UZIP.encode(), etc.
```