ultimate-jekyll-manager 0.0.1 → 0.0.3

package/.nvmrc

@@ -0,0 +1 @@
+v20/*

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Jr. AI
+Copyright (c) 2024 Ultimate Jekyll
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,2 +1,5 @@
 # ultimate-jekyll-manager
 All-in-one package for ultimate-jekyll
+
+# Commands
+* `npx uj setup && npm start` - Setup and start the project

package/dist/commands/clean.js

@@ -0,0 +1,22 @@
+// Libraries
+const path = require('path');
+const jetpack = require('fs-jetpack');
+
+// Load package
+const package = jetpack.read(path.join(__dirname, '../../', 'package.json'), 'json');
+const project = jetpack.read(path.join(process.cwd(), 'package.json'), 'json');
+
+module.exports = async function (options) {
+  // Log
+  console.log(`Cleaning up _site, .jekyll-cache, and .jekyll-metadata...`);
+
+  try {
+    // Delete _site, .jekyll-cache
+    jetpack.remove('_site');
+    jetpack.remove('site/.jekyll-cache');
+    jetpack.remove('site/.jekyll-metadata');
+
+  } catch (e) {
+    console.error(`Error during setup:`, e);
+  }
+};

package/dist/commands/i.js

@@ -0,0 +1,51 @@
+// Libraries
+const path = require('path');
+const jetpack = require('fs-jetpack');
+const { execute } = require('node-powertools');
+
+// Load package
+const package = jetpack.read(path.join(__dirname, '../../', 'package.json'), 'json');
+const project = jetpack.read(path.join(process.cwd(), 'package.json'), 'json');
+
+module.exports = async function (options) {
+  // Log
+  console.log(`Installing Ultimate Jekyll Manager...`);
+
+  // Get type
+  const type = options._[1] || 'prod';
+
+  try {
+    // Install production
+    if (['prod', 'p', 'production'].includes(type)) {
+      // Log
+      console.log('Installing production...');
+
+      // Install
+      await install('npm uninstall ultimate-jekyll-manager');
+      await install('npm install ultimate-jekyll-manager@latest --save-dev');
+
+      // Return
+      return console.log('Production installation complete.');
+    }
+
+    // Install development
+    if (['dev', 'd', 'development', 'local', 'l'].includes(type)) {
+      // Log
+      console.log('Installing development...');
+
+      // Install
+      await install('npm uninstall ultimate-jekyll-manager');
+      await install('npm install ../../ITW-Creative-Works/ultimate-jekyll-manager --save-dev');
+
+      // Return
+      return console.log('Development installation complete.');
+    }
+
+  } catch (e) {
+    console.error(`Error during install:`, e);
+  }
+};
+
+function install(command) {
+  return execute(command, { log: true });
+}

package/dist/commands/setup.js

@@ -1,35 +1,63 @@
 // Libraries
 const path = require('path');
-const { gte, clean } = require('semver');
+const jetpack = require('fs-jetpack');
+const wonderfulVersion = require('wonderful-version');
 const { execute } = require('node-powertools');
 const NPM = require('npm-api');
+const glob = require('glob').globSync;
 
 // Load package
-const package = require('../../package.json');
-const project = require(path.join(process.cwd(), 'package.json'));
+const package = jetpack.read(path.join(__dirname, '../../', 'package.json'), 'json');
+const project = jetpack.read(path.join(process.cwd(), 'package.json'), 'json');
+
+// Dependency MAP
+const DEPENDENCY_MAP = {
+  'gulp': 'dev',
+}
+
+// File MAP
+const FILE_MAP = {
+  'hooks/postbuild.js': {overwrite: false},
+  'hooks/prebuild.js': {overwrite: false},
+}
 
 module.exports = async function (options) {
+  // Log
   console.log(`Welcome to Ultimate Jekyll v${package.version}!`);
 
-  // Log
-  console.log('package:', package);
-  console.log('project:', project);
+  // Prefix project
+  project.dependencies = project.dependencies || {};
+  project.devDependencies = project.devDependencies || {};
 
   try {
     // Ensure this package is up-to-date
     await updateManager();
 
+    // Ensure proper node version
+    await ensureNodeVersion();
+
     // Run the setup
     await ensurePeerDependencies();
 
+    // Setup scripts
+    setupScripts();
+
+    // Build files
+    await buildSiteFiles();
+
+    // Check which locality we are using
+    checkLocality();
+
   } catch (e) {
-    console.error(`Error during the prompt: ${e.message}`);
+    console.error(`Error during setup:`, e);
   }
 };
 
 async function updateManager() {
   const npm = new NPM();
 
+  // Get the latest version
+  const installedVersion = project.devDependencies['ultimate-jekyll-manager'];
   const latestVersion = await npm.repo('ultimate-jekyll-manager')
   .package()
     .then((pkg) => {
@@ -38,40 +66,155 @@ async function updateManager() {
       return '0.0.0';
     });
 
-  // Compare the versions
-  console.log('latestVersion:', latestVersion);
+  // Quit if local
+  if (installedVersion.startsWith('file:')) {
+    return console.log('Local version detected. Skipping update check.');
+  }
 
+  // Log
+  console.log('Installed Version:', installedVersion);
+  console.log('Latest Version:', latestVersion);
+
+  // Check if we need to update
+  if (wonderfulVersion.is(installedVersion, '>=', latestVersion)) {
+    return console.log('Ultimate Jekyll Manager is up-to-date.');
+  } else {
+    await install('ultimate-jekyll-manager', latestVersion);
+  }
+}
+
+async function ensureNodeVersion() {
+  const installedVersion = process.version;
+  const requiredVersion = package.engines.node;
+
+  // Log
+  console.log('Installed Node Version:', installedVersion);
+  console.log('Required Node Version:', requiredVersion);
+
+  // Check if we need to update
+  if (wonderfulVersion.is(installedVersion, '>=', requiredVersion)) {
+    return console.log('Node version is up-to-date.');
+  } else {
+    console.error(`Node version is out-of-date. Required version is ${requiredVersion}.`);
+  }
 }
 
 async function ensurePeerDependencies() {
-  const requiredPeerDependencies = package.requiredPeerDependencies || {};
+  const requiredPeerDependencies = package.peerDependencies || {};
 
   // Loop through and make sure project has AT LEAST the required version
   for (const [dependency, version] of Object.entries(requiredPeerDependencies)) {
     const projectDependencyVersion = project.dependencies[dependency] || project.devDependencies[dependency];
+    const location = DEPENDENCY_MAP[dependency] === 'dev' ? '--save-dev' : '';
+
+    // Log
+    console.log('Checking peer dep:', dependency, '-->', projectDependencyVersion, '>=', version);
 
     // Install if not found
-    if (!projectDependencyVersion) {
-      await install(dependency, version);
-    } else {
-      // Clean the version and compare
-      const cleanProjectVersion = clean(projectDependencyVersion);
-      const cleanRequiredVersion = clean(version);
-
-      if (!gte(cleanProjectVersion, cleanRequiredVersion)) {
-        await install(dependency, version);
-      }
+    if (
+      // Not found
+      !projectDependencyVersion
+      // Not the right version
+      || wonderfulVersion.is(projectDependencyVersion, '<', version)
+    ) {
+      await install(dependency, version, location);
     }
   }
 }
 
-function install(package, version) {
+function setupScripts() {
+  // Setup the scripts
+  project.scripts = project.scripts || {};
+
+  // Setup the scripts
+  Object.keys(package.projectScripts).forEach((key) => {
+    project.scripts[key] = package.projectScripts[key];
+  });
+
+  // Save the project
+  jetpack.write(path.join(process.cwd(), 'package.json'), project);
+}
+
+function checkLocality() {
+  const installedVersion = project.devDependencies['ultimate-jekyll-manager'];
+
+  if (installedVersion.startsWith('file:')) {
+    console.warn('⚠️⚠️⚠️ You are using the local version of Ultimate Jekyll Manager. This WILL NOT WORK when published. ⚠️⚠️⚠️');
+  }
+}
+
+function install(package, version, location) {
   // Default to latest
   version || 'latest';
 
+  // Clean version if needed
+  version = version === 'latest' ? version : wonderfulVersion.clean(version);
+
   // Build the command
-  let command = `npm install ${package}@${version}`;
+  let command = `npm install ${package}@${version} ${location || '--save'}`;
+
+  // Log
+  console.log('Installing:', command);
 
   // Execute
   return execute(command, { log: true })
+  .then(async () => {
+    // Read new project
+    const projectUpdated = jetpack.read(path.join(process.cwd(), 'package.json'), 'json');
+
+    // Log
+    console.log('Installed:', package, version);
+
+    // Update package object
+    project.dependencies = projectUpdated.dependencies;
+    project.devDependencies = projectUpdated.devDependencies;
+  });
+}
+
+function buildSiteFiles() {
+  // Loop through all files in /templates directory
+  const dir = path.join(__dirname, '..', 'templates');
+  const files = glob('**/*', {
+    cwd: dir,
+    dot: true,
+    nodir: true,
+  });
+
+  // Loop
+  for (const file of files) {
+    // Get the destination
+    const source = path.join(dir, file);
+    const destination = path.join(process.cwd(), file.replace('templates/', ''));
+    const filename = path.basename(destination);
+    const options = FILE_MAP[file] || {overwrite: true};
+
+    // Quit if file is '_'
+    if (filename === '_') {
+      continue;
+    }
+
+    // Check if the file exists
+    const exists = jetpack.exists(destination);
+
+    // Log
+    // console.log('File:', file);
+    // console.log('filename:', filename);
+    // console.log('options:', options);
+    // console.log('contents:', jetpack.read(source));
+    // console.log('source:', source);
+    // console.log('Destination:', destination);
+
+    // Skip if it exists
+    // console.log('---1');
+
+    if (exists && !options.overwrite) {
+    // console.log('---2');
+      continue;
+    }
+    // console.log('---3', jetpack.read(source));
+
+    // Copy the file
+    // console.log('Copying:', file, 'to', destination);
+    jetpack.copy(source, destination, { overwrite: true });
+  }
 }

