[Node] Node 관련 패키지들 간략 정리. (갱신 중)

<div class="markdown-body"><p>다른 작업을 진행하다가 정말로 오랜만에 다시 Node.js 관련 오픈 소스 분석 작업을 하는데 참조하고 있는 패키지들이 많기도 하다. 아는 것보다는 모르는 것이 더 많아서 뭐가 뭔지 하나도 모르겠다.</p><p>앞으로 작업을 하면서 좀 더 다양한 패키지들을 자세하게 알아야 하지만, 당장은 제목과 기능이라도 알아야 이해를 할 수 있을 듯 하다. ㅠㅠ</p><h1 data-breakpage>Packages for NodeJS</h1><h2>bluebird</h2><blockquote><p><strong>Full featured promise library with unmatched performance</strong></p></blockquote><p><strong>Examples</strong></p><ul><li><p>설치</p><pre><code class='language-sh' lang='sh'> npm install bluebird </code></pre></li> <li><p>활용법</p><pre><code class='language-js' lang='js'> var Promise = require("bluebird"); </code></pre></li> </ul><p><strong>References</strong></p><ul><li><a href="http://bluebirdjs.com/docs/getting-started.html" target="_blank">http://bluebirdjs.com/docs/getting-started.html</a></li> <li><a href="https://github.com/petkaantonov/bluebird" target="_blank">https://github.com/petkaantonov/bluebird</a></li> </ul><hr /><h2>bunyan</h2><blockquote><p><strong>Simple and fast JSON Logging Module for node.js services</strong></p></blockquote><p><strong>Examples</strong></p><ul><li><p>설치</p><pre><code class='language-sh' lang='sh'> $ npm install bunyan </code></pre></li> <li><p>활용법</p><pre><code class='language-js' lang='js'> var bunyan = require('bunyan'); var log = bunyan.createLogger({name: "myapp"}); log.info("hi"); </code></pre></li> </ul><p><strong>References</strong></p><ul><li><a href="https://github.com/trentm/node-bunyan" target="_blank">https://github.com/trentm/node-bunyan</a></li> </ul><hr /><h2>camelcase</h2><blockquote><p><strong>Convert a dash/dot/underscore/space separated string to camelCase: foo-bar -> fooBar</strong></p></blockquote><p><strong>Examples</strong></p><ul><li><p>설치</p><pre><code class='language-sh' lang='sh'> $ npm install --save camelcase </code></pre></li> <li><p>활용법</p><pre><code class='language-sh' lang='sh'> const camelCase = require('camelcase'); camelCase('foo-bar'); //=> 'fooBar' camelCase('foo_bar'); //=> 'fooBar' camelCase('Foo-Bar'); //=> 'fooBar' camelCase('--foo.bar'); //=> 'fooBar' camelCase('__foo__bar__'); //=> 'fooBar' camelCase('foo bar'); //=> 'fooBar' camelCase('foo', 'bar'); //=> 'fooBar' camelCase('__foo__', '--bar'); //=> 'fooBar' console.log(process.argv[3]); //=> '--foo-bar' camelCase(process.argv[3]); //=> 'fooBar' </code></pre></li> </ul><p><strong>References</strong></p><ul><li><a href="https://github.com/sindresorhus/camelcase" target="_blank">https://github.com/sindresorhus/camelcase</a></li> </ul><hr /><h2>chai</h2><blockquote><p><strong>BDD (Behavior-Driven Development) / TDD (Test-Driven Development) Assersion Library for Node</strong></p></blockquote><p><strong>Examples</strong></p><ul><li><p>설치</p><pre><code class='language-sh' lang='sh'> $ npm install bunyan </code></pre></li> <li><p>활용법</p><pre><code class='language-js' lang='js'> // Should chai.should(); foo.should.be.a('string'); foo.should.equal('bar'); foo.should.have.lengthOf(3); tea.should.have.property('flavors').with.lengthOf(3); // Expect var expect = chai.expect; expect(foo).to.be.a('string'); expect(foo).to.equal('bar'); expect(foo).to.have.lengthOf(3); expect(tea).to.have.property('flavors').with.lengthOf(3); // Assert var assert = chai.assert; assert.typeOf(foo, 'string'); assert.equal(foo, 'bar'); assert.lengthOf(foo, 3) assert.property(tea, 'flavors'); assert.lengthOf(tea.flavors, 3); </code></pre></li> </ul><p><strong>References</strong></p><ul><li><a href="http://chaijs.com/" target="_blank">http://chaijs.com/</a></li> </ul><hr /><h2>chalk</h2><blockquote><p><strong>Terminal String Styling done right</strong></p></blockquote><p><strong>Examples</strong></p><ul><li><p>설치</p><pre><code class='language-sh' lang='sh'> $ npm install chalk </code></pre></li> <li><p>활용법</p><pre><code class='language-js' lang='js'> const chalk = require('chalk'); console.log(chalk.blue('Hello world!')); </code></pre></li> </ul><p><strong>References</strong></p><ul><li><a href="https://github.com/chalk/chalk" target="_blank">https://github.com/chalk/chalk</a></li> </ul><hr /><h2>chokidar</h2><blockquote><p><strong>A neat wrapper around node.js fs.watch / fs.watchFile / fsevents.</strong></p></blockquote><p><strong>Examples</strong></p><ul><li><p>설치</p><pre><code class='language-sh' lang='sh'> $ npm install chokidar --save </code></pre></li> <li><p>활용법</p><pre><code class='language-js' lang='js'> var chokidar = require('chokidar'); // One-liner for current directory, ignores .dotfiles chokidar.watch('.', {ignored: /(^|[\/\\])\../}).on('all', (event, path) => { console.log(event, path); }); // Example of a more typical implementation structure: // Initialize watcher. var watcher = chokidar.watch('file, dir, glob, or array', { ignored: /(^|[\/\\])\../, persistent: true }); // Something to use when events are received. var log = console.log.bind(console); // Add event listeners. watcher .on('add', path => log(`File ${path} has been added`)) .on('change', path => log(`File ${path} has been changed`)) .on('unlink', path => log(`File ${path} has been removed`)); // More possible events. watcher .on('addDir', path => log(`Directory ${path} has been added`)) .on('unlinkDir', path => log(`Directory ${path} has been removed`)) .on('error', error => log(`Watcher error: ${error}`)) .on('ready', () => log('Initial scan complete. Ready for changes')) .on('raw', (event, path, details) => { log('Raw event info:', event, path, details); }); // 'add', 'addDir' and 'change' events also receive stat() results as second // argument when available: http://nodejs.org/api/fs.html#fs_class_fs_stats watcher.on('change', (path, stats) => { if (stats) console.log(`File ${path} changed size to ${stats.size}`); }); // Watch new files. watcher.add('new-file'); watcher.add(['new-file-2', 'new-file-3', '**/other-file*']); // Get list of actual paths being watched on the filesystem var watchedPaths = watcher.getWatched(); // Un-watch some files. watcher.unwatch('new-file*'); // Stop watching. watcher.close(); // Full list of options. See below for descriptions. (do not use this example) chokidar.watch('file', { persistent: true, ignored: '*.txt', ignoreInitial: false, followSymlinks: true, cwd: '.', usePolling: true, interval: 100, binaryInterval: 300, alwaysStat: false, depth: 99, awaitWriteFinish: { stabilityThreshold: 2000, pollInterval: 100 }, ignorePermissionErrors: false, atomic: true // or a custom 'atomicity delay', in milliseconds (default 100) }); </code></pre></li> </ul><p><strong>References</strong></p><ul><li><a href="https://github.com/paulmillr/chokidar" target="_blank">https://github.com/paulmillr/chokidar</a></li> </ul><hr /><h2>escape-string-regexp</h2><blockquote><p><strong>Escape RegExp Special Characters</strong></p></blockquote><p><strong>Examples</strong></p><ul><li><p>설치</p><pre><code class='language-sh' lang='sh'> $ npm install --save escape-string-regexp </code></pre></li> <li><p>활용법</p><pre><code class='language-js' lang='js'> const escapeStringRegexp = require('escape-string-regexp'); const escapedString = escapeStringRegexp('how much $ for a unicorn?'); //=> 'how much \$ for a unicorn\?' new RegExp(escapedString); </code></pre></li> </ul><p><strong>References</strong></p><ul><li><a href="https://github.com/sindresorhus/escape-string-regexp" target="_blank">https://github.com/sindresorhus/escape-string-regexp</a></li> </ul><hr /><h2>eslint</h2><blockquote><p><strong>Pluggable Linting utility for JavaScript and JSX</strong></p></blockquote><p><strong>Examples</strong></p><ul><li><p>설치</p><pre><code class='language-sh' lang='sh'> $ npm install eslint </code></pre></li> <li><p>활용법</p><pre><code class='language-js' lang='js'> Rule 정의 파일 구성 $ npm run eslint . </code></pre></li> </ul><p><strong>References</strong></p><ul><li><a href="http://eslint.org/" target="_blank">http://eslint.org/</a></li> </ul><hr /><h2>graceful-fs</h2><blockquote><p><strong>drop-in replacement for the fs module, making various improvements.</strong></p></blockquote><p><strong>Examples</strong></p><ul><li><p>설치</p><pre><code class='language-sh' lang='sh'> $ npm install graceful-fs </code></pre></li> <li><p>활용법</p><pre><code class='language-js' lang='js'> // use just like fs var fs = require('graceful-fs') // now go and do stuff with it... fs.readFileSync('some-file-or-whatever') // // Global Patching // // Make sure to read the caveat below. var realFs = require('fs') var gracefulFs = require('graceful-fs') gracefulFs.gracefulify(realFs) </code></pre></li> </ul><p><strong>References</strong></p><ul><li><a href="https://www.npmjs.com/package/graceful-fs" target="_blank">https://www.npmjs.com/package/graceful-fs</a></li> </ul><hr /><h2>istanbul</h2><blockquote><p><strong>JS Code Coverage tool written in JS</strong></p></blockquote><p><strong>Examples</strong></p><ul><li><p>설치</p><pre><code class='language-sh' lang='sh'> $ npm install -g istanbul </code></pre></li> <li><p>활용법</p><pre><code class='language-sh' lang='sh'> $ istanbul cover test.js </code></pre></li> </ul><p><strong>References</strong></p><ul><li><a href="https://github.com/gotwarlost/istanbul" target="_blank">https://github.com/gotwarlost/istanbul</a></li> </ul><hr /><h2>jscs</h2><blockquote><p><strong>Javascript Code Style Checker</strong></p></blockquote><p><strong>Examples</strong></p><ul><li><p>설치</p><pre><code class='language-sh' lang='sh'> $ npm install jscs </code></pre></li> <li><br /> <p>활용법</p><pre><code class='language-sh' lang='sh'> $ jscs file.js --preset=airbnb </code></pre></li> </ul><p><strong>References</strong></p><ul><li><a href="http://jscs.info/" target="_blank">http://jscs.info/</a></li> </ul><hr /><h2>minimist</h2><blockquote><p><strong>guts of optimist's argument parser without all the fanciful decoration</strong></p></blockquote><p><strong>Examples</strong></p><ul><li><p>설치</p><pre><code class='language-sh' lang='sh'> $ npm install minimist </code></pre></li> <li><p>활용법</p><pre><code class='language-js' lang='js'> var argv = require('minimist')(process.argv.slice(2)); console.dir(argv); </code></pre></li> </ul><p><strong>References</strong></p><ul><li><a href="https://github.com/substack/minimist" target="_blank">https://github.com/substack/minimist</a></li> </ul><hr /><h2>mocha</h2><blockquote><p><strong>Fun, Simple, Flexible Javascript Test Framework</strong></p></blockquote><p><strong>Examples</strong></p><ul><li><p>설치</p><pre><code class='language-sh' lang='sh'> $ npm install mocha </code></pre></li> <li><p>활용법</p><pre><code class='language-sh' lang='sh'> Assert 파일 작성 $ mocha test/index.js </code></pre></li> </ul><p><strong>References</strong></p><ul><li><a href="https://mochajs.org/" target="_blank">https://mochajs.org/</a></li> <li><a href="https://github.com/mochajs/mocha" target="_blank">https://github.com/mochajs/mocha</a></li> </ul><hr /><h2>nyc</h2><blockquote><p><strong>Istanbul command line interface</strong></p></blockquote><p><strong>Examples</strong></p><ul><li><p>설치</p><pre><code class='language-sh' lang='sh'> $ npm i nyc --save-dev </code></pre></li> <li><p>활용법</p><ul><li><p>package.json script 설정</p><pre><code class='language-json' lang='json'> { "script": { "test": "nyc tap ./test/*.js" } } </code></pre></li> <li><p>실행</p><pre><code class='language-sh' lang='sh'> $ nyc npm test $ nyc --reporter=lcov --reporter=text-lcov npm test </code></pre></li> </ul></li> </ul><p><strong>References</strong></p><ul><li><a href="https://github.com/istanbuljs/nyc" target="_blank">https://github.com/istanbuljs/nyc</a></li> <li><a href="https://istanbul.js.org/" target="_blank">https://istanbul.js.org/</a></li> </ul><hr /><h2>require-dir</h2><blockquote><p><strong>Node.js 지원을 위해 지정한 디렉터리 단위로 존재하는 파일들을 일괄 require() 처리</strong></p></blockquote><p><strong>Examples</strong></p><ul><li><p>설치</p><pre><code class='language-sh' lang='sh'> $ npm install require-dir </code></pre></li> <li><p>활용법</p><pre><code class='language-sh' lang='sh'> var requireDir = require('require-dir'); var dir = requireDir('./path/to/dir'); var dir = requireDir('./path/to/dir', {recurse: true}); </code></pre></li> </ul><p><strong>References</strong></p><ul><li><a href="https://github.com/aseemk/requireDir" target="_blank">https://github.com/aseemk/requireDir</a></li> </ul><hr /><h2>rewire</h2><blockquote><p><strong>Easy monkey-patching for node.js unit tests</strong></p></blockquote><p><strong>Examples</strong></p><ul><li><p>설치</p><pre><code class='language-sh' lang='sh'> $ npm install rewire </code></pre></li> <li><p>활용법</p><pre><code> 자세한 활용법은 아래 사이트 설명 참조 </code></pre></li> </ul><p><strong>References</strong></p><ul><li><a href="https://github.com/jhnns/rewire" target="_blank">https://github.com/jhnns/rewire</a></li> </ul><hr /><h2>shelljs, shelljs/shx</h2><blockquote><p><strong>shelljs: Portable Unix shell commands for Node.js</strong><br /> <strong>shelljs/shx: Portable Shell Commands for Node.js</strong></p></blockquote><p><strong>Examples</strong></p><ul><li><p>설치</p><pre><code class='language-sh' lang='sh'> $ npm install shelljs $ npm install shelljs/shx # for command line </code></pre></li> <li><p>활용법 (shelljs)</p><pre><code class='language-js' lang='js'> var shell = require('shelljs'); if (!shell.which('git')) { shell.echo('Sorry, this script requires git'); shell.exit(1); } // Copy files to release dir shell.rm('-rf', 'out/Release'); shell.cp('-R', 'stuff/', 'out/Release'); // Replace macros in each .js file shell.cd('lib'); shell.ls('*.js').forEach(function (file) { shell.sed('-i', 'BUILD_VERSION', 'v0.1.2', file); shell.sed('-i', /^.*REMOVE_THIS_LINE.*$/, '', file); shell.sed('-i', /.*REPLACE_LINE_WITH_MACRO.*\n/, shell.cat('macro.js'), file); }); shell.cd('..'); // Run external tool synchronously if (shell.exec('git commit -am "Auto-commit"').code !== 0) { shell.echo('Error: Git commit failed'); shell.exit(1); } </code></pre></li> <li><p>활용법 (shelljs/shx)</p><pre><code class='language-sh' lang='sh'> # used in command line using shx $ shx mkdir -p foo $ shx touch foo/bar.txt $ shx rm -rf foo </code></pre></li> </ul><p><strong>References</strong></p><ul><li><a href="https://github.com/shelljs/shelljs" target="_blank">https://github.com/shelljs/shelljs</a></li> <li><a href="http://shelljs.org/" target="_blank">http://shelljs.org/</a></li> <li><a href="https://github.com/shelljs/shx" target="_blank">https://github.com/shelljs/shx</a></li> </ul><hr /><h2>sinon</h2><blockquote><p><strong>Standalone test spies, stubs and mocks for Javascript. work with any unit testing framework.</strong></p></blockquote><p><strong>Examples</strong></p><ul><li><p>설치</p><pre><code class='language-sh' lang='sh'> $ npm install sinon </code></pre></li> <li><p>활용법</p><pre><code> 자세한 활용법은 아래 사이트 설명 참조 </code></pre></li> </ul><p><strong>References</strong></p><ul><li><a href="http://sinonjs.org/" target="_blank">http://sinonjs.org/</a></li> </ul><hr /><h2>standard</h2><blockquote><p><strong>Javascript 표준 스타일 가이드 with Linter & Automatic code fixer</strong></p></blockquote><p><strong>Examples</strong></p><ul><li><p>설치</p><pre><code class='language-sh' lang='sh'> $ npm install standard --save-dev </code></pre></li> <li><p>활용법</p><pre><code class='language-sh' lang='sh'> $ standard Error: Use JavaScript Standard Style lib/torrent.js:950:11: Expected '===' and instead saw '=='. $ standard "src/util/**/*.js" "test/**/*.js" </code></pre></li> </ul><p><strong>References</strong></p><ul><li><a href="https://github.com/feross/standard" target="_blank">https://github.com/feross/standard</a></li> <li><a href="https://standardjs.com/" target="_blank">https://standardjs.com/</a></li> </ul><hr /><h2>tildify</h2><blockquote><p><strong>Convert an absolute path to the tilde path: /Users/sindresorhus/dev to ~/dev</strong></p></blockquote><p><strong>Examples</strong></p><ul><li><p>설치</p><pre><code class='language-sh' lang='sh'> $ npm install --save tildify </code></pre></li> <li><p>활용법</p><pre><code class='language-js' lang='js'> const tildify = require('tildify'); tildify('/Users/sindresorhus/dev'); //=> '~/dev' </code></pre></li> </ul><p><strong>References</strong></p><ul><li><a href="https://github.com/sindresorhus/tildify" target="_blank">https://github.com/sindresorhus/tildify</a></li> </ul><hr /><h2>yargs</h2><blockquote><p><strong>Yargs helps you build interactive command line tools by parsing arguments and generating an elegant user interface</strong></p></blockquote><p><strong>Examples</strong></p><ul><li><p>설치</p><pre><code class='language-sh' lang='sh'> $ npm install yargs </code></pre></li> <li><p>활용법</p><pre><code class='language-sh' lang='sh'> #!/usr/bin/env node require('yargs') .usage('$0 <cmd> [args]') .command('hello [name]', 'welcome ter yargs!', { name: { default: 'default name' } }, function (argv) { console.log('hello', argv.name, 'welcome to yargs!') }) .help() .argv 자세한 활용법은 아래 사이트 설명 참조 </code></pre></li> </ul><p><strong>References</strong></p><ul><li><a href="http://yargs.js.org/" target="_blank">http://yargs.js.org/</a></li> <li><a href="https://github.com/yargs/yargs" target="_blank">https://github.com/yargs/yargs</a></li> </ul><br /> <hr /><blockquote><p>Written by Morris (<a href="mailto:ccambo@gmail.com" target="_blank">ccambo@gmail.com</a> - MSFL)</p></blockquote><br /> </div>