# create-mit

**Repository Path**: nodets/create-mit

## Basic Information

- **Project Name**: create-mit
- **Description**: 一个命令行工具，用于快速创建 MIT 许可证文件。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-13
- **Last Updated**: 2025-09-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# create-mit

[![NPM version](https://img.shields.io/npm/v/create-mit.svg?style=flat)](https://www.npmjs.com/package/create-mit)
[![License](https://img.shields.io/npm/l/create-mit.svg?style=flat)](https://github.com/your-username/create-mit/blob/main/LICENSE)

一个命令行工具，用于快速创建 MIT 许可证文件。

## 简介

`create-mit` 是一个简单的命令行工具，可以帮助开发者快速在项目中添加 MIT 许可证。通过 `npm init mit` 命令，它会自动在当前目录生成一个包含正确年份和版权信息的 LICENSE 文件。

## 安装

无需预先安装，直接通过 npm 使用：

```bash
npm init mit
```

或者全局安装后使用：

```bash
npm install -g create-mit
create-mit
```

## 使用方法

在你的项目目录中运行：

```bash
npm init mit
```

这将在当前目录创建一个 LICENSE 文件，包含标准的 MIT 许可证文本。

### 功能特性

- 自动生成当前年份的 MIT 许可证
- 自动从 package.json 提取作者信息作为版权持有者
- 如果没有作者信息，则使用项目名称作为版权持有者
- 避免覆盖已存在的 LICENSE 文件

### 命令行选项

```bash
npm init mit --help    # 显示帮助信息
npm init mit --version # 显示版本信息
```

## 工作原理

1. 运行命令后，程序会检查当前目录是否存在 LICENSE 文件
2. 如果文件已存在，则退出并不做任何操作
3. 如果不存在，则从 package.json 中提取作者信息
4. 使用当前年份和作者信息生成标准 MIT 许可证
5. 将许可证内容写入 LICENSE 文件

## 示例输出

生成的 LICENSE 文件内容如下：

```
MIT License

Copyright (c) 2023 Your Project Name

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```