eleventy-generate-posts 0.0.2 → 0.0.4

package/changelog.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 20230709 - version 0.0.4
+
+Made number of posts the first prompt, it seemed better this way.
+
+## 20230701 - version 0.0.3
+
+Replaced command line options with interactive prompts
+
 ## 20230516
 
 Added support for the `-y` flag which saves generated posts to a subfolder for the current year. 

package/eleventy-generate-posts.js

@@ -3,7 +3,7 @@ import fs from 'fs-extra';
 import path from 'path';
 import boxen from 'boxen';
 import chalk from 'chalk';
-import { Command } from 'commander';
+import prompts from 'prompts';
 import YAML from 'yaml';
 import logger from 'cli-logger';
 var log = logger();
@@ -14,12 +14,18 @@ var HighlightType;
     HighlightType[HighlightType["Green"] = 2] = "Green";
 })(HighlightType || (HighlightType = {}));
 const APP_NAME = '11ty Generate Posts';
-const APP_AUTHOR = 'by John M. Wargo (https://johnwargo.com)';
+const APP_AUTHOR = 'by John M. Wargo (https://johnwargo.com)\n';
 const ELEVENTY_FILES = ['.eleventy.js', 'eleventy.config.js'];
 const NEW_LINE = "\n";
+const spaces40 = '-'.repeat(40);
 const red = HighlightType.Red;
 const yellow = HighlightType.Yellow;
 const green = HighlightType.Green;
+var numPosts;
+var startYear;
+var tag;
+var targetFolder;
+var yearMode;
 function zeroPad(tmpVal, numChars = 2) {
     return tmpVal.toString().padStart(numChars, '0');
 }
@@ -61,84 +67,101 @@ 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')
-    .option('-y, --year', 'Save to Year folder')
-    .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);
-    const yearMode = options.year;
-    writeConsole(yellow, 'Year mode', yearMode ? 'enabled' : 'disabled');
-    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);
-    }
+console.log(boxen(APP_NAME, { padding: 1 }));
+console.log(APP_AUTHOR);
+const debugMode = process.argv.includes('-d');
+if (debugMode) {
+    writeConsole(green, 'Debug mode', 'enabled\n');
+}
+log.level(debugMode ? log.DEBUG : log.INFO);
+const questions = [
+    {
+        type: 'number',
+        name: 'numPosts',
+        initial: 10,
+        message: 'Number of posts to generate?'
+    }, {
+        type: 'text',
+        name: 'targetFolder',
+        initial: 'src/posts',
+        message: 'Target folder for generated posts?'
+    }, {
+        type: 'text',
+        name: 'tag',
+        message: 'Post tag?',
+        initial: 'post'
+    }, {
+        type: 'number',
+        name: 'startYear',
+        initial: new Date().getFullYear(),
+        message: 'Start year for generated posts?'
+    }, {
+        type: 'confirm',
+        name: 'yearMode',
+        initial: true,
+        message: 'Use year folder for posts?'
+    },
+];
+const response = await prompts(questions);
+targetFolder = response.targetFolder;
+numPosts = response.numPosts;
+startYear = response.startYear;
+tag = response.tag;
+yearMode = response.yearMode;
+console.log('\nSettings Summary:');
+console.log(spaces40);
+writeConsole(yellow, 'Number of posts', numPosts.toString());
+writeConsole(yellow, 'Target Folder', targetFolder);
+writeConsole(yellow, 'Start Year', startYear.toString());
+writeConsole(yellow, 'Tag', tag);
+writeConsole(yellow, 'Year mode', yearMode ? 'enabled' : 'disabled');
+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', 'Output folder does not exist');
+    process.exit(1);
+}
+console.log('\nGenerating posts...');
+console.log(spaces40);
+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(process.cwd(), targetFolder);
-    writeConsole(yellow, 'Output folder', outputFilePath);
-    if (!directoryExists(outputFilePath)) {
-        writeConsole(red, 'Error', 'Target folder does not exist');
-        process.exit(1);
+    if (yearMode) {
+        outputFilePath = path.join(outputFilePath, currentDate.getFullYear().toString());
+        if (!fs.existsSync(outputFilePath))
+            fs.mkdirSync(outputFilePath, { recursive: true });
     }
-    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(process.cwd(), targetFolder);
-        if (yearMode) {
-            outputFilePath = path.join(outputFilePath, currentDate.getFullYear().toString());
-            if (!fs.existsSync(outputFilePath))
-                fs.mkdirSync(outputFilePath, { recursive: true });
-        }
-        var outputFilePath = path.join(outputFilePath, postTitle.toLowerCase().replaceAll(' ', '-') + '.md');
-        writeConsole(green, 'Writing', outputFilePath);
-        fs.writeFileSync(outputFilePath, thePost, 'utf8');
-    }
-});
-console.log();
-program.parse();
+    var outputFilePath = path.join(outputFilePath, postTitle.toLowerCase().replaceAll(' ', '-') + '.md');
+    writeConsole(green, 'Writing', outputFilePath);
+    fs.writeFileSync(outputFilePath, thePost, 'utf8');
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eleventy-generate-posts",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Generates batches of Eleventy posts",
   "author": "John M. Wargo",
   "license": "MIT",
