https://github.com/qiwi/license

QIWI Open Source License
https://github.com/qiwi/license

license mit

Last synced: 4 days ago
JSON representation

QIWI Open Source License

• Host: GitHub
• URL: https://github.com/qiwi/license
• Owner: qiwi
• License: other
• Created: 2019-09-30T14:44:00.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T02:15:35.000Z (18 days ago)
• Last Synced: 2024-10-30T12:53:01.841Z (16 days ago)
• Topics: license, mit
• Language: Smarty
• Homepage:
• Size: 1.15 MB
• Stars: 1
• Watchers: 8
• Forks: 1
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# QIWI Open Source Software License

[![CI](https://github.com/qiwi/license/actions/workflows/ci.yaml/badge.svg)](https://github.com/qiwi/license/actions/workflows/ci.yaml)

[![Maintainability](https://api.codeclimate.com/v1/badges/cae4d8e55c58e5cbc4b6/maintainability)](https://codeclimate.com/github/qiwi/license/maintainability)

[![Test Coverage](https://api.codeclimate.com/v1/badges/cae4d8e55c58e5cbc4b6/test_coverage)](https://codeclimate.com/github/qiwi/license/test_coverage)

[![npm (scoped)](https://img.shields.io/npm/v/@qiwi/license)](https://www.npmjs.com/package/@qiwi/license)

[MIT](https://en.wikipedia.org/wiki/MIT_License) compatible and corresponding to the [Civil Code](https://en.wikipedia.org/wiki/Civil_Code_of_Russia) of the Russian Federation. 

* [License in English](./src/main/tpl/license_en.tpl) (en)

* [Лицензия на русском](./src/main/tpl/license_ru.tpl) (ru)

## Install

```bash

yarn add @qiwi/license -D

npm add @qiwi/license -D

```

## Usage

Through CLI

```bash

qiwilicense --name='@qiwi/some-project' --cwd=. --lang=en --file=LICENSE --type=mit --year=2019

```

With [npx](https://blog.npmjs.org/post/162869356040/introducing-npx-an-npm-package-runner)

```bash

npx @qiwi/license --type=mit --year=2019 --cwd=/some/path

```

TS/JS

```ts

import {generate, render} from '@qiwi/license'

// Get the text and do something next

const text = render({

  lang: 'ru',

  year: '2010-2019'

})

// Or just write to a file:

generate({

  name: 'PROJECT_NAME',

  cwd: resolve(__dirname, '../foo/bar'),

  lang: 'en',

  year: '2019'

})

```

## Options

| Option                  | Description                                | Default                    |

|-------------------------|--------------------------------------------|----------------------------|

| `year`, `y`             | Sets year                                  | `new Date().getFullYear()` |

| `lang`, `l`             | Text language                              | `en`                       |

| `file`, `f`             | License file name                          | `LICENSE`                  |

| `cwd`, `c`, `dir`, `d`  | License target dir                         | `process.cwd()`            |

| `name`, `n`             | Project name                               | `name` from `package.json` |

| `type`, `t`             | License type                               | `qosl`                     |

| `patch-pkg-json`        | Set/update license field of `package.json` | `false`                    |

## License

MIT