LICENSE 中文文档教程

Question

license

轻松为您的项目生成许可证！

Table of Contents

• What is this?
• Usage
• Examples
• Advanced Usage
• Name
• Email
• Year
• Project
• Default License
• API Usage
• Getting a license you know
• Getting a list of licenses that match a search term
• API Docs
• getLicense(license[, replacements]) => string
• findLicense(search[, osiOnly = true]) => string[]
• License

What is this?

您是否曾经开始过一个新项目，并且需要为其添加新许可证，但是 不知道确切的措辞（因为谁会）？ 你必须 搜索所需的许可证，复制其文本，将其粘贴到新文件中，然后 然后检查是否有您需要的诸如版权信息之类的信息 更新。

License 是一个超级易于使用的 CLI 工具，用于简化 LICENSE 文件 创作过程。 受诸如以下工具的启发，具有超级简单但功能强大的 CLI 现在，为您的新项目设置许可证 从未如此简单！

Usage

首先，通过您选择的包管理器全局安装许可证。

$ yarn global add license
# or
$ npm i -g license

然后只需运行 license 即可生成许可证。

$ license [license]

如果您没有指定要生成的许可证，它将从您的配置中选择， 或显示交互式提示供您搜索。

如果您不想安装许可证而只想运行一次，可以使用 npx

$ npx license [license]
# Or using Yarn 2.x
$ yarn dlx license [license]

Examples

todo

Advanced Usage

默认情况下，许可证将尝试猜测您的姓名、电子邮件、当前项目和 在其生成的许可证中使用的当前年份。 您可以在 虽然有很多方法。

Name

默认情况下，许可证将尝试从您的 Git 配置中获取您的名称， （git config --global user.name）。 如果失败，它将回退到使用 USER 环境变量，通常是您在 shell 中的用户名。

您可以通过两种方式覆盖它：

1. Overriding it as a one time thing by providing a --name option while running license (also alised to -n).
2. Overriding it permanently by using license config --name <name>, which will add it to the global config, and will be used for any future calls to license, unless the --name option above is used, in which case that will take precedence.

Email

默认情况下，许可证将尝试从您的 Git 配置获取您的电子邮件，只需 就像它对你的名字所做的那样，（git config --global user.email），但它确实 没有任何后备可使用，因此建议您使用两者中的任何一个 覆盖下面的方法。

1. Overriding it as a one time thing by providing an --email option while running license (also aliased to -e).
2. Overriding it permanently by using license config --email <email>, which will add it to the global config, and will be used for any future calls to license, unless the --email option above is used, in which case that will take precedence.

Year

默认情况下，许可证将使用当前年份（根据您的系统时间）来 填写，但是您可以使用 --year 选项设置自定义年份 许可证。

它全年支持多种格式：

1. a plain year - 2009
2. a year range - 2005-2009
3. a list of years - 2004, 2006, 2007 - also supports ranges in it - 2004, 2005-2009, 2011

Project

默认情况下，许可证将使用其制作许可证文件的目录 项目的名称，但是如果目录名称与 项目名称或其他名称，您可以使用 --projectName 覆盖该名称 许可选项。

如果您想更改生成许可证的目录，而不需要 需要cd进入它，您可以提供--project选项（别名为-p） 而是使用目录路径，它将在那里生成许可证。 它还会将项目名称集更改为目录的名称，除非您 指定上面的 --projectName 选项。

Default License

如果您希望能够运行 license 而不必指定相同的 每次都使用许可证 - 假设您只想在任何地方使用 MIT 许可证，因为 那是你的首选。 您可以设置默认生成的许可证 license config --license，它将继续将其用于所有 以后的调用无需每次都指定 MIT 作为许可证。

当然，您可以通过指定许可证来推翻此决定 通过正常使用调用license，这只是更改默认的空 从搜索提示到自动填写许可证的行为。

API Usage

您还可以通过简单的API来使用license的核心功能，

Getting a license you know

import { getLicense } from "license";

// Get license template text
console.log(getLicense("MIT"));

// Fill out some info
console.log(getLicense("MIT", { author: "Ovyerus", year: "2020" }));

Getting a list of licenses that match a search term

import { findLicense } from "license";

console.log(findLicense("mi"));
// [ 'MIT', 'MirOS', 'Multics', 'MPL-2.0-no-copyleft-exception' ]

console.log(findLicense("mit"));
// [ 'MIT' ] (exact match)

// Showing more licenses than just OSI-approved
console.log(findLicense("mi", false));
// [
//   'CDLA-Permissive-1.0',
//   'MIT',
//   'MIT-0',
//   'MIT-CMU',
//   'MIT-advertising',
//   'MIT-enna',
//   'MIT-feh',
//   'MITNFA',
//   'MirOS',
//   ...
// ]

结合起来，您可以提供强大的许可证搜索体验，而无需 需要您的用户准确记住他们想要的内容的名称。

API Docs

getLicense(license[, replacements]) => string

获取给定许可证的正文，可以选择填写任何占位符 具有给定值的值，例如作者或日期。

许可证（字符串）

要获取/填写的许可证名称。必须完全匹配，包括 大写。

replacements (object)

一个简单的 key: value 对象，用于填充给定的任何当前占位符 许可证文本，其中 key 用作占位符的名称，value 为 什么取代占位符。

findLicense(search[, osiOnly = true]) => string[]

给定一个字符串，获取可能匹配的许可证标识符的列表 - 可能 用户输入。 如果输入完全匹配（无大写），它将返回 仅此而已，以便更轻松地确定用户是否获得了搜索 正确的。

搜索（字符串）

用于在所有标识符中搜索匹配项的字符串。

osiOnly（布尔值）

确定是否仅在文件中显示 OSI 批准的许可证。 结果。 默认为true。

License

该存储库及其内部的代码已根据 MIT 许可证获得许可。 读 许可证了解更多信息。