@aurodesignsystem/auro-library 2.6.1 → 2.6.3

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Semantic Release Automated Changelog
 
+## [2.6.3](https://github.com/AlaskaAirlines/auro-library/compare/v2.6.2...v2.6.3) (2024-08-07)
+
+
+### Bug Fixes
+
+* **readme:** update generateDocs script for dynamic readme support [#57](https://github.com/AlaskaAirlines/auro-library/issues/57) ([f3c3092](https://github.com/AlaskaAirlines/auro-library/commit/f3c3092f4c9cc61dcc9f4b55cb5f63be4127c6de))
+
+## [2.6.2](https://github.com/AlaskaAirlines/auro-library/compare/v2.6.1...v2.6.2) (2024-08-07)
+
+
+### Bug Fixes
+
+* update various build scripts ([9b726b3](https://github.com/AlaskaAirlines/auro-library/commit/9b726b3ad2fd616987a4488cc440f0f7498c0028))
+
 ## [2.6.1](https://github.com/AlaskaAirlines/auro-library/compare/v2.6.0...v2.6.1) (2024-08-06)
 
 

package/package.json

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

package/scripts/build/generateDocs.mjs

@@ -4,12 +4,29 @@ import fs from 'fs';
 import https from 'https';
 import { fileURLToPath } from 'url';
 
+import AuroLibraryUtils from "../utils/auroLibraryUtils.mjs";
+
+const auroLibraryUtils = new AuroLibraryUtils();
+
 const __dirname = fileURLToPath(new URL('.', import.meta.url));
 
-const readmeTemplateUrl = 'https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/README_esm.md';
 const dirDocTemplates = './docTemplates';
 const readmeFilePath = dirDocTemplates + '/README.md';
 
+// List of components that do not support ESM to determine which README to use
+const nonEsmComponents = ['combobox', 'datepicker', 'menu', 'pane', 'select'];
+
+function generateReadmeUrl() {
+  let nameExtractionData = nameExtraction();
+  let esmString = '';
+
+  if (!nonEsmComponents.includes(nameExtractionData.name)) {
+    esmString = '_esm';
+  }
+
+  return 'https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/README' + esmString + '.md';
+}
+
 /**
  * Extract NPM, NAMESPACE and NAME from package.json
  */
@@ -21,12 +38,12 @@ function nameExtraction() {
     }
   })
 
-  packageJson = JSON.parse(packageJson); 
-
+  packageJson = JSON.parse(packageJson);
+  
   let pName = packageJson.name;
   let pVersion = packageJson.version;
-  let pdtVersion = packageJson.peerDependencies['\@aurodesignsystem/design-tokens'].substring(1)
-  let wcssVersion = packageJson.peerDependencies['\@aurodesignsystem/webcorestylesheets'].substring(1)
+  let pdtVersion = packageJson.peerDependencies['\@aurodesignsystem/design-tokens'].substring(1);
+  let wcssVersion = packageJson.peerDependencies['\@aurodesignsystem/webcorestylesheets'].substring(1);
 
   let npmStart = pName.indexOf('@');
   let namespaceStart = pName.indexOf('/');
@@ -42,7 +59,7 @@ function nameExtraction() {
     'tokensVersion': pdtVersion,
     'wcssVersion': wcssVersion
   };
- }
+}
 
 /**
  * Replace all instances of [npm], [name], [Name], [namespace] and [Namespace] accordingly
@@ -50,23 +67,19 @@ function nameExtraction() {
 
 function formatTemplateFileContents(content, destination) {
   let nameExtractionData = nameExtraction();
+  let result = content;
 
   /**
    * Replace placeholder strings
    */
-  const placeholders = {
-    '[npm]': 'npm',
-    '[name](?!\\()': 'name',
-    '[Name](?!\\()': 'nameCap',
-    '[namespace]': 'namespace',
-    '[Namespace]': 'namespaceCap',
-    '[Version]': 'version',
-    '[dtVersion]': 'tokensVersion',
-    '[wcssVersion]': 'wcssVersion'
-  };
-
-  let result = Object.entries(placeholders).reduce((acc, [key, value]) => 
-    acc.replace(new RegExp(key, 'g'), nameExtractionData[value]), content);
+  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);
+  result = result.replace(/\[Version]/g, nameExtractionData.version);
+  result = result.replace(/\[dtVersion]/g, nameExtractionData.tokensVersion);
+  result = result.replace(/\[wcssVersion]/g, nameExtractionData.wcssVersion);
 
   /**
    * Cleanup line breaks
@@ -122,7 +135,7 @@ function processReadme() {
     outputDir: './'
   };
 
-  const markdownPath = path.join(__dirname, '../docTemplates/README.md');
+  const markdownPath = path.join(__dirname, './../../../../../docTemplates/README.md');
 
   markdownMagic(markdownPath, config, callback);
 }
@@ -135,7 +148,8 @@ function processDemo() {
   const callback = function(updatedContent, outputConfig) {
     if (fs.existsSync('./demo/index.md')) {
       fs.readFile('./demo/index.md', 'utf8', function(err, data) {
-        formatTemplateFileContents(data, './demo/index.md');
+        // formatTemplateFileContents(data, './demo/index.md');
+        auroLibraryUtils.formatFileContents(data, './demo/index.md');
       });
     } else {
       console.log('ERROR: ./demo/index.md file is missing');
@@ -147,7 +161,7 @@ function processDemo() {
     outputDir: './demo'
   };
 
-  const markdownPath = path.join(__dirname, '../docs/partials/index.md');
+  const markdownPath = path.join(__dirname, './../../../../../docs/partials/index.md');
 
   markdownMagic(markdownPath, configDemo, callback);
 }
@@ -172,7 +186,7 @@ function processApiExamples() {
     outputDir: './demo'
   };
 
-  const markdownPath = path.join(__dirname, '../docs/partials/api.md');
+  const markdownPath = path.join(__dirname, './../../../../../docs/partials/api.md');
 
   markdownMagic(markdownPath, config, callback);
 }
@@ -182,7 +196,6 @@ function processApiExamples() {
  * */
 
 function copyReadmeLocally() {
-
   if (!fs.existsSync(dirDocTemplates)){
     fs.mkdirSync(dirDocTemplates);
   }
@@ -195,7 +208,7 @@ function copyReadmeLocally() {
     });
   }
 
-  https.get(readmeTemplateUrl, function(response) {
+  https.get(generateReadmeUrl(), function(response) {
     let writeTemplate = response.pipe(fs.createWriteStream(readmeFilePath));
 
     writeTemplate.on('finish', () => {
@@ -213,3 +226,4 @@ function copyReadmeLocally() {
 copyReadmeLocally();
 processApiExamples();
 processDemo();
+

package/scripts/utils/auroLibraryUtils.mjs

@@ -128,7 +128,6 @@ export default class AuroLibraryUtils {
     packageJson = JSON.parse(packageJson);
 
     const pName = packageJson.name;
-
     const npmStart = pName.indexOf('@');
     const namespaceStart = pName.indexOf('/');
     const nameStart = pName.indexOf('-');
@@ -141,7 +140,10 @@ export default class AuroLibraryUtils {
       '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),
-      'version': packageJson.version
+      'version': packageJson.version,
+      'tokensVersion': packageJson.peerDependencies['\@aurodesignsystem/design-tokens'].substring(1),
+      'wcssVersion': packageJson.peerDependencies['\@aurodesignsystem/webcorestylesheets'].substring(1)
+
     };
   }