ultimate-jekyll-manager 0.0.13 → 0.0.15

package/README.md

@@ -1,5 +1,48 @@
-# ultimate-jekyll-manager
-All-in-one package for ultimate-jekyll
+<p align="center">
+  <a href="https://itwcreativeworks.com">
+    <img src="https://cdn.itwcreativeworks.com/assets/itw-creative-works/images/logo/itw-creative-works-brandmark-black-x.svg" width="100px">
+  </a>
+</p>
+
+<p align="center">
+  <img src="https://img.shields.io/github/package-json/v/itw-creative-works/ultimate-jekyll-manager.svg">
+  <br>
+  <img src="https://img.shields.io/librariesio/release/npm/ultimate-jekyll-manager.svg">
+  <img src="https://img.shields.io/bundlephobia/min/ultimate-jekyll-manager.svg">
+  <img src="https://img.shields.io/codeclimate/maintainability-percentage/itw-creative-works/ultimate-jekyll-manager.svg">
+  <img src="https://img.shields.io/npm/dm/ultimate-jekyll-manager.svg">
+  <img src="https://img.shields.io/node/v/ultimate-jekyll-manager.svg">
+  <img src="https://img.shields.io/website/https/itwcreativeworks.com.svg">
+  <img src="https://img.shields.io/github/license/itw-creative-works/ultimate-jekyll-manager.svg">
+  <img src="https://img.shields.io/github/contributors/itw-creative-works/ultimate-jekyll-manager.svg">
+  <img src="https://img.shields.io/github/last-commit/itw-creative-works/ultimate-jekyll-manager.svg">
+  <br>
+  <br>
+  <a href="https://itwcreativeworks.com">Site</a> | <a href="https://www.npmjs.com/package/ultimate-jekyll-manager">NPM Module</a> | <a href="https://github.com/itw-creative-works/ultimate-jekyll-manager">GitHub Repo</a>
+  <br>
+  <br>
+  <strong>Ultimate Jekyll</strong> is a template that helps you jumpstart your Jekyll sites and is fueled by an intuitive incorporation of npm, gulp, and is fully SEO optimized and blazingly fast.
+</p>
+
+## 🦄 Features
+* **SEO Optimized**: Ultimate Jekyll is fully SEO optimized.
+* **Blazingly Fast**: Ultimate Jekyll is blazingly fast.
+* **NPM & Gulp**: Ultimate Jekyll is fueled by an intuitive incorporation of npm and gulp.
+
+## 🚀 Getting started
+1. [Create a repo](https://github.com/itw-creative-works/ultimate-jekyll/generate) from the **Ultimate Jekyll** template.
+2. Clone the repo to your local machine.
+3. Run these command to get everything setup and sync'd!
+```bash
+npm install
+npx uj setup
+npm start
+```
+
+## 📦 How to sync with the template
+1. Simply run `npx uj setup` in Terminal to get all the latest updates from the **Ultimate Jekyll template**.
+
+## 🌎 Publishing your website
+1. Change the `url` in `_config.yml` to your domain.
+2. Push your changes to GitHub using `npm run dist` in Terminal.
 
-# Commands
-* `npx uj setup && npm start` - Setup and start the project

package/TODO.md

@@ -14,3 +14,58 @@ MIGRATIONS
 'npm-build': new Date().toISOString(),
 brand: config.brand,
 'admin-dashboard': JSON5.parse(config['admin-dashboard']),
+
+
+
+MAYBE
+ # - name: Log all files in node_modules/ultimate-jekyll-manager
+      #   run: |
+      #     echo "All files in node_modules/ultimate-jekyll-manager: "
+      #     ls -R node_modules/ultimate-jekyll-manager
+      # - name: Fetch ensure-production-build.js
+      #   run: |
+      #     [ -d node_modules/ultimate-jekyll-manager ] || mkdir -p node_modules/ultimate-jekyll-manager
+      #     curl -L https://raw.githubusercontent.com/itw-creative-works/ultimate-jekyll-manager/refs/heads/master/src/ensure-production-build.js > node_modules/ultimate-jekyll-manager/ensure-production-build.js
+      # - name: Log all files in repo
+      #   run: |
+      #     echo "All files in the repo: "
+      #     ls -R *
+      # - name: Run node build
+      #   # run: npm run build -- --buildLocation='server'
+      #   run: |
+      #     UJ_BUILD_MODE=true UJ_IS_SERVER=true node node_modules/ultimate-jekyll-manager/ensure-production-build.js && npx uj setup && npm run build
+      # - name: Create build.json
+      #   run: |
+      #     export TZ=UTC date
+      #     timestamp=$(date +%FT%TZ)
+      #     temp_build_json=$(cat @output/build/build.json)
+
+      #     echo account: $GITHUB_ACTOR
+      #     echo repo: $GITHUB_REPOSITORY
+      #     echo timestamp: $timestamp
+      #     echo build.json: $temp_build_json
+
+      #     build_log_path="@output/build/build.json"
+      #     sed "s/%GHP_TIMESTAMP%/$timestamp/g" $build_log_path > "$build_log_path"-temp && mv "$build_log_path"-temp $build_log_path
+
+      #     sed -n '1h;1!H;${;g;s/GEN>>>.*<<<GEN/<REDACTED FOR LIVE PUBLISH>/g;p;}' .gitignore > .gitignore
+      # - name: Delete gh-pages branch
+      #   uses: dawidd6/action-delete-branch@v3
+      #   with:
+      #     github_token: ${{ secrets.GH_TOKEN }}
+      #     branches: gh-pages
+      #     soft_fail: true
+
+      # - name: Purge artifacts
+      #   uses: c-hive/gha-remove-artifacts@v1
+      #   with:
+      #     ages: '5 minutes' # '<number> <unit>', e.g. 5 days, 2 years, 90 seconds, parsed by Moment.js
+      #     # Optional inputs
+      #     # skip-tags: true
+      #     # skip-recent: 5
+      # - name: Purge artifacts
+      #   uses: geekyeggo/delete-artifact@v5
+      #   with:
+      #       name: github-pages
+
+    "deploy": "UJ_BUILD_MODE=true UJ_IS_SERVER=true npx uj setup && npm run build"

package/dist/cli.js

@@ -2,16 +2,47 @@
 const path = require('path');
 const jetpack = require('fs-jetpack');
 
-// Main Function
-function Main() {
-  const self = this;
+// Command Aliases
+const DEFAULT = 'setup';
+const ALIASES = {
+  clean: ['-c', '--clean'],
+  'cloudflare-purge': ['-cf', 'purge', '--cloudflare-purge'],
+  install: ['-i', 'i', '--install'],
+  setup: ['-s', '--setup'],
+  version: ['-v', '--version'],
+};
+
+// Function to resolve command name from aliases
+function resolveCommand(options) {
+  // Check if a command was explicitly passed via positional argument
+  if (options._.length > 0) {
+    const command = options._[0];
+    for (const [key, aliases] of Object.entries(ALIASES)) {
+      if (command === key || aliases.includes(command)) {
+        return key;
+      }
+    }
+    return command; // If not found in aliases, return as-is
+  }
+
+  // Check if any alias was passed as a flag (e.g., -g)
+  for (const [key, aliases] of Object.entries(ALIASES)) {
+    for (const alias of aliases) {
+      if (options[alias.replace(/^-+/, '')]) { // Remove leading `-`
+        return key;
+      }
+    }
+  }
+
+  return DEFAULT; // Fallback to default if no match is found
 }
 
-Main.prototype.process = async function (options) {
-  const self = this;
+// Main Function
+function Main() {}
 
-  // Determine the command (default to "setup" if none provided)
-  const command = options._[0] || 'setup';
+Main.prototype.process = async function (options) {
+  // Determine the command (use default if not provided)
+  const command = resolveCommand(options);
 
   try {
     // Get the command file path

package/dist/commands/cloudflare-purge.js

@@ -0,0 +1,46 @@
+// Libraries
+const Manager = new (require('../build.js'));
+const logger = Manager.logger('cloudflare-purge');
+const path = require('path');
+const jetpack = require('fs-jetpack');
+const { execute } = require('node-powertools');
+const fetch = require('wonderful-fetch');
+
+// Load package
+const package = jetpack.read(path.join(__dirname, '../../', 'package.json'), 'json');
+const project = jetpack.read(path.join(process.cwd(), 'package.json'), 'json');
+
+// Get config
+const config = Manager.getConfig();
+
+module.exports = async function (options) {
+  // Log
+  logger.log(`Running Cloudflare purge...`);
+
+  // Get delay
+  const delay = options.delay
+    || (Manager.isServer() ? 60000 : 0);
+
+  // Make request to Cloudflare
+  try {
+    await fetch('https://api.itwcreativeworks.com/wrapper', {
+      method: 'post',
+      response: 'json',
+      log: true,
+      body: {
+        service: 'cloudflare',
+        command: `client/v4/zones/${config.cloudflare.zone}/purge_cache`,
+        method: 'post',
+        body: {
+          purge_everything: true
+        },
+        delay: delay,
+      },
+    })
+    .then((r) => {
+      logger.log('Cloudflare purge complete.', r);
+    })
+  } catch (e) {
+    logger.error(`Error during install:`, e);
+  }
+};

package/dist/commands/setup.js

@@ -250,9 +250,7 @@ function buildSiteFiles() {
   });
 
   // Log
-  // FLAG
-  console.log('🚩🚩🚩🚩🚩', 1, ); // FLAG
-  logger.log('Files:', files)
+  // logger.log('Files:', files);
 
   // Loop
   for (const file of files) {
@@ -280,9 +278,9 @@ function buildSiteFiles() {
     const exists = jetpack.exists(destination);
 
     // Log
-    logger.log('File:', file);
-    logger.log('filename:', filename);
-    logger.log('options:', options);
+    // logger.log('File:', file);
+    // logger.log('filename:', filename);
+    // logger.log('options:', options);
     // logger.log('contents:', jetpack.read(source));
     // logger.log('source:', source);
     // logger.log('Destination:', destination);

package/dist/defaults/.github/workflows/build.yml

@@ -81,46 +81,9 @@ jobs:
         run: |
           echo "All files in the repo: "
           ls -R *
-      # - name: Log all files in node_modules/ultimate-jekyll-manager
-      #   run: |
-      #     echo "All files in node_modules/ultimate-jekyll-manager: "
-      #     ls -R node_modules/ultimate-jekyll-manager
-      # - name: Fetch ensure-production-build.js
-      #   run: |
-      #     [ -d node_modules/ultimate-jekyll-manager ] || mkdir -p node_modules/ultimate-jekyll-manager
-      #     curl -L https://raw.githubusercontent.com/itw-creative-works/ultimate-jekyll-manager/refs/heads/master/src/ensure-production-build.js > node_modules/ultimate-jekyll-manager/ensure-production-build.js
-      # - name: Log all files in repo
-      #   run: |
-      #     echo "All files in the repo: "
-      #     ls -R *
-      # - name: Run node build
-      #   # run: npm run build -- --buildLocation='server'
-      #   run: |
-      #     UJ_BUILD_MODE=true UJ_IS_SERVER=true node node_modules/ultimate-jekyll-manager/ensure-production-build.js && npx uj setup && npm run build
       - name: Run node build
         run: |
           UJ_BUILD_MODE=true UJ_IS_SERVER=true npx uj setup && npm run build
-      # - name: Create build.json
-      #   run: |
-      #     export TZ=UTC date
-      #     timestamp=$(date +%FT%TZ)
-      #     temp_build_json=$(cat @output/build/build.json)
-
-      #     echo account: $GITHUB_ACTOR
-      #     echo repo: $GITHUB_REPOSITORY
-      #     echo timestamp: $timestamp
-      #     echo build.json: $temp_build_json
-
-      #     build_log_path="@output/build/build.json"
-      #     sed "s/%GHP_TIMESTAMP%/$timestamp/g" $build_log_path > "$build_log_path"-temp && mv "$build_log_path"-temp $build_log_path
-
-      #     sed -n '1h;1!H;${;g;s/GEN>>>.*<<<GEN/<REDACTED FOR LIVE PUBLISH>/g;p;}' .gitignore > .gitignore
-      # - name: Delete gh-pages branch
-      #   uses: dawidd6/action-delete-branch@v3
-      #   with:
-      #     github_token: ${{ secrets.GH_TOKEN }}
-      #     branches: gh-pages
-      #     soft_fail: true
       - name: Delete gh-pages branch
         continue-on-error: true
         run: |
@@ -133,21 +96,11 @@ jobs:
         with:
           github_token: ${{ secrets.GH_TOKEN }}
           publish_dir: ./_site
+          # enable_jekyll: true
       - name: Purge CloudFlare cache
-        run: npm run cloudflare:purge
+        run: npx uj cloudflare-purge
       - name: Purge artifacts
         uses: kolpav/purge-artifacts-action@v1
         with:
           token: ${{ secrets.GH_TOKEN }}
           expire-in: 30 minutes # Set this to 0 to delete instantly
-      # - name: Purge artifacts
-      #   uses: c-hive/gha-remove-artifacts@v1
-      #   with:
-      #     ages: '5 minutes' # '<number> <unit>', e.g. 5 days, 2 years, 90 seconds, parsed by Moment.js
-      #     # Optional inputs
-      #     # skip-tags: true
-      #     # skip-recent: 5
-      # - name: Purge artifacts
-      #   uses: geekyeggo/delete-artifact@v5
-      #   with:
-      #       name: github-pages

package/dist/defaults/_.gitignore

@@ -66,8 +66,8 @@ node_modules/
 .env
 
 # Jekyll
-_site/
+/_site
 
 # Custom
-dist/
-.temp/
+/dist
+/.temp

package/dist/defaults/src/pages/index.html

@@ -0,0 +1,9 @@
+<html>
+  <head>
+    <title>Home</title>
+  </head>
+  <body>
+    <h1>Home</h1>
+    <p>Welcome to the home page.</p>
+  </body>
+</html>

package/dist/gulp/tasks/distribute.js

@@ -2,6 +2,7 @@
 const Manager = new (require('../../build.js'));
 const logger = Manager.logger('distribute');
 const { src, dest, watch, series } = require('gulp');
+const through2 = require('through2');
 const jetpack = require('fs-jetpack');
 const path = require('path');
 const JSON5 = require('json5');
@@ -32,26 +33,24 @@ async function distribute(complete) {
   // Log
   logger.log('Starting...');
 
-  // Copy all files from src/defaults/dist on first run
+  // First-run tasks
   if (index === 0) {
-    // Get the directory
-    const dir = path.join(__dirname, '..', '..', 'defaults', 'dist');
+    // Copy all files from src/defaults/dist on first run
+    await copyDefaultDistFiles();
 
-    // Log
-    logger.log(`Copying default dist files from ${dir}`);
+    // Create CNAME
+    await createCNAME();
 
-    // Copy the files
-    jetpack.copy(dir, 'dist', { overwrite: true });
+    // Fetch firebase-auth files
+    await fetchFirebaseAuth();
   }
 
   // Create build JSON
   await createBuildJSON();
 
-  // Fetch firebase-auth files
-  await fetchFirebaseAuth();
-
   // Complete
-  return src(input)
+  return src(input, { base: 'src' })
+    .pipe(customPathTransform())
     .pipe(dest(output))
     .on('end', () => {
       // Log
@@ -62,6 +61,24 @@ async function distribute(complete) {
     });
 }
 
+function customPathTransform() {
+  return through2.obj(function(file, _, cb) {
+    if (file.isDirectory()) {
+      return cb(null, file);
+    }
+
+    const relativePath = path.relative(file.base, file.path);
+
+    if (relativePath.startsWith('pages/')) {
+      const newRelativePath = relativePath.replace(/^pages\//, '');
+      file.path = path.join(file.base, newRelativePath);
+    }
+
+    this.push(file);
+    cb();
+  });
+}
+
 // Watcher task
 function distributeWatcher(complete) {
   // Quit if in build mode
@@ -87,6 +104,7 @@ function distributeWatcher(complete) {
 module.exports = series(distribute, distributeWatcher);
 
 
+// Get git info
 async function getGitInfo() {
   return await execute('git remote -v')
   .then((r) => {
@@ -103,6 +121,7 @@ async function getGitInfo() {
   })
 }
 
+// Create build.json
 async function createBuildJSON() {
   // Create build log JSON
   try {
@@ -141,6 +160,32 @@ async function createBuildJSON() {
   }
 }
 
+// Copy default dist files
+async function copyDefaultDistFiles() {
+  // Get the directory
+  const dir = path.join(__dirname, '..', '..', 'defaults', 'dist');
+
+  // Log
+  logger.log(`Copying default dist files from ${dir}`);
+
+  // Copy the files
+  jetpack.copy(dir, 'dist', { overwrite: true });
+}
+
+// Create CNAME
+async function createCNAME() {
+  // Get the CNAME
+  const url = Manager.getConfig().url;
+  const host = new URL(url).host
+
+  // Write to file
+  jetpack.write('dist/CNAME', host);
+
+  // Log
+  logger.log('Created CNAME');
+}
+
+// Fetch firebase-auth files
 async function fetchFirebaseAuth() {
   const firebase = eval(`(${config.settings['manager-configuration']})`)?.libraries?.firebase_app?.config;
   const projectId = firebase.projectId || 'ultimate-jekyll';
@@ -206,3 +251,4 @@ async function fetchFirebaseAuth() {
   // Log
   logger.log('Fetched firebase-auth files');
 }
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultimate-jekyll-manager",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "description": "Ultimate Jekyll dependency manager",
   "main": "dist/index.js",
   "exports": {
@@ -23,8 +23,8 @@
   },
   "projectScripts": {
     "preinstall": "bundle install && bundle update",
+    "start": "npx uj setup && bundle exec npm run gulp",
     "gulp": "gulp --cwd ./ --gulpfile ./node_modules/ultimate-jekyll-manager/dist/gulp/main.js",
-    "start": "bundle exec npm run gulp",
     "build": "UJ_BUILD_MODE=true bundle exec npm run gulp -- build"
   },
   "engines": {
@@ -75,6 +75,7 @@
     "node-powertools": "^2.1.4",
     "npm-api": "^1.0.1",
     "sass": "^1.84.0",
+    "through2": "^4.0.2",
     "web-manager": "^3.2.73",
     "webpack": "^5.97.1",
     "wonderful-fetch": "^1.3.2",