基于node实现自动识别库(package.json)是否存在更新并拉取

背景

某年某月的某一天,同事A提交新功能,同时包含新功能所用到的依赖修改一并提交到仓库中。这时,同事b在不知情的情况下,同步了更新,并直接快乐的敲下了启动命令yarn dev,之后当然就是构建失败。

在上述背景下,同事b决定作出一个工具来解决这时候的尴尬

需求分析

  • 在每次运行某个脚本之前,先行检查库是否更新,通过后再运行后面的脚本
    实现思路:

在每个脚本前,放置检查脚本,例如:

{
 "scripts": {
   "dev": "node util/checkDependency.js && webpack-dev-server --open --config xxx"
 }
}
  • 用户在没有初始化的时候运行了脚本,需要帮助用户初始化
    实现思路:
  1. 先检查项目node_modules是否存在,不存在,则直接运行初始化脚本,并缓存当前package.json
  2. 再检查是否存在缓存的package.json文件,不存在也视为版本有差异,初始化后缓存
  3. 如果缓存的package.json存在,则检查其中的devDependenciesdependencies每项是否一致,并且keys都能对应得上。否则初始化,并更新缓存

实现代码

由于是ts实现,写完后需要先用tsc编译成js方可

import * as fs from 'fs'
import * as path from 'path'
import { spawn } from 'child_process';

function updateLib() {
  const cmd_yarn = 'yarn -i';//优先运行yarn -i
  const cmd_npm = 'npm install'// 如果上面的运行失败了,再降级运行这行
  spawn(cmd_yarn, {
    stdio: 'inherit',
    shell: true
  }).addListener('exit', (code) => {
    if (code !== 0) {
      spawn(cmd_npm, {
        stdio: 'inherit',
        shell: true
      })
    }
  })
}

(function () {
  const packagePath = path.resolve(__dirname, '../../package.json');//原始package.json路径
  const catchPath = path.resolve(__dirname, '../../.catch');//缓存的package.json路径
  const node_modulesPath = path.resolve(__dirname, '../../node_modules');
  const packageCatchPath = catchPath + '/package.json.catch';
  let packageJson: PackageJson;

//缓存功能实现函数
  function writeCatch() {
    try {
      fs.writeFileSync(packageCatchPath, JSON.stringify(packageJson, null, ""))
    } catch (error) {
      console.error('package.json缓存文件写入失败')
    }
  }

  try {
    packageJson = JSON.parse(fs.readFileSync(packagePath, 'utf-8'));
  } catch (error) {
    throw '包文件读取错误!'
  }

  if (!fs.existsSync(catchPath) || !fs.existsSync(node_modulesPath)) {
    if (!fs.existsSync(catchPath)) fs.mkdirSync(catchPath);
    updateLib();
    writeCatch();
  }
  else if (!fs.existsSync(packageCatchPath)) {
    updateLib();
    writeCatch();
  }
  else {
    try {
      const packageCatchJson: PackageJson = JSON.parse(fs.readFileSync(packageCatchPath, 'utf-8'));
      const packageCatchLibs = { ...packageCatchJson.dependencies, ...packageCatchJson.devDependencies };
      const packageLibs = { ...packageJson.devDependencies, ...packageJson.dependencies };
      const pcjks = Object.keys(packageCatchLibs);
      const pjksStack = Object.keys(packageLibs);
      let check = true;
//对比对应key的value(也就是版本)是否相同,一旦不相同,就更新它
      while (pjksStack.length) {
        const lib = pjksStack.pop();
        if (!packageCatchLibs[lib] || packageCatchLibs[lib] !== packageLibs[lib]) {
          console.log(`update lib[${lib}] => { package: ${packageLibs[lib]}, packageCatch: ${packageCatchLibs[lib]}}`)
          check = false;
          break;
        }

        pcjks.splice(pcjks.indexOf(lib), 1);
      }

      if (!check || pcjks.length) {
        console.log('检查到package依赖库有更新,正在执行更新操作......')
        updateLib();
        writeCatch();
      }
    } catch (error) {
      throw `缓存文件格式错误,请删除[${packageCatchPath}]后再试`
    }
  }

  console.log('依赖检查完毕')
})()


export interface PackageJson {
  name: string,
  version: string,
  license: string,
  scripts: {
    [shell: string]: string;
  },
  devDependencies: {
    [lib: string]: string;
  },
  dependencies: {
    [lib: string]: string;
  }
}

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,204评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,091评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,548评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,657评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,689评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,554评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,302评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,216评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,661评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,851评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,977评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,697评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,306评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,898评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,019评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,138评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,927评论 2 355

推荐阅读更多精彩内容