• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    公众号

TypeScript api-extractor.Extractor类代码示例

原作者: [db:作者] 来自: [db:来源] 收藏 邀请

本文整理汇总了TypeScript中@microsoft/api-extractor.Extractor的典型用法代码示例。如果您正苦于以下问题:TypeScript Extractor类的具体用法?TypeScript Extractor怎么用?TypeScript Extractor使用的例子?那么恭喜您, 这里精选的类代码示例或许可以为您提供帮助。



在下文中一共展示了Extractor类的2个代码示例,这些例子默认根据受欢迎程度排序。您可以为喜欢或者感觉有用的代码点赞,您的评价将有助于我们的系统推荐出更棒的TypeScript代码示例。

示例1: apiExtractorConfig

const runApiExtractor = (
  log: ToolingLog,
  folder: string,
  acceptChanges: boolean = false
): ExtractorResult => {
  const config = apiExtractorConfig(folder);
  const options = {
    // Indicates that API Extractor is running as part of a local build,
    // e.g. on developer's machine. For example, if the *.api.ts output file
    // has differences, it will be automatically overwritten for a
    // local build, whereas this should report an error for a production build.
    localBuild: acceptChanges,
    messageCallback: (message: ExtractorMessage) => {
      if (message.messageId === 'console-api-report-not-copied') {
        // ConsoleMessageId.ApiReportNotCopied
        log.warning(`You have changed the signature of the ${folder} Core API`);
        log.warning(
          'To accept these changes run `node scripts/check_core_api_changes.js --accept` and then:\n' +
            "\t 1. Commit the updated documentation and API review file '" +
            config.reportFilePath +
            "' \n" +
            "\t 2. Describe the change in your PR including whether it's a major, minor or patch"
        );
        message.handled = true;
      } else if (message.messageId === 'console-api-report-copied') {
        // ConsoleMessageId.ApiReportCopied
        log.warning(`You have changed the signature of the ${folder} Core API`);
        log.warning(
          "Please commit the updated API documentation and the review file in '" +
            config.reportFilePath
        );
        message.handled = true;
      } else if (message.messageId === 'console-api-report-unchanged') {
        // ConsoleMessageId.ApiReportUnchanged
        log.info(`Core ${folder} API: no changes detected ✔`);
        message.handled = true;
      }
    },
  };

  return Extractor.invoke(config, options);
};
开发者ID:horacimacias,项目名称:kibana,代码行数:42,代码来源:run_check_core_api_changes.ts


示例2: runMain

export function runMain(
    tsConfig: string, entryPoint: string, dtsBundleOut?: string, apiReviewFolder?: string,
    acceptApiUpdates = false): 1|0 {
  const [parsedConfig, errors] = parseTsconfig(tsConfig);
  if (errors && errors.length) {
    console.error(format('', errors));

    return 1;
  }

  const pkgJson = path.resolve(path.dirname(entryPoint), 'package.json');
  if (!fs.existsSync(pkgJson)) {
    fs.writeFileSync(pkgJson, JSON.stringify({
      'name': 'GENERATED-BY-BAZEL',
      'version': '0.0.0',
      'description': 'This is a dummy package.json as API Extractor always requires one.',
    }));
  }

  // API extractor doesn't always support the version of TypeScript used in the repo
  // example: at the moment it is not compatable with 3.2
  // to use the internal TypeScript we shall not create a program but rather pass a parsed tsConfig.
  const parsedTsConfig = parsedConfig !.config as any;
  const compilerOptions = parsedTsConfig.compilerOptions;
  for (const [key, values] of Object.entries<string[]>(compilerOptions.paths)) {
    if (key === '*') {
      continue;
    }

    // we shall not pass ts files as this will need to be parsed, and for example rxjs,
    // cannot be compiled with our tsconfig, as ours is more strict
    // hence amend the paths to point always to the '.d.ts' files.
    compilerOptions.paths[key] = values.map(path => {
      const pathSuffix = /(\*|index)$/.test(path) ? '.d.ts' : '/index.d.ts';

      return path + pathSuffix;
    });
  }

  const extractorOptions: IExtractorOptions = {
    localBuild: acceptApiUpdates,
    customLogger: DEBUG ? undefined : {
      // don't log verbose messages when not in debug mode
      logVerbose: _message => {}
    }
  };

  const extractorConfig: IExtractorConfig = {
    compiler: {
      configType: 'tsconfig',
      overrideTsconfig: parsedTsConfig,
      rootFolder: path.resolve(path.dirname(tsConfig))
    },
    project: {
      entryPointSourceFile: path.resolve(entryPoint),
    },
    apiReviewFile: {
      enabled: !!apiReviewFolder,
      apiReviewFolder: apiReviewFolder && path.resolve(apiReviewFolder),
    },
    apiJsonFile: {
      enabled: false,
    },
    policies: {
      namespaceSupport: 'permissive',
    },
    validationRules: {
      missingReleaseTags: ExtractorValidationRulePolicy.allow,
    },
    dtsRollup: {
      enabled: !!dtsBundleOut,
      publishFolder: dtsBundleOut && path.resolve(path.dirname(dtsBundleOut)),
      mainDtsRollupPath: dtsBundleOut && path.basename(dtsBundleOut),
    },
    tsdocMetadata: {
      enabled: false,
    }
  };

  const extractor = new Extractor(extractorConfig, extractorOptions);
  const isSuccessful = extractor.processProject();

  // API extractor errors are emitted by it's logger.
  return isSuccessful ? 0 : 1;
}
开发者ID:Cammisuli,项目名称:angular,代码行数:85,代码来源:index.ts



注:本文中的@microsoft/api-extractor.Extractor类示例由纯净天空整理自Github/MSDocs等源码及文档管理平台,相关代码片段筛选自各路编程大神贡献的开源项目,源码版权归原作者所有,传播和使用请参考对应项目的License;未经允许,请勿转载。


鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
上一篇:
TypeScript api-extractor.ExtractorConfig类代码示例发布时间:2022-05-28
下一篇:
TypeScript auth.service.AuthService类代码示例发布时间:2022-05-28
热门推荐
热门话题
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap