@aurodesignsystem/auro-library 2.2.3 → 2.2.5

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Semantic Release Automated Changelog
 
+## [2.2.5](https://github.com/AlaskaAirlines/auro-library/compare/v2.2.4...v2.2.5) (2024-01-11)
+
+
+### Bug Fixes
+
+* update package location ref ([e8cdbf8](https://github.com/AlaskaAirlines/auro-library/commit/e8cdbf8114dcc1e8a9a2af0e37fdca7a5616f6be))
+
+## [2.2.4](https://github.com/AlaskaAirlines/auro-library/compare/v2.2.3...v2.2.4) (2024-01-11)
+
+
+### Performance Improvements
+
+* add script to bin dir ([80476b5](https://github.com/AlaskaAirlines/auro-library/commit/80476b5d434446c34bf9a5c22749d4541fb5d8b9))
+
 ## [2.2.3](https://github.com/AlaskaAirlines/auro-library/compare/v2.2.2...v2.2.3) (2024-01-10)
 
 

package/bin/generateDocs.mjs

@@ -1,20 +1,81 @@
-import markdownMagic from 'markdown-magic';
-import * as fs from 'fs';
-import * as https from 'https';
+/**
+ * This version is sans dependencies
+ * Create for use with the SSR updates
+ */
 
-import AuroLibraryUtils from "../scripts/utils/auroLibraryUtils.mjs";
+import path from 'path';
+import markdownMagic from 'markdown-magic';
+import fs from 'fs';
+import https from 'https';
 
-const auroLibraryUtils = new AuroLibraryUtils();
+const __dirname = new URL('.', import.meta.url).pathname;
 
 const readmeTemplateUrl = 'https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/README.md';
 const dirDocTemplates = './docTemplates';
 const readmeFilePath = dirDocTemplates + '/README.md';
 
 /**
-   * Replace all instances of [npm], [name], [Name], [namespace] and [Namespace] accordingly
+ * Extract NPM, NAMESPACE and NAME from package.json
+ */
+
+function nameExtraction() {
+ const packageJson = fs.readFileSync('package.json', 'utf8', function(err, data) {
+   if (err) {
+     console.log('ERROR: Unable to read package.json file', err);
+   }
+ })
+
+ let pName = JSON.parse(packageJson).name;
+
+ let npmStart = pName.indexOf('@');
+ let namespaceStart = pName.indexOf('/');
+ let nameStart = pName.indexOf('-');
+
+ let result = {
+   'npm': pName.substring(npmStart, namespaceStart),
+   'namespace': pName.substring(namespaceStart + 1, nameStart),
+   'namespaceCap': pName.substring(namespaceStart + 1)[0].toUpperCase() + pName.substring(namespaceStart + 2, nameStart),
+   'name': pName.substring(nameStart + 1),
+   'nameCap': pName.substring(nameStart + 1)[0].toUpperCase() + pName.substring(nameStart + 2)
+ };
+
+ return result;
+}
+
+/**
+ * Replace all instances of [npm], [name], [Name], [namespace] and [Namespace] accordingly
+ */
+
+function formatTemplateFileContents(content, destination) {
+  let nameExtractionData = nameExtraction();
+  let result = content;
+
+  /**
+   * Replace placeholder strings
    */
+  result = result.replace(/\[npm]/g, nameExtractionData.npm);
+  result = result.replace(/\[name]/g, nameExtractionData.name);
+  result = result.replace(/\[Name]/g, nameExtractionData.nameCap);
+  result = result.replace(/\[namespace]/g, nameExtractionData.namespace);
+  result = result.replace(/\[Namespace]/g, nameExtractionData.namespaceCap);
+
+  /**
+   * Cleanup line breaks
+   */
+  result = result.replace(/(\r\n|\r|\n)[\s]+(\r\n|\r|\n)/g, '\r\n\r\n'); // Replace lines containing only whitespace with a carriage return.
+  result = result.replace(/>(\r\n|\r|\n){2,}/g, '>\r\n'); // Remove empty lines directly after a closing html tag.
+  result = result.replace(/>(\r\n|\r|\n)```/g, '>\r\n\r\n```'); // Ensure an empty line before code samples.
+  result = result.replace(/>(\r\n|\r|\n){2,}```(\r\n|\r|\n)/g, '>\r\n```\r\n'); // Ensure no empty lines before close of code sample.
+  result = result.replace(/([^(\r\n|\r|\n)])(\r\n|\r|\n)+#/g, "$1\r\n\r\n#"); // Ensure empty line before header sections.
+
+  /**
+   * Write the result to the destination file
+   */
+  fs.writeFileSync(destination, result, { encoding: 'utf8'});
+}
+
 function formatApiTableContents(content, destination) {
-  const nameExtractionData = auroLibraryUtils.nameExtraction();
+  const nameExtractionData = nameExtraction();
   const wcName = nameExtractionData.namespace + '-' + nameExtractionData.name;
 
   let result = content;
@@ -27,7 +88,7 @@ function formatApiTableContents(content, destination) {
   fs.writeFileSync(destination, result, { encoding: 'utf8'});
 
   fs.readFile('./demo/api.md', 'utf8', function(err, data) {
-    auroLibraryUtils.formatFileContents(data, './demo/api.md');
+    formatTemplateFileContents(data, './demo/api.md');
   });
 }
 
@@ -36,11 +97,11 @@ function formatApiTableContents(content, destination) {
  */
 
 function processReadme() {
-  const callback = function() {
+  const callback = function(updatedContent, outputConfig) {
 
     if (fs.existsSync('./README.md')) {
       fs.readFile('./README.md', 'utf8', function(err, data) {
-        auroLibraryUtils.formatFileContents(data, './README.md');
+        formatTemplateFileContents(data, './README.md');
       });
     } else {
       console.log('ERROR: ./README.md file is missing');
@@ -52,7 +113,7 @@ function processReadme() {
     outputDir: './'
   };
 
-  const markdownPath = './docTemplates/README.md';
+  const markdownPath = path.join(__dirname, '../docTemplates/README.md');
 
   markdownMagic(markdownPath, config, callback);
 }
@@ -62,10 +123,10 @@ function processReadme() {
  */
 
 function processDemo() {
-  const callback = function() {
+  const callback = function(updatedContent, outputConfig) {
     if (fs.existsSync('./demo/demo.md')) {
       fs.readFile('./demo/demo.md', 'utf8', function(err, data) {
-        auroLibraryUtils.formatFileContents(data, './demo/demo.md');
+        formatTemplateFileContents(data, './demo/demo.md');
       });
     } else {
       console.log('ERROR: ./demo/demo.md file is missing');
@@ -77,17 +138,17 @@ function processDemo() {
     outputDir: './demo'
   };
 
-  const markdownPath = './docs/partials/demo.md';
+  const markdownPath = path.join(__dirname, '../docs/partials/demo.md');
 
   markdownMagic(markdownPath, configDemo, callback);
 }
 
 /**
- * Compiles `./docTemplates/api.md` -> `./demo/api.md`
+ * Compiles `./docTemplates/apiExamples.md` -> `./demo/apiExamples.md`
  */
 
 function processApiExamples() {
-  const callback = function() {
+  const callback = function(updatedContent, outputConfig) {
     if (fs.existsSync('./demo/api.md')) {
       fs.readFile('./demo/api.md', 'utf8', function(err, data) {
         formatApiTableContents(data, './demo/api.md');
@@ -102,7 +163,7 @@ function processApiExamples() {
     outputDir: './demo'
   };
 
-  const markdownPath = './docs/partials/api.md';
+  const markdownPath = path.join(__dirname, '../docs/partials/api.md');
 
   markdownMagic(markdownPath, config, callback);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aurodesignsystem/auro-library",
-  "version": "2.2.3",
+  "version": "2.2.5",
   "description": "This repository holds shared scripts, utilities, and workflows utilized across repositories along the Auro Design System.",
   "repository": {
     "type": "git",

package/scripts/build/postinstall.mjs

@@ -3,7 +3,7 @@
 import chalk from 'chalk';
 import { createRequire } from 'node:module';
 const require = createRequire(import.meta.url);
-const pjson = require('../../package.json');
+const pjson = require('../package.json');
 
 console.log(chalk.hex('#f26135')(`