package/dist/commands/version.js

@@ -1,5 +1,12 @@
-const package = require('../../package.json');
+// Libraries
+const path = require('path');
+const jetpack = require('fs-jetpack');
+
+// Load package
+const package = jetpack.read(path.join(__dirname, '../../', 'package.json'), 'json');
+const project = jetpack.read(path.join(process.cwd(), 'package.json'), 'json');
 
 module.exports = async function (options) {
+  // Log
   console.log(package.version);
 };

package/dist/config/_config_main.yml

@@ -0,0 +1,305 @@
+# Welcome to Ultimate Jekyll!
+#
+# This config file is meant for settings that affect your whole blog, values
+# which you are expected to set up once and rarely edit after that. If you find
+# yourself editing this file very often, consider using Jekyll's data files
+# feature for the data you need to update frequently.
+#
+# For technical reasons, this file is *NOT* reloaded automatically when you use
+# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
+
+# Site settings
+# These are used to personalize your new site. If you look in the HTML files,
+# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
+# You can create any custom variable you would like, and they will be accessible
+# in the templates via {{ site.myvariable }}.
+
+# Site configurations
+url: "" # the base hostname & protocol for your site, e.g. http://example.com
+baseurl: "" # the subpath of your site, e.g. /blog
+test1: 1
+
+# Custom Configuration
+version: '1.0.0'
+app: ''
+meta:
+  title: "Title"
+  description: "Description"
+  og-images: "https://cdn.itwcreativeworks.com/assets/itw-creative-works/images/socials/itw-creative-works-brandmark-square-black-1024x1024.png"
+  keywords: "" # false or blank to disable, comma separated kws
+  viewport: "" # string, leave blank to use default
+  index: true # true | false
+  referrer: "" # string, leave blank to use default
+
+launcher:
+  download: "" # string, example: https://example.com/download
+
+cloudflare:
+  zone: ''
+
+socials:
+  facebook: "" # string, example: somiibo
+  twitter: "" # string, example: somiibo
+  linkedin: "" # string, example: somiibo
+  youtube: "" # string, example: somiibo
+  instagram: "" # string, example: somiibo
+  tumblr: "" # string, example: somiibo
+  slack: "" # string, example: somiibo
+  discord: "" # string, example: gxAuKX6
+  github: "" # string, example: somiibo
+  dev: "" # string, example: somiibo
+  tiktok: "" # string, example: somiibo
+  twitch: "" # string, example: somiibo
+  soundcloud: "" # string, example: somiibo
+  spotify: "" # string, example: somiibo
+  mixcloud: "" # string, example: somiibo
+
+download:
+  mac: '' # string, example: https://github.com/somiibo/download-server/releases/download/installer/Somiibo.dmg
+  windows: '' # string, example: https://github.com/somiibo/download-server/releases/download/installer/Somiibo-Setup.exe
+  linux-debian: '' # string, example: https://github.com/somiibo/download-server/releases/download/installer/Somiibo_amd64.deb
+  linux-snap: '' # string, example: https://snapcraft.io/somiibo
+  ios: '' # string, example: https://apps.apple.com/us/app/somiibo/id999999999
+  android: '' # string, example: https://play.google.com/store/apps/details?id=com.itwcreativeworks.somiibo
+
+extension:
+  chrome: '' # string, example: https://chrome.google.com/webstore/detail/somiibo/opidlipnbfhpdenbnanplcalbdgoplnc
+  firefox: '' # string, example: https://addons.mozilla.org/en-US/firefox/addon/somiibo
+  opera: '' # string, example: https://addons.opera.com/en/extensions/details/somiibo
+  safari: '' # string, example: https://apps.apple.com/us/app/somiibo/id999999999
+  edge: '' # string, example: https://microsoftedge.microsoft.com/addons/detail/somiibo/opidlipnbfhpdenbnanplcalbdgoplnc
+
+comments:
+  gisqus-repo: "Distalk/giscus" # string, example: somiibo/giscus
+  gisqus-repo-id: "R_kgDOJ-chGA" # string, example: R_kgDOJ-chGA
+  gisqus-category: "Giscus" # string, example: Giscus
+  gisqus-category-id: "DIC_kwDOJ-chGM4CYD4O" # string, example: DIC_kwDOJ-chGM4CYD4O
+
+tracking:
+  google-analytics: false # false to disable, example: UA-123456789
+  facebook-pixel: false # false to disable, example: fbp-123456789
+  tiktok-pixel: false # false to disable, example: D4829D83H38929384H48
+
+advertising:
+  google-adsense: "pub-7372939085773564" # false to disable, example: ca-pub-7372939085773564
+  google-adsense-display-slot: "9023354299" # example: 9023354299
+  google-adsense-in-article-slot: "7329067043" # example: 7329067043
+  google-adsense-in-feed-slot: "5986127415" # example: 5986127415
+  google-adsense-multiplex-slot: "8772072856" # example: 8772072856
+  cse-site-id: "5ad46a4c7412db0ae" # example: 5ad46a4c7412db0ae
+
+email-marketing: # Get this information from Mailchimp > Audience > Manage Audience > Signup forms > Embedded forms > Then look at code
+  mailchimp-user-id: "06dd652b8c707fdf51ebcff20" # string, example: 06dd652b8c707fdf51ebcff20
+  mailchimp-list-name: "" # string, example: somiibo
+  mailchimp-list-id: "" # string, example: b3456e5ffd
+
+contact:
+  email-support: "" # string, example: support@example.com
+  email-business: "" # string, example: hello@example.com
+  slapform-form-id: "" # string, example: abc123 (create one at https://slapform.com)
+  phone: "+1 (000) 000 - 0000" # string, example: +1 (000) 000 - 0000
+
+brand:
+  name: "" # example: Google
+  type: "Corporation" # example: Corporation
+  description: "." # example: A search engine company.
+  logo-images: "https://cdn.itwcreativeworks.com/assets/itw-creative-works/images/logo/itw-creative-works-brandmark-black-1024x1024.png" # URL | LOCAL path, example: https://defaultogimage.com, /assets/img/og/og.png
+  logo-image-svg: "https://cdn.itwcreativeworks.com/assets/itw-creative-works/images/logo/itw-creative-works-brandmark-black-x.svg" # URL | LOCAL path, example: https://defaultogimage.com, /assets/img/og/og.svg
+  address-locality: "Los Angeles" # String | example: Los Angeles
+  address-country: "United States" # String | example: United States
+
+manifest:
+  name: "" # example: Google Maps
+  short-name: "" # example: Maps
+  theme-color: "#ffffff" # example: #ffffff
+  background-color: "#ffffff" # example: #ffffff
+  display: "standalone" # example: standalone
+  start-url: "/?source=pwa" # example: /, /maps/?source=pwa
+  scope: "/" # example: /, /maps/
+  orientation: "portrait" # example: portrait,
+
+schema:
+  breadcrumbs: true # true | false
+  brand: true # true | false
+  sitelinks: true # true | false
+
+favicon:
+  path: "https://cdn.itwcreativeworks.com/assets/itw-creative-works/images/favicon" # example: /assets/images/favicon
+  safari-pinned-tab: "#5bbad5" # example: #5bbad5
+  msapp-tile-color: "#da532c" # example: #da532c"
+  theme-color: "#ffffff" # example: #ffffff
+
+search:
+  enable: true # true | false
+
+sitemap:
+  enable: true # true | false
+
+settings:
+  include-app-head: true # true | false
+  include-app-foot: true # true | false
+  include-script-bundle: true # true | false
+  include-script-bundle-optimization: "async" # defer | async | ""
+  include-script-core: false # true | false
+  include-script-core-optimization: "async" # defer | async | ""
+  include-script-slapform: false # true | false
+  include-script-slapform-optimization: "async" # defer | async | ""
+  include-css-bundle: true # true | false
+  include-css-normalize: false # true | false
+  include-css-reset: false # true | false
+  include-css-defaults: true # true | false
+  include-html5shiv: true # true | false
+  include-socialsharekit: true # true | false
+  include-debug-performance: false # true | false
+  blog-post-image-class: "" # class will be applied to all blog post images using the master include
+  blog-author-image-class: "" # class will be applied to all blog author images using the master include
+  manager-configuration: "
+    {
+      libraries: {
+        firebase_app: {
+          enabled: true,
+          config: {
+            apiKey: '',
+            authDomain: '',
+            databaseURL: '',
+            projectId: '',
+            storageBucket: '',
+            messagingSenderId: '',
+            appId: '',
+            measurementId: '',
+          },
+        },
+        firebase_appCheck: {
+          enabled: false,
+          config: {
+            siteKey: '',
+          },
+        },
+        cookieconsent: {
+          enabled: true,
+          config: {
+            palette: {
+              popup: {
+                background: '#fd5631',
+                text: '#fff',
+              },
+              button: {
+                background: '#fff',
+                text: '#fd5631',
+              },
+            },
+          },
+        },
+        chatsy: {
+          enabled: true,
+          config: {
+            accountId: '',
+            chatId: '',
+            settings: {
+              openChatButton: {
+                background: '#fd5631',
+                text: '#fff',
+              },
+            },
+          },
+        },
+        sentry: {
+          enabled: true,
+          config: {
+            dsn: '',
+            release: '',
+            replaysSessionSampleRate: 0.01,
+            replaysOnErrorSampleRate: 0.01,
+          },
+        },
+      },
+      exitPopup: {
+        enabled: true,
+        config: {
+          timeout: 1000 * 60 * 60 * 4,
+          handler: null,
+          title: 'Want 50% off your gift?',
+          messages: 'There are some gifts on sale today for as much as 50% off. Click the button below to claim your discount!',
+          okButton: {
+            text: 'Claim 50% Discount',
+            link: 'https://giftly.app',
+          },
+        },
+      },
+    }
+  " # javascript object to set the Configuration object for Web Manager
+
+# Custom admin dashboard pages
+admin-dashboard: "{
+  pages: [
+  ]
+}"
+
+# Escape shortcuts
+escapes:
+  underscore: "_"
+  asterisk: "*"
+  brace-left: "{"
+  brace-right: "}"
+  bracket-left: "["
+  bracket-right: "]"
+
+# Blog & Pagination
+permalink: /blog/:title
+pagination:
+  enabled: true
+  per_pages: 6
+  offset: 0
+  limit: 0
+  permalink: /page/:num.html
+  title: :title - page :num
+  sort_field: 'date'
+  sort_reverse: true
+
+# Jekyll Defaults
+collections:
+  team:
+    title: Team Members
+    output: true
+defaults:
+- scope:
+    path: ''
+    type: team
+  values:
+    permalink: /team/:title
+
+# Build settings
+markdown: kramdown
+plugins:
+  - jekyll-paginate-v2
+  - jekyll-liquify
+  - jekyll-uj-powertools
+  - jekyll-truthyfalsy
+
+# Exclude from processing.
+# The following items will not be processed, by default. Create a custom list
+# to override the default setting.
+exclude:
+  # DEFAULT
+  - Gemfile
+  - Gemfile.lock
+  - gulp_tasks
+  - gulpfile.js
+  - LICENSE
+  - node_modules
+  - npm-debug.log
+  - package.json
+  - package-lock.json
+  - README.md
+  - vendor/bundle/
+  - vendor/cache/
+  - vendor/gems/
+  - vendor/ruby/
+  - yarn.lock
+  # MASTER
+  - .placeholder
+  # APP
+
+include:
+  # MASTER
+  - .well-known