eleventy-generate-posts 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 John M. Wargo
+
+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/changelog.md

@@ -0,0 +1 @@
+# Changelog

package/eleventy-generate-posts.js

@@ -0,0 +1,135 @@
+#!/usr/bin/env node
+import fs from 'fs-extra';
+import path from 'path';
+import boxen from 'boxen';
+import chalk from 'chalk';
+import { Command } from 'commander';
+import YAML from 'yaml';
+import logger from 'cli-logger';
+var log = logger();
+var HighlightType;
+(function (HighlightType) {
+    HighlightType[HighlightType["Red"] = 0] = "Red";
+    HighlightType[HighlightType["Yellow"] = 1] = "Yellow";
+    HighlightType[HighlightType["Green"] = 2] = "Green";
+})(HighlightType || (HighlightType = {}));
+const APP_NAME = '11ty Generate Posts';
+const APP_AUTHOR = 'by John M. Wargo (https://johnwargo.com)';
+const ELEVENTY_FILES = ['.eleventy.js', 'eleventy.config.js'];
+const NEW_LINE = "\n";
+const red = HighlightType.Red;
+const yellow = HighlightType.Yellow;
+const green = HighlightType.Green;
+function zeroPad(tmpVal, numChars = 2) {
+    return tmpVal.toString().padStart(numChars, '0');
+}
+function directoryExists(filePath) {
+    if (fs.existsSync(filePath)) {
+        try {
+            return fs.lstatSync(filePath).isDirectory();
+        }
+        catch (err) {
+            log.error(`checkDirectory error: ${err}`);
+            return false;
+        }
+    }
+    return false;
+}
+function writeConsole(color, highlightText, msg) {
+    if (color == HighlightType.Red)
+        console.log(NEW_LINE + chalk.red(`${highlightText}: `) + msg + NEW_LINE);
+    if (color == HighlightType.Yellow)
+        console.log(chalk.yellow(`${highlightText}: `) + msg);
+    if (color == HighlightType.Green)
+        console.log(chalk.green(`${highlightText}: `) + msg);
+}
+function getRandomInt(max) {
+    return Math.floor(Math.random() * max) + 1;
+}
+function checkEleventyProject() {
+    log.debug('Validating project folder');
+    let result = false;
+    ELEVENTY_FILES.forEach((file) => {
+        let tmpFile = path.join(process.cwd(), file);
+        if (fs.existsSync(tmpFile)) {
+            result = true;
+        }
+    });
+    return result;
+}
+if (!checkEleventyProject()) {
+    log.error('Current folder is not an Eleventy project folder.');
+    process.exit(1);
+}
+const program = new Command();
+program
+    .name('11ty-gp')
+    .description('Generate a set of posts for an Eleventy project')
+    .argument('<numPosts>', 'Number of posts to generate')
+    .argument('<targetFolder>', 'Target folder for generated posts files')
+    .argument('<tag>', 'Tag to apply to all generated posts')
+    .argument('[startYear]', 'Start year for generated posts')
+    .option('-d, --debug', 'Debug mode')
+    .action(async (numPosts, targetFolder, tag, startYear) => {
+    console.log(boxen(APP_NAME, { padding: 1 }));
+    console.log(APP_AUTHOR);
+    const options = program.opts();
+    const debugMode = options.debug;
+    if (debugMode) {
+        console.log('Debug mode enabled.');
+    }
+    log.level(debugMode ? log.DEBUG : log.INFO);
+    writeConsole(yellow, 'Number of posts', numPosts);
+    writeConsole(yellow, 'Target Folder', targetFolder);
+    if (startYear)
+        writeConsole(yellow, 'Start Year', startYear);
+    writeConsole(yellow, 'Tag', tag);
+    if (!Number.isInteger(parseInt(numPosts))) {
+        writeConsole(red, 'Error', 'Number of posts must be an integer');
+        process.exit(1);
+    }
+    if (!(numPosts > 0 && numPosts < 101)) {
+        writeConsole(red, 'Error', 'Number of posts must be between 1 and 100');
+        process.exit(1);
+    }
+    var outputFilePath = path.join(process.cwd(), targetFolder);
+    writeConsole(yellow, 'Output folder', outputFilePath);
+    if (!directoryExists(outputFilePath)) {
+        writeConsole(red, 'Error', 'Target folder does not exist');
+        process.exit(1);
+    }
+    var currentDate = new Date();
+    if (startYear)
+        currentDate.setFullYear(startYear);
+    numPosts++;
+    for (let i = 1; i < numPosts; i++) {
+        log.debug('\nGetting random words (this may take a few seconds)');
+        let wordCount = getRandomInt(4) + 3;
+        let letTitleRes = await fetch(`https://random-word-api.vercel.app/api?words=${wordCount}`);
+        let titleWords = await letTitleRes.json();
+        titleWords = titleWords.map((a) => a.charAt(0).toUpperCase() + a.substr(1));
+        let postTitle = titleWords.join(' ');
+        log.debug(`Post title: ${postTitle}`);
+        currentDate.setDate(currentDate.getDate() - getRandomInt(20));
+        let postDate = `${currentDate.getFullYear()}-${zeroPad(currentDate.getMonth() + 1)}-${zeroPad(currentDate.getDate())}`;
+        log.debug(`Post date: ${postDate}`);
+        var postFm = {
+            title: postTitle,
+            date: postDate,
+            tags: tag
+        };
+        log.debug('Getting bacon ipsum text (this may take a few seconds)...');
+        let response = await fetch(`https://baconipsum.com/api/?type=all-meat&paras=${getRandomInt(10)}&start-with-lorem=1`);
+        let postContent = await response.json();
+        log.debug(`Post content: ${postContent}`);
+        var thePost = '---\n';
+        thePost += YAML.stringify(postFm, { logLevel: 'silent' });
+        thePost += '---\n\n';
+        thePost += postContent.join('\n\n');
+        var outputFilePath = path.join(targetFolder, postTitle.toLowerCase().replaceAll(' ', '-') + '.md');
+        writeConsole(green, 'Writing', outputFilePath);
+        fs.writeFileSync(outputFilePath, thePost, 'utf8');
+    }
+});
+console.log();
+program.parse();

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "eleventy-generate-posts",
+  "version": "0.0.1",
+  "description": "Generates batches of Eleventy posts",
+  "author": "John M. Wargo",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/johnwargo/eleventy-generate-posts"
+  },
+  "type": "module",
+  "main": "eleventy-generate-posts.js",
+  "bin": {
+    "11ty-gp": "eleventy-generate-posts.js"
+  },
+  "keywords": [
+    "node",
+    "eleventy"
+  ],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "tsc && node eleventy-generate-posts.js 5 posts post"
+  },
+  "dependencies": {
+    "boxen": "^7.0.2",
+    "chalk": "^5.2.0",
+    "cli-logger": "^0.5.40",
+    "commander": "^10.0.1",
+    "fs-extra": "^11.1.1",
+    "yaml": "^2.2.2"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.1",
+    "@types/node": "^18.15.5",
+    "@types/prompts": "^2.4.4",
+    "eleventy": "^1.0.6"
+  }
+}

