@aurodesignsystem/auro-library 1.0.2 → 2.0.0

package/CHANGELOG.md

@@ -1,5 +1,38 @@
 # Semantic Release Automated Changelog
 
+# [2.0.0](https://github.com/AlaskaAirlines/auro-library/compare/v1.1.0...v2.0.0) (2023-10-05)
+
+
+### Performance Improvements
+
+* **npmignore:** include scripts/config/ directory [#38](https://github.com/AlaskaAirlines/auro-library/issues/38) ([e4e1a75](https://github.com/AlaskaAirlines/auro-library/commit/e4e1a7526765cc828d6124c71853d8cb9e9d3f6f))
+* **scripts:** update directory file for config scripts [#38](https://github.com/AlaskaAirlines/auro-library/issues/38) ([8167f2f](https://github.com/AlaskaAirlines/auro-library/commit/8167f2f5521a22145419d9f7cd8f5e5c4ba5dd80))
+
+
+### BREAKING CHANGES
+
+* **scripts:** The automation scripts directory name has been changed from "setup" to "config".
+
+# [1.1.0](https://github.com/AlaskaAirlines/auro-library/compare/v1.0.2...v1.1.0) (2023-08-31)
+
+
+### Bug Fixes
+
+* **err:** update parameter handling ([04af13a](https://github.com/AlaskaAirlines/auro-library/commit/04af13a315ebb35795fe7b6c162373d7b9c5d3b3))
+
+
+### Features
+
+* **automation:** add automation scripts for workflows and linters [#32](https://github.com/AlaskaAirlines/auro-library/issues/32) ([5dff1b7](https://github.com/AlaskaAirlines/auro-library/commit/5dff1b7dcbe2d7862b4994399f40781037b48d69))
+* **surge:** add workflow that deploys surge demo [#35](https://github.com/AlaskaAirlines/auro-library/issues/35) ([7117212](https://github.com/AlaskaAirlines/auro-library/commit/71172129d0309e132821f1bcb5d8673baa746468))
+
+
+### Performance Improvements
+
+* **.npmignore:** update .npmignore ([2de9db7](https://github.com/AlaskaAirlines/auro-library/commit/2de9db717b6e069a8ffb6b6e067a83b08c41d8c6))
+* **docs:** add generateDocs script [#36](https://github.com/AlaskaAirlines/auro-library/issues/36) ([9746820](https://github.com/AlaskaAirlines/auro-library/commit/97468201ca83767b3cc1dd1396e0d78f311a69f5))
+* **extraction:** extract functions and insert into library utils [#36](https://github.com/AlaskaAirlines/auro-library/issues/36) ([c3018eb](https://github.com/AlaskaAirlines/auro-library/commit/c3018eb01acf4b3682b63b0b92c3beb5b3641161))
+
 ## [1.0.2](https://github.com/AlaskaAirlines/auro-library/compare/v1.0.1...v1.0.2) (2023-07-24)
 
 

package/README.md

@@ -1,3 +1,203 @@
-# Auro Library
+# Auro-Library
 
-This repository holds shared scripts, utilities, and workflows utilized acorss repositories along the Auro Design System. 
+<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/description.md) -->
+<!-- The below content is automatically added from ./../docs/partials/description.md -->
+This repository holds shared scripts, utilities, and workflows utilized acorss repositories along the Auro Design System.
+<!-- AURO-GENERATED-CONTENT:END -->
+
+## Scripts
+
+#### Publish Surge Demo
+
+<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/description.md) -->
+<!-- The below content is automatically added from ./../docs/partials/description.md -->
+This repository holds shared scripts, utilities, and workflows utilized acorss repositories along the Auro Design System.
+<!-- AURO-GENERATED-CONTENT:END -->
+
+#### Surge Demo Teardown
+
+<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/demoTeardown.md) -->
+<!-- The below content is automatically added from ./../docs/partials/demoTeardown.md -->
+
+## Dependency Tag Versioming
+
+This workflow works to automatically delete and clear any surge demos that have been active for more than 2+ months. Surge in theory allows us to have an infinite amount of active pages but by clearing unused and stale demos we can keep our Surge account more organized in the future.
+
+> Note: This workflow exectutes on a monthly cronjob on the first of each month.
+
+In order to clear all our surge projects we rely on [this GitHub Action](https://github.com/marketplace/actions/surge-sh-teardown) to handle the deletion logic.
+<!-- AURO-GENERATED-CONTENT:END -->
+
+#### Dependency Tag Versioning
+
+<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/dependencyTagVersioning.md) -->
+<!-- The below content is automatically added from ./../docs/partials/dependencyTagVersioning.md -->
+
+## Dependency Tag Versioming
+
+This is a two part utility for the purpose of generating a custom string for dependency component tag naming. This is important to prevent [version conflicts](https://www.thinktecture.com/en/web-components/web-components-flaws/#elementor-toc__heading-anchor-0) when multiple versions of a given Auro component may be loaded on a single page.
+
+_Note: The example configuration used below in all code samples assumes `auro-dropdown` is the dependency component. Substitute any Auro component in the example code as needed._
+
+### Part 1: The Build
+
+#### Configuration
+
+1. Create a new file `./scripts/version.js` with the following content:
+
+```js
+const versionWriter = require("./versionWriter"); // need to update this with the right path when used from node_modules
+
+versionWriter.writeDepVersionFile('@aurodesignsystem/auro-dropdown'); // duplicate this line for each Auro dependency.
+```
+
+2. Add the following script to the component `package.json` file:
+
+```json
+"build:version": "node scripts/version.js"
+```
+
+3. The `build:version` script in `package.json` should be added as the first step of the `build` script.
+
+```json
+"build": "npm-run-all build:version ... etc.",
+```
+
+#### Execution
+
+Once configuration is complete, execute `npm run build`. This must be done once before `npm run dev` when developing locally. When Auro dependencies are initially installed or updated to new versions then `npm run build:version` or a complete `npm run build` must be executed.
+
+Upon execution of `build:version`, for each Auro dependency defined in the `./scripts/version.js` file, a new JS file will be created that contains the installed version of the dependency.
+
+For example, following these steps:
+1. Run `npm i @aurodesignsystem/auro-dropdown@1.0.0`
+1. add the following to the `./scripts/version.js` script file:
+```js
+versionWriter.writeDepVersionFile('@aurodesignsystem/auro-dropdown');
+```
+1. Run `npm run build`
+
+Will result in:
+- A new file created: `./src/dropdownVersion.js`
+- File content will export the version of the component installed. In this case:
+`export default '1.0.0'`
+
+### Part 2: The Runtime
+
+#### Configuration
+
+In the main component JS file located in the `./src` directory add the following:
+
+```js
+import { AuroDependencyVersioning } from "../scripts/dependencyTagVersioning.mjs";
+import { AuroDropdown } from '@aurodesignsystem/auro-dropdown/src/auro-dropdown.js';
+import dropdownVersion from './dropdownVersion';
+```
+
+In the components constructor add the following:
+
+```js
+const versioning = new AuroDependencyVersioning();
+this.dropdownTag = versioning.generateTag('auro-dropdown', dropdownVersion, AuroDropdown);
+```
+
+In the component properties add the following:
+
+```js
+/**
+ * @private
+ */
+dropdownTag: { type: Object }
+```
+
+#### Usage
+
+The new dynamically named version of `auro-dropdown` may now be used in your component template as follows:
+
+```js
+render() {
+  return html`
+    <div>
+      <${this.dropdownTag}></${this.dropdownTag}>
+    </div>
+  `;
+}
+```
+
+When the component is rendered during runtime the DOM will now show up as follows:
+
+```html
+<div>
+  <auro-dropdown_1_0_0></auro-dropdown_1_0_0>
+</div>
+```
+
+_Note: the numbers attached in the tag name will match the version of the dependency that was installed._
+
+#### Accessing the dynamically named element with JS
+
+The dynamic component is accessible using a the following string in a JS query selector: `this.dropdownTag._$litStatic# Auro-Library
+
+<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/description.md) -->
+<!-- The below content is automatically added from ./../docs/partials/description.md -->
+This repository holds shared scripts, utilities, and workflows utilized acorss repositories along the Auro Design System.
+<!-- AURO-GENERATED-CONTENT:END -->
+
+## Scripts
+
+#### Publish Surge Demo
+
+<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/description.md) -->
+<!-- The below content is automatically added from ./../docs/partials/description.md -->
+This repository holds shared scripts, utilities, and workflows utilized acorss repositories along the Auro Design System.
+<!-- AURO-GENERATED-CONTENT:END -->
+
+#### Surge Demo Teardown
+
+<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/demoTeardown.md) -->
+<!-- The below content is automatically added from ./../docs/partials/demoTeardown.md -->
+
+## Dependency Tag Versioming
+
+This workflow works to automatically delete and clear any surge demos that have been active for more than 2+ months. Surge in theory allows us to have an infinite amount of active pages but by clearing unused and stale demos we can keep our Surge account more organized in the future.
+
+> Note: This workflow exectutes on a monthly cronjob on the first of each month.
+
+In order to clear all our surge projects we rely on [this GitHub Action](https://github.com/marketplace/actions/surge-sh-teardown) to handle the deletion logic.
+<!-- AURO-GENERATED-CONTENT:END -->
+
+#### Dependency Tag Versioning
+
+```js
+firstUpdated() {
+  this.dropdown = this.shadowRoot.querySelector(this.dropdownTag._$litStatic$);
+};
+```
+<!-- AURO-GENERATED-CONTENT:END -->
+
+#### Sync All Templates
+
+<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/syncAllTemplates.md) -->
+<!-- The below content is automatically added from ./../docs/partials/syncAllTemplates.md -->
+
+## How to Run the `syncAllTemplates.mjs` Script
+
+To run the `syncAllTemplates.mjs` script, you will need to add a new node script into the linked component and point that to the `syncAllTemplates.mjs` file. You can individually run the workflow configurations by pointing to the `syncAllTemplates.mjs` file and adding a `--github` parameter after the path. The same can be done for the linter configurations by adding a `--linters` parameter.
+
+### Example Calls
+
+```
+// Default
+"syncTemplates": "./node_modules/@aurodesignsystem/auro-library/scripts/config/syncAllTemplates.mjs"
+```
+
+```
+// Only sync github workflow templates
+"syncTemplates": "./node_modules/@aurodesignsystem/auro-library/scripts/config/syncAllTemplates.mjs --github"
+```
+
+```
+// Only sync linter configuration templates
+"syncTemplates": "./node_modules/@aurodesignsystem/auro-library/scripts/config/syncAllTemplates.mjs --linters"
+```
+<!-- AURO-GENERATED-CONTENT:END -->

package/componentTemplates/workflows/autoAssign.yml

@@ -0,0 +1,9 @@
+name: Issue assignment
+
+on:
+  issues:
+    types: [opened]
+
+jobs:
+  call-auro-assign-workflow:
+    uses: AlaskaAirlines/auro-library/.github/workflows/autoAssign.yml@main

package/componentTemplates/workflows/codeql.yml

@@ -0,0 +1,58 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ [branchName] ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ [branchName] ]
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    # - name: Autobuild
+      # uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

package/componentTemplates/workflows/demo.yml

@@ -0,0 +1,11 @@
+name: Deploy Demo
+
+on:
+  pull_request:
+    branches: [ [branchName] ]
+
+jobs:
+  call-publish-demo-workflow:
+    uses: AlaskaAirlines/auro-library/.github/workflows/publishDemo.yml@main
+    secrets:
+      AURO_SURGE_TOKEN: ${{secrets.AURO_SURGE_TOKEN}}

package/componentTemplates/workflows/testPublish.yml

@@ -0,0 +1,46 @@
+name: Test and publish
+
+# Controls when the action will run. Triggers the workflow on push or pull request
+# events but only for the main branch
+on:
+  push:
+    branches: [ [branchName] ]
+  pull_request:
+    branches: [ [branchName] ]
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [ [abstractNodeVersion] ]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm test
+
+  release:
+    # Only release on push to main
+    if: github.event_name == 'push' && github.ref == 'refs/heads/[branchName]'
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          persist-credentials: false
+      - uses: actions/setup-node@v3
+        with:
+          node-version: [abstractNodeVersion]
+      - run: npm ci
+      - run: npm run build:docs
+      - uses: cycjimmy/semantic-release-action@v3
+        env:
+          GITHUB_TOKEN: ${{ secrets.ACCESS_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@aurodesignsystem/auro-library",
-  "version": "1.0.2",
+  "version": "2.0.0",
   "description": "This repository holds shared scripts, utilities, and workflows utilized acorss repositories along the Auro Design System.",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/AlaskaAirlines/auro-library.git"
+    "url": "https://github.com/AlaskaAirlines/auro-library.git"
   },
   "main": "index.js",
   "license": "Apache-2.0",
@@ -13,15 +13,15 @@
   },
   "devDependencies": {
     "@aurodesignsystem/eslint-config": "^1.3.0",
-    "@commitlint/cli": "^17.6.6",
-    "@commitlint/config-conventional": "^17.6.6",
+    "@commitlint/cli": "^17.7.1",
+    "@commitlint/config-conventional": "^17.7.0",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "@semantic-release/npm": "^10.0.4",
-    "eslint": "^8.44.0",
-    "eslint-plugin-jsdoc": "^46.4.3",
+    "@semantic-release/npm": "^10.0.5",
+    "eslint": "^8.48.0",
+    "eslint-plugin-jsdoc": "^46.5.1",
     "husky": "^8.0.3",
-    "semantic-release": "^21.0.7"
+    "semantic-release": "^21.1.1"
   },
   "release": {
     "branches": [
@@ -57,9 +57,13 @@
   },
   "scripts": {
     "prepare": "husky install",
-    "lint": "eslint ./scripts/**/*.js"
+    "lint": "eslint ./scripts/**/*.js",
+    "build:docs": "node scripts/build/generateReadme.mjs"
   },
   "bugs": {
     "url": "https://github.com/AlaskaAirlines/auro-library/issues"
+  },
+  "dependencies": {
+    "markdown-magic": "^2.6.1"
   }
 }

package/scripts/build/generateDocs.mjs

@@ -0,0 +1,145 @@
+import markdownMagic from 'markdown-magic';
+import * as fs from 'fs';
+import * as https from 'https';
+
+import AuroLibraryUtils from "../utils/auroLibraryUtils.mjs";
+
+const auroLibraryUtils = new AuroLibraryUtils();
+
+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
+   */
+function formatApiTableContents(content, destination) {
+  const nameExtractionData = auroLibraryUtils.nameExtraction();
+  const wcName = nameExtractionData.namespace + '-' + nameExtractionData.name;
+
+  let result = content;
+
+  result = result
+    .replace(/\r\n|\r|\n####\s`([a-zA-Z]*)`/g, `\r\n#### <a name="$1"></a>\`$1\`<a href="#${wcName}" style="float: right; font-size: 1rem; font-weight: 100;">back to top</a>`)
+    .replace(/\r\n|\r|\n\|\s`([a-zA-Z]*)`/g, '\r\n| [$1](#$1)')
+    .replace(/\| \[\]\(#\)/g, "");
+
+  fs.writeFileSync(destination, result, { encoding: 'utf8'});
+
+  fs.readFile('./demo/api.md', 'utf8', function(err, data) {
+    auroLibraryUtils.formatFileContents(data, './demo/api.md');
+  });
+}
+
+/**
+ * Compiles `./docTemplates/README.md` -> `./README.md`
+ */
+
+function processReadme() {
+  const callback = function() {
+
+    if (fs.existsSync('./README.md')) {
+      fs.readFile('./README.md', 'utf8', function(err, data) {
+        auroLibraryUtils.formatFileContents(data, './README.md');
+      });
+    } else {
+      console.log('ERROR: ./README.md file is missing');
+    }
+  };
+
+  const config = {
+    matchWord: 'AURO-GENERATED-CONTENT',
+    outputDir: './'
+  };
+
+  const markdownPath = './docTemplates/README.md';
+
+  markdownMagic(markdownPath, config, callback);
+}
+
+/**
+ * Compiles `./docTemplates/demo.md` -> `./demo/demo.md`
+ */
+
+function processDemo() {
+  const callback = function() {
+    if (fs.existsSync('./demo/demo.md')) {
+      fs.readFile('./demo/demo.md', 'utf8', function(err, data) {
+        auroLibraryUtils.formatFileContents(data, './demo/demo.md');
+      });
+    } else {
+      console.log('ERROR: ./demo/demo.md file is missing');
+    }
+  };
+
+  const configDemo = {
+    matchWord: 'AURO-GENERATED-CONTENT',
+    outputDir: './demo'
+  };
+
+  const markdownPath = './docs/partials/demo.md';
+
+  markdownMagic(markdownPath, configDemo, callback);
+}
+
+/**
+ * Compiles `./docTemplates/api.md` -> `./demo/api.md`
+ */
+
+function processApiExamples() {
+  const callback = function() {
+    if (fs.existsSync('./demo/api.md')) {
+      fs.readFile('./demo/api.md', 'utf8', function(err, data) {
+        formatApiTableContents(data, './demo/api.md');
+      });
+    } else {
+      console.log('ERROR: ./demo/api.md file is missing');
+    }
+  };
+
+  const config = {
+    matchWord: 'AURO-GENERATED-CONTENT',
+    outputDir: './demo'
+  };
+
+  const markdownPath = './docs/partials/api.md';
+
+  markdownMagic(markdownPath, config, callback);
+}
+
+/**
+ * Copy README.md template from static source
+ * */
+
+function copyReadmeLocally() {
+
+  if (!fs.existsSync(dirDocTemplates)){
+    fs.mkdirSync(dirDocTemplates);
+  }
+
+  if (!fs.existsSync(readmeFilePath)) {
+    fs.writeFile(readmeFilePath, '', function(err) {
+      if(err) {
+        console.log('ERROR: Unable to create README.md file.', err);
+      }
+    });
+  }
+
+  https.get(readmeTemplateUrl, function(response) {
+    let writeTemplate = response.pipe(fs.createWriteStream(readmeFilePath));
+
+    writeTemplate.on('finish', () => {
+      processReadme();
+    });
+
+  }).on('error', (err) => {
+    console.log('ERROR: Unable to fetch README.md file from server.', err);
+  });
+}
+
+/**
+ * Run all the actual document generation
+ */
+copyReadmeLocally();
+processApiExamples();
+processDemo();

package/scripts/build/generateReadme.mjs

@@ -0,0 +1,60 @@
+import markdownMagic from 'markdown-magic';
+import * as fs from 'fs';
+
+const dirDocs = './docs';
+const readmeFilePath = dirDocs + '/README.md';
+
+import AuroLibraryUtils from "../utils/auroLibraryUtils.mjs";
+
+const auroLibraryUtils = new AuroLibraryUtils();
+
+/**
+ * Compiles `./docs/README.md` -> `./README.md`
+ */
+
+function processReadme() {
+  const callback = function() {
+
+    if (fs.existsSync('./README.md')) {
+      fs.readFile('./README.md', 'utf8', function(err, data) {
+        auroLibraryUtils.formatFileContents(data, './README.md');
+      });
+    } else {
+      console.log('ERROR: ./README.md file is missing');
+    }
+  };
+
+  const config = {
+    matchWord: 'AURO-GENERATED-CONTENT',
+    outputDir: './'
+  };
+
+  const markdownPath = './docs/README.md';
+
+  markdownMagic(markdownPath, config, callback);
+
+  fs.copyFileSync(readmeFilePath, './README.md');
+}
+
+/**
+ * Copy README.md template from static source
+ * */
+
+function copyReadmeLocally() {
+
+  if (!fs.existsSync(dirDocs)){
+    fs.mkdirSync(dirDocs);
+  }
+
+  if (!fs.existsSync(readmeFilePath)) {
+    fs.writeFile(readmeFilePath, '', function(err) {
+      if(err) {
+        console.log('ERROR: Unable to create README.md file.', err);
+      }
+    });
+  }
+
+  processReadme();
+}
+
+copyReadmeLocally();

package/scripts/utils/auroLibraryUtils.mjs

@@ -0,0 +1,178 @@
+// Copyright (c) Alaska Air. All right reserved. Licensed under the Apache-2.0 license
+// See LICENSE in the project root for license information.
+
+// ---------------------------------------------------------------------
+
+import * as fs from 'fs';
+import * as path from 'path';
+import chalk from 'chalk';
+
+export default class AuroLibraryUtils {
+
+  /**
+   * Copys and pastes all files in a source directory into a destination directory.
+   * @param {String} srcDir - File path of directory to copy from.
+   * @param {String} destDir - File path of directory to paste files into.
+   * @param {Boolean} removeFiles - If true, removes all files in destination directory before pasting files.
+   */
+  copyDirectory(srcDir, destDir, removeFiles) {
+    if (!fs.existsSync(srcDir)) {
+      this.auroLogger(`Source directory ${srcDir} does not exist`, 'error', false);
+    } else {
+      // Removes all files from directory
+      if (removeFiles && fs.existsSync(destDir)) {
+        const destFiles = fs.readdirSync(destDir);
+
+        let filesRemoved = 0;
+    
+        destFiles.forEach(file => {
+          const filePath = path.join(destDir, file);
+          fs.unlinkSync(filePath);
+          this.auroLogger(`Removed file: ${file}`, 'success', false);
+
+          filesRemoved += 1;
+        });
+
+        if (filesRemoved > 0) {
+          this.auroLogger(`Removed ${filesRemoved} files`, 'success', false);
+        }
+      }
+
+      // Creates destination directory if it does not exist
+      if (!fs.existsSync(destDir)) {
+        fs.mkdirSync(destDir);
+      }
+    
+      // All files from source directory
+      const files = fs.readdirSync(srcDir);
+    
+      // Copys over all files from source directory to destination directory
+      files.forEach(file => {
+        const sourceFilePath = path.join(srcDir, file);
+        const destFilePath = path.join(destDir, file);
+    
+        const stat = fs.statSync(sourceFilePath);
+    
+        if (stat.isDirectory()) {
+          this.copyDirectory(srcDir, destDir, removeFiles);
+        } else {
+          fs.copyFileSync(sourceFilePath, destFilePath);
+
+          fs.readFile(destFilePath, 'utf8', (err, data) => {
+            this.formatFileContents(data, destFilePath); 
+          });
+
+          this.auroLogger(`Copied file: ${file}`, 'success');
+        }
+      });
+    }
+  }
+
+  /**
+   * Logs out messages in a readble format.
+   * @param {String} message - Message to be logged.
+   * @param {String} status - Status that determines the color of the logged message.
+   * @param {Boolean} section - If true, adds a box around the message for readability.
+   */
+  auroLogger(message, status, section) {
+    if (status) {
+      const infoColor = '#0096FF'; // blue
+      const successColor = '#4CBB17'; // green
+      const errorColor = '#ff0000'; // red
+
+      let color = undefined;
+
+      if (status === 'info') {
+        color = infoColor;
+      } else if (status === 'success') {
+        color = successColor;
+      } else if (status === 'error') {
+        color = errorColor;
+      }
+
+      if (section) {
+        console.log(chalk.hex(color)(`╭ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ──────────────────────────────╮\n`));
+      }
+  
+      console.log(chalk.hex(color)(message));
+  
+      if (section) {
+        console.log(chalk.hex(color)('\n╰─────────────────────────────── ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─╯'));
+      }
+    } else {
+      if (section) {
+        console.log(`╭ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ──────────────────────────────╮\n`);
+      }
+  
+      console.log(message);
+  
+      if (section) {
+        console.log(`\n╰─────────────────────────────── ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─╯`);
+      }
+    }
+  }
+
+  /**
+   * Extracts NPM VERSION, BRANCH NAME, NPM, NAMESPACE, and NAME from package.json.
+   * @returns {Object} result - Object containing data from package.json. 
+   */
+  nameExtraction() {
+    const packageJson = fs.readFileSync('package.json', 'utf8', function(err) {
+      if (err) {
+        console.log('ERROR: Unable to read package.json file', err);
+      }
+    });
+  
+    const pName = JSON.parse(packageJson).name;
+  
+    let npmStart = pName.indexOf('@');
+    let namespaceStart = pName.indexOf('/');
+    let nameStart = pName.indexOf('-');
+  
+    let result = {
+      'abstractNodeVersion': JSON.parse(packageJson).engines.node.substring(2),
+      'branchName': JSON.parse(packageJson).release.branch,
+      '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 [abstractNodeVersion], [branchName], [npm], [name], [Name], [namespace] and [Namespace] accordingly
+   */
+  formatFileContents(content, destination) {
+    let nameExtractionData = this.nameExtraction();
+    let result = content;
+
+    /**
+     * Replace placeholder strings
+     */
+    result = result.replace(/\[abstractNodeVersion]/g, nameExtractionData.abstractNodeVersion);
+    result = result.replace(/\[branchName]/g, nameExtractionData.branchName);
+    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'});
+  }
+}
+