【小ネタ】README.md書いてからnpm initするとpackage.jsonの様子が……！？

ふじい

友人とリモートペアプロ中にたまたま発見した小ネタ。

ディレクトリ作ってその中にREADME.mdを置き、「今日は何しようか」と話し合いながら方向性をREADME.mdにまとめていました。

foo/
  - README.md

README.mdの中身はこんな感じでした。

# README

目的：React + Redux + TypeScriptで～～～を作る。

目的も決まり、「じゃあとりあえずnpm initしよう」となり普通にnpm initしました。

foo > npm init -y

そうして「package.json出力されたね」とpackage.jsonを開くと……！？

{
 "name": "test",
 "version": "1.0.0",
 "description": "目的：React + Redux + TypeScriptで～～～を作る。",
 "main": "index.js",
 "scripts": {
   "test": "echo \"Error: no test specified\" && exit 1"
 },
 "keywords": [],
 "author": "",
 "license": "ISC"
}

なんということでしょう。普段は空文字として出力されているdescriptionにREADME.mdで記述した文章が入っているではありませんか！
いい仕事してますねえ。

後で調べたらドキュメントに記載されていました。

description: info from the README, or an empty string ""

以上、README.mdを書いてからnpm initするとpackage.jsonのdescriptionに記述した内容が反映されているという小ネタでした。




😉