adev/shared-docs/pipeline/examples/zip/builder.mts - main - githubmirror/angular

adev/shared-docs/pipeline/examples/zip/builder.mts
113 строк3 KB
SkyZeroZx
docs(docs-infra): apply OnPush change detection and remove redundant root provider
02 янв 2026, 10:23
02 янв 2026, 10:233b73eff
/*!
 * @license
 * Copyright Google LLC 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.dev/license
 */

import {join} from 'path';
import {readFile} from 'fs/promises';
import {copyFolder, createFolder} from '../shared/file-system.mjs';
import {glob} from 'tinyglobby';
import {appendCopyrightToFile} from '../shared/copyright.mjs';
import {EXCLUDE_FILES, CONFIG_FILENAME} from './defaults.mjs';
import {zip, strToU8} from 'fflate';

import {FileAndContent} from '../../../interfaces';
import {FileType} from '../../shared/regions/remove-eslint-comments.mjs';
import {regionParser} from '../../shared/regions/region-parser.mjs';

interface ZipConfig {
  ignore: string[];
  files: string[];
}

export async function generateZipExample(
  exampleDir: string,
  workingDir: string,
  templateDir: string,
) {
  const config = await readFile(join(exampleDir, CONFIG_FILENAME), 'utf-8');
  const stackblitzConfig: ZipConfig = JSON.parse(config) as ZipConfig;

  await createFolder(workingDir);

  // Copy template files to TEMP folder
  await copyFolder(templateDir, workingDir);

  // Copy example files to TEMP folder
  await copyFolder(exampleDir, workingDir);
  const includedPaths = await getIncludedPaths(workingDir, stackblitzConfig);

  const filesObj: Record<string, Uint8Array> = {};
  for (const path of includedPaths) {
    const file = await getFileAndContent(workingDir, path);
    filesObj[file.path] = typeof file.content === 'string' ? strToU8(file.content) : file.content;
  }

  return new Promise<Uint8Array>((resolve, reject) => {
    zip(filesObj, (err, data) => {
      if (err) {
        reject(err);
      } else {
        resolve(data);
      }
    });
  });
}

async function getIncludedPaths(workingDir: string, config: ZipConfig): Promise<string[]> {
  const defaultIncludes = [
    '**/*.ts',
    '**/*.js',
    '**/*.css',
    '**/*.html',
    '**/*.md',
    '**/*.json',
    '**/*.svg',
  ];
  return glob(defaultIncludes, {
    cwd: workingDir,
    onlyFiles: true,
    dot: true,
    ignore: config.ignore,
  });
}

async function getFileAndContent(workingDir: string, path: string): Promise<FileAndContent> {
  let content = await readFile(join(workingDir, path), 'utf-8');
  content = appendCopyrightToFile(path, content);
  content = extractRegions(path, content);

  return {content, path};
}

// Use once we restore the StackBlitz feature
async function createPostData(
  exampleDir: string,
  config: ZipConfig,
  exampleFilePaths: string[],
): Promise<Record<string, string>> {
  const postData: Record<string, string> = {};

  for (const filePath of exampleFilePaths) {
    if (EXCLUDE_FILES.some((excludedFile) => filePath.endsWith(excludedFile))) {
      continue;
    }

    let content = await readFile(join(exampleDir, filePath), 'utf-8');
    content = appendCopyrightToFile(filePath, content);
    content = extractRegions(filePath, content);

    postData[`project[files][${filePath}]`] = content;
  }

  return postData;
}

function extractRegions(path: string, contents: string): string {
  const fileType: FileType | undefined = path?.split('.').pop() as FileType;
  const regionParserResult = regionParser(contents, fileType);
  return regionParserResult.contents;
}