Create a new node module: Difference between revisions

Latest revision as of 17:04, 2 March 2023

Basic local module

Create a directory for the module and cd into it
Initialize it

npx license mit > LICENSE # optional
npx covgen YOUR_EMAIL_ADDRESS # optional
npx gitignore node
npm init es6 -y

Published module

pick a name that doesn't yet exist on [1] just to be safe
create a wiki page off of in-progress Projects
mkdir ~/development/websockets-tester
cd ~/development/websockets-tester
cp -rp ~/development/scripts/node/mah-haus/* .
subl index.js package.json # clean to use wst (our top-level command)
mv sy-cmd.js wst-cmd.js && mv sync-utils.js wst-utils.js
npm install --save ws # to install a local copy of any dependency under node_modules, and auto-add dependency to package.json
git init --shared && git add *.js package.json
on bitpost:
- mkdir ~/development/websockets-tester.git && cd ~/development/websockets-tester.git
- git init --bare --shared
git remote add origin bitpost.com:/home/m/development/websockets-tester.git
git push origin master ... (come back once git-sync is doing auto version creation!)
code your ass off
if it gets good... and is useful to others... publish it!

@@ Line 1: / Line 1: @@
+== Basic local module ==
+* Create a directory for the module and cd into it
+* Initialize it
+ npx license mit > LICENSE # optional
+ npx covgen YOUR_EMAIL_ADDRESS # optional
+ npx gitignore node
+ npm init es6 -y
+== Published module ==
+* pick a name that doesn't yet exist on [https://www.npmjs.com/] just to be safe
 * create a wiki page off of [[Projects#In_Progress|in-progress Projects]]
-* mkdir ~/development/websockets-tester && cd ~/development/websockets-tester
+* mkdir ~/development/websockets-tester
-author up a new node package
+* cd ~/development/websockets-tester
-* cp mah-haus project
+* cp -rp ~/development/scripts/node/mah-haus/* .
-* # clean index.js package.json to use wst (our top-level command) (don't worry about ws dependency, we add that next)
+* subl index.js package.json # clean to use wst (our top-level command)
-* npm install --save ws # to install a local copy under node_modules, and add dep to package.json
+* mv sy-cmd.js wst-cmd.js && mv sync-utils.js wst-utils.js
+* npm install --save ws # to install a local copy of any dependency under node_modules, and auto-add dependency to package.json
+* git init --shared && git add *.js package.json
+* on bitpost:
+** mkdir ~/development/websockets-tester.git && cd ~/development/websockets-tester.git
+** git init --bare --shared
+* git remote add origin bitpost.com:/home/m/development/websockets-tester.git
+* git push origin master   ... (come back once git-sync is doing auto version creation!)
+* code your ass off
+* if it gets good... and is useful to others... publish it!