graycoreio/daffodil

/**
 * @license
 * Copyright Google Inc. All Rights Reserved.
 *
 * Use of this source code is governed by an MIT-style license that can be
 * found in the LICENSE file at https://angular.io/license
 */
import { Package } from 'dgeni';
import * as basePackage from 'dgeni-packages/base';
import * as nunjucksPackage from 'dgeni-packages/nunjucks';
import * as path from 'path';

import { ABSOLUTIFY_PATHS_PROCESSOR_PROVIDER } from '../../processors/absolutify-paths';
import { ADD_KIND_PROCESSOR_PROVIDER } from '../../processors/add-kind';
import { BREADCRUMB_PROCESSOR_PROVIDER } from '../../processors/breadcrumb';
import {
  CONVERT_TO_JSON_PROCESSOR_PROVIDER,
  ConvertToJsonProcessor,
} from '../../processors/convertToJson';
import { ID_SANITIZER_PROVIDER } from '../../services/id-sanitizer';
import {
  PROJECT_ROOT,
  TEMPLATES_PATH,
  OUTPUT_PATH,
} from '../config';

export const daffodilBasePackage = new Package('daffodil-base', [
  basePackage,
  nunjucksPackage,
])
  .processor({ name: 'absolutify-paths', $runAfter: ['paths-computed'], $process: (d) => d })
  .processor(...ABSOLUTIFY_PATHS_PROCESSOR_PROVIDER)
  .processor({ name: 'paths-absolutified', $runAfter: ['absolutify-paths'], $process: (d) => d })
  .processor(...ADD_KIND_PROCESSOR_PROVIDER)
  .factory(...ID_SANITIZER_PROVIDER)
  .processor(...BREADCRUMB_PROCESSOR_PROVIDER)
  .processor(...CONVERT_TO_JSON_PROCESSOR_PROVIDER)
  // eslint-disable-next-line @typescript-eslint/no-require-imports
  .factory('packageInfo', () => require(path.resolve(PROJECT_ROOT, 'package.json')))

// Where do we get the source files?
  .config((readFilesProcessor) => {
    readFilesProcessor.basePath = PROJECT_ROOT;
    readFilesProcessor.fileReaders = [];
    readFilesProcessor.sourceFiles = [];
  })

// Where do we write the output files?
  .config((writeFilesProcessor) => {
    writeFilesProcessor.outputFolder = OUTPUT_PATH;
  })

// Configure nunjucks rendering of docs via templates
  .config((renderDocsProcessor, templateFinder, templateEngine) => {
    // Where to find the templates for the doc rendering
    templateFinder.templateFolders = [TEMPLATES_PATH];

    // Standard patterns for matching docs to templates
    templateFinder.templatePatterns = [
      '${ doc.template }',
      '${ doc.id }.${ doc.docType }.template.html',
      '${ doc.id }.template.html',
      '${ doc.docType }.template.html',
      '${ doc.id }.${ doc.docType }.template.js',
      '${ doc.id }.template.js',
      '${ doc.docType }.template.js',
      '${ doc.id }.${ doc.docType }.template.json',
      '${ doc.id }.template.json',
      '${ doc.docType }.template.json',
      'common.template.html',
    ];

    // Nunjucks and Angular conflict in their template bindings so change Nunjucks
    templateEngine.config.tags = { variableStart: '{$', variableEnd: '$}' };

    // helpers are made available to the nunjucks templates
    renderDocsProcessor.helpers.relativePath = (from, to) => path.relative(from, to);
  })

  .config((convertToJson: ConvertToJsonProcessor) => {
    convertToJson.extraFields.push('breadcrumbs');
  });