# npm-packages

**Repository Path**: salvater/npm-packages

## Basic Information

- **Project Name**: npm-packages
- **Description**: 适用与 npm 包管理、上传个人插件
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-03-22
- **Last Updated**: 2024-11-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### 简介

npm包管理工具，使用vue框架开发，项目支持ts语法。

### 环境搭建

```nginx
# 安装
yarn install

#运行
yarn run serve
```

### 目录

> src/package 插件包
>
> src/package/index 打包配置文件
>
> package.json 配置打包文件
>
> - --target lib 关键字指定打包的目录
> - --name 打包后的文件名字
> - --dest 打包后的文件夹的名称

### 包配置

- 在package.json执行指向的build。

  ```nginx
  yarn run elementForm
  ```

- 打包成功之后，在包下面运行以下命令将会生成一个package.json文件，用于管理该包的一些配置属性。

  ```nginx
  npm init -y
  ```

  - package.json 文件属性

    ```json
    {
      "name": "elementForm",  // 改包命名
      "version": "1.0.0",	  //该包版本号
      "description": "",	  //改包描述，简介
      "main": "elementForm.common.js",	//程序运行入口
      "scripts": {  
        "test": "echo \"Error: no test specified\" && exit 1" 
      },
      "keywords": [],   // 关键字，用于搜索引擎抓取
      "author": "",	    // 作者是谁
      "license": "ISC"  // 许可证
    }
    ```

- README.MD文件
  - 打包之后建议创建README.MD文件，用于描述该包使用描述。

### 发布

- 发布之前没有npm账号先注册，地址：https://www.npmjs.com

- 在发布之前设置npm镜像源，使用以下命令查看或者设置镜像源。

  ```nginx
  # 查看npm配置项
  npm get --list
  
  #查看npm镜像源 如果镜像源是 registry = https://registry.npmjs.org 则不需要改动
  npm get registry
  
  # 如果镜像源为 null 或者其他镜像源需要执行以下命令，用于更改镜像源
  npm config set registry=https://registry.npmjs.org
  ```

- 创建npm账户

  ```nginx
  # 添加账户
  npm addUser 或 npm login
  	Username: 用户名
      Password: 密码
      Email: 邮箱
  	code：邮箱验证码
  ```

- 发布

  ```nginx
  npm publish
  ```