grunt-ftp-deploy 使用教程

grunt-ftp-deploy 使用教程

grunt-ftp-deployGrunt task for code deployment over ftp项目地址:https://gitcode.com/gh_mirrors/gr/grunt-ftp-deploy

1. 项目的目录结构及介绍

grunt-ftp-deploy 是一个用于通过 FTP 自动部署前端代码的 Grunt 插件。以下是该项目的目录结构及各部分介绍：

grunt-ftp-deploy/
├── LICENSE
├── README.md
├── examples/
│   └── Gruntfile.js
├── lib/
│   ├── deploy.js
│   └── utils.js
├── package.json
└── tasks/
    └── ftp_deploy.js

• LICENSE: 项目的许可证文件。
• README.md: 项目的说明文档。
• examples/: 包含示例配置文件 Gruntfile.js。
• lib/: 包含核心功能的实现文件 deploy.js 和工具函数 utils.js。
• package.json: 项目的依赖和元数据信息。
• tasks/: 包含插件的主要任务文件 ftp_deploy.js。

2. 项目的启动文件介绍

项目的启动文件是 Gruntfile.js，通常位于项目的根目录或 examples 目录下。以下是一个示例 Gruntfile.js 的内容：

module.exports = function(grunt) {
  grunt.initConfig({
    'ftp-deploy': {
      build: {
        auth: {
          host: 'ftp.example.com',
          port: 21,
          authKey: 'key1'
        },
        src: 'path/to/source/folder',
        dest: '/path/to/destination/folder',
        exclusions: ['path/to/source/folder/**/.DS_Store']
      }
    }
  });

  grunt.loadNpmTasks('grunt-ftp-deploy');

  grunt.registerTask('default', ['ftp-deploy']);
};

• grunt.initConfig: 初始化配置，定义 FTP 部署的详细参数。
• ftp-deploy: 定义部署任务的配置，包括认证信息、源文件路径、目标路径和排除文件。
• grunt.loadNpmTasks: 加载 grunt-ftp-deploy 任务。
• grunt.registerTask: 注册默认任务，执行 ftp-deploy。

3. 项目的配置文件介绍

项目的配置文件主要是 Gruntfile.js 和 ftppass 文件。以下是这两个文件的详细介绍：

Gruntfile.js

如上所述，Gruntfile.js 包含了 FTP 部署任务的配置信息，包括认证信息、源文件路径、目标路径和排除文件。

ftppass 文件

ftppass 文件用于存储 FTP 认证信息，通常是一个 JSON 文件，内容如下：

{
  "key1": {
    "username": "your_username",
    "password": "your_password"
  }
}

• key1: 认证信息的键名。
• username: FTP 用户名。
• password: FTP 密码。

将 ftppass 文件放置在与 Gruntfile.js 同一目录下，并在 Gruntfile.js 中引用 authKey 为 key1。

通过以上配置，可以实现自动化的 FTP 部署任务。

grunt-ftp-deployGrunt task for code deployment over ftp项目地址:https://gitcode.com/gh_mirrors/gr/grunt-ftp-deploy