lacolaco

唐揚げとアニメとプログラミングが大好きです

社内向けprettierの設定をnpmパッケージとして公開した話

こんにちは、lacoです。

今日は業務中にこういったものを作ってnpmに公開しました。

www.npmjs.com

リポジトリはこちらです。ご覧の通りKaizen PlatformのOSSです。

github.com

なにこれ

Prettierというコードフォーマッターがあり、その設定をKaizen Platform内で共有するためのnpmパッケージです。 社内向けではありますが別にprivateにしておく必要もないし @kaizenplatform スコープでnpmパッケージを出したかったのでエイヤでpublicにしました。

f:id:lacolaco:20170915174833p:plain

すでにいくつかのリポジトリで使い始めていますがなかなか良い体験です。

f:id:lacolaco:20170915174918p:plain

内容としては基本的にPrettierに従いつつ、以下の点は上書きしてます

  • 折り返し幅は120に広げる
  • クォートはシングル
  • 末尾カンマは常に付与
    • 基本的にTypeScriptと併用するのでES5対応はトランスパイラの仕事という判断

使い方

READMEにも書いてますが、 prettier.config.js を使うケースを想定しています。 commonjsとしてrequireしてもらい、そのままexportsに渡します。

module.exports = require('@kaizenplatform/prettier-config');

何か上書きしたいときには Object.assign() やらなんやらで好きにオブジェクトをいじればよいです。

目的

  • 社内のコードフォーマットを統一したい
    • コードレビューの観点を減らす
    • 慣れたフォーマットのコードは読みやすいので速度も上がるはず
  • Kaizen Platformのフロントエンドエンジニア何してるかよくわからないという雰囲気(要出典)を払拭していきたい
    • 表に見える活動を増やしていきたい気持ち
    • 我々楽しくやってますよ!

今後もpublicにできそうなものはKaizen発のOSSとして公開していきたい気持ちがあるので、もし気になったかたはぜひ使ってみてください。フィードバックも大歓迎です!