@aurodesignsystem/auro-library 3.0.0 → 3.0.2

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Semantic Release Automated Changelog
 
+## [3.0.2](https://github.com/AlaskaAirlines/auro-library/compare/v3.0.1...v3.0.2) (2024-11-13)
+
+
+### Bug Fixes
+
+* automatically create `docTemplate` when generating docs [#94](https://github.com/AlaskaAirlines/auro-library/issues/94) ([e6195d9](https://github.com/AlaskaAirlines/auro-library/commit/e6195d958233cd5b0902cb5afbf769dff246e852))
+
+
+### Performance Improvements
+
+* omit dir exist checking (sourcery reccomendation) ([68de618](https://github.com/AlaskaAirlines/auro-library/commit/68de61844960bf6d32df2ed66ca714857da1d623))
+
+## [3.0.1](https://github.com/AlaskaAirlines/auro-library/compare/v3.0.0...v3.0.1) (2024-11-07)
+
+
+### Bug Fixes
+
+* make api table formatter a preProcessor ([98d3de1](https://github.com/AlaskaAirlines/auro-library/commit/98d3de1e290ea2e3f03da9ef0d167c3291bc195b))
+* properly consume remoteReadmeVariant ([7b5f108](https://github.com/AlaskaAirlines/auro-library/commit/7b5f1082710288d86f8bf182c0ceb71ac3ad7420))
+* sourcery feedback ([de11fe8](https://github.com/AlaskaAirlines/auro-library/commit/de11fe8d70946b6096970026406f63bd9fdc10ba))
+* use fileURLToPath instead of manual formatting ([3d4e834](https://github.com/AlaskaAirlines/auro-library/commit/3d4e8348bf249620eb88a6e1094a8f920c34369a))
+* use import.meta.url instead of __dirname ([9185197](https://github.com/AlaskaAirlines/auro-library/commit/9185197d8b0179dfe645497c640b025d8f39c6b3))
+
 # [3.0.0](https://github.com/AlaskaAirlines/auro-library/compare/v2.11.0...v3.0.0) (2024-11-05)
 
 

package/package.json

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

package/scripts/build/prepWcaCompatibleCode.mjs

@@ -1,7 +1,7 @@
 export default (code, sourcePath) => {
   const defaultTag = (code.match(/static register\(name \= (.+)\)/) || code.match(/customElements.get\((.+?)\)/))[1];
   const className = code.match(/export class (.+) extends/)?.[1];
-  const classDesc = code.match(/\/\*\*((.|\n)*?)\*\//)?.[1] || '';
+  const classDesc = code.match(/\/\*\*((.|\n)*?)(\*\n|\*\/)/)?.[1] || '';
 
   if (!defaultTag || !className) {
     return code;

package/scripts/build/processors/defaultDocsProcessor.mjs

@@ -25,14 +25,14 @@ export const defaultDocsProcessorConfig = {
   // eslint-disable-next-line no-warning-comments
   // TODO: remove this variant when all components are updated to use latest auro-library
   // AND the default README.md is updated to use the new paths
-  readmeVariant: "_updated_paths"
+  remoteReadmeVariant: "_updated_paths"
 };
 
 /**
  * @param {ProcessorConfig} config - The configuration for this processor.
  * @returns {import('../utils/sharedFileProcessorUtils').FileProcessorConfig[]}
  */
-export const fileConfigs = (config = defaultDocsProcessorConfig) => [
+export const fileConfigs = (config) => [
   // README.md
   {
     identifier: 'README.md',
@@ -59,7 +59,7 @@ export const fileConfigs = (config = defaultDocsProcessorConfig) => [
     identifier: 'api.md',
     input: fromAuroComponentRoot("/docs/partials/api.md"),
     output: fromAuroComponentRoot("/demo/api.md"),
-    postProcessors: [templateFiller.formatApiTable],
+    preProcessors: [templateFiller.formatApiTable],
   }
 ];
 

package/scripts/utils/auroFileHandler.mjs

@@ -1,4 +1,5 @@
 import fs from 'node:fs/promises';
+import path from 'node:path';
 
 import {Logger} from "../utils/logger.mjs";
 
@@ -40,7 +41,9 @@ export class AuroFileHandler {
    * @returns {Promise<boolean>}
    */
   static async tryWriteFile(filePath, fileContents) {
-    try {
+    try { 
+      const dirname = path.dirname(filePath);
+      await fs.mkdir(dirname, {recursive: true});
       await fs.writeFile(filePath, fileContents, {encoding: 'utf-8'});
       return true;
     } catch (err) {

package/scripts/utils/auroLibraryUtils.mjs

@@ -8,17 +8,13 @@
 import * as fs from 'fs';
 import * as path from 'path';
 import chalk from 'chalk';
+import { fileURLToPath } from 'url';
+
 import {Logger} from "./logger.mjs";
 
 export default class AuroLibraryUtils {
   getDirname() {
-    if (typeof __dirname === 'undefined') {
-      Logger.warn('Unable to determine project root as __dirname is not defined. Assuming current directory is okay!', true);
-      return '';
-    }
-
-    // eslint-disable-next-line no-undef
-    return __dirname;
+    return fileURLToPath(import.meta.url);
   }
 
   get getProjectRootPath() {

package/scripts/utils/sharedFileProcessorUtils.mjs

@@ -1,7 +1,6 @@
-import path from 'path';
 import * as mdMagic from 'markdown-magic';
 import fs from 'node:fs/promises';
-import { fileURLToPath } from 'url';
+import path from "node:path";
 
 import AuroLibraryUtils from "./auroLibraryUtils.mjs";
 import { AuroTemplateFiller } from "./auroTemplateFiller.mjs";
@@ -75,8 +74,12 @@ export const nonEsmComponents = ['combobox', 'datepicker', 'menu', 'pane', 'sele
  */
 // TODO: test this in auro-flight before merging to main
 export function fromAuroComponentRoot(pathLike) {
-  const currentDir = fileURLToPath(new URL('.', import.meta.url))
-  return path.join(currentDir, `${auroLibraryUtils.getProjectRootPath}${pathLike}`)
+  if (pathLike.startsWith('/')) {
+    // remove the first slash
+    return path.join(auroLibraryUtils.getProjectRootPath, pathLike.slice(1))
+  }
+
+  return path.join(auroLibraryUtils.getProjectRootPath, pathLike)
 }
 
 
@@ -149,6 +152,7 @@ export function generateReadmeUrl(branchOrTag = 'master', variantOverride = '')
  * @property {string | InputFileType} input - path to an input file, including filename
  * @property {string} output - path to an output file, including filename
  * @property {Partial<MarkdownMagicOptions>} [mdMagicConfig] - extra configuration options for md magic
+ * @property {Array<(contents: string) => string>} [preProcessors] - extra processor functions to run on content AFTER markdownmagic and BEFORE templateFiller
  * @property {Array<(contents: string) => string>} [postProcessors] - extra processor functions to run on content
  */
 
@@ -241,17 +245,24 @@ export async function processContentForFile(config) {
   // 3a. Read the output file contents
   let fileContents = await fs.readFile(output, {encoding: 'utf-8'});
 
-  // 3b. Replace template variables in output file
+  // 3b. Run any pre-processors
+  if (config.preProcessors) {
+    for (const processor of config.preProcessors) {
+      fileContents = processor(fileContents)
+    }
+  }
+
+  // 3c. Replace template variables in output file
   fileContents = templateFiller.replaceTemplateValues(fileContents);
 
-  // 3c. Run any post-processors
+  // 3d. Run any post-processors
   if (config.postProcessors) {
     for (const processor of config.postProcessors) {
       fileContents = processor(fileContents)
     }
   }
 
-  // 3d. Write the final file contents
+  // 3e. Write the final file contents
   if (!await AuroFileHandler.tryWriteFile(output, fileContents)) {
     throw new Error(`Error writing "${bareFileName}" file to output ${output}`);
   }