Skip to content

qiwi/license

Repository files navigation

QIWI Open Source Software License

CI Maintainability Test Coverage npm (scoped)

MIT compatible and corresponding to the Civil Code of the Russian Federation.

Install

yarn add @qiwi/license -D
npm add @qiwi/license -D

Usage

Through CLI

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

With npx

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

TS/JS

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