new README file #73
new README file #73
Conversation
|
|
||
| [![NPM Status][npm-img]][npm] |
There was a problem hiding this comment.
Hey, everybody loves such badges. And they are very useful while searching new npm module.
|
|
||
| [npm]: https://www.npmjs.org/package/bem-walk | ||
| [npm-img]: https://img.shields.io/npm/v/bem-walk.svg | ||
| Инструмент обходит файловую структуру БЭМ-проекта и возвращает информацию о найденных файлах. |
| bem-walk | ||
| ======== | ||
|
|
||
| [![NPM Status][npm-img]][npm] |
| [david]: https://david-dm.org/bem-sdk/bem-walk | ||
| [david-img]: http://img.shields.io/david/bem-sdk/bem-walk.svg?style=flat | ||
|
|
||
| Инструмент позволяет обойти файловую систему БЭМ-проекта и получить следующую информацию о найденных файлах: |
There was a problem hiding this comment.
давайте во всех пакетах всегда держать первый абзац с основным описанием пакета перед бейджами? @miripiruni показывал, что если класть их сразу после заголовка, это негативно сказывается на поиск пакета в npm
There was a problem hiding this comment.
А можно посмотреть, где он это показывал? Вообще, я первый раз слышу, что через npm можно что-то вменяемое найти.
There was a problem hiding this comment.
Когда рассказывал про bem/bem-xjst@abab495 вбивал bem-xjst в саджест npm и там вместо описания пакета всплывала HTML-разметка бейджиков.
There was a problem hiding this comment.
Убедительно. 👍 Только там очень мало места и надо компактно, умело владея языком.
В полтвиттера.
| @@ -1,5 +1,11 @@ | |||
| # bem-walk | |||
|
|
|||
| Инструмент позволяет обойти файловую систему БЭМ-проекта и получить следующую информацию о найденных файлах: | |||
There was a problem hiding this comment.
Не не, как раз такое не очень хорошо делать.
Лучше написать кратко про назначение модуля, типа: «Штука для обхода файловой системы».
Может быть поменять на:
Инструмент для обхода файловой системы БЭМ-проекта.
Получает следующую информацию о найденных файлах:
…
| [david]: https://david-dm.org/bem-sdk/bem-walk | ||
| [david-img]: http://img.shields.io/david/bem-sdk/bem-walk.svg?style=flat | ||
|
|
||
| Bem-walk позволяет получить следующую информацию о найденных файлах: |
There was a problem hiding this comment.
Давай название пакета/инструмента всегда писать так: bem-walk.
There was a problem hiding this comment.
Может упростим?
Позволяет получить информацию о найденных файлах:
There was a problem hiding this comment.
Возвращает информацию о найденных файлах: Как тебе?
| }) | ||
| .pipe(through2.obj(function(file, enc, callback) { | ||
|
|
||
| if (fs.statSync(file.path).isFile()) { |
There was a problem hiding this comment.
Этот код надо обернуть в try/catch, и на ошибку вызывать callback(err)
No description provided.