bahmutov / manpm Goto Github PK

View Code? Open in Web Editor NEW

42.0 3.0 216.0 192 KB

Shows the relevant part of NPM module's README file right in your terminal

JavaScript 100.00%

npm man cli

manpm's Introduction

manpm

Shows the relevant part of NPM module's README file right in your terminal

CHECKLIST.md

Badge

If you module has API well-described in the README, and manpm <text> works well, consider adding the following manpm compatible badge to your README. Here is the markdown for both variants: words or unicode symbols

[![manpm](https://img.shields.io/badge/manpm-compatible-3399ff.svg)](https://github.com/bahmutov/manpm)
[![alternate](https://img.shields.io/badge/manpm-%E2%9C%93-3399ff.svg)](https://github.com/bahmutov/manpm)

Install

npm install -g manpm

Show the entire README from a package or github repo

You can give NPM package name (like manpm), GitHub user / repo pair (like bahmutov/manpm) or full GitHub url (like https://github.com/bahmutov/object-fitter or [email protected]:bahmutov/object-fitter.git).

manpm <package name | github repo>

For example manpm email-regex will render the README from email-regex package in you terminal

Show part of the readme

manpm <package name> [optional search text inside README]

If search text is provided, only a section of the README file with that text (if found) will be displayed.

The following search features are implemented

find exact match in the section heading text
fuzzy text match in the section heading text
find exact match in the section body
fuzzy text match in the section body

I am still looking for a library capable of fuzzy text search. Maybe lunr?

Show and search local README

Sometimes you just want to find a section in the local README file, right in the current directory.

manpm . [optional search text]

Example: showing ES6 docs

There is a great GitHub repo ES6 Overview in 350 Bullet Points hosted at https://github.com/bevacqua/es6. Let us see how we can info for WeakSets

$ manpm bevacqua/es6 weaksets
# WeakSets

    * WeakSet is sort of a cross-breed between Set and WeakMap
    * A WeakSet is a set that can't be iterated and doesn't have enumeration methods
    * WeakSet values must be reference types
    * WeakSet may be useful for a metadata table indicating whether a reference is actively in use or not
    * Read ES6 WeakSets in Depth (https://ponyfoo.com/articles/es6-weakmaps-sets-and-weaksets-in-depth#es6-weaksets)

<sup>(back to table of contents) (#table-of-contents)</sup>

I added an alias to manpm bevacqua/es6 command to my shell alias file for convenience

$ echo 'alias es6-docs="manpm bevacqua/es6"' >> ~/.alias
source ~/.alias
es6-docs weaksets
es6-docs array

Example: showing ES6 features

Another great succint overview of ES6 features is in lukehoban/es6features. Let us add an alias

echo 'alias es6-features="manpm lukehoban/es6features"' >> ~/.alias
source ~/.alias

Let us look up the binary notation in ES6

es6-features binary
### Binary and Octal Literals
Two new numeric literal forms are added for binary (b) and octal (o).
    0b111110111 === 503 // true
    0o767 === 503 // true

Pipe through less | more

You can pipe the output of manpm through "less" or "more" tools - but you will lose the Markdown highlighting.

manpm <package name> | less
manpm <package name> | more

Advanced

If there are problems and manpm is not working as expected, you can see the debug output. Just run the tool with DEBUG=manpm manpm ... environment setting.

$ DEBUG=manpm manpm object-fitter
manpm fetching README for package +0ms object-fitter

Good testing commands:

DEBUG=manpm npm run example-es6-docs

Inspired by the following tools

I wanted something a little more API friendly, like finding and showing a README section that talked about a specific API method for example.

More examples

📺 Watch video Type Placeholders Into The Form: manp and cypress-await example

Small print

License: MIT - do anything with the code, but don't blame me if it does not work.

Spread the word: tweet, star on github, etc.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

manpm's People

Contributors

Stargazers

Watchers

Forkers

emmelmann-fokus mariusz-blaszczak alexmorley yhon-acurio shlomitc michelalves clowenhg gonnagle jonocairns muratcakmak fikrigha nomcopter justin0022 annamcabee relu91 spati2 afahmip vmujadia gopimn weihua4455 h3xar0n aryopg mrsequeira rojaswestall psoares-resilient mike131 hassanazzam katsil aeroglyphic sguillia tiraffe isty001 tonymorony infernalslam kishorevaishnav pfr-flemmardsminot matsuoiv mandalvesq seopftware accimeesterlin marcacard moiyan antoniotaha gilokimu yannbriancon khaledelmahdi alobaidizt scouvreur osalama7 domenicrosati caluser jonlovera pkalever trangpham rahulreddyr3 tunri mkwilbux machadoum 201604772 ranvijayj chuan137 windertonsbooks sfedak-fusion shellyxuehan jazzikpeng vrbsm duriduri darrylkilzer ashiddo11 lilymgoh juancamilo1203unal ursu-polar jairodealmeida boxi11 awadodeh r0maink ahmedsbytes shyama95 edoardomarsili mineshsapkota adremiere andresz1 isuvorov pchoulgu monapasan idanceinbetween abhinavshaw1993 linbo8303 armantaherian appinho pablocattaneo dimabendera kayju jonas154 yavorsky yardwill nk91 illuap cassandrale179 andrei-tatar

manpm's Issues

Add support for fetching README from github repos directly

For repos that are not published on NPM

accept full github url (robust parsing library?)
accept username/repo pair - I had parsing for it somewhere

target: https://github.com/bevacqua/es6

Implement showing README markdown file

If simple manpm <package name> grab the markdown and display in the terminal

If there are multiple matches using header text, return all of them

Not just the first one.

Good example manpm heroin 'heroin(' - should return two API sections

'shasum check failed' on installation

Hey there, I just wanted to give manpm a try and it fails in several npm and node version in the installation process.

stefan @ stefan-mac: ~/Sites/electron-build-demo master (╯°□°)╯
> npm install -g manpm                                                                    [14:25:07]
npm ERR! Darwin 15.0.0
npm ERR! argv "/Users/stefan/.nvm/v5.0.0/bin/node" "/Users/stefan/.nvm/v5.0.0/bin/npm" "install" "-g" "manpm"
npm ERR! node v5.0.0
npm ERR! npm  v3.3.6

npm ERR! shasum check failed for /var/folders/03/cgg2bwfd6j92tfllylt5b91m0000gn/T/npm-81868-930781f3/registry.npmjs.org/manpm/-/manpm-1.3.0.tgz
npm ERR! Expected: 3f055d6e700df08338d821b9793d527b3f0641c7
npm ERR! Actual:   afc36a15f9ffd57ef168823207494e4574ff4326
npm ERR! From:     https://registry.npmjs.org/manpm/-/manpm-1.3.0.tgz
npm ERR!
npm ERR! If you need help, you may report this error at:
npm ERR!     <https://github.com/npm/npm/issues>

npm ERR! Please include the following file with any support request:
npm ERR!     /Users/stefan/Sites/electron-build-demo/npm-debug.log

FAIL: 1

Installing other packages globally works fine.

Do you maybe have an idea what going on here?

Allow looking the README in the current folder

manpm . [search text] should load the README in the current folder

If cannot find section with given text, show message

Something like "could not find the text <...>, showing entire README file"

Test different README filenames in git

sometimes GitHub readme file has a different name. Try to fetch until found

README.md
readme.markdown

Make sure the npm run example-es6-docs works

Crashes on Node 5.4

Seems problem with bluebird Promisify

var Promise = require('bluebird');
var getReadmeFile = Promise.promisify(require('get-package-readme'));
TypeError: Promise.promisify is not a function

could also be related to using really-need?

Test es6features example

Is it fetching wrong file? https://twitter.com/youyuxi/status/712468392205262849

Problem with check-more-types

$ manpm check-more-types defend
{ [Error: check-more-types: package.json has no readmeFilename]
  cause: [Error: check-more-types: package.json has no readmeFilename],
  isOperational: true }

Invalid dependency name

npm install -g manpm
npm ERR! unpack Could not read data for @bahmutov/[email protected]
npm ERR! Darwin 15.3.0
npm ERR! argv "/usr/local/bin/iojs" "/usr/local/bin/npm" "install" "-g" "manpm"
npm ERR! node v4.3.0
npm ERR! npm  v2.14.12

npm ERR! Invalid name: "@bahmutov/parse-github-repo-url"

$ DEBUG=manpm manpm hr
  manpm fetching README for package +0ms hr
{ [Error: hr: cannot parse repository url]

problem npm 2.10 node 0.12

ip-10-1-10-144:~ bfaviero$ manpm k2
module.js:338
    throw err;
          ^
Error: Cannot find module 'github-url-to-object'
    at Function.Module._resolveFilename (module.js:336:15)
    at Module.reallyNeedRequire [as require] (/usr/local/lib/node_modules/manpm/node_modules/really-need/index.js:84:27)
    at Object.<anonymous> (/usr/local/lib/node_modules/manpm/src/get-readme.js:11:1)

$ npm install -g manpm
/home/d2s/.nvm/versions/node/v5.2.0/bin/manpm -> /home/d2s/.nvm/versions/node/v5.2.0/lib/node_modules/manpm/bin/manpm.js
/home/d2s/.nvm/versions/node/v5.2.0/lib

When running the software, manpm fails to find Node executable.

$ manpm bevacqua/es6 weaksets
/usr/bin/env: node --harmony: No such file or directory

Enviroment variables include path to Node.js binary folder.

$ /usr/bin/env | grep node
NVM_BIN=/home/d2s/.nvm/versions/node/v5.2.0/bin
NVM_PATH=/home/d2s/.nvm/versions/node/v5.2.0/lib/node
…

Directory has the node binary file:

$ ll /home/d2s/.nvm/versions/node/v5.2.0/bin/node 
-rwxrwxr-x 1 d2s d2s 24M joulu  9 06:06 /home/d2s/.nvm/versions/node/v5.2.0/bin/node

Not really sure how this should be fixed, but the problem is probably caused by the line in manpm.js file:

#!/usr/bin/env node --harmony

(Ubuntu, with zsh shell as the default console environment.)

Badge with just icons

Something with checklist and a checkmark? list icon | check

Use npm checklist

And add a badge