@@ -19,7 +19,7 @@
   ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "start": "tsc && node eleventy-generate-posts.js 5 posts post"
+    "start": "tsc && node eleventy-generate-posts.js"
   },
   "dependencies": {
     "boxen": "^7.0.2",
@@ -27,6 +27,7 @@
     "cli-logger": "^0.5.40",
     "commander": "^10.0.1",
     "fs-extra": "^11.1.1",
+    "prompts": "^2.4.2",
     "yaml": "^2.2.2"
   },
   "devDependencies": {

package/pub.mjs

@@ -0,0 +1,5 @@
+#!/usr/bin/env zx
+
+await $`npm version patch`;
+await $`git push`;
+await $`npm publish`;

package/readme.md

@@ -6,6 +6,8 @@ When you're testing out some aspect of an Eleventy site or doing a demo, you oft
 
 The utility generates batches of Eleventy site posts, populating the post title with a random quantity of random words using the [Rando Free Random Word Generator API](https://random-word-api.vercel.app/) and populating the post body with a random number of paragraphs of [Bacon Ipsum](https://baconipsum.com/) text.
 
+The original version of this utility used command-line arguments, but this version replaces them with prompts.
+
 ## Installation
 
 To install the command globally on the system, open a terminal window or command prompt, then execute the following command:
@@ -16,53 +18,67 @@ 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.
+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 it will execute without being installed.
 
 ## Usage
 
-Execute the command using the following command-line parameters:
-
-```shell
-11ty-gp [options] <numPosts> <targetFolder> <tag> [startYear]
-```
-
-Supported command-line parameters 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.
-
-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
-* `-y` or `--year`: instructs the command to store posts to a subfolder for the post date year.
-
-As an example, to generate 10 posts in the project's `posts` folder using a `tags` value of `post`, use:
+Execute the command using the following command:
 
 ```shell
-11ty-gp 10 posts post
+11ty-gp
 ```
 
-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
+The module will prompt you for all the required options:
+
+```text
+┌─────────────────────────┐
+│                         │
+│   11ty Generate Posts   │
+│                         │
+└─────────────────────────┘
+by John M. Wargo (https://johnwargo.com)
+
+√ Number of posts to generate? ... 10
+√ Target folder for generated posts? ... posts
+√ Post tag? ... post
+√ Start year for generated posts? ... 2023
+√ Use year folder for posts? ... yes
+
+Settings Summary:
+----------------------------------------
+Number of posts: 10
+Target Folder: posts
+Start Year: 2023
+Tag: post
+Year mode: enabled
+Output folder: D:\dev\node\11ty-generate-posts\posts
+
+Generating posts...
+----------------------------------------
+Writing: D:\dev\node\11ty-generate-posts\posts\2023\navigator-washbasin-dramatize-landside-sensation.md
+Writing: D:\dev\node\11ty-generate-posts\posts\2023\amusing-peculiar-surgical-borough-impotency-surround-tubular.md
+Writing: D:\dev\node\11ty-generate-posts\posts\2023\maturely-convene-squishier-verify.md
+Writing: D:\dev\node\11ty-generate-posts\posts\2023\matchless-overlaid-expend-oxidation-tribesman.md
+Writing: D:\dev\node\11ty-generate-posts\posts\2023\basis-brunt-swaddling-ladylike-support-epidemic-graded.md
+Writing: D:\dev\node\11ty-generate-posts\posts\2023\certify-unsheathe-undress-obstacle-tweak-tray-ridden.md
+Writing: D:\dev\node\11ty-generate-posts\posts\2023\matching-enjoying-contact-atlas.md
+Writing: D:\dev\node\11ty-generate-posts\posts\2023\android-gecko-penalize-possum.md
+Writing: D:\dev\node\11ty-generate-posts\posts\2023\contempt-acquire-filtrate-defense-ergonomic-acts.md
+Writing: D:\dev\node\11ty-generate-posts\posts\2023\splinter-ecology-computer-nearby-shorts-feminize.md
 ```
 
-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.
+Configuration options are:
 
-To generate 20 posts starting in 2021 and store them in a folder for the current year (`posts/2021` in this example), use the `-y` or `--year` flag on the command line:
-
-```shell
-11ty-gp 20 posts post 2021 -y
-```
+* **Number of Posts:** An integer value between 1 and 100 representing the number of posts generated.
+* **Posts Folder:** Relative path pointing to the Eleventy project's posts folder; use `.` for the current folder.
+* **Post Tag:** The front matter `tag` property applied to the generated posts
+* **Start Year:** 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.
+* **Use Year Folder:** specifies whether the module writes generated posts to the Posts folder (`N`) or into a separate folder for each year (`Y`).
 
 Obviously if you generate enough posts to push into the previous year, the posts will save into a folder for the previous year. 
 
+To enable debug mode, pass a `-d` flag on the command-line; in this mode, the module writes additional information to the console as it executes.
+
 ## Example Post
 
 A sample generated post looks like the following: