notes-of-encouragement 2.0.9

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 David Neal
+
+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.

package/README.md

@@ -0,0 +1,46 @@
+# Notes of Encouragement
+
+This is a command-line interface (CLI) application written in Node.js that displays one random note of encouragement each time it is run.
+
+I wrote this application for my son, so he can always get a note of encouragement from me whenever he needs one. You don't even need to be connected to the Internet!
+
+![Example Note](./cli-app-example.png)
+
+## Modifying For Someone Special in Your Life
+
+If you want to use this application for someone special, you can update the following using a good editor like [Visual Studio Code](https://code.visualstudio.com):
+
+* `/bin/notes.json`: this contains a JavaScript object with an array of introductions and an array of notes.
+* `/package.json`: change the `/bin` to be whatever command you want. Right now it's set to `heybuddy`. Change yours to `heygirl`, `heyprincess`, `hi-beautiful`, or whatever you wish!
+
+## Installing on Someone's Computer
+
+1. Download and install [node.js](https://nodejs.org).
+1. Download, extract, and modify this source code, or copy all the modified source code from your computer to a folder on their computer.
+1. Open up a terminal/command window.
+1. Change to the directory where the source code files are located.
+1. Run the following command to install dependencies and install it as a CLI app.
+
+```bash
+npm install
+npm install -g .
+```
+
+Last, add instructions to your loved one's computer to open up a terminal/command prompt window and type `heybuddy` (or whatever you defined as your app in the `package.json` file).
+
+Hope this helps you touch someone's heart and let them know you love them! ❤
+
+## Updating
+
+1. Modify the source code to add/remove notes.
+1. Reinstall the CLI app same as installing it before.
+
+```bash
+npm install -g .
+```
+
+## Uninstalling
+
+```bash
+npm uninstall -g notes-of-encouragement
+```

package/bin/index.js

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+import fs from "node:fs/promises";
+import { resolve } from "node:path";
+import chalk from "chalk";
+import boxen from "boxen";
+
+const __dirname = import.meta.dirname;
+
+const boxenOptions = {
+	padding: 1,
+	margin: 0,
+	borderStyle: "round",
+	borderColor: "green"
+};
+
+function getRandomIndex( max ) {
+	return Math.floor( Math.random() * max );
+}
+
+try {
+	const text = await fs.readFile( resolve( __dirname, "notes.json" ), { encoding: "utf-8" } );
+	const { notes, intros } = JSON.parse( text );
+	const randomIntro = intros[getRandomIndex( intros.length )];
+	const randomNote = notes[getRandomIndex( notes.length )];
+	const message = `${ randomIntro }\n${ randomNote }`;
+	console.log( boxen( chalk.bold( message ), boxenOptions ) );
+} catch ( error ) {
+	console.error( error );
+}

package/bin/notes.json

@@ -0,0 +1,43 @@
+{
+	"intros": [
+		"Hey buddy, I just want you to know...",
+		"Hey buddy, I want you to remember...",
+		"Hey buddy, don't ever forget...",
+		"Hey buddy, no matter what anyone else says..."
+	],
+	"notes": [
+		"I know you can do it. Don't give up.",
+		"You are __so__ special!",
+		"You are amazing!",
+		"I am so proud of you 😊",
+		"You are a pretty good bass player 🎸 😉",
+		"God has very special plans for your life!",
+		"You are strong 💪",
+		"I'm so glad I get to be your Dad!",
+		"Don't believe the lies the world keeps throwing at you.",
+		"You are smart 🧠",
+		"You are brave! 👊",
+		"You are uniquely gifted to do incredible things!",
+		"Always look for the sacred in the ordinary things.",
+		"Treat others with kindness ❤️",
+		"There is always something you can be grateful for.",
+		"You can change lives by serving others.",
+		"You are loved ❤️",
+		"You can sing 🎶",
+		"You can be someone others can always trust.",
+		"Focus on staying pure of heart ❤️",
+		"Don't forget to pray 🙏",
+		"It's okay to ask for help.",
+		"No matter what happens, I will always love you.",
+		"I am so blessed you are my son.",
+		"Your mistakes do not make you a failure. Learn and grow.",
+		"Do good for those around you.",
+		"Be patient with yourself.",
+		"Forgive others, and be sure to forgive yourself.",
+		"Happiness will come and go, but you can always have hope and joy.",
+		"I need you. Your family needs you. Your friends need you. The world needs you.",
+		"Amazing things are yet to come!",
+		"You are not responsible for the actions of others.",
+		"Keep a good attitude!"
+	]
+}

package/eslint.config.js

@@ -0,0 +1,8 @@
+import { defineConfig } from "eslint/config"; // eslint-disable-line n/no-unpublished-import
+import rg from "eslint-config-reverentgeek"; // eslint-disable-line n/no-unpublished-import
+
+export default defineConfig( {
+	extends: [ rg.configs["node-esm"] ],
+	rules: {
+	}
+} );

package/package.json

@@ -0,0 +1,28 @@
+{
+	"name": "notes-of-encouragement",
+	"version": "2.0.9",
+	"description": "",
+	"main": "bin/index.js",
+	"type": "module",
+	"engines": {
+		"node": ">=22.16"
+	},
+	"scripts": {
+		"test": "echo \"Error: no test specified\" && exit 1"
+	},
+	"keywords": [],
+	"author": "David Neal <david@reverentgeek.com> (https://reverentgeek.com)",
+	"license": "MIT",
+	"bin": {
+		"heybuddy": "./bin/index.js"
+	},
+	"dependencies": {
+		"boxen": "^8.0.1",
+		"chalk": "^5.6.2"
+	},
+	"devDependencies": {
+		"eslint": "^9.39.2",
+		"eslint-config-reverentgeek": "^6.3.7"
+	},
+	"packageManager": "pnpm@10.27.0+sha512.72d699da16b1179c14ba9e64dc71c9a40988cbdc65c264cb0e489db7de917f20dcf4d64d8723625f2969ba52d4b7e2a1170682d9ac2a5dcaeaab732b7e16f04a"
+}