package/readme.md

@@ -0,0 +1,86 @@
+# Eleventy Generate Posts
+
+A simple command-line utility that creates a batch of new posts for an [Eleventy](https://www.11ty.dev/) site.
+
+When you're testing out some aspect of an Eleventy site or doing a demo, you often need to populate the site with a set of posts to flesh out the site. Copying a single post or set of posts repeatedly into the site works, but an automated solution is better. This is that solution.
+
+The utility generates batches of Eleventy site posts, populating the post title with a random quantity of random words and populating the post body with a random number of paragraphs of [Bacon Ipsum](https://baconipsum.com/) text.
+
+## Installation
+
+To install the command globally on the system, open a terminal window or command prompt, then execute the following command:
+
+```shell
+npm install -g eleventy-generate-posts
+```
+
+This adds a `11ty-gp` command to the system.
+
+You don't have to install the package to use it; simply open a terminal window or command prompt to your Eleventy project folder and execute the command using `npx eleventy-generate-posts` and the command-line options described in the following section.
+## Usage
+
+Execute the command using the following command-line parameters:
+
+```shell
+11ty-gp [options] <numPosts> <targetFolder> <tag> [startYear]
+```
+
+Supported command-line options are:
+
+* `numPosts` (required) An integer value representing the number of posts generated.
+* `targetFolder` (required) Relative path pointing to the Eleventy project's posts folder; use `.` for the current folder.
+* `tag` (required) The post tag applied to the generated posts
+* `startYear` (optional) The starting year used for post date in the generated posts. The command uses the current date or the current date with the specified year (when provided) to for the post date for the first generated post. For subsequent post dates, the command randomly decrements the day.
+
+As an example, to generate 10 posts in the project's `posts` folder using a `tags` value of `post`, use:
+
+```shell
+11ty-gp 10 posts post
+```
+
+This command sets the post date for the current post to the current date, then works backwards (random days) for each subsequent generated post.
+
+To generate 20 posts starting in 2021, use the following:
+
+```shell
+11ty-gp 20 posts post 2021
+```
+
+This command sets the post date for the current post to the current month/day plus the provided year, then works backwards (random days) for each subsequent generated post. So, if you execute the command on May 10, 2023, the command sets the post date for the first post to May 10, 2021 and works (randomly) backwards from there.
+
+Supported command-line options (flags) are:
+
+* `-d` or `--debug`: Enables debug mode which generates additional content to the terminal during execution
+* `h` or `--help`: Displays usage information in the terminal
+
+A sample generated post looks like the following:
+
+```markdown
+---
+title: Boaster Halogen Jokingly Evident Decode Steadfast
+date: 2023-03-19
+tags: post
+---
+
+Bacon ipsum dolor amet brisket picanha swine beef ribs pork.  Pig short ribs andouille ham ribeye hamburger
+tail rump turducken kevin alcatra bacon beef meatloaf.  Bresaola pancetta pig, cupim frankfurter brisket 
+pork belly turkey.  Pork belly frankfurter cupim, salami picanha short ribs beef ribs chuck fatback pastrami 
+doner chicken ham.  Tail fatback landjaeger chicken jowl, pancetta bresaola picanha.  Pork belly ball tip 
+picanha bresaola capicola prosciutto drumstick swine flank cupim corned beef.
+
+Sausage frankfurter ground round tail, tri-tip burgdoggen flank pork loin.  Bresaola landjaeger shoulder 
+pastrami burgdoggen meatball.  Frankfurter kevin pig, hamburger andouille tail meatloaf cupim meatball beef 
+ribs prosciutto.  Meatloaf chislic flank tri-tip swine filet mignon brisket sirloin turkey porchetta.
+```
+
+### Getting Help Or Making Changes
+
+Use [GitHub Issues](https://github.com/johnwargo/eleventy-generate-posts/issues) to get help with this module.
+
+Pull Requests gladly accepted, but only with complete documentation of what the change is, why you made it, and why you think its important to have in the module.
+
+***
+
+If this code helps you, please consider buying me a coffee.
+
+<a href="https://www.buymeacoffee.com/johnwargo" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>