file-syncer-dev:一个简化你的多项目开发流程的工具

158 阅读2分钟

开发动机:

表面上:

由于公司项目的复杂性,经常一个功能需要在多个项目中开发。有时候需要更改的项目还是 npm 包或者是小程序的分包,这种场景下,本地调试使用 npm link 已经不能很好满足需求了。「改一下再打个测试包」这种方法的效率慢得太难受了;「先在主项目改完,然后再 copy 一份到子项目去」这方法也不是不能玩,就是改完 copy 的时候漏一两个文件就原地起飞而已~ 实在是受够了多项目开发的调试痛苦(意味着 ddl 加班赶工😭),才有了这么一个小东西。

实际上:骗下载量🤣

闲话说完,入正题~


简介

file-syncer-dev 本身是一个工具型的 NPM 包。它可以帮助你快速配置和使用文件同步功能。适用于 npm 包本地调试、小程序子包开发等其他跨项目的文件同步需求。(剩余场景等你们挖掘);此外,它同样适用于单一项目的文件同步,确保您的开发流程更加顺畅和高效。

功能

  • 实时文件同步:自动将文件从源目录同步到目标目录。
  • 可定制的配置:轻松配置需要同步的目录。

安装

本地安装

在你的项目中,可以用以下方法来安装 file-syncer-dev 命令行工具:

npm install -D file-syncer-dev

全局安装

npm install -g file-syncer-dev

安装后,你可以在任意项目中直接使用 filesync-dev 命令。

配置

在项目的根目录中创建一个 filesync.config.js 文件,以指定要同步的目录。以下是一个示例配置:

const path = require('path');

module.exports = [
    {
        key: 'services',
        source: path.join(__dirname, './services'),
        target: path.join(__dirname, './dist/services')
    },
    {
        key: 'components',
        source: path.join(__dirname, './src/components'),
        target: path.join(__dirname, './dist/components')
    }
];

配置详情

  • key:每个同步配置的唯一标识符。在使用命令行时用于指定要同步的目录。
  • source:文件所在的源目录路径。此目录中的更改将触发同步。
  • target:文件将被复制到的目标目录路径。这是同步文件的目的地。

使用

要启动文件同步器,请使用以下命令:

npx filesync-dev watch  # 只安装在项目

# or

filesync-dev watch # 已全局安装

这将开始监控指定的目录,并实时同步任何更改。

使用 sync 和 watch 命令

  • sync:使用 filesync-dev sync <keys...> 命令手动同步指定的目录。此命令将立即将源目录中的所有文件复制到目标目录。

  • watch:使用 filesync-dev watch 命令启动文件监控模式。此模式下,任何源目录中的更改都会自动同步到目标目录。


写在后面:

有什么改进建议或者疑问,欢迎在评论区提出~

file-syncer-dev 的 NPM地址