1. 程式人生 > >使用node.js開發一個生成逐幀動畫小工具

使用node.js開發一個生成逐幀動畫小工具

在實際工作中我們已經下下來不下於一萬個npm包了,像我們熟悉的 vue-clireact-native-cli 等,只需要輸入簡單的命令 vue init webpack project,即可快速幫我們生成一個初始專案。在實際開發專案中,我們也可以定製一個屬於自己的npm包,來提高自己的工作效率。

為什麼要開發一個工具包?

  • 減少重複性的工作,不再需要複製其他專案再刪除無關程式碼,或者從零建立一個專案和檔案。

  • 根據互動動態生成專案結構和所需要的檔案等。

  • 減少人工檢查的成本。

  • 提高工作效率,解放生產力。

這次以幀動畫工具為例,來一步一步解析如何開發一個npm

包。

開始前的準備

以我們這次為例。由於目前在做一些活動頁相關的工作,其中動畫部分全都採用CSS3中的animation來完成,但是這樣每次開發都要計算百分比,手動判斷動畫的一些屬性值,十分耗時又很容易出錯,就想能不能寫個指令碼,直接一行命令就可以搞定了呢?!答案當然是肯定的。

理清思路

我們要做一個可以通過讀取圖片就可以自動生成包含CSS animationHTML頁面,以後需要生成相應的CSS片段,直接執行命令就可以了。

初始化

既然是npm包,那我們就需要在npmjs上註冊一個賬號,註冊完成之後回到本地新建一個檔案目錄fbf,進入fbf目錄下執行npm init -y。

  {
     "name": "fbf",
     "version": "1.0.0",
     "description": "",
     "main": "index.js",
     "scripts": {
       "test": "echo \"Error: no test specified\" && exit 1"
     },
     "bin": {
       "test": "index.js"
     },
     "keywords": [],
     "author": "",
     "license": "ISC"
 }

  這樣,你的package.json就建好了。

依賴的庫

來看看會用到哪些庫。

  • commander.js,可以自動的解析命令和引數,用於處理使用者輸入的命令。

  • chalk,可以給終端的字型加上顏色。

  • create-html,建立HTML模版,用於生成HTML

  • image-size,獲取圖片大小。

 

npm install commander chalk create-html image-size -S

 

命令列操作

node.js 內建了對命令列操作的支援,在 package.json 中的 bin 欄位可以定義命令名和關聯的執行檔案。所以現在 package.json

 中加上 bin 的內容:

{
  "name": "fbf",
  "version": "1.0.0",
  "description": "",
  "bin": {
    "fbf": "index.js"
  },
  ...
}

然後在 index.js 中來定義 start 命令:

#!/usr/bin/env node
const program = require('commander');

program.version('1.0.0', '-v, --version')
  .command('start <name>')
  .action((name) => {
    console.log(name);
  });
program.parse(process.argv);

呼叫 version('1.0.0', '-v, --version') 會將 -v 和 --version 新增到命令中,可以通過這些選項打印出版本號。

呼叫 command('start <name>') 定義 start 命令,name 則是必傳的引數,為檔名。

action() 則是執行 start 命令會發生的行為,要生成專案的過程就是在這裡面執行的,這裡暫時只打印出 name

其實到這裡,已經可以執行 start 命令了。我們來測試一下,在 fbf 的同級目錄下執行:

node ./test/index.js start HelloWorld

可以看到命令列工具也打印出了 HelloWorld,那麼很清楚, action((name) => {}) 這裡的引數 name,就是我們執行 start 命令時輸入的專案名稱。

命令已經完成,接下來就要針對圖片的操作了。

獲取圖片資訊

這裡我們預設根據第一張圖片的尺寸資訊作為外層DIV的預設尺寸。

 #!/usr/bin/env node
  const program = require('commander');
  const fs = require('fs');
  const path = require('path');
  const createHTML = require('create-html');
  const sizeOf = require('image-size');
  const chalk = require('chalk');

  program.version('1.0.0', '-v, --version')
  .command('start <dir>')
  .action((dir) => {
    
    //獲取圖片路徑
    const imgPath = path.resolve(dir)

    let imgSize = null;
    fs.readdir(imgPath, (err, file) => {
      imgSize = sizeOf(dir + '/' +file[0]);  
      //取第一個圖片的尺寸作為框尺寸
      let cssString = `
        .fbf-animation{
          width: ${imgSize.width}px;
          height: ${imgSize.height}px;
          margin:auto;
          background-image: url(./${dir}/${file[0]});
          background-size: ${imgSize.width}px ${imgSize.height}px;
          background-repeat: no-repeat;
          animation-name: keyframes-img;
          animation-duration: 0.36s;
          animation-delay: 0s;
          animation-iteration-count: infinite;
          animation-fill-mode: forwards;
          animation-timing-function: steps(1);
      }
    `
    })
  })

生成CSS程式碼

