Merge pull request #5 from D4N14L/user/danade/MultiPhaseHeftApiExtractor

Create @rushstack/heft-api-extractor-plugin and update for multi-phase Heft

apps/api-extractor/src/api/ExtractorConfig.ts

@@ -191,7 +191,7 @@ export class ExtractorConfig {
   /**
    * The config file name "api-extractor.json".
    */
-  public static readonly FILENAME: string = 'api-extractor.json';
+  public static readonly FILENAME: 'api-extractor.json' = 'api-extractor.json';
 
   /**
    * The full path to `extends/tsdoc-base.json` which contains the standard TSDoc configuration

heft-plugins/heft-api-extractor-plugin/.eslintrc.js

@@ -0,0 +1,10 @@
+// This is a workaround for https://github.com/eslint/eslint/issues/3458
+require('@rushstack/eslint-config/patch/modern-module-resolution');
+
+module.exports = {
+  extends: [
+    '@rushstack/eslint-config/profile/node-trusted-tool',
+    '@rushstack/eslint-config/mixins/friendly-locals'
+  ],
+  parserOptions: { tsconfigRootDir: __dirname }
+};

heft-plugins/heft-api-extractor-plugin/.npmignore

@@ -0,0 +1,31 @@
+# THIS IS A STANDARD TEMPLATE FOR .npmignore FILES IN THIS REPO.
+
+# Ignore all files by default, to avoid accidentally publishing unintended files.
+*
+
+# Use negative patterns to bring back the specific things we want to publish.
+!/bin/**
+!/lib/**
+!/lib-*/**
+!/dist/**
+!ThirdPartyNotice.txt
+
+# Ignore certain patterns that should not get published.
+/dist/*.stats.*
+/lib/**/test/
+/lib-*/**/test/
+*.test.js
+
+# NOTE: These don't need to be specified, because NPM includes them automatically.
+#
+# package.json
+# README (and its variants)
+# CHANGELOG (and its variants)
+# LICENSE / LICENCE
+
+#--------------------------------------------
+# DO NOT MODIFY THE TEMPLATE ABOVE THIS LINE
+#--------------------------------------------
+
+# (Add your project-specific overrides here)
+!heft-plugin.json

heft-plugins/heft-api-extractor-plugin/LICENSE

@@ -0,0 +1,24 @@
+@rushstack/heft-api-extractor-plugin
+
+Copyright (c) Microsoft Corporation. All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

heft-plugins/heft-api-extractor-plugin/README.md

@@ -0,0 +1,12 @@
+# @rushstack/heft-api-extractor-plugin
+
+This is a Heft plugin for running API Extractor.
+
+## Links
+
+- [CHANGELOG.md](
+  https://github.com/microsoft/rushstack/blob/main/heft-plugins/heft-api-extractor-plugin/CHANGELOG.md) - Find
+out what's new in the latest version
+- [@rushstack/heft](https://www.npmjs.com/package/@rushstack/heft) - Heft is a config-driven toolchain that invokes popular tools such as TypeScript, ESLint, Jest, Webpack, and API Extractor.
+
+Heft is part of the [Rush Stack](https://rushstack.io/) family of projects.