eleventy-generate-posts 0.0.1 → 0.0.2

package/changelog.md

@@ -1 +1,5 @@
 # Changelog
+
+## 20230516
+
+Added support for the `-y` flag which saves generated posts to a subfolder for the current year. 

package/eleventy-generate-posts.js

@@ -70,6 +70,7 @@ program
     .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);
@@ -84,6 +85,8 @@ program
     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);
@@ -126,7 +129,13 @@ program
         thePost += YAML.stringify(postFm, { logLevel: 'silent' });
         thePost += '---\n\n';
         thePost += postContent.join('\n\n');
-        var outputFilePath = path.join(targetFolder, postTitle.toLowerCase().replaceAll(' ', '-') + '.md');
+        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');
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eleventy-generate-posts",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Generates batches of Eleventy posts",
   "author": "John M. Wargo",
   "license": "MIT",

package/readme.md

@@ -4,7 +4,7 @@ A simple command-line utility that creates a batch of new posts for an [Eleventy
 
 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.
+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.
 
 ## Installation
 
@@ -17,6 +17,7 @@ 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:
@@ -25,13 +26,19 @@ Execute the command using the following command-line parameters:
 11ty-gp [options] <numPosts> <targetFolder> <tag> [startYear]
 ```
 
-Supported command-line options are:
+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:
 
 ```shell
@@ -48,10 +55,15 @@ To generate 20 posts starting in 2021, use the following:
 
 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:
+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:
 
-* `-d` or `--debug`: Enables debug mode which generates additional content to the terminal during execution
-* `h` or `--help`: Displays usage information in the terminal
+```shell
+11ty-gp 20 posts post 2021 -y
+```
+
+Obviously if you generate enough posts to push into the previous year, the posts will save into a folder for the previous year. 
+
+## Example Post
 
 A sample generated post looks like the following:
 
@@ -73,7 +85,7 @@ pastrami burgdoggen meatball.  Frankfurter kevin pig, hamburger andouille tail m
 ribs prosciutto.  Meatloaf chislic flank tri-tip swine filet mignon brisket sirloin turkey porchetta.
 ```
 
-### Getting Help Or Making Changes
+## Getting Help Or Making Changes
 
 Use [GitHub Issues](https://github.com/johnwargo/eleventy-generate-posts/issues) to get help with this module.