読者です 読者をやめる 読者になる 読者になる

Tbpgr Blog

Ruby プログラマ tbpgr(てぃーびー) のブログ

AtomのSnippet.csonからREADME用のMarkdownを生成するnpm Package atom-snippet-cson-to-readme を作成した

Atom

f:id:tbpg:20160628232346p:plain

AtomのSnippet.csonからREADME用のMarkdownを生成するnpm Package atom-snippet-cson-to-readme を作成しました。

経緯

AtomのSnippetを2個作ったのですが、READMEにSnippetの内容をまとめたくなりました。
まとめる情報は Snippet 本体に記載されている情報のみなので、
手動でメンテナンスしたくありません。
そこで、Snippet本体の情報を元にREADMEを生成する npm Package を作成することにしました。

ちなみに普段 JS 周りは殆ど書いてないので仲間に教えてもらいながら手探りで書きました。
Oさん、Hさんありがとう。

デモ

$ cson2readme <filepath>

From CSON

'.source.crystal,.source.ruby':
  'if … else … end':
    'prefix': 'if else'
    'body': 'if (\${1:condition})\\n\\t$2\\nelse\\n\\t$3\\nend'
  'if … end':
    'prefix': 'if'
    'body': 'if (\${1:condition})\\n\\t$0\\nend'

To Markdown

## Types
* .source.crystal
* .source.ruby

## Snippets
### if … else … end
prefix: if else  
body:

~~~
if (${1:condition})
    $2
else
    $3
end
~~~

### if … end
prefix: if  
body:

~~~
if (${1:condition})
    $0
end
~~~

npm Package

関連情報