RHCLOUD-23014: Use API Extractor on distributable packages

.dockerignore

@@ -3,3 +3,4 @@
 /screenshots
 **/node_modules
 **/dist
+**/.DS_Store

.gitignore

@@ -3,6 +3,7 @@
 /screenshots
 **/node_modules
 **/dist
+**/.DS_Store
 
 # https://next.yarnpkg.com/getting-started/qa#which-files-should-be-gitignored
 .pnp.*

clean.sh

@@ -1,7 +1,6 @@
 #!/bin/bash
 set -euo pipefail
 
-for dir in 'node_modules' 'dist'
-do
+for dir in node_modules dist; do
   find . -type d -name "$dir" -prune -exec rm -rf {} \;
 done

generate-api-docs.sh

@@ -6,7 +6,8 @@ yarn build-libs
 
 mkdir -p docs/generated && rm -rf docs/generated/*
 
-shopt -s globstar
-cp packages/lib-*/dist/api/lib-*.api.json docs/generated
+for dir in packages/lib-*; do
+  cp $dir/dist/api/$(basename $dir).api.json docs/generated
+done
 
 yarn api-documenter markdown -i docs/generated -o docs/generated/api

packages/eslint-plugin-internal/src/rules/all-bases.js

@@ -17,7 +17,7 @@ module.exports = {
   // Enforce a maximum number of classes per file
   'max-classes-per-file': 'off',
 
-  // This rule has inconsistent behavior and poor monorepo support, replaced by lib-restricted-external-imports
+  // Replaced by lib-restricted-external-imports, see the replacement rule documentation for details
   'import/no-extraneous-dependencies': 'off',
 
   // Enforce imported external modules to be declared in dependencies or peerDependencies within the closest parent package.json

packages/eslint-plugin-internal/src/runtime-rules/lib-restricted-external-imports.js

@@ -61,6 +61,16 @@ const checkImport = (context, node) => {
  * Enforce imported external modules to be declared in `dependencies` or `peerDependencies`
  * within the closest parent `package.json`.
  *
+ * This rule is meant to replace `import/no-extraneous-dependencies` which seems to have
+ * some behavioral inconsistencies as well as suboptimal support for monorepo projects.
+ *
+ * This rule differs from `import/no-extraneous-dependencies` in the following ways:
+ * - only the first closest parent `package.json` found is taken into account
+ * - external modules must be declared in either `dependencies` or `peerDependencies`
+ * - supports optional criteria that determine whether a file should be linted
+ *   - `includeFiles` and `excludeFiles` - `minimatch` compatible file glob patterns
+ *   - `excludeModules` - external modules to exclude from linting
+ *
  * @type {import('eslint').Rule.RuleModule}
  */
 module.exports = {

packages/lib-extensions/src/index.ts

@@ -3,7 +3,7 @@
  *
  * @remarks
  * This package provides extension types and corresponding type guard functions
- * used to interpret these extensions at runtime.
+ * used to interpret the corresponding extension objects at runtime.
  *
  * @packageDocumentation
  */

test.sh

@@ -21,11 +21,5 @@ yarn lint
 # Run unit tests
 yarn test
 
-# Ensure that Git repo is still clean
-if [[ -n "$(git status --porcelain)" ]]; then
-  echo "Git repository is not clean, make sure that all changes are committed"
-  exit 1
-fi
-
 # Upload code coverage
 ./prow-codecov.sh 2>/dev/null