然後根據圖片數量生成相應的keyframes程式碼

 function toCss(dir, fileList){
    let _css = '';
    let start = 0;
    const per = Math.floor(100/fileList.length);
    fileList.map((path, i) => {
      if(i === fileList.length - 1){
        _css += `
          ${start + i*per}%, 100% {
            background:url(./${dir}/${path}) center center no-repeat;
            background-size:100% auto;
          }
        `
      }else{
        _css += `
          ${start + i*per}% {
            background:url(./${dir}/${path}) center center no-repeat;
            background-size:100% auto;
          }
        `
      }
    })
    
    return _css;
  }
  
  let frameCss = toCss(dir, newFile)

  //取第一個圖片的尺寸作為框尺寸
  let cssString = `
    .fbf-animation{
      width: ${imgSize.width}px;
      height: ${imgSize.height}px;
      margin:auto;
      background-image: url(./${dir}/${file[0]});
      background-size: ${imgSize.width}px ${imgSize.height}px;
      background-repeat: no-repeat;
      animation-name: keyframes-img;
      animation-duration: 0.36s;
      animation-delay: 0s;
      animation-iteration-count: infinite;
      animation-fill-mode: forwards;
      animation-timing-function: steps(1);
    }
    @keyframes keyframes-img {
      ${frameCss}
    }

生成html檔案

最後我們把生成的CSS放到HTML裡。

//生成html
let html = createHTML({
  title: '逐幀動畫',
  scriptAsync: true,
  lang: 'en',
  dir: 'rtl',
  head: '<meta name="description" content="example">',
  body: '<div class="fbf-animation"></div>' + css,
  favicon: 'favicon.png'
})
fs.writeFile('fbf.html', html, function (err) {
  if (err) console.log(err)
})

視覺美化

通過 chalk 來為列印資訊加上樣式,比如成功資訊為綠色,失敗資訊為紅色,這樣子會讓使用者更加容易分辨,同時也讓終端的顯示更加的好看。

const chalk = require('chalk'); console.log(chalk.green('生成程式碼成功!')); console.log(chalk.red('生成程式碼失敗'));

完整示例

#!/usr/bin/env node
const program = require('commander');
const fs = require('fs');
const path = require('path');
const createHTML = require('create-html');
const sizeOf = require('image-size');
const chalk = require('chalk');

//排序
const sortByFileName = files =>  {
  const reg = /[0-9]+/g;
  return files.sort((a, b) => {
    let imga = (a.match(reg) || []).slice(-1),
      imgb = (b.match(reg) || []).slice(-1)
    return imga - imgb
  });
}

//刪除.DS_Store
function deleteDS(file) {
  file.map((v, i) => {
    if(v === '.DS_Store'){
      fs.unlink('img/.DS_Store', err => {})
    }
  })
}

// 生成keyframe
function toCss(dir, fileList){
  let _css = '';
  let start = 0;
  const per = Math.floor(100/fileList.length);
  fileList.map((path, i) => {
    if(i === fileList.length - 1){
      _css += `
        ${start + i*per}%, 100% {
          background:url(./${dir}/${path}) center center no-repeat;
          background-size:100% auto;
        }
      `
    }else{
      _css += `
        ${start + i*per}% {
          background:url(./${dir}/${path}) center center no-repeat;
          background-size:100% auto;
        }
      `
    }
  })
  console.log(chalk.green('css successed!'))
  return _css;
}

program.version('1.0.0', '-v, --version')
  .command('start <dir>')
  .action((dir) => {

    const imgPath = path.resolve(dir)

    let imgSize = null;
    fs.readdir(imgPath, (err, file) => {
      const newFile = sortByFileName(file)
      deleteDS(newFile)
      imgSize = sizeOf(dir + '/' +file[0]);
      let frameCss = toCss(dir, newFile)

      //取第一個圖片的尺寸作為框尺寸
      let cssString = `
      .fbf-animation{
        width: ${imgSize.width}px;
        height: ${imgSize.height}px;
        margin:auto;
        background-image: url(./${dir}/${file[0]});
        background-size: ${imgSize.width}px ${imgSize.height}px;
        background-repeat: no-repeat;
        animation-name: keyframes-img;
        animation-duration: 0.36s;
        animation-delay: 0s;
        animation-iteration-count: infinite;
        animation-fill-mode: forwards;
        animation-timing-function: steps(1);
      }
      @keyframes keyframes-img {
        ${frameCss}
      }
    `
      let css = `
      <style>${cssString}</style>
    `
      //生成html
      let html = createHTML({
        title: '逐幀動畫',
        scriptAsync: true,
        lang: 'en',
        dir: 'rtl',
        head: '<meta name="description" content="example">',
        body: '<div class="fbf-animation"></div>' + css,
        favicon: 'favicon.png'
      })
      fs.writeFile('fbf.html', html, function (err) {
        console.log(chalk.green('html successed!'))
        if (err) console.log(err)
      })
    })
  });
program.parse(process.argv);

程式碼一共100行左右,可以說非常簡單明瞭,有興趣的同學可以試試。

最後

完成之後,使用npm publish fbf就可以把腳手架釋出到 npm 上面,通過 -g 進行全域性安裝,就可以在自己本機上執行 fbf start [dir]來生成一個fbf.html檔案,這樣便完成了一個簡單的node工具