もやぶろ

moyashidaisukeのブログだからもやぶろ。フリーランスのエンジニアのダイスケです。プログラム関連とかギター関連とか旅行関連とか色々。

【JavaScript】JSDocでfooterの作成日時を消す

概要

JavaScriptのドキュメンテンションツールのJSDocのfooterの日時を削除する方法です。

前回の

www.moyashidaisuke.com

どこのこと?何がダメなの?

defaultテンプレートを使った時のフッターの

f:id:moyashidaisuke:20191030205036p:plain

ここのことです。

CIで毎回JSDocを自動的にビルドして、生成されたhtmlファイルをコミットしない運用であれば特に問題はありません。むしろ最新版である事がわかって良いですね。

一方で、CIにJSDocを組み込んでいない場合、生成されたHTMLをコミットする事になります。 その時に、この更新日時が表示されると、全ファイルに必ずdiffが発生する事になります。リポジトリは誇大化するし、本当の差分が埋もれてしまうのであまりよくありません。

対応方法

github.com

なんかcloseされてなかったのでコメントしていますが、

マニュアル

jsdoc.app

ソースコード

github.com

設定ファイル

'use strict';

module.exports = {
  "templates": {
    "default": {
      "includeDate": false
    }
  }

これでfooterから作成日時が消えます。

f:id:moyashidaisuke:20191030205525p:plain

まあ本当はCIに組み込んだ方がいいんですけどね。