Create npm module and publish to npm

Transcript

1. Create npm modules and publish to npm k-kuwahara @kuwahara_jsri @clown0082 Aug 23, 2018 αϙʔλʔζColabษڧձ
2. About me const my_info = { Name: ‘܂ݪ੟ਔ’, Home: ‘૔ෑ, ޿ౡ’, Community: ‘Riot.js, Ionic, Dist’, Podcast: ‘͕͠ͳ͍ϥδΦ sp.30a’, Workplace: ‘Yumemi Inc’, }
3. github.com/riot
4. 1. Have you ever published a library? 2. Procedure until release to npm 3. Create one library with Node.js 4. Publish to npm, install, confirm operation Table of Contents
5. Have you ever published a library?
6. I made these two libraries using .
7. https://www.npmjs.com/package/ja-greetings
8. https://www.npmjs.com/package/ja-greetings Please download
9. https://www.npmjs.com/package/cmd-ranking
10. https://www.npmjs.com/package/cmd-ranking Please download
11. Why ?
12. 1. JavaScript 2. Studying asynchronous processing ✎ 3. Easier than I thought 4. There are lots of knowledge Because…
13. Why ?
14. 1. High affinity with javascript 2. Studying OSS ✎ Because…
15. Procedure until release to npm
16. 1. Create account on npm site 2. Develop library 3. Write setting items necessary for package.json 4. Login npm on your terminal 5. execute “npm publish” ToDo
17. Create one library with Node.js
18. URL: https://github.com/k-kuwahara/check-stats-modules Product this time
19. Sorry...% The source code of this time is … ɹɾno tests ɹɾno refactoring
20. Sorry...%
21. 1. Create account on npm site 2. Develop library 3. Tips for OSS ToDo
22. 1. Create account on npm site URL: https://github.com/k-kuwahara/check-stats-modules here!!
23. 1. Create account on npm site 2. Develop library 3. Tips for OSS ToDo
24. Directory Structure ./ ᵓᴷ bin/ ᵓᴷ lib/ ᵓᴷ package.json ᵓᴷ package-lock.json ᵋᴷ node_modules/ command files logic files
25. Initialize $ mkdir check-stats-modules $ cd check-stats-modules $ npm init -y $ npm i -S yargs chalk moment npm-stat-api
26. Initialize $ mkdir lib $ mkdir bin && cd bin $ touch check-stats-modules
27. Process flow $ csm -h I found!!
28. Edit package.json … “name”: “check-stats-modules”, “main”: “./lib/check-stats-modules”, “bin”: { “check-stats-modules”: “./bin/check-stats-modules” }, …
29. ⚠Attention⚠
30. Edit package.json … “name”: “check-stats-modules”, “main”: “./lib/check-stats-modules”, “bin”: { “check-stats-modules”: “./bin/check-stats-modules” }, … Since the module with this name already exists in npm, please change it when publishing.
31. Edit bin/check-stats-modules #!/usr/bin/env node ‘use strict’ console.log(‘Hello node command !!’)
32. Execute command $ ./bin/check-stats-modules
33. Local module link $ npm link #(shortcut: ln) $ check-stats-modules
34. The simplest CLI application has been created
35. Edit check-stats-modules #!/usr/bin/env node ‘use strict’ - console.log(‘Hello node command!!’) + require(‘../lib/check-stats-modules’)()
36. Edit check-stats-modules #!/usr/bin/env node ‘use strict’ - console.log(‘Hello node command!!’) + require(‘../lib/check-stats-modules’)() create and edit this file
37. Initialize $ cd .. $ mkdir lib && cd lib $ touch check-stats-modules.js
38. Edit lib/check-stats-modules.js 'use strict’ const args = require(‘./args’) const yargs = require(‘yargs’) const pkg = require(‘../package.json’) (continue...)
39. Edit lib/check-stats-modules.js /** * run function * * @param void * @return void */ module.exports = () => { // 'help' is top priority option if (args.h) { show_help() } else if (args.v) { console.log(pkg.version) } } (continue...)
40. Edit lib/check-stats-modules.js /** * show help * * @param {String} help message if specifying a message * @return {String} full help message */ const show_help = (text) => { if (text) console.log(text) yargs.showHelp() }
41. Edit lib/check-stats-modules.js 'use strict’ const args = require(‘./args’) const yargs = require(‘yargs’) const pkg = require(‘../package.json’) (continue...) create and edit this file
42. Initialize # current directory is ‘lib’ $ touch args.js
43. Edit lib/args.js (Omit this time. Please copy all contents of this file.) ↓ https://github.com/k-kuwahara/check-stats-modules/blob/master/src/ lib/args.js
44. Edit lib/args.js (Omit this time. Please copy all contents of this file.) ↓ https://github.com/k-kuwahara/check-stats-modules/blob/master/src/ lib/args.js Briefly, we describe the setting of the contents of the “help“ and the processing to handle the arguments and options of the command.
45. Let's check the operation!!
46. Initialize $ check-stats-modules -h $ check-stats-modules -v
47. Let's finish creating this application!!
48. Edit lib/check-stats-modules.js 'use strict’ const args = require(‘./args’) const yargs = require(‘yargs’) const pkg = require(‘../package.json’) + const npm = require('npm-stat-api') + const moment = require('moment') + const chalk = require('chalk')
49. Edit lib/check-stats-modules.js 'use strict’ const args = require(‘./args’) const yargs = require(‘yargs’) const pkg = require(‘../package.json’) + const npm = require('npm-stat-api') + const moment = require('moment') + const chalk = require('chalk') get module’s stats from Github
50. Edit lib/check-stats-modules.js 'use strict’ const args = require(‘./args’) const yargs = require(‘yargs’) const pkg = require(‘../package.json’) + const npm = require('npm-stat-api') + const moment = require('moment') + const chalk = require('chalk') makes it easy to handle dates and times
51. Edit lib/check-stats-modules.js 'use strict’ const args = require(‘./args’) const yargs = require(‘yargs’) const pkg = require(‘../package.json’) + const npm = require('npm-stat-api') + const moment = require('moment') + const chalk = require('chalk') for decorating output contents
52. Edit lib/check-stats-modules.js module.exports = () => { // 'help' is top priority option if (args.h) { show_help() } else if (args.v) { console.log(pkg.version) - } + } else if (args._.length === 0) { + show_help(chalk.yellow.bold('Please enter the module names at least one. \n')) + } else { + const rank = show_stats() + } } (continue...)
53. Edit lib/check-stats-modules.js /** * show stats about modules * * @param void * @return void */ const show_stats = () => { // Omit this time. Please copy all contents of this file. // ↓ // https://github.com/k-kuwahara/check-stats-modules/blob/master/ src/lib/check-stats-modules.js }
54. That is the completion of the CLI application “check-stats-modules”
55. 1. Create account on npm site 2. Develop library 3. Tips for OSS ToDo
56. • Enrich README • Enhance help • Prepare a shortcut command • Put some badges on README Tips
57. README contents
58. Help contents
59. shortcut command The name “check-stats-modules” is too long... Let's prepare a shortcut command called “csm” !!
60. Install node-alias $ npm i -S node-alias $ npm link $ csm -h
61. shortcut command #!/usr/bin/env node require('node-alias')('csm', __dirname) add alias
62. shortcut command Here is the main #!/usr/bin/env node require(‘../lib/check-stats-modules’)()
63. Add badges into top of README Plz show this site → https://shields.io/ BTW, We can also make our own badge ↓ Badges
64. Publish to npm, install, confirm operation
65. Login npm, Publish $ npm login $ npm publish
66. Installation, Confirmation $ npm i -g check-stats-modules $ csm module_name -f 2018-01-01
67. ⚠Attention⚠ ɹɾRequire tests ɹɾAttention to security ɹɾWrite license ɹɾContinually update ɹɹ(do not throw away on the way)
68. Let’s create any libraries!! and Let’s self branding!!