@pattern-lab/core/src/lib/loaduikits.js

Create atomic design systems with Pattern Lab. This is the core API and orchestrator of the ecosystem.

'use strict';

const path = require('path');
const _ = require('lodash');

const logger = require('./log');

const { resolvePackageFolder } = require('./resolver');

let fs = require('fs-extra'); // eslint-disable-line

const readModuleFile = (uikitLocation, subPath) => {
  return fs.readFileSync(
    path.resolve(path.join(uikitLocation, subPath)),
    'utf8'
  );
};

/**
 * Loads uikits, connecting configuration and installed modules
 * [1] Lists the enabled uikits from patternlab-config.json
 * [2] Try to resolve the location of the uikit in the package dependencies
 * [3] Warn when the uikit couldn't be loaded
 * [4] Reads files from uikit that apply to every template
 * @param {object} patternlab
 */
module.exports = (patternlab) => {
  const paths = patternlab.config.paths;

  const uikitConfigs = _.filter(patternlab.config.uikits, 'enabled'); // [1]
  uikitConfigs.forEach((uikitConfig) => {
    let uikitLocation = null;
    if ('package' in uikitConfig) {
      try {
        uikitLocation = resolvePackageFolder(uikitConfig.package);
      } catch (ex) {
        logger.warning(
          `Could not find uikit with package name ${uikitConfig.package}. Did you add it to the 'dependencies' section in your 'package.json' file?`
        );
        return;
      }
    } else {
      // For backwards compatibility, name to package calculation is:
      // 1. name -> name
      // 2. name -> uikit-name
      // 3. name -> @pattern-lab/name
      // 4. name -> @pattern-lab/uikit-name
      for (const packageName of [
        uikitConfig.name,
        `uikit-${uikitConfig.name}`,
        `@pattern-lab/${uikitConfig.name}`,
        `@pattern-lab/uikit-${uikitConfig.name}`,
      ]) {
        try {
          uikitLocation = resolvePackageFolder(packageName); // [2]
        } catch (ex) {
          // Ignore
        }
        if (uikitLocation != null) {
          uikitConfig.package = packageName;
          logger.info(`Found uikit package ${packageName}`);
          break;
        }
      }
      if (uikitLocation == null) {
        logger.warning(
          `Could not find uikit with package name ${uikitConfig.name}, uikit-${uikitConfig.name}, @pattern-lab/${uikitConfig.name} or @pattern-lab/uikit-${uikitConfig.name} defined within patternlab-config.json in the package dependencies.`
        );
        return;
      } else {
        logger.warning(
          `Please update the configuration of UIKit ${uikitConfig.name} with property 'package: ${uikitConfig.package}' in patternlab-config.json. Lookup by 'name' is deprecated and will be removed in the future.`
        );
      } // [3]
    }

    try {
      patternlab.uikits[uikitConfig.name] = {
        name: uikitConfig.name,
        package: uikitConfig.package,
        modulePath: uikitLocation,
        enabled: true,
        outputDir: uikitConfig.outputDir,
        excludedPatternStates: uikitConfig.excludedPatternStates,
        excludedTags: uikitConfig.excludedTags,
        header: readModuleFile(
          uikitLocation,
          paths.source.patternlabFiles['general-header']
        ),
        footer: readModuleFile(
          uikitLocation,
          paths.source.patternlabFiles['general-footer']
        ),
        patternSection: readModuleFile(
          uikitLocation,
          paths.source.patternlabFiles.patternSection
        ),
        patternSectionSubgroup: readModuleFile(
          uikitLocation,
          paths.source.patternlabFiles.patternSectionSubgroup
        ),
        viewAll: readModuleFile(
          uikitLocation,
          paths.source.patternlabFiles.viewall
        ),
      }; // [4]
    } catch (ex) {
      logger.error(ex);
      logger.error(
        '\nERROR: missing an essential file from ' +
          uikitLocation +
          paths.source.patternlabFiles +
          ". Pattern Lab won't work without this file.\n"
      );
    }
  });
  return Promise.resolve();
};