-
+ The Lockfile Explorer server has disconnected!
+
{manualChecked ? (
-
+ We were still not able to connect to the server. Are you sure the "lockfile-explorer"
+ shell command is running?
+
) : (
-
+ Please restart the "lockfile-explorer" shell command to continue using this application.
+
)}
The server has disconnected!
+We were still not able to establish a connection to the server. Are you sure it is running?
+Please re-start the local development server to continue using this application.
+
-
+ {checking ? Checking... : null}
- {options.map((opt: IFilterBarOption) => (
-
- );
-};
diff --git a/apps/lockfile-explorer-web/src/components/FilterBar/styles.scss b/apps/lockfile-explorer-web/src/components/FilterBar/styles.scss
deleted file mode 100644
index bbd2bcd1429..00000000000
--- a/apps/lockfile-explorer-web/src/components/FilterBar/styles.scss
+++ /dev/null
@@ -1,20 +0,0 @@
-@import 'office-ui-fabric-core/dist/sass/References';
-
-.FilterBar {
- display: flex;
- box-shadow: $ms-depth-shadow-8;
- width: fit-content;
- & > * + * {
- border-left: 1px solid $ms-color-gray20;
- }
-}
-
-.FilterItem {
- background-color: $ms-color-gray10;
- padding: 6px 12px;
- cursor: pointer;
-}
-
-.FilterItemActive {
- border-bottom: 3px solid #107c10;
-}
diff --git a/apps/lockfile-explorer-web/src/containers/BookmarksSidebar/index.tsx b/apps/lockfile-explorer-web/src/containers/BookmarksSidebar/index.tsx
index a42522c021f..eebd3c54643 100644
--- a/apps/lockfile-explorer-web/src/containers/BookmarksSidebar/index.tsx
+++ b/apps/lockfile-explorer-web/src/containers/BookmarksSidebar/index.tsx
@@ -7,6 +7,7 @@ import styles from './styles.scss';
import { useAppDispatch, useAppSelector } from '../../store/hooks';
import { LockfileEntry } from '../../parsing/LockfileEntry';
import { clearStackAndPush, removeBookmark } from '../../store/slices/entrySlice';
+import { Button, ScrollArea, Text } from '@rushstack/rush-themed-ui';
export const BookmarksSidebar = (): JSX.Element => {
const bookmarks = useAppSelector((state) => state.entry.bookmarkedEntries);
@@ -27,14 +28,18 @@ export const BookmarksSidebar = (): JSX.Element => {
return (
- {opt.text}
-
- ))}
-
-
- {bookmarks.map((bookmarkedEntry) => ( -
+ Bookmarks
+
+ {bookmarks.map((bookmarkedEntry) => ( +
);
};
diff --git a/apps/lockfile-explorer-web/src/containers/BookmarksSidebar/styles.scss b/apps/lockfile-explorer-web/src/containers/BookmarksSidebar/styles.scss
index 329508f3696..08b03e0a3b4 100644
--- a/apps/lockfile-explorer-web/src/containers/BookmarksSidebar/styles.scss
+++ b/apps/lockfile-explorer-web/src/containers/BookmarksSidebar/styles.scss
@@ -1,16 +1,19 @@
.BookmarksWrapper {
- flex: 1;
margin: 12px 0;
+ height: calc(100vh - 94px - 44px);
}
.BookmarkEntry {
padding: 4px 0;
margin-top: 8px;
cursor: pointer;
- &:hover {
- background: #dff6dd;
- }
& > * + * {
margin-top: 8px;
}
}
+
+.BookmarkLabel {
+ &:hover {
+ background: #dff6dd;
+ }
+}
diff --git a/apps/lockfile-explorer-web/src/containers/LockfileEntryDetailsView/index.tsx b/apps/lockfile-explorer-web/src/containers/LockfileEntryDetailsView/index.tsx
index 14cbd190e32..8eb049e2043 100644
--- a/apps/lockfile-explorer-web/src/containers/LockfileEntryDetailsView/index.tsx
+++ b/apps/lockfile-explorer-web/src/containers/LockfileEntryDetailsView/index.tsx
@@ -2,6 +2,7 @@
// See LICENSE in the project root for license information.
import React, { useCallback, useEffect, useState } from 'react';
+import { ScrollArea, Text } from '@rushstack/rush-themed-ui';
import styles from './styles.scss';
import appStyles from '../../App.scss';
import { IDependencyType, LockfileDependency } from '../../parsing/LockfileDependency';
@@ -120,7 +121,6 @@ export const LockfileEntryDetailsView = (): JSX.Element | ReactNull => {
const selectResolvedReferencer = useCallback(
(referrer) => () => {
- console.log('going to entry: ', referrer);
dispatch(pushToStack(referrer));
},
[selectedEntry]
@@ -131,31 +131,39 @@ export const LockfileEntryDetailsView = (): JSX.Element | ReactNull => {
return ReactNull;
}
return (
- Bookmarks
-- {bookmarks.map((bookmarkedEntry) => ( -
-
- ))}
+ {bookmarkedEntry.displayText}
- -+ {bookmarks.map((bookmarkedEntry) => ( +
+
+ ))}
+
+ {bookmarkedEntry.displayText}
+
+
+
-
@@ -61,7 +60,9 @@ const LockfileEntryLi = ({ group }: { group: ILockfileEntryGroup }): JSX.Element
return (
(PackageView.PARSED_PACKAGE_JSON);
+ const [selection, setSelection] = useState(PackageView.PARSED_PACKAGE_JSON);
- const cb = useCallback((s: PackageView) => () => setSelection(s), []);
+ const cb = useCallback((s: string) => {
+ setSelection(s);
+ }, []);
useEffect(() => {
async function loadPnpmFileAsync(): Promise {
@@ -76,57 +78,73 @@ export const PackageJsonViewer = (): JSX.Element => {
case 'add':
if (name) {
return (
-
+ {dep}:
+
+ );
} else {
- return
+ {version}
+
+ );
}
}
} else {
if (name) {
- return
+ {dep}:
+
+ );
} else {
- return
+ {version}
+
+ );
}
}
};
@@ -134,55 +152,84 @@ export const PackageJsonViewer = (): JSX.Element => {
const renderFile = (): JSX.Element | null => {
switch (selection) {
case PackageView.PACKAGE_JSON:
- if (!packageJSON) return
+ Please select a Project or Package to view it's package.json
+
+ );
return
+
+
);
}
return
+ Please select a Project or Package to view the parsed package.json
+
+ );
return (
-
- Selected Dependency:
- - {inspectDependency.name}: {inspectDependency.version} - -
-
- package.json spec:
- - {inspectDependency.dependencyType === IDependencyType.PEER_DEPENDENCY - ? `"${inspectDependency.peerDependencyMeta.version}" ${ - inspectDependency.peerDependencyMeta.optional ? 'Optional' : 'Required' - } Peer` - : inspectDependency.version} - -
-
+ .pnpmfile.cjs:
- - {specChanges.has(inspectDependency.name) - ? displaySpecChanges(specChanges, inspectDependency.name) - : 'No Effect'} - -
+
+
);
};
@@ -168,14 +176,14 @@ export const LockfileEntryDetailsView = (): JSX.Element | ReactNull => {
if (!peerDeps.length) {
return (
+
+ Selected Dependency:{' '}
+
+
+ {inspectDependency.name}: {inspectDependency.version}
+
+
+
+
+ package.json spec:{' '}
+
+
+ {inspectDependency.dependencyType === IDependencyType.PEER_DEPENDENCY
+ ? `"${inspectDependency.peerDependencyMeta.version}" ${
+ inspectDependency.peerDependencyMeta.optional ? 'Optional' : 'Required'
+ } Peer`
+ : inspectDependency.version}
+
+
+
+
+ .pnpmfile.cjs:{' '}
+
+
+ {specChanges.has(inspectDependency.name)
+ ? displaySpecChanges(specChanges, inspectDependency.name)
+ : 'No Effect'}
+
+
+
- No peer dependencies.
);
}
if (!inspectDependency || inspectDependency.dependencyType !== IDependencyType.PEER_DEPENDENCY) {
return (
No peer dependencies.
+
- Select a peer dependency to view its influencers
);
}
@@ -185,34 +193,40 @@ export const LockfileEntryDetailsView = (): JSX.Element | ReactNull => {
return (
Select a peer dependency to view its influencers
+
-
+
+ Determinants:
+
+ {determinants.length ? (
+ determinants.map(({ entry }) => (
+
+ {entry.displayText}
+
+ ))
+ ) : (
+ (none)
+ )}
+
+ Transitive Referencers:
+
+ {transitiveReferrers.length ? (
+ transitiveReferrers.map(({ entry }) => (
+
+ {entry.displayText}
+
+ ))
+ ) : (
+ (none)
+ )}
+
);
};
@@ -220,7 +234,9 @@ export const LockfileEntryDetailsView = (): JSX.Element | ReactNull => {
if (!selectedEntry) {
return (
Determinants:
- {determinants.length ? ( - determinants.map(({ entry }) => ( - - {entry.displayText} - - )) - ) : ( -(none)
- )} -Transitive Referencers:
- {transitiveReferrers.length ? ( - transitiveReferrers.map(({ entry }) => ( - - {entry.displayText} - - )) - ) : ( -(none)
- )} +
-
+ Select an entry to view its details
+
);
}
@@ -229,47 +245,57 @@ export const LockfileEntryDetailsView = (): JSX.Element | ReactNull => {
<>
Select an entry to view its details
+
-
+ Direct Referrers
+
{entry.entryPackageName}
))}
Direct Referrers
+
- {selectedEntry.referrers?.map((referrer: LockfileEntry) => (
-
-
Name: {referrer.displayText}
-
-
+ {selectedEntry.referrers?.map((referrer: LockfileEntry) => (
+
- ))}
+ ))}
+
Entry ID: {referrer.rawEntryId}
+
+
+ Name: {referrer.displayText}
+
+
-
+ Entry ID: {referrer.rawEntryId}
+
-
+ Direct Dependencies
+
diff --git a/apps/lockfile-explorer-web/src/containers/LockfileEntryDetailsView/styles.scss b/apps/lockfile-explorer-web/src/containers/LockfileEntryDetailsView/styles.scss
index 700eb3702fa..5cdbee54471 100644
--- a/apps/lockfile-explorer-web/src/containers/LockfileEntryDetailsView/styles.scss
+++ b/apps/lockfile-explorer-web/src/containers/LockfileEntryDetailsView/styles.scss
@@ -1,22 +1,19 @@
-@import 'office-ui-fabric-core/dist/sass/References';
+@use '../../styles/base';
.LockfileEntryListView {
display: flex;
justify-content: space-between;
- height: 30%;
+ min-height: 400px;
+ flex: 1;
padding-top: 12px;
& > * {
- width: calc(50% - 48px - 12px);
- }
- h5 {
- margin: 0;
+ width: calc(50% - 24px - 12px);
}
}
.DependencyListWrapper {
margin-top: 8px;
- height: calc(25vh - 24px);
- overflow: scroll;
+ height: calc(100% - 24px);
}
.DependencyItem {
@@ -26,9 +23,6 @@
&:hover {
border: 1px solid #107c10;
}
- p {
- margin: 0;
- }
& > * + * {
margin-top: 8px;
}
@@ -39,15 +33,13 @@
}
.InfluencerList {
- margin-top: 12px;
- height: 10%;
- overflow: scroll;
+ margin: 12px 0;
}
.DependencyDetails {
+ @include base.card;
+ padding: 12px;
margin-top: 12px;
- height: 4%;
- overflow: scroll;
}
.InfluencerEntry {
@@ -63,7 +55,6 @@
display: flex;
align-items: center;
span {
- font-size: 12px;
margin-left: 4px;
}
}
diff --git a/apps/lockfile-explorer-web/src/containers/LockfileViewer/index.tsx b/apps/lockfile-explorer-web/src/containers/LockfileViewer/index.tsx
index cfa247ba58c..d4a1083786f 100644
--- a/apps/lockfile-explorer-web/src/containers/LockfileViewer/index.tsx
+++ b/apps/lockfile-explorer-web/src/containers/LockfileViewer/index.tsx
@@ -2,7 +2,6 @@
// See LICENSE in the project root for license information.
import React, { useCallback, useEffect, useRef, useState } from 'react';
-import appStyles from '../../App.scss';
import styles from './styles.scss';
import { LockfileEntry, LockfileEntryFilter } from '../../parsing/LockfileEntry';
import { ReactNull } from '../../types/ReactNull';
@@ -13,8 +12,8 @@ import {
selectFilteredEntries,
setFilter as selectFilter
} from '../../store/slices/entrySlice';
-import { FilterBar } from '../../components/FilterBar';
import { getFilterFromLocalStorage, saveFilterToLocalStorage } from '../../helpers/localStorage';
+import { Tabs, Checkbox, ScrollArea, Input, Text } from '@rushstack/rush-themed-ui';
interface ILockfileEntryGroup {
entryName: string;
@@ -52,7 +51,7 @@ const LockfileEntryLi = ({ group }: { group: ILockfileEntryGroup }): JSX.Element
selectedEntry?.rawEntryId === entry.rawEntryId ? styles.lockfileSelectedEntry : ''
}`}
>
- Direct Dependencies
+
- {selectedEntry.dependencies?.map((dependency: LockfileDependency) => (
-
-
- Name: {dependency.name}{' '} - {dependency.dependencyType === IDependencyType.PEER_DEPENDENCY - ? `${ - dependency.peerDependencyMeta.optional ? '(Optional)' : '(Non-optional)' - } Peer Dependency` - : ''} -
-
-
+ {selectedEntry.dependencies?.map((dependency: LockfileDependency) => (
+
- ))}
+ ))}
+
Version: {dependency.version}
-Entry ID: {dependency.entryId}
+
+
+ Name: {dependency.name}{' '}
+ {dependency.dependencyType === IDependencyType.PEER_DEPENDENCY
+ ? `${
+ dependency.peerDependencyMeta.optional ? '(Optional)' : '(Non-optional)'
+ } Peer Dependency`
+ : ''}
+
+
-
+ Version: {dependency.version}
+ Entry ID: {dependency.entryId}
+
{entry.entryPackageName}
+
-
+ {group.entryName}
+
{group.versions.map((entry) => (
@@ -120,6 +121,7 @@ export const LockfileViewer = (): JSX.Element | ReactNull => {
} else if (packageFilter && activeFilters[LockfileEntryFilter.Package]) {
filteredEntries = entries.filter((entry) => entry.entryPackageName.indexOf(packageFilter) !== -1);
}
+
const reducedEntries = filteredEntries.reduce((groups: { [key in string]: LockfileEntry[] }, item) => {
const group = groups[item.entryPackageName] || [];
group.push(item);
@@ -141,6 +143,12 @@ export const LockfileViewer = (): JSX.Element | ReactNull => {
groupedEntries = groupedEntries.filter((entry) => multipleVersions(entry.versions));
}
+ if (activeFilters[LockfileEntryFilter.Project]) {
+ groupedEntries = groupedEntries.sort((a, b) =>
+ a.entryName > b.entryName ? 1 : b.entryName > a.entryName ? -1 : 0
+ );
+ }
+
return groupedEntries;
};
@@ -152,8 +160,8 @@ export const LockfileViewer = (): JSX.Element | ReactNull => {
);
const togglePackageView = useCallback(
- (selected: LockfileEntryFilter) => () => {
- if (selected === LockfileEntryFilter.Project) {
+ (selected: string) => {
+ if (selected === 'Projects') {
dispatch(selectFilter({ filter: LockfileEntryFilter.Project, state: true }));
dispatch(selectFilter({ filter: LockfileEntryFilter.Package, state: false }));
} else {
@@ -166,61 +174,55 @@ export const LockfileViewer = (): JSX.Element | ReactNull => {
return (
{group.entryName}
+
-
))}
+
-
diff --git a/apps/lockfile-explorer-web/src/containers/PackageJsonViewer/index.tsx b/apps/lockfile-explorer-web/src/containers/PackageJsonViewer/index.tsx
index dbc733c9b16..94087655684 100644
--- a/apps/lockfile-explorer-web/src/containers/PackageJsonViewer/index.tsx
+++ b/apps/lockfile-explorer-web/src/containers/PackageJsonViewer/index.tsx
@@ -4,21 +4,21 @@
import React, { useCallback, useEffect, useState } from 'react';
import { readPnpmfileAsync, readPackageSpecAsync, readPackageJsonAsync } from '../../parsing/getPackageFiles';
import styles from './styles.scss';
-import appStyles from '../../App.scss';
import { useAppDispatch, useAppSelector } from '../../store/hooks';
import { selectCurrentEntry } from '../../store/slices/entrySlice';
import { IPackageJson } from '../../types/IPackageJson';
import { compareSpec } from '../../parsing/compareSpec';
-import { FilterBar } from '../../components/FilterBar';
import { loadSpecChanges } from '../../store/slices/workspaceSlice';
import { displaySpecChanges } from '../../helpers/displaySpecChanges';
import { isEntryModified } from '../../helpers/isEntryModified';
+import { ScrollArea, Tabs, Text } from '@rushstack/rush-themed-ui';
+import { LockfileEntryFilter } from '../../parsing/LockfileEntry';
-enum PackageView {
- PACKAGE_JSON,
- PACKAGE_SPEC,
- PARSED_PACKAGE_JSON
-}
+const PackageView: { [key in string]: string } = {
+ PACKAGE_JSON: 'PACKAGE_JSON',
+ PACKAGE_SPEC: 'PACKAGE_SPEC',
+ PARSED_PACKAGE_JSON: 'PARSED_PACKAGE_JSON'
+};
export const PackageJsonViewer = (): JSX.Element => {
const dispatch = useAppDispatch();
@@ -29,9 +29,11 @@ export const PackageJsonViewer = (): JSX.Element => {
const specChanges = useAppSelector((state) => state.workspace.specChanges);
- const [selection, setSelection] = useState
-
diff --git a/apps/lockfile-explorer-web/src/containers/LockfileViewer/styles.scss b/apps/lockfile-explorer-web/src/containers/LockfileViewer/styles.scss
index eef96b23180..51321ffa193 100644
--- a/apps/lockfile-explorer-web/src/containers/LockfileViewer/styles.scss
+++ b/apps/lockfile-explorer-web/src/containers/LockfileViewer/styles.scss
@@ -1,13 +1,19 @@
+@use '../../styles/base';
+
.ViewWrapper {
- height: calc(100% - 12px);
- padding-top: 12px;
+ height: calc(100% - 24px);
+ @include base.card;
+ padding: 0 12px;
+ margin-top: 12px;
}
.ViewContents {
display: flex;
flex-direction: column;
- min-height: calc(100% - 70px - 35px);
- max-height: calc(100% - 70px - 35px);
+ height: calc(100% - 35px);
+ & > * + * {
+ margin-top: 12px;
+ }
}
.LockfileEntryListViewWrapper {
@@ -20,27 +26,7 @@
}
}
-.LockfileFilterBar {
- display: flex;
- align-items: center;
- margin-bottom: 12px;
-
- input {
- border: solid 1px #666;
- border-radius: 4px;
- padding: 0.4em;
- width: 100%;
- }
-
- & > * + * {
- margin-left: 12px;
- }
-}
-
.packageGroup {
- h5 {
- margin: 0;
- }
& > * + * {
margin-top: 4px;
}
@@ -59,11 +45,8 @@
}
.lockfileEntriesWrapper {
- overflow: scroll;
flex: 1;
- & > * + * {
- margin-top: 12px;
- }
+ height: 100%;
}
.filterSection {
@@ -73,12 +56,3 @@
margin-top: 4px;
}
}
-
-.filterOption {
- display: flex;
- align-items: center;
- cursor: pointer;
- & > * + * {
- margin-left: 4px;
- }
-}
diff --git a/apps/lockfile-explorer-web/src/containers/LogoPanel/index.tsx b/apps/lockfile-explorer-web/src/containers/LogoPanel/index.tsx
index ed172278c4e..0d13a4e4abc 100644
--- a/apps/lockfile-explorer-web/src/containers/LogoPanel/index.tsx
+++ b/apps/lockfile-explorer-web/src/containers/LogoPanel/index.tsx
@@ -12,7 +12,9 @@ export const LogoPanel = (): JSX.Element => {
return (
-
-
-
+
) : null}
+
{getEntriesToShow().map((lockfileEntryGroup) => (
+
{activeFilters[LockfileEntryFilter.Package] ? (
-
-
-
+ />
Filters
-
+ Filters
+
+
-
-
-
+ Must have side-by-side versions
-Must have doppelgangers
-}){kind=icon}
+
+
+
+
+
+
+
{dep}:
; + return ( +{version}
; + return ( +{dep}:
; + return ( +{version}
; + return ( +Please select a Project or Package to view it's package.json
; + if (!packageJSON) + return ( +{JSON.stringify(packageJSON, null, 2)};
case PackageView.PACKAGE_SPEC:
if (!pnpmfile) {
return (
-
+
Couldn't load the pnpmfile.cjs file - does it exist in the expected location?
(/common/config/rush/.pnpmfile.cjs)
-
+
);
}
return {pnpmfile};
case PackageView.PARSED_PACKAGE_JSON:
if (!parsedPackageJSON)
- return Please select a Project or Package to view the parsed package.json
; + return ( +
-
+ Package Name:
+
+
+ {selectedEntry?.kind === LockfileEntryFilter.Project
+ ? parsedPackageJSON.name
+ : selectedEntry?.displayText}
+
Package Name:
-{selectedEntry?.displayText}
+
-
+ Version:
+
+ {selectedEntry?.entryPackageVersion || parsedPackageJSON.version}
Version:
-{selectedEntry?.entryPackageVersion}
+
-
+ Dependencies
+
{parsedPackageJSON.dependencies &&
Object.entries(parsedPackageJSON.dependencies).map(renderDep(true))}
-
+ Dev Dependencies
+
{parsedPackageJSON.devDependencies &&
Object.entries(parsedPackageJSON.devDependencies).map(renderDep(true))}
-
+ Peer Dependencies
+
{parsedPackageJSON.peerDependencies &&
Object.entries(parsedPackageJSON.peerDependencies).map(renderDep(true))}
Dependencies
+Dev Dependencies
+Peer Dependencies
+
-
+
+
{parsedPackageJSON.dependencies &&
Object.entries(parsedPackageJSON.dependencies).map(renderDep(false))}
-
+
+
{parsedPackageJSON.devDependencies &&
Object.entries(parsedPackageJSON.devDependencies).map(renderDep(false))}
-
+
+
{parsedPackageJSON.peerDependencies &&
Object.entries(parsedPackageJSON.peerDependencies).map(renderDep(false))}
@@ -196,27 +243,29 @@ export const PackageJsonViewer = (): JSX.Element => {
return (
+
+
+
-
-
);
diff --git a/apps/lockfile-explorer-web/src/containers/PackageJsonViewer/styles.scss b/apps/lockfile-explorer-web/src/containers/PackageJsonViewer/styles.scss
index 3b8c866609e..bf4530d422e 100644
--- a/apps/lockfile-explorer-web/src/containers/PackageJsonViewer/styles.scss
+++ b/apps/lockfile-explorer-web/src/containers/PackageJsonViewer/styles.scss
@@ -1,11 +1,19 @@
+@use '../../styles/base';
+
.PackageJsonWrapper {
- height: 30%;
+ @include base.card;
+ min-height: 400px;
+ flex: 1;
margin-top: 12px;
}
.FileContents {
- height: calc(25vh - 35px);
- overflow: scroll;
+ height: calc(100% - 46px);
+ padding: 0 12px;
+}
+
+.FileInnerContent {
+ padding-top: 12px;
}
@mixin SpecWrapper {
@@ -31,7 +39,7 @@
.PackageSpecWrapper {
h5 {
- margin-bottom: 12px;
+ margin-bottom: 8px;
}
& > * + * {
margin-top: 8px;
diff --git a/apps/lockfile-explorer-web/src/containers/SelectedEntryPreview/index.tsx b/apps/lockfile-explorer-web/src/containers/SelectedEntryPreview/index.tsx
index 739afb5ceac..14c5ca393f9 100644
--- a/apps/lockfile-explorer-web/src/containers/SelectedEntryPreview/index.tsx
+++ b/apps/lockfile-explorer-web/src/containers/SelectedEntryPreview/index.tsx
@@ -11,6 +11,7 @@ import {
removeBookmark,
selectCurrentEntry
} from '../../store/slices/entrySlice';
+import { Button, ScrollArea, Text } from '@rushstack/rush-themed-ui';
export const SelectedEntryPreview = (): JSX.Element => {
const selectedEntry = useAppSelector(selectCurrentEntry);
@@ -39,20 +40,20 @@ export const SelectedEntryPreview = (): JSX.Element => {
const renderButtonRow = (): JSX.Element => {
return (
{renderFile()}
+
+
+
+
{renderFile()}
+
-
{isBookmarked ? (
-
) : (
-
)}
);
@@ -62,7 +63,9 @@ export const SelectedEntryPreview = (): JSX.Element => {
return (
-
+ No Entry Selected
+
{renderButtonRow()}
No Entry Selected
+
- , dep: s
case 'add':
return '[Added by .pnpmfile.cjs]';
case 'diff':
- return '[Changed from {specChanges.get(dep)?.from}]';
+ return `[Changed from ${specChanges.get(dep)?.from}]`;
case 'remove':
return '[Deleted by .pnpmfile.cjs]';
default:
diff --git a/apps/lockfile-explorer-web/src/parsing/LockfileEntry.ts b/apps/lockfile-explorer-web/src/parsing/LockfileEntry.ts
index 6c02ddb6b6c..057f4aa3c99 100644
--- a/apps/lockfile-explorer-web/src/parsing/LockfileEntry.ts
+++ b/apps/lockfile-explorer-web/src/parsing/LockfileEntry.ts
@@ -17,6 +17,7 @@ interface IProps {
rawEntryId: string;
kind: LockfileEntryFilter;
rawYamlData: ILockfileNode;
+ duplicates?: Set;
}
/**
@@ -61,7 +62,7 @@ export class LockfileEntry {
public entrySuffix: string = '';
public constructor(data: IProps) {
- const { rawEntryId, kind, rawYamlData } = data;
+ const { rawEntryId, kind, rawYamlData, duplicates } = data;
this.rawEntryId = rawEntryId;
this.kind = kind;
@@ -85,7 +86,13 @@ export class LockfileEntry {
this.packageJsonFolderPath = packageJsonFolderPath.toString();
this.entryId = 'project:' + this.packageJsonFolderPath;
this.entryPackageName = packageName.toString();
- this.displayText = 'Project: ' + this.entryPackageName;
+ if (duplicates?.has(this.entryPackageName)) {
+ const fullPath = new Path(rawEntryId).makeAbsolute('/').toString().substring(1);
+ this.displayText = `Project: ${this.entryPackageName} (${fullPath})`;
+ this.entryPackageName = `${this.entryPackageName} (${fullPath})`;
+ } else {
+ this.displayText = 'Project: ' + this.entryPackageName;
+ }
} else {
this.displayText = rawEntryId;
diff --git a/apps/lockfile-explorer-web/src/parsing/readLockfile.ts b/apps/lockfile-explorer-web/src/parsing/readLockfile.ts
index 8a067e30c29..d016bd35beb 100644
--- a/apps/lockfile-explorer-web/src/parsing/readLockfile.ts
+++ b/apps/lockfile-explorer-web/src/parsing/readLockfile.ts
@@ -3,6 +3,7 @@
import { LockfileEntry, LockfileEntryFilter } from './LockfileEntry';
import { IDependencyType } from './LockfileDependency';
+import { Path } from '@lifaon/path';
const serviceUrl: string = window.appContext.serviceUrl;
@@ -59,6 +60,19 @@ export function generateLockfileGraph(lockfile: ILockfilePackageType): LockfileE
const allImporters = [];
if (lockfile.importers) {
+ // Find duplicate importer names
+ const baseNames = new Set();
+ const duplicates = new Set();
+ for (const importerKey of Object.keys(lockfile.importers)) {
+ const baseName = new Path(importerKey).basename();
+ if (baseName) {
+ if (baseNames.has(baseName)) {
+ duplicates.add(baseName);
+ }
+ baseNames.add(baseName);
+ }
+ }
+
for (const [importerKey, importerValue] of Object.entries(lockfile.importers)) {
// console.log('normalized importer key: ', new Path(importerKey).makeAbsolute('/').toString());
@@ -67,7 +81,8 @@ export function generateLockfileGraph(lockfile: ILockfilePackageType): LockfileE
// entryId: normalizedPath,
rawEntryId: importerKey,
kind: LockfileEntryFilter.Project,
- rawYamlData: importerValue
+ rawYamlData: importerValue,
+ duplicates
});
allImporters.push(importer);
allEntries.push(importer);
diff --git a/apps/lockfile-explorer-web/src/parsing/test/compareSpec.test.ts b/apps/lockfile-explorer-web/src/parsing/test/compareSpec.test.ts
index 9818eb86964..1941552dee9 100644
--- a/apps/lockfile-explorer-web/src/parsing/test/compareSpec.test.ts
+++ b/apps/lockfile-explorer-web/src/parsing/test/compareSpec.test.ts
@@ -6,6 +6,7 @@ import { compareSpec } from '../compareSpec';
const packageJson: IPackageJson = {
name: 'testPackage',
+ version: '0.0.0',
dependencies: {
package1: '0.0.0'
},
@@ -17,6 +18,7 @@ const packageJson: IPackageJson = {
const parsedPackageJson: IPackageJson = {
name: 'testPackage',
+ version: '0.0.0',
dependencies: {
package1: '1.0.0'
},
diff --git a/apps/lockfile-explorer-web/src/start.css b/apps/lockfile-explorer-web/src/start.css
index c7d2f557200..43f0b44e3f4 100644
--- a/apps/lockfile-explorer-web/src/start.css
+++ b/apps/lockfile-explorer-web/src/start.css
@@ -10,9 +10,3 @@ body {
font-family: Tahoma, sans-serif;
box-sizing: border-box;
}
-
-h5,
-p {
- margin: 0;
- font-size: 14px;
-}
diff --git a/apps/lockfile-explorer-web/src/styles/_base.scss b/apps/lockfile-explorer-web/src/styles/_base.scss
new file mode 100644
index 00000000000..5799704e1e3
--- /dev/null
+++ b/apps/lockfile-explorer-web/src/styles/_base.scss
@@ -0,0 +1,7 @@
+$shadow: 0 2px 10px hsla(0, 0%, 0%, 0.141);
+$background-primary: white;
+
+@mixin card {
+ box-shadow: $shadow;
+ background-color: $background-primary;
+}
diff --git a/apps/lockfile-explorer-web/src/types/IPackageJson.ts b/apps/lockfile-explorer-web/src/types/IPackageJson.ts
index f774e147933..9ca29b24b7c 100644
--- a/apps/lockfile-explorer-web/src/types/IPackageJson.ts
+++ b/apps/lockfile-explorer-web/src/types/IPackageJson.ts
@@ -3,6 +3,7 @@
export interface IPackageJson {
name: string;
+ version: string;
dependencies: {
[key in string]: string;
};
diff --git a/apps/lockfile-explorer-web/webpack.config.js b/apps/lockfile-explorer-web/webpack.config.js
index 5d8baf21a38..db1db2d8a01 100644
--- a/apps/lockfile-explorer-web/webpack.config.js
+++ b/apps/lockfile-explorer-web/webpack.config.js
@@ -12,9 +12,8 @@ module.exports = function createConfig(env, argv) {
configOverride: {
resolve: {
alias: {
- // // Use the bundled library
- // 'heft-web-rig-library-tutorial':
- // 'heft-web-rig-library-tutorial/dist/heft-web-rig-library-tutorial.js'
+ // Don't rebundle this large library
+ '@rushstack/rush-themed-ui': '@rushstack/rush-themed-ui/dist/rush-themed-ui.js'
}
},
performance: {
diff --git a/apps/lockfile-explorer/CHANGELOG.json b/apps/lockfile-explorer/CHANGELOG.json
index 68b323a757a..635c791aefc 100644
--- a/apps/lockfile-explorer/CHANGELOG.json
+++ b/apps/lockfile-explorer/CHANGELOG.json
@@ -1,6 +1,224 @@
{
"name": "@rushstack/lockfile-explorer",
"entries": [
+ {
+ "version": "1.0.9",
+ "tag": "@rushstack/lockfile-explorer_v1.0.9",
+ "date": "Sat, 18 Mar 2023 00:20:56 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.5`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.50.0`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "1.0.8",
+ "tag": "@rushstack/lockfile-explorer_v1.0.8",
+ "date": "Fri, 10 Feb 2023 01:18:51 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/eslint-config\" to `3.2.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.4`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.7`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "1.0.7",
+ "tag": "@rushstack/lockfile-explorer_v1.0.7",
+ "date": "Wed, 08 Feb 2023 19:58:16 GMT",
+ "comments": {
+ "patch": [
+ {
+ "comment": "Support context parameter in pnpmfile readPackage"
+ }
+ ]
+ }
+ },
+ {
+ "version": "1.0.6",
+ "tag": "@rushstack/lockfile-explorer_v1.0.6",
+ "date": "Sun, 05 Feb 2023 03:02:02 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.3`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.6`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "1.0.5",
+ "tag": "@rushstack/lockfile-explorer_v1.0.5",
+ "date": "Wed, 01 Feb 2023 02:16:34 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.5`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "1.0.4",
+ "tag": "@rushstack/lockfile-explorer_v1.0.4",
+ "date": "Mon, 30 Jan 2023 16:22:31 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.54.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.4`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "1.0.3",
+ "tag": "@rushstack/lockfile-explorer_v1.0.3",
+ "date": "Mon, 30 Jan 2023 00:55:44 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.0`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "1.0.2",
+ "tag": "@rushstack/lockfile-explorer_v1.0.2",
+ "date": "Thu, 26 Jan 2023 02:55:10 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.14`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.3`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "1.0.1",
+ "tag": "@rushstack/lockfile-explorer_v1.0.1",
+ "date": "Wed, 25 Jan 2023 07:26:55 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.13`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.2`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "1.0.0",
+ "tag": "@rushstack/lockfile-explorer_v1.0.0",
+ "date": "Wed, 25 Jan 2023 03:01:43 GMT",
+ "comments": {
+ "major": [
+ {
+ "comment": "Initial feature-complete release of Lockfile Explorer"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.2.2",
+ "tag": "@rushstack/lockfile-explorer_v0.2.2",
+ "date": "Tue, 24 Jan 2023 00:16:54 GMT",
+ "comments": {
+ "patch": [
+ {
+ "comment": "Fix an issue with the tab component"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.2.1",
+ "tag": "@rushstack/lockfile-explorer_v0.2.1",
+ "date": "Sun, 22 Jan 2023 20:37:08 GMT",
+ "comments": {
+ "patch": [
+ {
+ "comment": "Fix an issue where the upgrade notice wasn't displayed until after pressing CTRL+C"
+ },
+ {
+ "comment": "Fix a regression where some CSS styles were not being loaded properly"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.2.0",
+ "tag": "@rushstack/lockfile-explorer_v0.2.0",
+ "date": "Sat, 21 Jan 2023 04:36:33 GMT",
+ "comments": {
+ "minor": [
+ {
+ "comment": "Add \"lfx\" as an alias for the \"lockfile-explorer\" shell command"
+ }
+ ],
+ "patch": [
+ {
+ "comment": "Add some basic command-line help and improve some message strings"
+ },
+ {
+ "comment": "Add support for rush components"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.1.8",
+ "tag": "@rushstack/lockfile-explorer_v0.1.8",
+ "date": "Wed, 18 Jan 2023 22:44:12 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.12`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.1`"
+ }
+ ]
+ }
+ },
{
"version": "0.1.7",
"tag": "@rushstack/lockfile-explorer_v0.1.7",
diff --git a/apps/lockfile-explorer/CHANGELOG.md b/apps/lockfile-explorer/CHANGELOG.md
index ade516ab586..e942ef4e1d5 100644
--- a/apps/lockfile-explorer/CHANGELOG.md
+++ b/apps/lockfile-explorer/CHANGELOG.md
@@ -1,6 +1,92 @@
# Change Log - @rushstack/lockfile-explorer
-This log was last generated on Wed, 18 Jan 2023 05:02:16 GMT and should not be manually modified.
+This log was last generated on Sat, 18 Mar 2023 00:20:56 GMT and should not be manually modified.
+
+## 1.0.9
+Sat, 18 Mar 2023 00:20:56 GMT
+
+_Version update only_
+
+## 1.0.8
+Fri, 10 Feb 2023 01:18:51 GMT
+
+_Version update only_
+
+## 1.0.7
+Wed, 08 Feb 2023 19:58:16 GMT
+
+### Patches
+
+- Support context parameter in pnpmfile readPackage
+
+## 1.0.6
+Sun, 05 Feb 2023 03:02:02 GMT
+
+_Version update only_
+
+## 1.0.5
+Wed, 01 Feb 2023 02:16:34 GMT
+
+_Version update only_
+
+## 1.0.4
+Mon, 30 Jan 2023 16:22:31 GMT
+
+_Version update only_
+
+## 1.0.3
+Mon, 30 Jan 2023 00:55:44 GMT
+
+_Version update only_
+
+## 1.0.2
+Thu, 26 Jan 2023 02:55:10 GMT
+
+_Version update only_
+
+## 1.0.1
+Wed, 25 Jan 2023 07:26:55 GMT
+
+_Version update only_
+
+## 1.0.0
+Wed, 25 Jan 2023 03:01:43 GMT
+
+### Breaking changes
+
+- Initial feature-complete release of Lockfile Explorer
+
+## 0.2.2
+Tue, 24 Jan 2023 00:16:54 GMT
+
+### Patches
+
+- Fix an issue with the tab component
+
+## 0.2.1
+Sun, 22 Jan 2023 20:37:08 GMT
+
+### Patches
+
+- Fix an issue where the upgrade notice wasn't displayed until after pressing CTRL+C
+- Fix a regression where some CSS styles were not being loaded properly
+
+## 0.2.0
+Sat, 21 Jan 2023 04:36:33 GMT
+
+### Minor changes
+
+- Add "lfx" as an alias for the "lockfile-explorer" shell command
+
+### Patches
+
+- Add some basic command-line help and improve some message strings
+- Add support for rush components
+
+## 0.1.8
+Wed, 18 Jan 2023 22:44:12 GMT
+
+_Version update only_
## 0.1.7
Wed, 18 Jan 2023 05:02:16 GMT
diff --git a/apps/lockfile-explorer/README.md b/apps/lockfile-explorer/README.md
index 1643d5bdd27..28a196676ae 100644
--- a/apps/lockfile-explorer/README.md
+++ b/apps/lockfile-explorer/README.md
@@ -3,79 +3,72 @@
-> 🚨 *EARLY PREVIEW RELEASE* 🚨
->
-> Please provide feedback by commenting on
-> the [Design Proposal](https://github.com/microsoft/rushstack/issues/3695)
-> or creating a GitHub issue. Thanks!
+**Rush Lockfile Explorer** helps you investigate and solve version conflicts when working in a monorepo
+that uses the [PNPM package manager](https://pnpm.io/). It's designed for the [Rush](https://rushjs.io)
+build orchestrator, but you can also use it to analyze a standalone PNPM workspace without Rush.
-**Rush Lockfile Explorer** helps you investigate and solve version conflicts when working
-in a [Rush](https://rushjs.io) monorepo using the [PNPM package manager](https://pnpm.io/).
+Lockfile Explorer helps with problems such as:
-Typical use cases:
-
-- After `rush update`, the app is reporting errors caused by duplicate instances of
- a singleton object, probably introduced by a
- [peer dependency doppelganger](https://rushjs.io/pages/advanced/npm_doppelgangers/)
- -- how to find the likely culprits?
-
-- After `rush update`, the app's bundle size has increased significantly due to
- side-by-side versions -- how to find which packages have extra versions?
-
-- When you identify the problematic package, it is an obscure indirect dependency of
- your middleware -- how to work backwards in the dependency graph to determine which
- **package.json** files should be patched in **.pnpmfile.cjs**?
-
-- Your project's installation footprint is unusually large because it has picked up
- a lot of extra NPM dependencies that seem unnecessary, however `rush-pnpm why` prints
- thousands of lines of output. How to filter this report to see the important
- relationships?
+- Understanding why multiple versions of an NPM package are appearing in your `node_modules` folder
+- Tracing dependencies to determine which project caused an NPM package to be installed
+- Finding and eliminating "doppelgangers" (multiple installations of the same version
+ of the same package)
+- Troubleshooting problems involving peer dependencies
+> This project is a new idea whose design is still evolving.
+> Please provide feedback by
+> [creating a GitHub issue](https://github.com/microsoft/rushstack/issues/new/choose)
+> or posting in the Rush Stack
+> [Zulip chat room](https://rushstack.zulipchat.com/). Thank you!
## Usage
+Here's how to invoke the **Rush Lockfile Explorer** tool:
+
```bash
-# Install the NPM package globally:
+# Install the NPM package globally.
+#
+# (You could substitute "pnpm" or "yarn" instead of "npm" here. To avoid confusing
+# duplicate installs, always use the same tool for global installations!)
npm install -g @rushstack/lockfile-explorer
# Go to your monorepo folder
cd my-rush-repo
-# Run "rush install" to ensure common/temp/node_modules is up to date
+# Run "rush install" to ensure common/temp/node_modules is up to date.
+# (If your monorepo is using PNPM without Rush, substitute "pnpm install" for this step.)
rush install
# Launch the Lockfile Explorer command line interface (CLI).
-# It expects to find a Rush workspace in your shell's current working directory.
+# It expects to find a Rush/PNPM workspace in your shell's current working directory.
+# As a shorthand, the "lfx" alias can be used here instead of "lockfile-explorer".
lockfile-explorer
```
-The CLI will start a Node.js service on `http://localhost/` and try to launch your default web browser:
+The CLI will start a Node.js service on `http://localhost/` and launch your default web browser:
-*Lockfile Explorer main window* - +_Lockfile Explorer main window_ ## How it works -The web app will expect to find a Rush workspace in the current working directory where the `lockfile-explorer` -command was invoked. It will read files such as: +The web app will expect to find a Rush/PNPM workspace in the current working directory where +the `lockfile-explorer` command was invoked. It will read files such as: - **common/config/rush/pnpm-lock.yaml** - the PNPM lockfile for your monorepo - **common/config/rush/.pnpmfile.cjs** - which transforms **package.json** files during installation -- The **package.json** files for your Rush projects -- The **package.json** files for packages installed under - +- The **package.json** files for your local workspace projects +- The **package.json** files for external packages installed in the `node_modules` folders. ## Links -- [Documentation](https://lfx.rushstack.io/) on the Lockfile Explorer project website -- [CHANGELOG.md]( - https://github.com/microsoft/rushstack/blob/main/apps/lockfile-explorer/CHANGELOG.md) - Find +- [Documentation and tutorials](https://lfx.rushstack.io/) on the Lockfile Explorer project website +- [CHANGELOG.md](https://github.com/microsoft/rushstack/blob/main/apps/lockfile-explorer/CHANGELOG.md) - Find out what's new in the latest version - [@rushstack/trace-import](https://www.npmjs.com/package/@rushstack/trace-import) - a command-line tool for troubleshooting how modules are resolved by `import` and `require()` diff --git a/apps/lockfile-explorer/package.json b/apps/lockfile-explorer/package.json index 02ea46678a7..99a1a27f662 100644 --- a/apps/lockfile-explorer/package.json +++ b/apps/lockfile-explorer/package.json @@ -1,6 +1,6 @@ { "name": "@rushstack/lockfile-explorer", - "version": "0.1.7", + "version": "1.0.9", "description": "Rush Lockfile Explorer: The UI for solving version conflicts quickly in a large monorepo", "keywords": [ "conflict", @@ -25,7 +25,8 @@ "homepage": "https://lfx.rushstack.io/", "license": "MIT", "bin": { - "lockfile-explorer": "./bin/lockfile-explorer" + "lockfile-explorer": "./bin/lockfile-explorer", + "lfx": "./bin/lockfile-explorer" }, "scripts": { "build": "heft build --clean", @@ -45,7 +46,7 @@ "@types/express": "4.17.13", "@types/heft-jest": "1.0.1", "@types/js-yaml": "3.12.1", - "@types/node": "12.20.24", + "@types/node": "14.18.36", "@types/update-notifier": "~6.0.1" }, "dependencies": { diff --git a/apps/lockfile-explorer/src/init.ts b/apps/lockfile-explorer/src/init.ts index 2870e68c61c..1baf98ea0fd 100644 --- a/apps/lockfile-explorer/src/init.ts +++ b/apps/lockfile-explorer/src/init.ts @@ -4,15 +4,18 @@ // This function will read the current directory and try to figure out if it's a rush project or regular pnpm workspace // Currently it will throw error if neither can be determined -import { FileSystem, JsonFile, PackageJsonLookup, Path } from '@rushstack/node-core-library'; +import { FileSystem, JsonFile, Path } from '@rushstack/node-core-library'; import type { IRushConfigurationJson } from '@microsoft/rush-lib/lib/api/RushConfiguration'; import { type IAppState, IRushProjectDetails, ProjectType } from './state'; -export const init = (): IAppState => { +export const init = (options: { + lockfileExplorerProjectRoot: string; + appVersion: string; + debugMode: boolean; +}): IAppState => { + const { lockfileExplorerProjectRoot, appVersion, debugMode } = options; const currDir = process.cwd(); - const lockfileExplorerProjectRoot: string = PackageJsonLookup.instance.tryGetPackageFolderFor(__dirname)!; - const appVersion: string = JsonFile.load(`${lockfileExplorerProjectRoot}/package.json`).version; let appState: IAppState | undefined; let currExploredDir = Path.convertToSlashes(currDir); @@ -21,7 +24,7 @@ export const init = (): IAppState => { const rushJsonPath: string = `${currExploredDir}/rush.json`; const pnpmLockPath: string = `${currExploredDir}/pnpm-lock.yaml`; if (FileSystem.exists(rushJsonPath)) { - console.log('found rush project: ', rushJsonPath); + console.log('Found a Rush workspace: ', rushJsonPath); // Load the rush projects const rushJson: IRushConfigurationJson = JsonFile.load(rushJsonPath); const projectsByProjectFolder: Map = new Map();
@@ -35,6 +38,7 @@ export const init = (): IAppState => {
appState = {
currDir,
appVersion,
+ debugMode,
lockfileExplorerProjectRoot,
projectType: ProjectType.RUSH_PROJECT,
pnpmLockfileLocation: `${currExploredDir}/common/config/rush/pnpm-lock.yaml`,
@@ -50,6 +54,7 @@ export const init = (): IAppState => {
appState = {
currDir,
appVersion,
+ debugMode,
lockfileExplorerProjectRoot,
projectType: ProjectType.PNPM_WORKSPACE,
pnpmLockfileLocation: `${currExploredDir}/pnpm-lock.yaml`,
@@ -64,7 +69,7 @@ export const init = (): IAppState => {
}
if (!appState) {
- throw new Error('Could not find a rush or pnpm project!');
+ throw new Error('Could not find a Rush or PNPM workspace!');
}
return appState;
diff --git a/apps/lockfile-explorer/src/start.ts b/apps/lockfile-explorer/src/start.ts
index 13257282bbe..99281baee23 100644
--- a/apps/lockfile-explorer/src/start.ts
+++ b/apps/lockfile-explorer/src/start.ts
@@ -8,151 +8,198 @@ import process from 'process';
import colors from 'colors/safe';
import open from 'open';
import updateNotifier from 'update-notifier';
-import { FileSystem, type IPackageJson, JsonFile } from '@rushstack/node-core-library';
+import { FileSystem, type IPackageJson, JsonFile, PackageJsonLookup } from '@rushstack/node-core-library';
import type { IAppContext } from '@rushstack/lockfile-explorer-web/lib/AppContext';
import packageJSON from '../package.json';
import { init } from './init';
import type { IAppState } from './state';
-
-const PORT: number = 8091;
-// Must not have a trailing slash
-const SERVICE_URL: string = `http://localhost:${PORT}`;
-
-updateNotifier({ pkg: packageJSON }).notify();
-
-const appState: IAppState = init();
-
-process.chdir(appState.lockfileExplorerProjectRoot);
-const distFolderPath: string = `${appState.lockfileExplorerProjectRoot}/dist`;
-const app: express.Application = express();
-app.use(express.json());
-app.use(cors());
-
-// Variable used to check if the front-end client is still connected
-let awaitingFirstConnect: boolean = true;
-let isClientConnected: boolean = false;
-let disconnected: boolean = false;
-setInterval(() => {
- if (!isClientConnected && !awaitingFirstConnect && !disconnected) {
- console.log(colors.red('The client has disconnected!'));
- console.log(`Please open a browser window at http://localhost:${PORT}/app`);
- disconnected = true;
- } else if (!awaitingFirstConnect) {
- isClientConnected = false;
- }
-}, 4000);
-
-// This takes precedence over the `/app` static route, which also has an `initappcontext.js` file.
-app.get('/initappcontext.js', (req: express.Request, res: express.Response) => {
- const appContext: IAppContext = {
- serviceUrl: SERVICE_URL,
- appVersion: appState.appVersion,
- debugMode: process.argv.indexOf('--debug') >= 0
- };
- const sourceCode: string = [
- `console.log('Loaded initappcontext.js');`,
- `appContext = ${JSON.stringify(appContext)}`
- ].join('\n');
-
- res.type('application/javascript').send(sourceCode);
-});
-
-app.use('/', express.static(distFolderPath));
-
-app.use('/favicon.ico', express.static(distFolderPath, { index: 'favicon.ico' }));
-
-app.get('/api/lockfile', async (req: express.Request, res: express.Response) => {
- const pnpmLockfileText: string = await FileSystem.readFileAsync(appState.pnpmLockfileLocation);
- const doc = yaml.load(pnpmLockfileText);
- res.send(doc);
-});
-
-app.get('/api/health', (req: express.Request, res: express.Response) => {
- awaitingFirstConnect = false;
- isClientConnected = true;
- if (disconnected) {
- disconnected = false;
- console.log(colors.green('The client has reconnected!'));
- }
- res.status(200).send();
-});
-
-app.post(
- '/api/package-json',
- async (req: express.Request<{}, {}, { projectPath: string }, {}>, res: express.Response) => {
- const { projectPath } = req.body;
- const fileLocation = `${appState.projectRoot}/${projectPath}/package.json`;
- let packageJsonText: string;
- try {
- packageJsonText = await FileSystem.readFileAsync(fileLocation);
- } catch (e) {
- if (FileSystem.isNotExistError(e)) {
- return res.status(404).send({
- message: `Could not load package.json file for this package. Have you installed all the dependencies for this workspace?`,
- error: `No package.json in location: ${projectPath}`
- });
- } else {
- throw e;
- }
- }
-
- res.send(packageJsonText);
+import { AlreadyReportedError } from '@rushstack/node-core-library';
+
+function startApp(debugMode: boolean): void {
+ const lockfileExplorerProjectRoot: string = PackageJsonLookup.instance.tryGetPackageFolderFor(__dirname)!;
+ const appVersion: string = JsonFile.load(`${lockfileExplorerProjectRoot}/package.json`).version;
+
+ console.log(
+ colors.bold(`\nRush Lockfile Explorer ${appVersion}`) + colors.cyan(' - https://lfx.rushstack.io/\n')
+ );
+
+ updateNotifier({
+ pkg: packageJSON,
+ // Normally update-notifier waits a day or so before it starts displaying upgrade notices.
+ // In debug mode, show the notice right away.
+ updateCheckInterval: debugMode ? 0 : undefined
+ }).notify({
+ // Make sure it says "-g" in the "npm install" example command line
+ isGlobal: true,
+ // Show the notice immediately, rather than waiting for process.onExit()
+ defer: false
+ });
+
+ const PORT: number = 8091;
+ // Must not have a trailing slash
+ const SERVICE_URL: string = `http://localhost:${PORT}`;
+
+ // TODO: Later if we introduce more CLI parameters, switch to a proper CLI parser
+ const args: string[] = process.argv.slice(2);
+ if (args.length > 0 && args[0] !== '--debug') {
+ console.log('Usage: lockfile-explorer [--debug]\n');
+ console.log('The "lfx" command is a shorthand alias for "lockfile-explorer".');
+ console.log('See the project website for documentation and support.\n');
+ throw new AlreadyReportedError();
}
-);
-app.get('/api/pnpmfile', async (req: express.Request, res: express.Response) => {
- let pnpmLockfile: string;
- try {
- pnpmLockfile = await FileSystem.readFileAsync(appState.pnpmLockfileLocation);
- } catch (e) {
- if (FileSystem.isNotExistError(e)) {
- return res.status(404).send({
- message: `Could not load pnpmfile file in this repo.`,
- error: `No .pnpmifile.cjs found.`
- });
- } else {
- throw e;
+ const appState: IAppState = init({ lockfileExplorerProjectRoot, appVersion, debugMode });
+
+ // Important: This must happen after init() reads the current working directory
+ process.chdir(appState.lockfileExplorerProjectRoot);
+
+ const distFolderPath: string = `${appState.lockfileExplorerProjectRoot}/dist`;
+ const app: express.Application = express();
+ app.use(express.json());
+ app.use(cors());
+
+ // Variable used to check if the front-end client is still connected
+ let awaitingFirstConnect: boolean = true;
+ let isClientConnected: boolean = false;
+ let disconnected: boolean = false;
+ setInterval(() => {
+ if (!isClientConnected && !awaitingFirstConnect && !disconnected) {
+ console.log(colors.red('The client has disconnected!'));
+ console.log(`Please open a browser window at http://localhost:${PORT}/app`);
+ disconnected = true;
+ } else if (!awaitingFirstConnect) {
+ isClientConnected = false;
}
- }
+ }, 4000);
+
+ // This takes precedence over the `/app` static route, which also has an `initappcontext.js` file.
+ app.get('/initappcontext.js', (req: express.Request, res: express.Response) => {
+ const appContext: IAppContext = {
+ serviceUrl: SERVICE_URL,
+ appVersion: appState.appVersion,
+ debugMode: process.argv.indexOf('--debug') >= 0
+ };
+ const sourceCode: string = [
+ `console.log('Loaded initappcontext.js');`,
+ `appContext = ${JSON.stringify(appContext)}`
+ ].join('\n');
+
+ res.type('application/javascript').send(sourceCode);
+ });
+
+ app.use('/', express.static(distFolderPath));
+
+ app.use('/favicon.ico', express.static(distFolderPath, { index: 'favicon.ico' }));
+
+ app.get('/api/lockfile', async (req: express.Request, res: express.Response) => {
+ const pnpmLockfileText: string = await FileSystem.readFileAsync(appState.pnpmLockfileLocation);
+ const doc = yaml.load(pnpmLockfileText);
+ res.send(doc);
+ });
+
+ app.get('/api/health', (req: express.Request, res: express.Response) => {
+ awaitingFirstConnect = false;
+ isClientConnected = true;
+ if (disconnected) {
+ disconnected = false;
+ console.log(colors.green('The client has reconnected!'));
+ }
+ res.status(200).send();
+ });
+
+ app.post(
+ '/api/package-json',
+ async (req: express.Request<{}, {}, { projectPath: string }, {}>, res: express.Response) => {
+ const { projectPath } = req.body;
+ const fileLocation = `${appState.projectRoot}/${projectPath}/package.json`;
+ let packageJsonText: string;
+ try {
+ packageJsonText = await FileSystem.readFileAsync(fileLocation);
+ } catch (e) {
+ if (FileSystem.isNotExistError(e)) {
+ return res.status(404).send({
+ message: `Could not load package.json file for this package. Have you installed all the dependencies for this workspace?`,
+ error: `No package.json in location: ${projectPath}`
+ });
+ } else {
+ throw e;
+ }
+ }
- res.send(pnpmLockfile);
-});
+ res.send(packageJsonText);
+ }
+ );
-app.post(
- '/api/package-spec',
- async (req: express.Request<{}, {}, { projectPath: string }, {}>, res: express.Response) => {
- const { projectPath } = req.body;
- const fileLocation = `${appState.projectRoot}/${projectPath}/package.json`;
- let packageJson: IPackageJson;
+ app.get('/api/pnpmfile', async (req: express.Request, res: express.Response) => {
+ let pnpmfile: string;
try {
- packageJson = await JsonFile.loadAsync(fileLocation);
+ pnpmfile = await FileSystem.readFileAsync(appState.pnpmfileLocation);
} catch (e) {
if (FileSystem.isNotExistError(e)) {
return res.status(404).send({
- message: `Could not load package.json file in location: ${projectPath}`
+ message: `Could not load pnpmfile file in this repo.`,
+ error: `No .pnpmifile.cjs found.`
});
} else {
throw e;
}
}
- const {
- hooks: { readPackage }
- } = require(appState.pnpmfileLocation);
- const parsedPackage = readPackage(packageJson);
- res.send(parsedPackage);
- }
-);
+ res.send(pnpmfile);
+ });
+
+ app.post(
+ '/api/package-spec',
+ async (req: express.Request<{}, {}, { projectPath: string }, {}>, res: express.Response) => {
+ const { projectPath } = req.body;
+ const fileLocation = `${appState.projectRoot}/${projectPath}/package.json`;
+ let packageJson: IPackageJson;
+ try {
+ packageJson = await JsonFile.loadAsync(fileLocation);
+ } catch (e) {
+ if (FileSystem.isNotExistError(e)) {
+ return res.status(404).send({
+ message: `Could not load package.json file in location: ${projectPath}`
+ });
+ } else {
+ throw e;
+ }
+ }
-app.listen(PORT, async () => {
- console.log(`Rush Lockfile Explorer ${appState.appVersion} running at ${SERVICE_URL}`);
+ const {
+ hooks: { readPackage }
+ } = require(appState.pnpmfileLocation);
+ const parsedPackage = readPackage(packageJson, {});
+ res.send(parsedPackage);
+ }
+ );
- if (!process.argv.includes('--debug')) {
- try {
- // Launch the web browser
- await open(SERVICE_URL);
- } catch (e) {
- console.error('Error launching browser: ' + e.toString());
+ app.listen(PORT, async () => {
+ console.log(`App launched on ${SERVICE_URL}`);
+
+ if (!appState.debugMode) {
+ try {
+ // Launch the web browser
+ await open(SERVICE_URL);
+ } catch (e) {
+ console.error('Error launching browser: ' + e.toString());
+ }
+ }
+ });
+}
+
+const debugMode: boolean = process.argv.indexOf('--debug') >= 0;
+if (debugMode) {
+ // Display the full callstack for errors
+ startApp(debugMode);
+} else {
+ // Catch exceptions and report them nicely
+ try {
+ startApp(debugMode);
+ } catch (error) {
+ if (!(error instanceof AlreadyReportedError)) {
+ console.error();
+ console.error(colors.red('ERROR: ' + error.message));
}
}
-});
+}
diff --git a/apps/lockfile-explorer/src/state/index.ts b/apps/lockfile-explorer/src/state/index.ts
index e9f1a161671..43b356f6ab7 100644
--- a/apps/lockfile-explorer/src/state/index.ts
+++ b/apps/lockfile-explorer/src/state/index.ts
@@ -19,6 +19,7 @@ export interface IAppStateBase {
pnpmLockfileLocation: string;
pnpmfileLocation: string;
appVersion: string;
+ debugMode: boolean;
}
export interface IRushAppState extends IAppStateBase {
diff --git a/apps/rundown/CHANGELOG.json b/apps/rundown/CHANGELOG.json
index 6c4c4e702da..6ccf81f46b6 100644
--- a/apps/rundown/CHANGELOG.json
+++ b/apps/rundown/CHANGELOG.json
@@ -1,6 +1,156 @@
{
"name": "@rushstack/rundown",
"entries": [
+ {
+ "version": "1.0.243",
+ "tag": "@rushstack/rundown_v1.0.243",
+ "date": "Sat, 18 Mar 2023 00:20:56 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.50.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.5`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "1.0.242",
+ "tag": "@rushstack/rundown_v1.0.242",
+ "date": "Fri, 10 Feb 2023 01:18:51 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/ts-command-line\" to `4.13.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/eslint-config\" to `3.2.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.7`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.4`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "1.0.241",
+ "tag": "@rushstack/rundown_v1.0.241",
+ "date": "Sun, 05 Feb 2023 03:02:02 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.6`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.3`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "1.0.240",
+ "tag": "@rushstack/rundown_v1.0.240",
+ "date": "Wed, 01 Feb 2023 02:16:34 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.5`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.2`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "1.0.239",
+ "tag": "@rushstack/rundown_v1.0.239",
+ "date": "Mon, 30 Jan 2023 16:22:31 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.54.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.4`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.1`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "1.0.238",
+ "tag": "@rushstack/rundown_v1.0.238",
+ "date": "Mon, 30 Jan 2023 00:55:44 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.0`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "1.0.237",
+ "tag": "@rushstack/rundown_v1.0.237",
+ "date": "Thu, 26 Jan 2023 02:55:10 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.3`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.14`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "1.0.236",
+ "tag": "@rushstack/rundown_v1.0.236",
+ "date": "Wed, 25 Jan 2023 07:26:55 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.13`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "1.0.235",
+ "tag": "@rushstack/rundown_v1.0.235",
+ "date": "Wed, 18 Jan 2023 22:44:12 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.12`"
+ }
+ ]
+ }
+ },
{
"version": "1.0.234",
"tag": "@rushstack/rundown_v1.0.234",
diff --git a/apps/rundown/CHANGELOG.md b/apps/rundown/CHANGELOG.md
index bd7420f94f5..33d112b7250 100644
--- a/apps/rundown/CHANGELOG.md
+++ b/apps/rundown/CHANGELOG.md
@@ -1,6 +1,51 @@
# Change Log - @rushstack/rundown
-This log was last generated on Tue, 20 Dec 2022 01:18:22 GMT and should not be manually modified.
+This log was last generated on Sat, 18 Mar 2023 00:20:56 GMT and should not be manually modified.
+
+## 1.0.243
+Sat, 18 Mar 2023 00:20:56 GMT
+
+_Version update only_
+
+## 1.0.242
+Fri, 10 Feb 2023 01:18:51 GMT
+
+_Version update only_
+
+## 1.0.241
+Sun, 05 Feb 2023 03:02:02 GMT
+
+_Version update only_
+
+## 1.0.240
+Wed, 01 Feb 2023 02:16:34 GMT
+
+_Version update only_
+
+## 1.0.239
+Mon, 30 Jan 2023 16:22:31 GMT
+
+_Version update only_
+
+## 1.0.238
+Mon, 30 Jan 2023 00:55:44 GMT
+
+_Version update only_
+
+## 1.0.237
+Thu, 26 Jan 2023 02:55:10 GMT
+
+_Version update only_
+
+## 1.0.236
+Wed, 25 Jan 2023 07:26:55 GMT
+
+_Version update only_
+
+## 1.0.235
+Wed, 18 Jan 2023 22:44:12 GMT
+
+_Version update only_
## 1.0.234
Tue, 20 Dec 2022 01:18:22 GMT
diff --git a/apps/rundown/package.json b/apps/rundown/package.json
index e110227b9f1..82356950c51 100644
--- a/apps/rundown/package.json
+++ b/apps/rundown/package.json
@@ -1,6 +1,6 @@
{
"name": "@rushstack/rundown",
- "version": "1.0.234",
+ "version": "1.0.243",
"description": "Detect load time regressions by running an app, tracing require() calls, and generating a deterministic report",
"repository": {
"type": "git",
@@ -29,6 +29,7 @@
"@rushstack/eslint-config": "workspace:*",
"@rushstack/heft": "workspace:*",
"@rushstack/heft-node-rig": "workspace:*",
- "@types/node": "12.20.24"
+ "@types/heft-jest": "1.0.1",
+ "@types/node": "14.18.36"
}
}
diff --git a/apps/rundown/src/launcher.ts b/apps/rundown/src/launcher.ts
index fb7173c168c..a7d6938840d 100644
--- a/apps/rundown/src/launcher.ts
+++ b/apps/rundown/src/launcher.ts
@@ -58,7 +58,7 @@ class Launcher {
}
public installHook(): void {
- const realRequire: NodeRequireFunction = moduleApi.Module.prototype.require;
+ const realRequire: NodeJS.Require = moduleApi.Module.prototype.require;
const importedModules: Set = this._importedModules; // for closure
const importedModulePaths: Set = this._importedModulePaths; // for closure
@@ -110,7 +110,7 @@ class Launcher {
return importedModule;
}
- moduleApi.Module.prototype.require = hookedRequire;
+ moduleApi.Module.prototype.require = hookedRequire as NodeJS.Require;
Launcher._copyProperties(hookedRequire, realRequire);
process.on('exit', () => {
diff --git a/apps/rush/CHANGELOG.json b/apps/rush/CHANGELOG.json
index 609c16529d3..4aa6af9efe5 100644
--- a/apps/rush/CHANGELOG.json
+++ b/apps/rush/CHANGELOG.json
@@ -1,6 +1,224 @@
{
"name": "@microsoft/rush",
"entries": [
+ {
+ "version": "5.95.0",
+ "tag": "@microsoft/rush_v5.95.0",
+ "date": "Fri, 24 Mar 2023 08:53:43 GMT",
+ "comments": {
+ "none": [
+ {
+ "comment": "Add experiment `printEventHooksOutputToConsole` to allow printing outputs from event hooks to the console."
+ }
+ ]
+ }
+ },
+ {
+ "version": "5.94.1",
+ "tag": "@microsoft/rush_v5.94.1",
+ "date": "Wed, 22 Mar 2023 20:48:48 GMT",
+ "comments": {
+ "none": [
+ {
+ "comment": "Fix an issue where rush plugin autoinstallers would fail to install because the Rush global folder had not yet been initialized."
+ },
+ {
+ "comment": "Fix an issue with `rush update-autoinstaller` where it may fail with an `Cannot install with \"frozen-lockfile\" because pnpm-lock.yaml is not up to date with package.json` error."
+ }
+ ]
+ }
+ },
+ {
+ "version": "5.94.0",
+ "tag": "@microsoft/rush_v5.94.0",
+ "date": "Mon, 20 Mar 2023 20:14:36 GMT",
+ "comments": {
+ "none": [
+ {
+ "comment": "Update the `nodeSupportedVersionRange` in `rush.json` generated by `rush init` to remove Node 12 as it is no longer supported and include Node 18 as it is the current LTS version."
+ },
+ {
+ "comment": "Extend LookupByPath to also be able to obtain the index of the remainder of the matched path."
+ },
+ {
+ "comment": "Include some more hooks to allow plugins to monitor phased command execution in real-time."
+ },
+ {
+ "comment": "Fix an issue where running `rush update-autoinstaller` without having run `rush install` or `rush update` first would cause a crash with an unhelpful error message."
+ }
+ ]
+ }
+ },
+ {
+ "version": "5.93.2",
+ "tag": "@microsoft/rush_v5.93.2",
+ "date": "Mon, 06 Mar 2023 20:18:01 GMT",
+ "comments": {
+ "none": [
+ {
+ "comment": "Do not delete the local pnpm store after all install attempts has failed. `rush purge` will still delete a local store."
+ }
+ ]
+ }
+ },
+ {
+ "version": "5.93.1",
+ "tag": "@microsoft/rush_v5.93.1",
+ "date": "Fri, 17 Feb 2023 14:46:59 GMT",
+ "comments": {
+ "none": [
+ {
+ "comment": "Fix a regression where \"rush-sdk\" failed to load older versions of \"rush-lib\" (GitHub #3979)"
+ }
+ ]
+ }
+ },
+ {
+ "version": "5.93.0",
+ "tag": "@microsoft/rush_v5.93.0",
+ "date": "Fri, 17 Feb 2023 02:14:43 GMT",
+ "comments": {
+ "none": [
+ {
+ "comment": "Add code path to @rushstack/rush-sdk for inheriting @microsoft/rush-lib location from a parent process via the RUSH_LIB_PATH environment variable."
+ }
+ ]
+ }
+ },
+ {
+ "version": "5.92.0",
+ "tag": "@microsoft/rush_v5.92.0",
+ "date": "Sun, 12 Feb 2023 02:50:42 GMT",
+ "comments": {
+ "none": [
+ {
+ "comment": "Enable @rushstack/rush-sdk to import internal APIs from the proxied @microsoft/rush-lib instance (GitHub #3895)"
+ }
+ ]
+ }
+ },
+ {
+ "version": "5.91.0",
+ "tag": "@microsoft/rush_v5.91.0",
+ "date": "Sat, 11 Feb 2023 02:04:14 GMT",
+ "comments": {
+ "none": [
+ {
+ "comment": "Remove runtime dependency on @rushstack/rush-sdk from the AzureStorageAuthentication class in @rushstack/rush-azure-storage-build-cache-plugin so that it can be used in isolation."
+ },
+ {
+ "comment": "Include operation log files in the cache, and restore them during cache hits."
+ }
+ ]
+ }
+ },
+ {
+ "version": "5.90.2",
+ "tag": "@microsoft/rush_v5.90.2",
+ "date": "Wed, 08 Feb 2023 20:27:06 GMT",
+ "comments": {}
+ },
+ {
+ "version": "5.90.1",
+ "tag": "@microsoft/rush_v5.90.1",
+ "date": "Wed, 08 Feb 2023 19:58:35 GMT",
+ "comments": {
+ "none": [
+ {
+ "comment": "Disable unused depcheck feature for upgrade-interactive."
+ },
+ {
+ "comment": "Fix an issue where deleting the `common/temp/node_modules` folder encounters an EPERM error and aborts."
+ }
+ ],
+ "patch": [
+ {
+ "comment": "Fix determination of the root of the current Git worktree when in a multi-worktree setup."
+ }
+ ]
+ }
+ },
+ {
+ "version": "5.90.0",
+ "tag": "@microsoft/rush_v5.90.0",
+ "date": "Sun, 29 Jan 2023 20:10:17 GMT",
+ "comments": {
+ "none": [
+ {
+ "comment": "Allow \"shellCommand\" to be optionally specified for bulk custom commands, so that a centralized script can be used instead of invoking package.json scripts (GitHub #3819)"
+ }
+ ]
+ }
+ },
+ {
+ "version": "5.89.1",
+ "tag": "@microsoft/rush_v5.89.1",
+ "date": "Thu, 26 Jan 2023 02:55:30 GMT",
+ "comments": {
+ "none": [
+ {
+ "comment": "Fix an issue with `rush add` where the approved packages files aren't updated."
+ },
+ {
+ "comment": "Revert generation of scripts in the Git hooks folder due to various git-related issues"
+ },
+ {
+ "comment": "Upgrade to webpack 5.75.0"
+ }
+ ]
+ }
+ },
+ {
+ "version": "5.89.0",
+ "tag": "@microsoft/rush_v5.89.0",
+ "date": "Tue, 24 Jan 2023 22:30:06 GMT",
+ "comments": {
+ "none": [
+ {
+ "comment": "Fix linking error due to PNPM v7 local install path breaking change"
+ },
+ {
+ "comment": "Introduce \"dependsOnAdditionalFiles\" configuration option to operations in rush-project.json. This option allows to pass glob (minimatch) patterns pointing to files outside of .git repository. If provided, the hash values of these files will become part of the final hash when reading and writing from cache."
+ },
+ {
+ "comment": "Use getRepoStateAsync to optimize performance of calculating repository state."
+ },
+ {
+ "comment": "Generate scripts in the Git hooks folder referring to the actual hook implementations in-place in the Rush `common/git-hooks/` folder instead of copying the scripts to the Git hooks folder."
+ }
+ ]
+ }
+ },
+ {
+ "version": "5.88.2",
+ "tag": "@microsoft/rush_v5.88.2",
+ "date": "Sun, 22 Jan 2023 04:18:44 GMT",
+ "comments": {
+ "none": [
+ {
+ "comment": "Fix a regression where the 'dist/scripts' folder name was named 'dist/undefined'"
+ }
+ ]
+ }
+ },
+ {
+ "version": "5.88.1",
+ "tag": "@microsoft/rush_v5.88.1",
+ "date": "Wed, 18 Jan 2023 22:44:31 GMT",
+ "comments": {
+ "none": [
+ {
+ "comment": "Fix an issue where `create-scripts.js` does not exist during `rush deploy`."
+ },
+ {
+ "comment": "Add install-run-rush-pnpm.js script"
+ },
+ {
+ "comment": "Update JSZip to 3.8.0."
+ }
+ ]
+ }
+ },
{
"version": "5.88.0",
"tag": "@microsoft/rush_v5.88.0",
diff --git a/apps/rush/CHANGELOG.md b/apps/rush/CHANGELOG.md
index 5ffd7f87b52..408d2400ba3 100644
--- a/apps/rush/CHANGELOG.md
+++ b/apps/rush/CHANGELOG.md
@@ -1,6 +1,126 @@
# Change Log - @microsoft/rush
-This log was last generated on Thu, 22 Dec 2022 20:11:58 GMT and should not be manually modified.
+This log was last generated on Fri, 24 Mar 2023 08:53:43 GMT and should not be manually modified.
+
+## 5.95.0
+Fri, 24 Mar 2023 08:53:43 GMT
+
+### Updates
+
+- Add experiment `printEventHooksOutputToConsole` to allow printing outputs from event hooks to the console.
+
+## 5.94.1
+Wed, 22 Mar 2023 20:48:48 GMT
+
+### Updates
+
+- Fix an issue where rush plugin autoinstallers would fail to install because the Rush global folder had not yet been initialized.
+- Fix an issue with `rush update-autoinstaller` where it may fail with an `Cannot install with "frozen-lockfile" because pnpm-lock.yaml is not up to date with package.json` error.
+
+## 5.94.0
+Mon, 20 Mar 2023 20:14:36 GMT
+
+### Updates
+
+- Update the `nodeSupportedVersionRange` in `rush.json` generated by `rush init` to remove Node 12 as it is no longer supported and include Node 18 as it is the current LTS version.
+- Extend LookupByPath to also be able to obtain the index of the remainder of the matched path.
+- Include some more hooks to allow plugins to monitor phased command execution in real-time.
+- Fix an issue where running `rush update-autoinstaller` without having run `rush install` or `rush update` first would cause a crash with an unhelpful error message.
+
+## 5.93.2
+Mon, 06 Mar 2023 20:18:01 GMT
+
+### Updates
+
+- Do not delete the local pnpm store after all install attempts has failed. `rush purge` will still delete a local store.
+
+## 5.93.1
+Fri, 17 Feb 2023 14:46:59 GMT
+
+### Updates
+
+- Fix a regression where "rush-sdk" failed to load older versions of "rush-lib" (GitHub #3979)
+
+## 5.93.0
+Fri, 17 Feb 2023 02:14:43 GMT
+
+### Updates
+
+- Add code path to @rushstack/rush-sdk for inheriting @microsoft/rush-lib location from a parent process via the RUSH_LIB_PATH environment variable.
+
+## 5.92.0
+Sun, 12 Feb 2023 02:50:42 GMT
+
+### Updates
+
+- Enable @rushstack/rush-sdk to import internal APIs from the proxied @microsoft/rush-lib instance (GitHub #3895)
+
+## 5.91.0
+Sat, 11 Feb 2023 02:04:14 GMT
+
+### Updates
+
+- Remove runtime dependency on @rushstack/rush-sdk from the AzureStorageAuthentication class in @rushstack/rush-azure-storage-build-cache-plugin so that it can be used in isolation.
+- Include operation log files in the cache, and restore them during cache hits.
+
+## 5.90.2
+Wed, 08 Feb 2023 20:27:06 GMT
+
+_Version update only_
+
+## 5.90.1
+Wed, 08 Feb 2023 19:58:35 GMT
+
+### Patches
+
+- Fix determination of the root of the current Git worktree when in a multi-worktree setup.
+
+### Updates
+
+- Disable unused depcheck feature for upgrade-interactive.
+- Fix an issue where deleting the `common/temp/node_modules` folder encounters an EPERM error and aborts.
+
+## 5.90.0
+Sun, 29 Jan 2023 20:10:17 GMT
+
+### Updates
+
+- Allow "shellCommand" to be optionally specified for bulk custom commands, so that a centralized script can be used instead of invoking package.json scripts (GitHub #3819)
+
+## 5.89.1
+Thu, 26 Jan 2023 02:55:30 GMT
+
+### Updates
+
+- Fix an issue with `rush add` where the approved packages files aren't updated.
+- Revert generation of scripts in the Git hooks folder due to various git-related issues
+- Upgrade to webpack 5.75.0
+
+## 5.89.0
+Tue, 24 Jan 2023 22:30:06 GMT
+
+### Updates
+
+- Fix linking error due to PNPM v7 local install path breaking change
+- Introduce "dependsOnAdditionalFiles" configuration option to operations in rush-project.json. This option allows to pass glob (minimatch) patterns pointing to files outside of .git repository. If provided, the hash values of these files will become part of the final hash when reading and writing from cache.
+- Use getRepoStateAsync to optimize performance of calculating repository state.
+- Generate scripts in the Git hooks folder referring to the actual hook implementations in-place in the Rush `common/git-hooks/` folder instead of copying the scripts to the Git hooks folder.
+
+## 5.88.2
+Sun, 22 Jan 2023 04:18:44 GMT
+
+### Updates
+
+- Fix a regression where the 'dist/scripts' folder name was named 'dist/undefined'
+
+## 5.88.1
+Wed, 18 Jan 2023 22:44:31 GMT
+
+### Updates
+
+- Fix an issue where `create-scripts.js` does not exist during `rush deploy`.
+- Add install-run-rush-pnpm.js script
+- Update JSZip to 3.8.0.
## 5.88.0
Thu, 22 Dec 2022 20:11:58 GMT
diff --git a/apps/rush/package.json b/apps/rush/package.json
index 4c33eb2cd1f..d5623a1ab72 100644
--- a/apps/rush/package.json
+++ b/apps/rush/package.json
@@ -1,6 +1,6 @@
{
"name": "@microsoft/rush",
- "version": "5.88.0",
+ "version": "5.95.0",
"description": "A professional solution for consolidating all your JavaScript projects in one Git repo",
"keywords": [
"install",
@@ -47,7 +47,8 @@
"@rushstack/heft-node-rig": "workspace:*",
"@rushstack/rush-amazon-s3-build-cache-plugin": "workspace:*",
"@rushstack/rush-azure-storage-build-cache-plugin": "workspace:*",
- "@types/node": "12.20.24",
+ "@types/heft-jest": "1.0.1",
+ "@types/node": "14.18.36",
"@types/semver": "7.3.5"
}
}
diff --git a/apps/trace-import/CHANGELOG.json b/apps/trace-import/CHANGELOG.json
index b2373c2095d..457bdd023fd 100644
--- a/apps/trace-import/CHANGELOG.json
+++ b/apps/trace-import/CHANGELOG.json
@@ -1,6 +1,168 @@
{
"name": "@rushstack/trace-import",
"entries": [
+ {
+ "version": "0.1.12",
+ "tag": "@rushstack/trace-import_v0.1.12",
+ "date": "Sat, 18 Mar 2023 00:20:56 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.50.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.5`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.1.11",
+ "tag": "@rushstack/trace-import_v0.1.11",
+ "date": "Fri, 10 Feb 2023 01:18:51 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/ts-command-line\" to `4.13.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/eslint-config\" to `3.2.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.7`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.4`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.1.10",
+ "tag": "@rushstack/trace-import_v0.1.10",
+ "date": "Sun, 05 Feb 2023 03:02:02 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.6`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.3`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.1.9",
+ "tag": "@rushstack/trace-import_v0.1.9",
+ "date": "Wed, 01 Feb 2023 02:16:34 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.5`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.2`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.1.8",
+ "tag": "@rushstack/trace-import_v0.1.8",
+ "date": "Mon, 30 Jan 2023 16:22:31 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.54.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.4`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.1`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.1.7",
+ "tag": "@rushstack/trace-import_v0.1.7",
+ "date": "Mon, 30 Jan 2023 00:55:44 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.0`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.1.6",
+ "tag": "@rushstack/trace-import_v0.1.6",
+ "date": "Thu, 26 Jan 2023 02:55:10 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.3`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.14`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.1.5",
+ "tag": "@rushstack/trace-import_v0.1.5",
+ "date": "Wed, 25 Jan 2023 07:26:56 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.13`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.1.4",
+ "tag": "@rushstack/trace-import_v0.1.4",
+ "date": "Sat, 21 Jan 2023 04:36:33 GMT",
+ "comments": {
+ "patch": [
+ {
+ "comment": "Update README.md"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.1.3",
+ "tag": "@rushstack/trace-import_v0.1.3",
+ "date": "Wed, 18 Jan 2023 22:44:12 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.12`"
+ }
+ ]
+ }
+ },
{
"version": "0.1.2",
"tag": "@rushstack/trace-import_v0.1.2",
diff --git a/apps/trace-import/CHANGELOG.md b/apps/trace-import/CHANGELOG.md
index 994d8bd875b..2da252e03ef 100644
--- a/apps/trace-import/CHANGELOG.md
+++ b/apps/trace-import/CHANGELOG.md
@@ -1,6 +1,58 @@
# Change Log - @rushstack/trace-import
-This log was last generated on Tue, 20 Dec 2022 01:18:23 GMT and should not be manually modified.
+This log was last generated on Sat, 18 Mar 2023 00:20:56 GMT and should not be manually modified.
+
+## 0.1.12
+Sat, 18 Mar 2023 00:20:56 GMT
+
+_Version update only_
+
+## 0.1.11
+Fri, 10 Feb 2023 01:18:51 GMT
+
+_Version update only_
+
+## 0.1.10
+Sun, 05 Feb 2023 03:02:02 GMT
+
+_Version update only_
+
+## 0.1.9
+Wed, 01 Feb 2023 02:16:34 GMT
+
+_Version update only_
+
+## 0.1.8
+Mon, 30 Jan 2023 16:22:31 GMT
+
+_Version update only_
+
+## 0.1.7
+Mon, 30 Jan 2023 00:55:44 GMT
+
+_Version update only_
+
+## 0.1.6
+Thu, 26 Jan 2023 02:55:10 GMT
+
+_Version update only_
+
+## 0.1.5
+Wed, 25 Jan 2023 07:26:56 GMT
+
+_Version update only_
+
+## 0.1.4
+Sat, 21 Jan 2023 04:36:33 GMT
+
+### Patches
+
+- Update README.md
+
+## 0.1.3
+Wed, 18 Jan 2023 22:44:12 GMT
+
+_Version update only_
## 0.1.2
Tue, 20 Dec 2022 01:18:23 GMT
diff --git a/apps/trace-import/README.md b/apps/trace-import/README.md
index 88ac84442aa..cce9b091799 100644
--- a/apps/trace-import/README.md
+++ b/apps/trace-import/README.md
@@ -1,8 +1,8 @@
-# @microsoft/trace-import
+# @rushstack/trace-import
-> 🚨 *EARLY PREVIEW RELEASE* 🚨
+> 🚨 _EARLY PREVIEW RELEASE_ 🚨
>
-> Not all features are implemented yet. To provide suggestions, please
+> Not all features are implemented yet. To provide suggestions, please
> [create a GitHub issue](https://github.com/microsoft/rushstack/issues/new/choose).
> If you have questions, see the [Rush Stack Help page](https://rushstack.io/pages/help/support/)
> for support resources.
@@ -62,11 +62,13 @@ These commands were invoked in the `C:\Git\rushstack\apps\trace-import` folder
where trace-import is developed.
### Resolving a CommonJS main index
+
```
trace-import --path semver
```
Sample output:
+
```
Base folder: C:\Git\rushstack\apps\trace-import
Package name: semver
@@ -82,11 +84,13 @@ Target path: C:\Git\rushstack\common\temp\node_modules\.pnpm\semver@
```
### Resolving a CommonJS package subpath
+
```
trace-import --path typescript/bin/tsc
```
Sample output:
+
```
Base folder: C:\Git\rushstack\apps\trace-import
Package name: typescript
@@ -101,11 +105,13 @@ Target path: C:\Git\rushstack\common\temp\node_modules\.pnpm\typescr
```
### Resolving a TypeScript declaration
+
```
trace-import --resolution-type ts --path semver
```
Sample output:
+
```
Base folder: C:\Git\rushstack\apps\trace-import
Package name: semver
@@ -123,11 +129,13 @@ Target path: C:\Git\rushstack\common\temp\node_modules\.pnpm\@types+
```
### Resolving a relative path
+
```
trace-import --path ./config/rig.json
```
Sample output:
+
```
Base folder: C:\Git\rushstack\apps\trace-import
Import path: ./config/rig.json
@@ -140,8 +148,7 @@ Target path: C:\Git\rushstack\apps\trace-import\config\rig.json
## Links
-- [CHANGELOG.md](
- https://github.com/microsoft/rushstack/blob/main/apps/trace-import/CHANGELOG.md) - Find
+- [CHANGELOG.md](https://github.com/microsoft/rushstack/blob/main/apps/trace-import/CHANGELOG.md) - Find
out what's new in the latest version
- [Rush Lockfile Explorer](https://lfx.rushstack.io) - The desktop app for troubleshooting PNPM lockfiles
diff --git a/apps/trace-import/package.json b/apps/trace-import/package.json
index e307ca499f8..a43b6e59a36 100644
--- a/apps/trace-import/package.json
+++ b/apps/trace-import/package.json
@@ -1,6 +1,6 @@
{
"name": "@rushstack/trace-import",
- "version": "0.1.2",
+ "version": "0.1.12",
"description": "CLI tool for understanding how require() and \"import\" statements get resolved",
"repository": {
"type": "git",
@@ -30,7 +30,7 @@
"@rushstack/heft": "workspace:*",
"@rushstack/heft-node-rig": "workspace:*",
"@types/heft-jest": "1.0.1",
- "@types/node": "12.20.24",
+ "@types/node": "14.18.36",
"@types/resolve": "1.20.2",
"@types/semver": "7.3.5"
}
diff --git a/build-tests-samples/heft-node-basic-tutorial/package.json b/build-tests-samples/heft-node-basic-tutorial/package.json
index a86c7872998..e98bbdb1367 100644
--- a/build-tests-samples/heft-node-basic-tutorial/package.json
+++ b/build-tests-samples/heft-node-basic-tutorial/package.json
@@ -17,7 +17,7 @@
"@rushstack/heft-lint-plugin": "workspace:*",
"@rushstack/heft-typescript-plugin": "workspace:*",
"@types/heft-jest": "1.0.1",
- "@types/node": "12.20.24",
+ "@types/node": "14.18.36",
"eslint": "~8.7.0",
"typescript": "~4.8.4"
}
diff --git a/build-tests-samples/heft-node-jest-tutorial/package.json b/build-tests-samples/heft-node-jest-tutorial/package.json
index 159f09954dc..f44f23255ce 100644
--- a/build-tests-samples/heft-node-jest-tutorial/package.json
+++ b/build-tests-samples/heft-node-jest-tutorial/package.json
@@ -16,7 +16,7 @@
"@rushstack/heft-lint-plugin": "workspace:*",
"@rushstack/heft-typescript-plugin": "workspace:*",
"@types/heft-jest": "1.0.1",
- "@types/node": "12.20.24",
+ "@types/node": "14.18.36",
"eslint": "~8.7.0",
"typescript": "~4.8.4"
}
diff --git a/build-tests-samples/heft-node-rig-tutorial/package.json b/build-tests-samples/heft-node-rig-tutorial/package.json
index 4f0e3c2b2f3..9fcf3ea48bd 100644
--- a/build-tests-samples/heft-node-rig-tutorial/package.json
+++ b/build-tests-samples/heft-node-rig-tutorial/package.json
@@ -14,6 +14,7 @@
"@rushstack/eslint-config": "workspace:*",
"@rushstack/heft": "workspace:*",
"@rushstack/heft-node-rig": "workspace:*",
- "@types/node": "12.20.24"
+ "@types/heft-jest": "1.0.1",
+ "@types/node": "14.18.36"
}
}
diff --git a/build-tests-samples/heft-serverless-stack-tutorial/package.json b/build-tests-samples/heft-serverless-stack-tutorial/package.json
index 13d0c49ef9b..ce351d3f889 100644
--- a/build-tests-samples/heft-serverless-stack-tutorial/package.json
+++ b/build-tests-samples/heft-serverless-stack-tutorial/package.json
@@ -24,7 +24,7 @@
"@serverless-stack/resources": "0.67.0",
"@types/aws-lambda": "8.10.93",
"@types/heft-jest": "1.0.1",
- "@types/node": "12.20.24",
+ "@types/node": "14.18.36",
"aws-cdk-lib": "2.7.0",
"constructs": "~10.0.98",
"eslint": "~8.7.0",
diff --git a/build-tests-samples/heft-storybook-react-tutorial-storykit/package.json b/build-tests-samples/heft-storybook-react-tutorial-storykit/package.json
index 3f2428360b0..2a2fd09d520 100644
--- a/build-tests-samples/heft-storybook-react-tutorial-storykit/package.json
+++ b/build-tests-samples/heft-storybook-react-tutorial-storykit/package.json
@@ -11,7 +11,7 @@
"_phase:build": ""
},
"devDependencies": {
- "@babel/core": "~7.17.0",
+ "@babel/core": "~7.20.0",
"@storybook/addon-actions": "~6.4.18",
"@storybook/addon-essentials": "~6.4.18",
"@storybook/addon-links": "~6.4.18",
@@ -21,10 +21,10 @@
"@storybook/react": "~6.4.18",
"@storybook/theming": "~6.4.18",
"@types/heft-jest": "1.0.1",
- "@types/node": "12.20.24",
+ "@types/node": "14.18.36",
"@types/react-dom": "16.9.14",
"@types/react": "16.14.23",
- "@types/webpack-env": "1.13.0",
+ "@types/webpack-env": "1.18.0",
"babel-loader": "~8.2.3",
"css-loader": "~5.2.7",
"jest": "~29.3.1",
diff --git a/build-tests-samples/heft-storybook-react-tutorial/config/heft.json b/build-tests-samples/heft-storybook-react-tutorial/config/heft.json
index 3ba875a0e99..9c1f6c5ea7c 100644
--- a/build-tests-samples/heft-storybook-react-tutorial/config/heft.json
+++ b/build-tests-samples/heft-storybook-react-tutorial/config/heft.json
@@ -39,7 +39,9 @@
"pluginPackage": "@rushstack/heft-storybook-plugin",
"options": {
"storykitPackageName": "heft-storybook-react-tutorial-storykit",
- "startupModulePath": "@storybook/react/bin/index.js"
+ "startupModulePath": "@storybook/react/bin/index.js",
+ "staticBuildModulePath": "@storybook/react/bin/build.js",
+ "staticBuildOutputFolder": "static-build-dir"
}
}
}
diff --git a/build-tests-samples/heft-storybook-react-tutorial/package.json b/build-tests-samples/heft-storybook-react-tutorial/package.json
index 526894d2789..a8611ed769a 100644
--- a/build-tests-samples/heft-storybook-react-tutorial/package.json
+++ b/build-tests-samples/heft-storybook-react-tutorial/package.json
@@ -7,6 +7,7 @@
"build": "heft build --clean",
"start": "heft start",
"storybook": "heft start --storybook",
+ "build-storybook": "heft build --storybook",
"_phase:build": "heft run --only build -- --clean",
"_phase:test": "heft run --only test -- --clean"
},
@@ -16,6 +17,7 @@
"tslib": "~2.3.1"
},
"devDependencies": {
+ "@babel/core": "~7.20.0",
"@rushstack/eslint-config": "workspace:*",
"@rushstack/heft-jest-plugin": "workspace:*",
"@rushstack/heft-lint-plugin": "workspace:*",
@@ -23,10 +25,12 @@
"@rushstack/heft-typescript-plugin": "workspace:*",
"@rushstack/heft-webpack4-plugin": "workspace:*",
"@rushstack/heft": "workspace:*",
+ "@storybook/react": "~6.4.18",
"@types/heft-jest": "1.0.1",
+ "@types/node": "14.18.36",
"@types/react-dom": "16.9.14",
"@types/react": "16.14.23",
- "@types/webpack-env": "1.13.0",
+ "@types/webpack-env": "1.18.0",
"css-loader": "~5.2.7",
"eslint": "~8.7.0",
"heft-storybook-react-tutorial-storykit": "workspace:*",
diff --git a/build-tests-samples/heft-web-rig-app-tutorial/package.json b/build-tests-samples/heft-web-rig-app-tutorial/package.json
index 406533dbb58..07530147c38 100644
--- a/build-tests-samples/heft-web-rig-app-tutorial/package.json
+++ b/build-tests-samples/heft-web-rig-app-tutorial/package.json
@@ -21,7 +21,7 @@
"@rushstack/heft": "workspace:*",
"@types/react-dom": "16.9.14",
"@types/react": "16.14.23",
- "@types/webpack-env": "1.13.0",
+ "@types/webpack-env": "1.18.0",
"typescript": "~4.8.4"
}
}
diff --git a/build-tests-samples/heft-web-rig-library-tutorial/package.json b/build-tests-samples/heft-web-rig-library-tutorial/package.json
index 81861b302f8..076806ade1d 100644
--- a/build-tests-samples/heft-web-rig-library-tutorial/package.json
+++ b/build-tests-samples/heft-web-rig-library-tutorial/package.json
@@ -23,7 +23,7 @@
"@rushstack/heft": "workspace:*",
"@types/react-dom": "16.9.14",
"@types/react": "16.14.23",
- "@types/webpack-env": "1.13.0",
+ "@types/webpack-env": "1.18.0",
"typescript": "~4.8.4"
}
}
diff --git a/build-tests-samples/heft-webpack-basic-tutorial/package.json b/build-tests-samples/heft-webpack-basic-tutorial/package.json
index b318ce59716..3544123ffb2 100644
--- a/build-tests-samples/heft-webpack-basic-tutorial/package.json
+++ b/build-tests-samples/heft-webpack-basic-tutorial/package.json
@@ -24,13 +24,13 @@
"@types/heft-jest": "1.0.1",
"@types/react-dom": "16.9.14",
"@types/react": "16.14.23",
- "@types/webpack-env": "1.13.0",
+ "@types/webpack-env": "1.18.0",
"css-loader": "~6.6.0",
"eslint": "~8.7.0",
"html-webpack-plugin": "~5.5.0",
"source-map-loader": "~3.0.1",
"style-loader": "~3.3.1",
"typescript": "~4.8.4",
- "webpack": "~5.68.0"
+ "webpack": "~5.75.0"
}
}
diff --git a/build-tests-samples/packlets-tutorial/package.json b/build-tests-samples/packlets-tutorial/package.json
index 04854433427..4fb672fd3c1 100644
--- a/build-tests-samples/packlets-tutorial/package.json
+++ b/build-tests-samples/packlets-tutorial/package.json
@@ -14,7 +14,7 @@
"@rushstack/heft": "workspace:*",
"@rushstack/heft-lint-plugin": "workspace:*",
"@rushstack/heft-typescript-plugin": "workspace:*",
- "@types/node": "12.20.24",
+ "@types/node": "14.18.36",
"eslint": "~8.7.0",
"typescript": "~4.8.4"
}
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/api-documenter-scenarios.api.json b/build-tests/api-documenter-scenarios/etc/inheritedMembers/api-documenter-scenarios.api.json
index 0d12ea0af06..9118d0a598f 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/api-documenter-scenarios.api.json
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/api-documenter-scenarios.api.json
@@ -2,7 +2,7 @@
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "[test mode]",
- "schemaVersion": 1010,
+ "schemaVersion": 1011,
"oldestForwardsCompatibleVersion": 1001,
"tsdocConfig": {
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
@@ -197,6 +197,7 @@
],
"fileUrlPath": "src/inheritedMembers/index.ts",
"releaseTag": "Public",
+ "isAbstract": false,
"name": "Class1",
"preserveMemberOrder": false,
"members": [
@@ -227,7 +228,8 @@
"endIndex": 2
},
"isStatic": false,
- "isProtected": false
+ "isProtected": false,
+ "isAbstract": false
},
{
"kind": "Property",
@@ -256,7 +258,8 @@
"endIndex": 2
},
"isStatic": false,
- "isProtected": false
+ "isProtected": false,
+ "isAbstract": false
},
{
"kind": "Method",
@@ -303,6 +306,7 @@
}
],
"isOptional": false,
+ "isAbstract": false,
"name": "someOverload"
}
],
@@ -346,6 +350,7 @@
}
}
],
+ "isAbstract": false,
"name": "Class2",
"preserveMemberOrder": false,
"members": [
@@ -376,7 +381,8 @@
"endIndex": 2
},
"isStatic": false,
- "isProtected": false
+ "isProtected": false,
+ "isAbstract": false
},
{
"kind": "Method",
@@ -423,6 +429,7 @@
}
],
"isOptional": false,
+ "isAbstract": false,
"name": "someMethod"
},
{
@@ -452,7 +459,8 @@
"endIndex": 2
},
"isStatic": false,
- "isProtected": false
+ "isProtected": false,
+ "isAbstract": false
}
],
"extendsTokenRange": {
@@ -505,6 +513,7 @@
],
"fileUrlPath": "src/inheritedMembers/index.ts",
"releaseTag": "Public",
+ "isAbstract": false,
"name": "ExtendsAnonymousClass",
"preserveMemberOrder": false,
"members": [],
@@ -535,6 +544,7 @@
],
"fileUrlPath": "src/inheritedMembers/index.ts",
"releaseTag": "Public",
+ "isAbstract": false,
"name": "ExtendsClassFromAnotherPackage",
"preserveMemberOrder": false,
"members": [],
@@ -565,6 +575,7 @@
],
"fileUrlPath": "src/inheritedMembers/index.ts",
"releaseTag": "Public",
+ "isAbstract": false,
"name": "ExtendsClassLikeVariable",
"preserveMemberOrder": false,
"members": [],
@@ -595,6 +606,7 @@
],
"fileUrlPath": "src/inheritedMembers/index.ts",
"releaseTag": "Public",
+ "isAbstract": false,
"name": "ExtendsUnexportedClass",
"preserveMemberOrder": false,
"members": [],
@@ -916,6 +928,7 @@
}
],
"releaseTag": "Public",
+ "isAbstract": false,
"name": "Class3",
"preserveMemberOrder": false,
"members": [
@@ -964,6 +977,7 @@
}
],
"isOptional": false,
+ "isAbstract": false,
"name": "someMethod"
},
{
@@ -1011,6 +1025,7 @@
}
],
"isOptional": false,
+ "isAbstract": false,
"name": "someOverload"
},
{
@@ -1058,6 +1073,7 @@
}
],
"isOptional": false,
+ "isAbstract": false,
"name": "someOverload"
},
{
@@ -1087,7 +1103,8 @@
"endIndex": 2
},
"isStatic": false,
- "isProtected": false
+ "isProtected": false,
+ "isAbstract": false
}
],
"implementsTokenRanges": []
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.fourthprop.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.fourthprop.md
index 5e54a34385e..62dca05ad18 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.fourthprop.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.fourthprop.md
@@ -6,7 +6,7 @@
A fourth prop
-Signature:
+**Signature:**
```typescript
fourthProp: number;
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.md
index 3f8e400993d..40286ceedb2 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.md
@@ -5,12 +5,12 @@
## Class1 class
-Signature:
+**Signature:**
```typescript
export declare class Class1 extends Class2
```
-Extends: [Class2](./api-documenter-scenarios.class2.md)<number>
+**Extends:** [Class2](./api-documenter-scenarios.class2.md)<number>
## Properties
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.secondprop.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.secondprop.md
index 88d937932c6..d45f01c74dd 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.secondprop.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.secondprop.md
@@ -6,7 +6,7 @@
A second prop. Overrides `Class2.secondProp`.
-Signature:
+**Signature:**
```typescript
secondProp: boolean;
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.someoverload.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.someoverload.md
index 4d3c6e4e0c0..43cd1dcb975 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.someoverload.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.someoverload.md
@@ -6,7 +6,7 @@
Some overload. Overrides `Class3.someOverload`.
-Signature:
+**Signature:**
```typescript
someOverload(x: boolean | string): void;
@@ -18,7 +18,7 @@ someOverload(x: boolean | string): void;
| --- | --- | --- |
| x | boolean \| string | |
-Returns:
+**Returns:**
void
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.md
index ed505536b4c..64d21d6aaf7 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.md
@@ -5,12 +5,12 @@
## Class2 class
-Signature:
+**Signature:**
```typescript
export declare class Class2 extends Namespace1.Class3
```
-Extends: [Namespace1.Class3](./api-documenter-scenarios.namespace1.class3.md)
+**Extends:** [Namespace1.Class3](./api-documenter-scenarios.namespace1.class3.md)
## Properties
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.secondprop.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.secondprop.md
index 3cd6d33ddf1..d27bd64612a 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.secondprop.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.secondprop.md
@@ -6,7 +6,7 @@
A second prop.
-Signature:
+**Signature:**
```typescript
secondProp: boolean | string;
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.somemethod.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.somemethod.md
index 76593e3305b..804fa09c005 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.somemethod.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.somemethod.md
@@ -6,7 +6,7 @@
Some method. Overrides `Class3.someMethod`.
-Signature:
+**Signature:**
```typescript
someMethod(x: boolean): void;
@@ -18,7 +18,7 @@ someMethod(x: boolean): void;
| --- | --- | --- |
| x | boolean | |
-Returns:
+**Returns:**
void
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.thirdprop.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.thirdprop.md
index c9e77cd20b1..601018a30fc 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.thirdprop.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.thirdprop.md
@@ -6,7 +6,7 @@
A third prop.
-Signature:
+**Signature:**
```typescript
thirdProp: T;
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.classlikevariable.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.classlikevariable.md
index f1511fa4620..cc7788ea1fb 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.classlikevariable.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.classlikevariable.md
@@ -6,7 +6,7 @@
Some class-like variable.
-Signature:
+**Signature:**
```typescript
ClassLikeVariable: {
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.extendsanonymousclass.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.extendsanonymousclass.md
index 097aad9a4d2..5deec45ca0d 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.extendsanonymousclass.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.extendsanonymousclass.md
@@ -6,12 +6,12 @@
Some class that extends an anonymous class.
-Signature:
+**Signature:**
```typescript
export declare class ExtendsAnonymousClass extends ExtendsAnonymousClass_base
```
-Extends: ExtendsAnonymousClass\_base
+**Extends:** ExtendsAnonymousClass\_base
-(Some inherited members may not be shown because they are not represented in the documentation.)
+_(Some inherited members may not be shown because they are not represented in the documentation.)_
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.extendsclassfromanotherpackage.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.extendsclassfromanotherpackage.md
index a920ca7732c..9e92e1877a7 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.extendsclassfromanotherpackage.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.extendsclassfromanotherpackage.md
@@ -6,12 +6,12 @@
Some class that extends a class from another package. This base class is not in any API doc model.
-Signature:
+**Signature:**
```typescript
export declare class ExtendsClassFromAnotherPackage extends Extractor
```
-Extends: Extractor
+**Extends:** Extractor
-(Some inherited members may not be shown because they are not represented in the documentation.)
+_(Some inherited members may not be shown because they are not represented in the documentation.)_
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.extendsclasslikevariable.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.extendsclasslikevariable.md
index ce358851bfa..2681786e781 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.extendsclasslikevariable.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.extendsclasslikevariable.md
@@ -6,12 +6,12 @@
Some class that extends a class-like variable.
-Signature:
+**Signature:**
```typescript
export declare class ExtendsClassLikeVariable extends ClassLikeVariable
```
-Extends: ClassLikeVariable
+**Extends:** ClassLikeVariable
-(Some inherited members may not be shown because they are not represented in the documentation.)
+_(Some inherited members may not be shown because they are not represented in the documentation.)_
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.extendsunexportedclass.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.extendsunexportedclass.md
index 355d9611d44..f7c3a288137 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.extendsunexportedclass.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.extendsunexportedclass.md
@@ -6,12 +6,12 @@
Some class that extends an unexported class.
-Signature:
+**Signature:**
```typescript
export declare class ExtendsUnexportedClass extends UnexportedClass
```
-Extends: UnexportedClass
+**Extends:** UnexportedClass
-(Some inherited members may not be shown because they are not represented in the documentation.)
+_(Some inherited members may not be shown because they are not represented in the documentation.)_
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsinterfaceliketypealias.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsinterfaceliketypealias.md
index ddf3ffe6f3e..d7b01f76490 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsinterfaceliketypealias.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsinterfaceliketypealias.md
@@ -6,14 +6,14 @@
Some interface that extends an interface-like type alias as well as another interface.
-Signature:
+**Signature:**
```typescript
export interface IExtendsInterfaceLikeTypeAlias extends IInterfaceLikeTypeAlias, IInterface1
```
-Extends: [IInterfaceLikeTypeAlias](./api-documenter-scenarios.iinterfaceliketypealias.md), [IInterface1](./api-documenter-scenarios.iinterface1.md)
+**Extends:** [IInterfaceLikeTypeAlias](./api-documenter-scenarios.iinterfaceliketypealias.md), [IInterface1](./api-documenter-scenarios.iinterface1.md)
-(Some inherited members may not be shown because they are not represented in the documentation.)
+_(Some inherited members may not be shown because they are not represented in the documentation.)_
## Properties
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsmultipleinterfaces.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsmultipleinterfaces.md
index 77e1c48bca6..100c750a17c 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsmultipleinterfaces.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsmultipleinterfaces.md
@@ -6,12 +6,12 @@
Some interface that extends multiple interfaces.
-Signature:
+**Signature:**
```typescript
export interface IExtendsMultipleInterfaces extends IInterface1, IInterface2
```
-Extends: [IInterface1](./api-documenter-scenarios.iinterface1.md), [IInterface2](./api-documenter-scenarios.iinterface2.md)
+**Extends:** [IInterface1](./api-documenter-scenarios.iinterface1.md), [IInterface2](./api-documenter-scenarios.iinterface2.md)
## Properties
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsmultipleinterfaces.secondprop.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsmultipleinterfaces.secondprop.md
index 5a9fb3b83fa..a9ac71ab095 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsmultipleinterfaces.secondprop.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsmultipleinterfaces.secondprop.md
@@ -6,7 +6,7 @@
A second prop. Overrides `IInterface1.someProp`.
-Signature:
+**Signature:**
```typescript
secondProp: boolean;
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsmultipleinterfaces.thirdprop.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsmultipleinterfaces.thirdprop.md
index 835f41f7860..d522140c0a5 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsmultipleinterfaces.thirdprop.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsmultipleinterfaces.thirdprop.md
@@ -6,7 +6,7 @@
A third prop.
-Signature:
+**Signature:**
```typescript
thirdProp: string;
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface1.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface1.md
index 7ec58265781..f3fa0933e54 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface1.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface1.md
@@ -5,7 +5,7 @@
## IInterface1 interface
-Signature:
+**Signature:**
```typescript
export interface IInterface1
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface1.secondprop.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface1.secondprop.md
index 05ce9c31e1e..f7e8fe6c40e 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface1.secondprop.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface1.secondprop.md
@@ -6,7 +6,7 @@
A second prop.
-Signature:
+**Signature:**
```typescript
secondProp: boolean | string;
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface1.someprop.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface1.someprop.md
index da41c88728e..fa9cbf2a012 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface1.someprop.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface1.someprop.md
@@ -6,7 +6,7 @@
Some prop.
-Signature:
+**Signature:**
```typescript
someProp: number;
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface2.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface2.md
index 4816e2799d3..32a50b5ce2c 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface2.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface2.md
@@ -5,7 +5,7 @@
## IInterface2 interface
-Signature:
+**Signature:**
```typescript
export interface IInterface2
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface2.someprop.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface2.someprop.md
index 4079ad6f63f..bbd551ac110 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface2.someprop.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface2.someprop.md
@@ -6,7 +6,7 @@
Some prop.
-Signature:
+**Signature:**
```typescript
someProp: number;
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterfaceliketypealias.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterfaceliketypealias.md
index adb92231563..35892b1be67 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterfaceliketypealias.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterfaceliketypealias.md
@@ -6,7 +6,7 @@
Some interface-like type alias.
-Signature:
+**Signature:**
```typescript
export declare type IInterfaceLikeTypeAlias = {
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.md
index a5014d799fc..8167ea6c94f 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.md
@@ -5,7 +5,7 @@
## Namespace1.Class3 class
-Signature:
+**Signature:**
```typescript
class Class3
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.somemethod.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.somemethod.md
index 4975757832e..4e729cc2d18 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.somemethod.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.somemethod.md
@@ -6,7 +6,7 @@
Some method.
-Signature:
+**Signature:**
```typescript
someMethod(x: boolean | string): void;
@@ -18,7 +18,7 @@ someMethod(x: boolean | string): void;
| --- | --- | --- |
| x | boolean \| string | |
-Returns:
+**Returns:**
void
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.someoverload.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.someoverload.md
index 23b0f47ddd0..4824c88c162 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.someoverload.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.someoverload.md
@@ -6,7 +6,7 @@
Some overload.
-Signature:
+**Signature:**
```typescript
someOverload(x: boolean): void;
@@ -18,7 +18,7 @@ someOverload(x: boolean): void;
| --- | --- | --- |
| x | boolean | |
-Returns:
+**Returns:**
void
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.someoverload_1.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.someoverload_1.md
index cc9cc6b5006..71b607dc325 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.someoverload_1.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.someoverload_1.md
@@ -6,7 +6,7 @@
Some overload.
-Signature:
+**Signature:**
```typescript
someOverload(x: string): void;
@@ -18,7 +18,7 @@ someOverload(x: string): void;
| --- | --- | --- |
| x | string | |
-Returns:
+**Returns:**
void
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.someprop.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.someprop.md
index 2083e377c19..651df68d102 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.someprop.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.someprop.md
@@ -6,7 +6,7 @@
Some prop.
-Signature:
+**Signature:**
```typescript
someProp: number;
diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.md
index 3e8b7e5051b..c7956bcc7a5 100644
--- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.md
+++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.md
@@ -5,7 +5,7 @@
## Namespace1 namespace
-Signature:
+**Signature:**
```typescript
export declare namespace Namespace1
diff --git a/build-tests/api-documenter-scenarios/package.json b/build-tests/api-documenter-scenarios/package.json
index 7a69c215508..b57ca02f3b7 100644
--- a/build-tests/api-documenter-scenarios/package.json
+++ b/build-tests/api-documenter-scenarios/package.json
@@ -14,7 +14,7 @@
"@microsoft/teams-js": "1.3.0-beta.4",
"@rushstack/node-core-library": "workspace:*",
"@types/jest": "29.2.5",
- "@types/node": "12.20.24",
+ "@types/node": "14.18.36",
"fs-extra": "~7.0.1",
"typescript": "~4.8.4"
}
diff --git a/build-tests/api-documenter-test/etc/api-documenter-test.api.json b/build-tests/api-documenter-test/etc/api-documenter-test.api.json
index a6ad887b50a..4b8d0a7951b 100644
--- a/build-tests/api-documenter-test/etc/api-documenter-test.api.json
+++ b/build-tests/api-documenter-test/etc/api-documenter-test.api.json
@@ -2,7 +2,7 @@
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "[test mode]",
- "schemaVersion": 1010,
+ "schemaVersion": 1011,
"oldestForwardsCompatibleVersion": 1001,
"tsdocConfig": {
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
@@ -182,6 +182,86 @@
"name": "",
"preserveMemberOrder": false,
"members": [
+ {
+ "kind": "Class",
+ "canonicalReference": "api-documenter-test!AbstractClass:class",
+ "docComment": "/**\n * Some abstract class with abstract members.\n *\n * @public\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "export declare abstract class AbstractClass "
+ }
+ ],
+ "fileUrlPath": "src/AbstractClass.ts",
+ "releaseTag": "Public",
+ "isAbstract": true,
+ "name": "AbstractClass",
+ "preserveMemberOrder": false,
+ "members": [
+ {
+ "kind": "Method",
+ "canonicalReference": "api-documenter-test!AbstractClass#method:member(1)",
+ "docComment": "/**\n * Some abstract method.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "abstract method(): "
+ },
+ {
+ "kind": "Content",
+ "text": "void"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isStatic": false,
+ "returnTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "releaseTag": "Public",
+ "isProtected": false,
+ "overloadIndex": 1,
+ "parameters": [],
+ "isOptional": false,
+ "isAbstract": true,
+ "name": "method"
+ },
+ {
+ "kind": "Property",
+ "canonicalReference": "api-documenter-test!AbstractClass#property:member",
+ "docComment": "/**\n * Some abstract property.\n */\n",
+ "excerptTokens": [
+ {
+ "kind": "Content",
+ "text": "protected abstract property: "
+ },
+ {
+ "kind": "Content",
+ "text": "number"
+ },
+ {
+ "kind": "Content",
+ "text": ";"
+ }
+ ],
+ "isReadonly": false,
+ "isOptional": false,
+ "releaseTag": "Public",
+ "name": "property",
+ "propertyTypeTokenRange": {
+ "startIndex": 1,
+ "endIndex": 2
+ },
+ "isStatic": false,
+ "isProtected": true,
+ "isAbstract": true
+ }
+ ],
+ "implementsTokenRanges": []
+ },
{
"kind": "Interface",
"canonicalReference": "api-documenter-test!Constraint:interface",
@@ -234,6 +314,7 @@
],
"fileUrlPath": "src/DecoratorExample.ts",
"releaseTag": "Public",
+ "isAbstract": false,
"name": "DecoratorExample",
"preserveMemberOrder": false,
"members": [
@@ -265,7 +346,8 @@
"endIndex": 2
},
"isStatic": false,
- "isProtected": false
+ "isProtected": false,
+ "isAbstract": false
}
],
"implementsTokenRanges": []
@@ -299,6 +381,7 @@
],
"fileUrlPath": "src/DocClass1.ts",
"releaseTag": "Public",
+ "isAbstract": false,
"name": "DocBaseClass",
"preserveMemberOrder": false,
"members": [
@@ -391,6 +474,7 @@
],
"fileUrlPath": "src/DocClass1.ts",
"releaseTag": "Public",
+ "isAbstract": false,
"name": "DocClass1",
"preserveMemberOrder": false,
"members": [
@@ -422,6 +506,7 @@
"overloadIndex": 1,
"parameters": [],
"isOptional": false,
+ "isAbstract": false,
"name": "deprecatedExample"
},
{
@@ -485,6 +570,7 @@
}
],
"isOptional": false,
+ "isAbstract": false,
"name": "exampleFunction"
},
{
@@ -532,6 +618,7 @@
}
],
"isOptional": false,
+ "isAbstract": false,
"name": "exampleFunction"
},
{
@@ -610,6 +697,7 @@
}
],
"isOptional": false,
+ "isAbstract": false,
"name": "genericWithConstraintAndDefault"
},
{
@@ -640,6 +728,7 @@
"overloadIndex": 1,
"parameters": [],
"isOptional": false,
+ "isAbstract": false,
"name": "interestingEdgeCases"
},
{
@@ -670,7 +759,8 @@
"endIndex": 2
},
"isStatic": false,
- "isProtected": false
+ "isProtected": false,
+ "isAbstract": false
},
{
"kind": "Property",
@@ -700,7 +790,8 @@
"endIndex": 2
},
"isStatic": false,
- "isProtected": false
+ "isProtected": false,
+ "isAbstract": false
},
{
"kind": "Property",
@@ -729,7 +820,8 @@
"endIndex": 2
},
"isStatic": true,
- "isProtected": true
+ "isProtected": true,
+ "isAbstract": false
},
{
"kind": "Method",
@@ -776,6 +868,7 @@
}
],
"isOptional": false,
+ "isAbstract": false,
"name": "optionalParamFunction"
},
{
@@ -805,7 +898,8 @@
"endIndex": 2
},
"isStatic": false,
- "isProtected": true
+ "isProtected": true,
+ "isAbstract": false
},
{
"kind": "Property",
@@ -834,7 +928,8 @@
"endIndex": 2
},
"isStatic": false,
- "isProtected": false
+ "isProtected": false,
+ "isAbstract": false
},
{
"kind": "Property",
@@ -864,7 +959,8 @@
"endIndex": 2
},
"isStatic": false,
- "isProtected": false
+ "isProtected": false,
+ "isAbstract": false
},
{
"kind": "Method",
@@ -927,6 +1023,7 @@
}
],
"isOptional": false,
+ "isAbstract": false,
"name": "sumWithExample"
},
{
@@ -957,6 +1054,7 @@
"overloadIndex": 1,
"parameters": [],
"isOptional": false,
+ "isAbstract": false,
"name": "tableExample"
},
{
@@ -986,7 +1084,8 @@
"endIndex": 2
},
"isStatic": false,
- "isProtected": false
+ "isProtected": false,
+ "isAbstract": false
},
{
"kind": "Property",
@@ -1015,7 +1114,8 @@
"endIndex": 2
},
"isStatic": false,
- "isProtected": false
+ "isProtected": false,
+ "isAbstract": false
}
],
"extendsTokenRange": {
@@ -1045,6 +1145,7 @@
],
"fileUrlPath": "src/DocClass1.ts",
"releaseTag": "Public",
+ "isAbstract": false,
"name": "DocClassInterfaceMerge",
"preserveMemberOrder": false,
"members": [],
@@ -1480,6 +1581,7 @@
}
}
],
+ "isAbstract": false,
"name": "Generic",
"preserveMemberOrder": false,
"members": [],
@@ -2561,6 +2663,7 @@
],
"fileUrlPath": "src/DocClass1.ts",
"releaseTag": "Public",
+ "isAbstract": false,
"name": "SystemEvent",
"preserveMemberOrder": false,
"members": [
@@ -2609,6 +2712,7 @@
}
],
"isOptional": false,
+ "isAbstract": false,
"name": "addHandler"
}
],
diff --git a/build-tests/api-documenter-test/etc/api-documenter-test.api.md b/build-tests/api-documenter-test/etc/api-documenter-test.api.md
index 22fa1fef52d..18bab020adb 100644
--- a/build-tests/api-documenter-test/etc/api-documenter-test.api.md
+++ b/build-tests/api-documenter-test/etc/api-documenter-test.api.md
@@ -4,6 +4,12 @@
```ts
+// @public
+export abstract class AbstractClass {
+ abstract method(): void;
+ protected abstract property: number;
+}
+
// @public
export interface Constraint {
}
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.abstractclass.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.abstractclass.md
new file mode 100644
index 00000000000..eb8ca6923d4
--- /dev/null
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.abstractclass.md
@@ -0,0 +1,26 @@
+
+
+[Home](./index.md) > [api-documenter-test](./api-documenter-test.md) > [AbstractClass](./api-documenter-test.abstractclass.md)
+
+## AbstractClass class
+
+Some abstract class with abstract members.
+
+**Signature:**
+
+```typescript
+export declare abstract class AbstractClass
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [property](./api-documenter-test.abstractclass.property.md) | (x: T): void;
@@ -18,7 +18,7 @@ genericWithConstraintAndDefault(x: T): void;
| --- | --- | --- |
| x | T | some generic parameter. |
-Returns:
+**Returns:**
void
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.interestingedgecases.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.interestingedgecases.md
index dac3180381c..d38c8881388 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.interestingedgecases.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.interestingedgecases.md
@@ -8,12 +8,12 @@ Example: "{ \\"maxItemsToShow\\": 123 }"
The regular expression used to validate the constraints is /^\[a-zA-Z0-9\\-\_\]+$/
-Signature:
+**Signature:**
```typescript
interestingEdgeCases(): void;
```
-Returns:
+**Returns:**
void
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.malformedevent.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.malformedevent.md
index 8f399f0611b..d5366273cce 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.malformedevent.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.malformedevent.md
@@ -6,7 +6,7 @@
This event should have been marked as readonly.
-Signature:
+**Signature:**
```typescript
malformedEvent: SystemEvent;
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.md
index 4ae28213699..5a0a095b7e4 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.md
@@ -6,14 +6,14 @@
This is an example class.
-Signature:
+**Signature:**
```typescript
export declare class DocClass1 extends DocBaseClass implements IDocInterface1, IDocInterface2
```
-Extends: [DocBaseClass](./api-documenter-test.docbaseclass.md)
+**Extends:** [DocBaseClass](./api-documenter-test.docbaseclass.md)
-Implements: [IDocInterface1](./api-documenter-test.idocinterface1.md), [IDocInterface2](./api-documenter-test.idocinterface2.md)
+**Implements:** [IDocInterface1](./api-documenter-test.idocinterface1.md), [IDocInterface2](./api-documenter-test.idocinterface2.md)
## Remarks
@@ -35,7 +35,7 @@ The constructor for this class is marked as internal. Third-party code should no
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
-| [multipleModifiersProperty](./api-documenter-test.docclass1.multiplemodifiersproperty.md) | ;
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.exampleuniontypealias.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.exampleuniontypealias.md
index 15ccb494423..f3caddca82e 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.exampleuniontypealias.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.exampleuniontypealias.md
@@ -6,10 +6,10 @@
A type alias that references multiple other types.
-Signature:
+**Signature:**
```typescript
export declare type ExampleUnionTypeAlias = IDocInterface1 | IDocInterface3;
```
-References: [IDocInterface1](./api-documenter-test.idocinterface1.md), [IDocInterface3](./api-documenter-test.idocinterface3.md)
+**References:** [IDocInterface1](./api-documenter-test.idocinterface1.md), [IDocInterface3](./api-documenter-test.idocinterface3.md)
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.generic.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.generic.md
index 5c9289a7f71..78cadda1bb5 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.generic.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.generic.md
@@ -6,7 +6,7 @@
Generic class.
-Signature:
+**Signature:**
```typescript
export declare class Generic
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.generictypealias.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.generictypealias.md
index d0ce5a0e31e..a0104e3cb3b 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.generictypealias.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.generictypealias.md
@@ -5,7 +5,7 @@
## GenericTypeAlias type
-Signature:
+**Signature:**
```typescript
export declare type GenericTypeAlias = T[];
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface1.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface1.md
index 6c820eb9c87..077ad95bb0a 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface1.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface1.md
@@ -5,7 +5,7 @@
## IDocInterface1 interface
-Signature:
+**Signature:**
```typescript
export interface IDocInterface1
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface1.regularproperty.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface1.regularproperty.md
index 759d9b9f192..0f6a2940db8 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface1.regularproperty.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface1.regularproperty.md
@@ -6,7 +6,7 @@
Does something
-Signature:
+**Signature:**
```typescript
regularProperty: SystemEvent;
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface2.deprecatedexample.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface2.deprecatedexample.md
index 08812d228e5..e49ad4c922c 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface2.deprecatedexample.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface2.deprecatedexample.md
@@ -9,12 +9,12 @@
> Use `otherThing()` instead.
>
-Signature:
+**Signature:**
```typescript
deprecatedExample(): void;
```
-Returns:
+**Returns:**
void
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface2.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface2.md
index c945f070c7d..56c63981e8e 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface2.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface2.md
@@ -5,12 +5,12 @@
## IDocInterface2 interface
-Signature:
+**Signature:**
```typescript
export interface IDocInterface2 extends IDocInterface1
```
-Extends: [IDocInterface1](./api-documenter-test.idocinterface1.md)
+**Extends:** [IDocInterface1](./api-documenter-test.idocinterface1.md)
## Methods
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface3.__not.a.symbol__.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface3.__not.a.symbol__.md
index 0f95405605b..b6911fc3191 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface3.__not.a.symbol__.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface3.__not.a.symbol__.md
@@ -6,7 +6,7 @@
An identifier that does need quotes. It misleadingly looks like an ECMAScript symbol.
-Signature:
+**Signature:**
```typescript
"[not.a.symbol]": string;
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface3._ecmasmbols.example_.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface3._ecmasmbols.example_.md
index 756b8bf970e..40924a574db 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface3._ecmasmbols.example_.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface3._ecmasmbols.example_.md
@@ -6,7 +6,7 @@
ECMAScript symbol
-Signature:
+**Signature:**
```typescript
[EcmaSmbols.example]: string;
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface3._new_.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface3._new_.md
index 991a58d3a75..8e5092862e7 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface3._new_.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface3._new_.md
@@ -6,12 +6,12 @@
Construct signature
-Signature:
+**Signature:**
```typescript
new (): IDocInterface1;
```
-Returns:
+**Returns:**
[IDocInterface1](./api-documenter-test.idocinterface1.md)
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface3.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface3.md
index 0bff0e7ba91..94e789746c8 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface3.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface3.md
@@ -7,7 +7,7 @@
Some less common TypeScript declaration kinds.
-Signature:
+**Signature:**
```typescript
export interface IDocInterface3
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface3.redundantquotes.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface3.redundantquotes.md
index d777ba79b49..436d698afd1 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface3.redundantquotes.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface3.redundantquotes.md
@@ -6,7 +6,7 @@
A quoted identifier with redundant quotes.
-Signature:
+**Signature:**
```typescript
"redundantQuotes": string;
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface4.context.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface4.context.md
index 325f354140b..9401520b9b0 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface4.context.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface4.context.md
@@ -6,7 +6,7 @@
Test newline rendering when code blocks are used in tables
-Signature:
+**Signature:**
```typescript
Context: ({ children }: {
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface4.generic.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface4.generic.md
index 7391c2def0b..ea1eb271b11 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface4.generic.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface4.generic.md
@@ -6,7 +6,7 @@
make sure html entities are escaped in tables.
-Signature:
+**Signature:**
```typescript
generic: Generic;
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface4.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface4.md
index c57e796aee0..94eaaf0b17a 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface4.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface4.md
@@ -7,7 +7,7 @@
Type union in an interface.
-Signature:
+**Signature:**
```typescript
export interface IDocInterface4
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface4.numberorfunction.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface4.numberorfunction.md
index e36e91fd338..50e32926ea2 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface4.numberorfunction.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface4.numberorfunction.md
@@ -6,7 +6,7 @@
a union type with a function
-Signature:
+**Signature:**
```typescript
numberOrFunction: number | (() => number);
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface4.stringornumber.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface4.stringornumber.md
index 814dd1faeb7..cf2a3c0d630 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface4.stringornumber.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface4.stringornumber.md
@@ -6,7 +6,7 @@
a union type
-Signature:
+**Signature:**
```typescript
stringOrNumber: string | number;
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface5.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface5.md
index 9053af2cfba..96de72c48b2 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface5.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface5.md
@@ -6,7 +6,7 @@
Interface without inline tag to test custom TOC
-Signature:
+**Signature:**
```typescript
export interface IDocInterface5
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface5.regularproperty.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface5.regularproperty.md
index 903ec43e4df..0db8715b972 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface5.regularproperty.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface5.regularproperty.md
@@ -6,7 +6,7 @@
Property of type string that does something
-Signature:
+**Signature:**
```typescript
regularProperty: string;
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.arrayproperty.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.arrayproperty.md
index aee7a495e71..40dccacfec2 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.arrayproperty.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.arrayproperty.md
@@ -4,7 +4,7 @@
## IDocInterface6.arrayProperty property
-Signature:
+**Signature:**
```typescript
arrayProperty: IDocInterface1[];
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.genericreferencemethod.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.genericreferencemethod.md
index 5aafced4331..f4b1091b493 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.genericreferencemethod.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.genericreferencemethod.md
@@ -4,7 +4,7 @@
## IDocInterface6.genericReferenceMethod() method
-Signature:
+**Signature:**
```typescript
genericReferenceMethod(x: T): T;
@@ -16,7 +16,7 @@ genericReferenceMethod(x: T): T;
| --- | --- | --- |
| x | T | |
-Returns:
+**Returns:**
T
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.intersectionproperty.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.intersectionproperty.md
index ba405892095..0487eada5e2 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.intersectionproperty.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.intersectionproperty.md
@@ -4,7 +4,7 @@
## IDocInterface6.intersectionProperty property
-Signature:
+**Signature:**
```typescript
intersectionProperty: IDocInterface1 & IDocInterface2;
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.md
index b9d96a22ed8..9a38896d932 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.md
@@ -6,7 +6,7 @@
Interface without inline tag to test custom TOC with injection
-Signature:
+**Signature:**
```typescript
export interface IDocInterface6
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.regularproperty.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.regularproperty.md
index 2160d81ba49..ac13117a377 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.regularproperty.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.regularproperty.md
@@ -6,7 +6,7 @@
Property of type number that does something
-Signature:
+**Signature:**
```typescript
regularProperty: number;
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.tupleproperty.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.tupleproperty.md
index c1732ee3106..8f0627e8d6e 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.tupleproperty.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.tupleproperty.md
@@ -4,7 +4,7 @@
## IDocInterface6.tupleProperty property
-Signature:
+**Signature:**
```typescript
tupleProperty: [IDocInterface1, IDocInterface2];
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.typereferenceproperty.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.typereferenceproperty.md
index f6df24d6005..d265dc5b78b 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.typereferenceproperty.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.typereferenceproperty.md
@@ -4,7 +4,7 @@
## IDocInterface6.typeReferenceProperty property
-Signature:
+**Signature:**
```typescript
typeReferenceProperty: Generic;
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.unionproperty.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.unionproperty.md
index 35139d8a9b8..1e364da532b 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.unionproperty.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface6.unionproperty.md
@@ -4,7 +4,7 @@
## IDocInterface6.unionProperty property
-Signature:
+**Signature:**
```typescript
unionProperty: IDocInterface1 | IDocInterface2;
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface7.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface7.md
index 39f6bb81fea..fc66ce93d27 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface7.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface7.md
@@ -6,7 +6,7 @@
Interface for testing optional properties
-Signature:
+**Signature:**
```typescript
export interface IDocInterface7
@@ -16,13 +16,13 @@ export interface IDocInterface7
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
-| [optionalField?](./api-documenter-test.idocinterface7.optionalfield.md) | | boolean | (Optional) Description of optionalField |
-| [optionalReadonlyField?](./api-documenter-test.idocinterface7.optionalreadonlyfield.md) | (baseClass: TBaseClass): TBaseClass & (new (...args: any[]) => ApiAbstractMixin);
+
+// @public
+export interface ApiAbstractMixin extends ApiItem {
+ readonly isAbstract: boolean;
+ // Warning: (ae-forgotten-export) The symbol "IApiItemJson" needs to be exported by the entry point index.d.ts
+ //
+ // (undocumented)
+ serializeInto(jsonObject: Partial): void;
+}
+
+// @public
+export namespace ApiAbstractMixin {
+ export function isBaseClassOf(apiItem: ApiItem): apiItem is ApiAbstractMixin;
+}
+
// Warning: (ae-forgotten-export) The symbol "ApiCallSignature_base" needs to be exported by the entry point index.d.ts
//
// @public
@@ -115,8 +132,6 @@ export class ApiDeclaredItem extends ApiDocumentedItem {
// @public
export class ApiDocumentedItem extends ApiItem {
constructor(options: IApiDocumentedItemOptions);
- // Warning: (ae-forgotten-export) The symbol "IApiItemJson" needs to be exported by the entry point index.d.ts
- //
// @override (undocumented)
static onDeserializeInto(options: Partial, context: DeserializerContext, jsonObject: IApiItemJson): void;
// Warning: (ae-forgotten-export) The symbol "IApiDocumentedItemJson" needs to be exported by the entry point index.d.ts
@@ -727,12 +742,18 @@ export class HeritageType {
readonly excerpt: Excerpt;
}
+// @public
+export interface IApiAbstractMixinOptions extends IApiItemOptions {
+ // (undocumented)
+ isAbstract: boolean;
+}
+
// @public
export interface IApiCallSignatureOptions extends IApiTypeParameterListMixinOptions, IApiParameterListMixinOptions, IApiReleaseTagMixinOptions, IApiReturnTypeMixinOptions, IApiDeclaredItemOptions {
}
// @public
-export interface IApiClassOptions extends IApiItemContainerMixinOptions, IApiNameMixinOptions, IApiReleaseTagMixinOptions, IApiDeclaredItemOptions, IApiTypeParameterListMixinOptions, IApiExportedMixinOptions {
+export interface IApiClassOptions extends IApiItemContainerMixinOptions, IApiNameMixinOptions, IApiAbstractMixinOptions, IApiReleaseTagMixinOptions, IApiDeclaredItemOptions, IApiTypeParameterListMixinOptions, IApiExportedMixinOptions {
// (undocumented)
extendsTokenRange: IExcerptTokenRange | undefined;
// (undocumented)
@@ -816,7 +837,7 @@ export interface IApiItemOptions {
}
// @public
-export interface IApiMethodOptions extends IApiNameMixinOptions, IApiOptionalMixinOptions, IApiParameterListMixinOptions, IApiProtectedMixinOptions, IApiReleaseTagMixinOptions, IApiReturnTypeMixinOptions, IApiStaticMixinOptions, IApiTypeParameterListMixinOptions, IApiDeclaredItemOptions {
+export interface IApiMethodOptions extends IApiNameMixinOptions, IApiAbstractMixinOptions, IApiOptionalMixinOptions, IApiParameterListMixinOptions, IApiProtectedMixinOptions, IApiReleaseTagMixinOptions, IApiReturnTypeMixinOptions, IApiStaticMixinOptions, IApiTypeParameterListMixinOptions, IApiDeclaredItemOptions {
}
// @public (undocumented)
@@ -879,7 +900,7 @@ export interface IApiPropertyItemOptions extends IApiNameMixinOptions, IApiRelea
}
// @public
-export interface IApiPropertyOptions extends IApiPropertyItemOptions, IApiProtectedMixinOptions, IApiStaticMixinOptions, IApiInitializerMixinOptions {
+export interface IApiPropertyOptions extends IApiPropertyItemOptions, IApiAbstractMixinOptions, IApiProtectedMixinOptions, IApiStaticMixinOptions, IApiInitializerMixinOptions {
}
// @public
diff --git a/common/reviews/api/heft-config-file.api.md b/common/reviews/api/heft-config-file.api.md
index f5d4572340d..0bda735760b 100644
--- a/common/reviews/api/heft-config-file.api.md
+++ b/common/reviews/api/heft-config-file.api.md
@@ -117,6 +117,4 @@ export enum PathResolutionMethod {
// @beta (undocumented)
export type PropertyInheritanceCustomFunction = (currentObject: TObject, parentObject: TObject) => TObject;
-// (No @packageDocumentation comment for this package)
-
```
diff --git a/common/reviews/api/heft-storybook-plugin.api.md b/common/reviews/api/heft-storybook-plugin.api.md
index 0fe6373cd61..01834ab9ec2 100644
--- a/common/reviews/api/heft-storybook-plugin.api.md
+++ b/common/reviews/api/heft-storybook-plugin.api.md
@@ -12,7 +12,9 @@ export default _default;
// @public
export interface IStorybookPluginOptions {
- startupModulePath: string;
+ startupModulePath?: string;
+ staticBuildModulePath?: string;
+ staticBuildOutputFolder?: string;
storykitPackageName: string;
}
diff --git a/common/reviews/api/heft.api.md b/common/reviews/api/heft.api.md
index 4f406086b21..7614b2d5b51 100644
--- a/common/reviews/api/heft.api.md
+++ b/common/reviews/api/heft.api.md
@@ -305,6 +305,4 @@ export class _MetricsCollector {
// @public
export type WatchGlobFn = (pattern: string | string[], options?: IGlobOptions | undefined) => Promise>;
-// (No @packageDocumentation comment for this package)
-
```
diff --git a/common/reviews/api/localization-utilities.api.md b/common/reviews/api/localization-utilities.api.md
index df7ad1e5dcf..8496e99298c 100644
--- a/common/reviews/api/localization-utilities.api.md
+++ b/common/reviews/api/localization-utilities.api.md
@@ -110,6 +110,4 @@ export class TypingsGenerator extends StringValuesTypingsGenerator {
constructor(options: ITypingsGeneratorOptions);
}
-// (No @packageDocumentation comment for this package)
-
```
diff --git a/common/reviews/api/module-minifier.api.md b/common/reviews/api/module-minifier.api.md
index ad5c23f471b..126078c517f 100644
--- a/common/reviews/api/module-minifier.api.md
+++ b/common/reviews/api/module-minifier.api.md
@@ -118,6 +118,4 @@ export class WorkerPoolMinifier implements IModuleMinifier {
minify(request: IModuleMinificationRequest, callback: IModuleMinificationCallback): void;
}
-// (No @packageDocumentation comment for this package)
-
```
diff --git a/common/reviews/api/node-core-library.api.md b/common/reviews/api/node-core-library.api.md
index 2c01fe5142c..ae22448ef35 100644
--- a/common/reviews/api/node-core-library.api.md
+++ b/common/reviews/api/node-core-library.api.md
@@ -519,6 +519,7 @@ export interface INodePackageJson {
name: string;
optionalDependencies?: IPackageJsonDependencyTable;
peerDependencies?: IPackageJsonDependencyTable;
+ peerDependenciesMeta?: IPeerDependenciesMetaTable;
private?: boolean;
repository?: string | IPackageJsonRepository;
resolutions?: Record;
@@ -599,6 +600,14 @@ export interface IPathFormatFileLocationOptions {
pathToFormat: string;
}
+// @public
+export interface IPeerDependenciesMetaTable {
+ // (undocumented)
+ [dependencyName: string]: {
+ optional?: boolean;
+ };
+}
+
// @public
export interface IProtectableMapParameters {
onClear?: (source: ProtectableMap) => void;
diff --git a/common/reviews/api/package-deps-hash.api.md b/common/reviews/api/package-deps-hash.api.md
index cd2808a61ee..def3204392e 100644
--- a/common/reviews/api/package-deps-hash.api.md
+++ b/common/reviews/api/package-deps-hash.api.md
@@ -20,7 +20,7 @@ export function getRepoChanges(currentWorkingDirectory: string, revision?: strin
export function getRepoRoot(currentWorkingDirectory: string, gitPath?: string): string;
// @beta
-export function getRepoState(currentWorkingDirectory: string, gitPath?: string): Map;
+export function getRepoStateAsync(rootDirectory: string, additionalRelativePathsToHash?: string[], gitPath?: string): Promise>;
// @beta
export interface IFileDiffStatus {
diff --git a/common/reviews/api/rush-azure-storage-build-cache-plugin.api.md b/common/reviews/api/rush-azure-storage-build-cache-plugin.api.md
index 0062151703b..15ad72b0b0f 100644
--- a/common/reviews/api/rush-azure-storage-build-cache-plugin.api.md
+++ b/common/reviews/api/rush-azure-storage-build-cache-plugin.api.md
@@ -22,7 +22,7 @@ export abstract class AzureAuthenticationBase {
// (undocumented)
protected abstract readonly _credentialNameForCache: string;
// (undocumented)
- protected abstract readonly _credentialUpdateCommandForLogging: string | undefined;
+ protected readonly _credentialUpdateCommandForLogging: string | undefined;
// (undocumented)
deleteCachedCredentialsAsync(terminal: ITerminal): Promise;
protected abstract _getCacheIdParts(): string[];
@@ -48,8 +48,6 @@ export class AzureStorageAuthentication extends AzureAuthenticationBase {
// (undocumented)
protected readonly _credentialNameForCache: string;
// (undocumented)
- protected readonly _credentialUpdateCommandForLogging: string;
- // (undocumented)
protected _getCacheIdParts(): string[];
// (undocumented)
protected _getCredentialFromDeviceCodeAsync(terminal: ITerminal, deviceCodeCredential: DeviceCodeCredential): Promise;
@@ -70,6 +68,8 @@ export type ExpiredCredentialBehavior = 'logWarning' | 'throwError' | 'ignore';
export interface IAzureAuthenticationBaseOptions {
// (undocumented)
azureEnvironment?: AzureEnvironmentName;
+ // (undocumented)
+ credentialUpdateCommandForLogging?: string | undefined;
}
// @public (undocumented)
diff --git a/common/reviews/api/rush-lib.api.md b/common/reviews/api/rush-lib.api.md
index 2a0de769dcd..cbf4bb27366 100644
--- a/common/reviews/api/rush-lib.api.md
+++ b/common/reviews/api/rush-lib.api.md
@@ -177,6 +177,7 @@ export enum EnvironmentVariableNames {
RUSH_GIT_BINARY_PATH = "RUSH_GIT_BINARY_PATH",
RUSH_GLOBAL_FOLDER = "RUSH_GLOBAL_FOLDER",
RUSH_INVOKED_FOLDER = "RUSH_INVOKED_FOLDER",
+ RUSH_LIB_PATH = "_RUSH_LIB_PATH",
RUSH_PARALLELISM = "RUSH_PARALLELISM",
RUSH_PNPM_STORE_PATH = "RUSH_PNPM_STORE_PATH",
RUSH_PNPM_VERIFY_STORE_INTEGRITY = "RUSH_PNPM_VERIFY_STORE_INTEGRITY",
@@ -262,6 +263,7 @@ export interface ICreateOperationsContext {
readonly isIncrementalBuildAllowed: boolean;
readonly isInitial: boolean;
readonly isWatch: boolean;
+ readonly phaseOriginal: ReadonlySet;
readonly phaseSelection: ReadonlySet;
readonly projectChangeAnalyzer: ProjectChangeAnalyzer;
readonly projectSelection: ReadonlySet;
@@ -304,6 +306,7 @@ export interface IExperimentsJson {
noChmodFieldInTarHeaderNormalization?: boolean;
omitImportersFromPreventManualShrinkwrapChanges?: boolean;
phasedCommands?: boolean;
+ printEventHooksOutputToConsole?: boolean;
usePnpmFrozenLockfileForRushInstall?: boolean;
usePnpmPreferFrozenLockfileForRushUpdate?: boolean;
}
@@ -389,6 +392,24 @@ export interface IOperationExecutionResult {
readonly stopwatch: IStopwatchResult;
}
+// @internal (undocumented)
+export interface _IOperationMetadata {
+ // (undocumented)
+ durationInSeconds: number;
+ // (undocumented)
+ errorLogPath: string;
+ // (undocumented)
+ logPath: string;
+}
+
+// @internal (undocumented)
+export interface _IOperationMetadataManagerOptions {
+ // (undocumented)
+ phase: IPhase;
+ // (undocumented)
+ rushProject: RushConfigurationProject;
+}
+
// @alpha
export interface IOperationOptions {
phase?: IPhase | undefined;
@@ -412,7 +433,7 @@ export interface IOperationRunnerContext {
collatedWriter: CollatedWriter;
debugMode: boolean;
// @internal
- _operationStateFile?: _OperationStateFile;
+ _operationMetadataManager?: _OperationMetadataManager;
quietMode: boolean;
stdioSummarizer: StdioSummarizer;
stopwatch: IStopwatchResult;
@@ -421,9 +442,9 @@ export interface IOperationRunnerContext {
// @internal (undocumented)
export interface _IOperationStateFileOptions {
// (undocumented)
- phase: IPhase;
+ metadataFolder: string;
// (undocumented)
- rushProject: RushConfigurationProject;
+ projectFolder: string;
}
// @internal (undocumented)
@@ -449,6 +470,7 @@ export interface IPhase {
isSynthetic: boolean;
logFilenameIdentifier: string;
name: string;
+ shellCommand?: string;
}
// @beta
@@ -474,6 +496,14 @@ export interface _IPnpmOptionsJson extends IPackageManagerOptionsJsonBase {
useWorkspaces?: boolean;
}
+// @beta
+export interface IPrefixMatch {
+ // (undocumented)
+ index: number;
+ // (undocumented)
+ value: TItem;
+}
+
// @beta
export interface IRushCommand {
readonly actionName: string;
@@ -590,6 +620,7 @@ export class LookupByPath {
readonly delimiter: string;
findChildPath(childPath: string): TItem | undefined;
findChildPathFromSegments(childPathSegments: Iterable): TItem | undefined;
+ findLongestPrefixMatch(query: string): IPrefixMatch | undefined;
static iteratePathSegments(serializedPath: string, delimiter?: string): Iterable;
setItem(serializedPath: string, value: TItem): this;
setItemFromSegments(pathSegments: Iterable, value: TItem): this;
@@ -615,11 +646,29 @@ export class Operation {
weight: number;
}
+// @internal
+export class _OperationMetadataManager {
+ constructor(options: _IOperationMetadataManagerOptions);
+ get relativeFilepaths(): string[];
+ // (undocumented)
+ saveAsync({ durationInSeconds, logPath, errorLogPath }: _IOperationMetadata): Promise;
+ // (undocumented)
+ readonly stateFile: _OperationStateFile;
+ // (undocumented)
+ tryRestoreAsync({ terminal, logPath, errorLogPath }: {
+ terminal: ITerminal;
+ logPath: string;
+ errorLogPath: string;
+ }): Promise;
+}
+
// @internal
export class _OperationStateFile {
constructor(options: _IOperationStateFileOptions);
- readonly filename: string;
- static getFilenameRelativeToProjectRoot(phase: IPhase): string;
+ // (undocumented)
+ static filename: string;
+ readonly filepath: string;
+ readonly relativeFilepath: string;
// (undocumented)
get state(): _IOperationStateJson | undefined;
// (undocumented)
@@ -656,6 +705,8 @@ export class PackageJsonDependency {
// @public (undocumented)
export class PackageJsonEditor {
+ // @internal
+ protected constructor(filepath: string, data: IPackageJson);
// (undocumented)
addOrUpdateDependency(packageName: string, newVersion: string, dependencyType: DependencyType): void;
get dependencyList(): ReadonlyArray;
@@ -704,7 +755,9 @@ export abstract class PackageManagerOptionsConfigurationBase implements IPackage
// @alpha
export class PhasedCommandHooks {
readonly afterExecuteOperations: AsyncSeriesHook<[IExecutionResult, ICreateOperationsContext]>;
+ readonly beforeExecuteOperations: AsyncSeriesHook<[Map]>;
readonly createOperations: AsyncSeriesWaterfallHook<[Set, ICreateOperationsContext]>;
+ readonly onOperationStatusChanged: SyncHook<[IOperationExecutionResult]>;
readonly waitingForChanges: SyncHook;
}
@@ -740,7 +793,7 @@ export class ProjectChangeAnalyzer {
// Warning: (ae-forgotten-export) The symbol "IRawRepoState" needs to be exported by the entry point index.d.ts
//
// @internal (undocumented)
- _ensureInitialized(terminal: ITerminal): IRawRepoState | undefined;
+ _ensureInitializedAsync(terminal: ITerminal): Promise;
// (undocumented)
_filterProjectDataAsync(project: RushConfigurationProject, unfilteredProjectData: Map, rootDir: string, terminal: ITerminal): Promise>;
getChangedProjectsAsync(options: IGetChangedProjectsOptions): Promise>;
@@ -765,6 +818,8 @@ export class Rush {
static launch(launcherVersion: string, arg: ILaunchOptions): void;
static launchRushPnpm(launcherVersion: string, options: ILaunchOptions): void;
static launchRushX(launcherVersion: string, options: ILaunchOptions): void;
+ // (undocumented)
+ static get _rushLibPackageFolder(): string;
// @internal (undocumented)
static get _rushLibPackageJson(): IPackageJson;
static get version(): string;
@@ -881,7 +936,7 @@ export class RushConfigurationProject {
get isMainProject(): boolean;
// @deprecated
get localDependencyProjects(): ReadonlyArray;
- readonly packageJson: IPackageJson;
+ get packageJson(): IPackageJson;
// @beta
readonly packageJsonEditor: PackageJsonEditor;
readonly packageName: string;
@@ -963,6 +1018,11 @@ export class _RushGlobalFolder {
readonly path: string;
}
+// @internal
+export class _RushInternals {
+ static loadModule(srcImportPath: string): unknown;
+}
+
// @beta
export class RushLifecycleHooks {
beforeInstall: AsyncSeriesHook;
diff --git a/common/reviews/api/rush-themed-ui.api.md b/common/reviews/api/rush-themed-ui.api.md
new file mode 100644
index 00000000000..69176682dd2
--- /dev/null
+++ b/common/reviews/api/rush-themed-ui.api.md
@@ -0,0 +1,107 @@
+## API Report File for "@rushstack/rush-themed-ui"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { default as React_2 } from 'react';
+
+// @public
+export const Button: ({ children, disabled, onClick }: IButtonProps) => JSX.Element;
+
+// @public
+export const Checkbox: ({ label, isChecked, onChecked }: ICheckboxProps) => JSX.Element;
+
+// @public
+export interface IButtonProps {
+ // (undocumented)
+ children: JSX.Element | string;
+ // (undocumented)
+ disabled?: boolean;
+ // (undocumented)
+ onClick: () => void;
+}
+
+// @public
+export interface ICheckboxProps {
+ // (undocumented)
+ isChecked: boolean;
+ // (undocumented)
+ label: string;
+ // (undocumented)
+ onChecked: (checked: boolean) => void;
+}
+
+// @public
+export interface IInputProps {
+ // (undocumented)
+ onChange: (e: React_2.ChangeEvent) => void;
+ // (undocumented)
+ placeholder?: string;
+ // (undocumented)
+ type?: string;
+ // (undocumented)
+ value: string;
+}
+
+// @public
+export const Input: ({ value, placeholder, onChange, type }: IInputProps) => JSX.Element;
+
+// @public
+export interface IScrollAreaProps {
+ // (undocumented)
+ children: React_2.ReactNode;
+}
+
+// @public
+export interface ITabsItem {
+ // (undocumented)
+ body?: React_2.ReactNode;
+ // (undocumented)
+ header: string;
+ // (undocumented)
+ value?: string;
+}
+
+// @public
+export interface ITabsProps {
+ // (undocumented)
+ def?: string;
+ // (undocumented)
+ items: ITabsItem[];
+ // (undocumented)
+ onChange?: (value: any) => void;
+ // (undocumented)
+ renderChildren?: () => JSX.Element;
+ // (undocumented)
+ value: string;
+}
+
+// @public
+export interface ITextProps {
+ // (undocumented)
+ bold?: boolean;
+ // (undocumented)
+ children: React_2.ReactNode;
+ // (undocumented)
+ className?: string;
+ // (undocumented)
+ size?: number;
+ // (undocumented)
+ type: TextType;
+}
+
+// @public
+export const ScrollArea: ({ children }: IScrollAreaProps) => JSX.Element;
+
+// @public
+export const Tabs: ({ items, def, value, onChange, renderChildren }: ITabsProps) => JSX.Element;
+
+// @public
+const Text_2: ({ type, bold, children, className, size }: ITextProps) => JSX.Element;
+export { Text_2 as Text }
+
+// @public
+export type TextType = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'p' | 'span';
+
+```
diff --git a/common/reviews/api/typings-generator.api.md b/common/reviews/api/typings-generator.api.md
index 8ef630234c9..b3fdbc77b42 100644
--- a/common/reviews/api/typings-generator.api.md
+++ b/common/reviews/api/typings-generator.api.md
@@ -73,6 +73,4 @@ export class TypingsGenerator {
readonly sourceFolderPath: string;
}
-// (No @packageDocumentation comment for this package)
-
```
diff --git a/common/reviews/api/webpack-embedded-dependencies-plugin.api.md b/common/reviews/api/webpack-embedded-dependencies-plugin.api.md
new file mode 100644
index 00000000000..1fa9db5337d
--- /dev/null
+++ b/common/reviews/api/webpack-embedded-dependencies-plugin.api.md
@@ -0,0 +1,46 @@
+## API Report File for "@rushstack/webpack-embedded-dependencies-plugin"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import type { Compiler } from 'webpack';
+import type { IPackageJson } from '@rushstack/node-core-library';
+import type { WebpackPluginInstance } from 'webpack';
+
+// @beta
+class EmbeddedDependenciesWebpackPlugin implements WebpackPluginInstance {
+ constructor(options?: IEmbeddedDependenciesWebpackPluginOptions);
+ apply(compiler: Compiler): void;
+}
+export default EmbeddedDependenciesWebpackPlugin;
+
+// @beta
+export interface IEmbeddedDependenciesWebpackPluginOptions {
+ generatedLicenseFilename?: LicenseFileName;
+ generateLicenseFile?: boolean;
+ generateLicenseFileFunction?: LicenseFileGeneratorFunction;
+ outputFileName?: string;
+ packageFilterPredicate?: (packageJson: IPackageData, filePath: string) => boolean;
+}
+
+// @beta
+export interface IPackageData extends IPackageJson {
+ author?: string | {
+ name?: string;
+ };
+ copyright: string | undefined;
+ licenses?: {
+ type: string;
+ url: string;
+ }[];
+ licenseSource?: string;
+}
+
+// @beta
+export type LicenseFileGeneratorFunction = (packages: IPackageData[]) => string;
+
+// @beta
+export type LicenseFileName = `${string}.${'html' | 'md' | 'txt'}`;
+
+```
diff --git a/common/reviews/api/webpack-plugin-utilities.api.md b/common/reviews/api/webpack-plugin-utilities.api.md
index cbf1cc93af3..3b2bf0ac56f 100644
--- a/common/reviews/api/webpack-plugin-utilities.api.md
+++ b/common/reviews/api/webpack-plugin-utilities.api.md
@@ -4,8 +4,15 @@
```ts
+import type { Configuration } from 'webpack';
+import { IFs } from 'memfs';
+import type { MultiStats } from 'webpack';
+import type { Stats } from 'webpack';
import type * as Webpack from 'webpack';
+// @public
+function getTestingWebpackCompilerAsync(entry: string, additionalConfig?: Configuration, memFs?: IFs): Promise<(Stats | MultiStats) | undefined>;
+
// @public
function isWebpack3OrEarlier(compiler: Webpack.Compiler): boolean;
@@ -15,6 +22,13 @@ function isWebpack4(compiler: Webpack.Compiler): boolean;
// @public
function isWebpack5(compiler: Webpack.Compiler): boolean;
+declare namespace Testing {
+ export {
+ getTestingWebpackCompilerAsync
+ }
+}
+export { Testing }
+
declare namespace VersionDetection {
export {
isWebpack3OrEarlier,
diff --git a/common/reviews/api/worker-pool.api.md b/common/reviews/api/worker-pool.api.md
index 76b1572c2a9..83d458d5576 100644
--- a/common/reviews/api/worker-pool.api.md
+++ b/common/reviews/api/worker-pool.api.md
@@ -43,6 +43,4 @@ export class WorkerPool {
reset(): void;
}
-// (No @packageDocumentation comment for this package)
-
```
diff --git a/common/scripts/install-run-rush-pnpm.js b/common/scripts/install-run-rush-pnpm.js
new file mode 100644
index 00000000000..5c149955de6
--- /dev/null
+++ b/common/scripts/install-run-rush-pnpm.js
@@ -0,0 +1,28 @@
+// THIS FILE WAS GENERATED BY A TOOL. ANY MANUAL MODIFICATIONS WILL GET OVERWRITTEN WHENEVER RUSH IS UPGRADED.
+//
+// This script is intended for usage in an automated build environment where the Rush command may not have
+// been preinstalled, or may have an unpredictable version. This script will automatically install the version of Rush
+// specified in the rush.json configuration file (if not already installed), and then pass a command-line to the
+// rush-pnpm command.
+//
+// An example usage would be:
+//
+// node common/scripts/install-run-rush-pnpm.js pnpm-command
+//
+// For more information, see: https://rushjs.io/pages/maintainer/setup_new_repo/
+
+/******/ (() => { // webpackBootstrap
+/******/ "use strict";
+var __webpack_exports__ = {};
+/*!*****************************************************!*\
+ !*** ./lib-esnext/scripts/install-run-rush-pnpm.js ***!
+ \*****************************************************/
+
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See the @microsoft/rush package's LICENSE file for license information.
+require('./install-run-rush');
+//# sourceMappingURL=install-run-rush-pnpm.js.map
+module.exports = __webpack_exports__;
+/******/ })()
+;
+//# sourceMappingURL=install-run-rush-pnpm.js.map
\ No newline at end of file
diff --git a/common/scripts/install-run-rush.js b/common/scripts/install-run-rush.js
index ff569fa92a8..cada1eded21 100644
--- a/common/scripts/install-run-rush.js
+++ b/common/scripts/install-run-rush.js
@@ -1,30 +1,3 @@
-"use strict";
-// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
-// See the @microsoft/rush package's LICENSE file for license information.
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
- if (k2 === undefined) k2 = k;
- var desc = Object.getOwnPropertyDescriptor(m, k);
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
- desc = { enumerable: true, get: function() { return m[k]; } };
- }
- Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
- if (k2 === undefined) k2 = k;
- o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
- Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
- o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
- if (mod && mod.__esModule) return mod;
- var result = {};
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
- __setModuleDefault(result, mod);
- return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
// THIS FILE WAS GENERATED BY A TOOL. ANY MANUAL MODIFICATIONS WILL GET OVERWRITTEN WHENEVER RUSH IS UPGRADED.
//
// This script is intended for usage in an automated build environment where the Rush command may not have
@@ -35,21 +8,128 @@ Object.defineProperty(exports, "__esModule", { value: true });
// node common/scripts/install-run-rush.js install
//
// For more information, see: https://rushjs.io/pages/maintainer/setup_new_repo/
-const path = __importStar(require("path"));
-const fs = __importStar(require("fs"));
-const install_run_1 = require("./install-run");
+
+/******/ (() => { // webpackBootstrap
+/******/ "use strict";
+/******/ var __webpack_modules__ = ({
+
+/***/ 657147:
+/*!*********************!*\
+ !*** external "fs" ***!
+ \*********************/
+/***/ ((module) => {
+
+module.exports = require("fs");
+
+/***/ }),
+
+/***/ 371017:
+/*!***********************!*\
+ !*** external "path" ***!
+ \***********************/
+/***/ ((module) => {
+
+module.exports = require("path");
+
+/***/ })
+
+/******/ });
+/************************************************************************/
+/******/ // The module cache
+/******/ var __webpack_module_cache__ = {};
+/******/
+/******/ // The require function
+/******/ function __webpack_require__(moduleId) {
+/******/ // Check if module is in cache
+/******/ var cachedModule = __webpack_module_cache__[moduleId];
+/******/ if (cachedModule !== undefined) {
+/******/ return cachedModule.exports;
+/******/ }
+/******/ // Create a new module (and put it into the cache)
+/******/ var module = __webpack_module_cache__[moduleId] = {
+/******/ // no module.id needed
+/******/ // no module.loaded needed
+/******/ exports: {}
+/******/ };
+/******/
+/******/ // Execute the module function
+/******/ __webpack_modules__[moduleId](module, module.exports, __webpack_require__);
+/******/
+/******/ // Return the exports of the module
+/******/ return module.exports;
+/******/ }
+/******/
+/************************************************************************/
+/******/ /* webpack/runtime/compat get default export */
+/******/ (() => {
+/******/ // getDefaultExport function for compatibility with non-harmony modules
+/******/ __webpack_require__.n = (module) => {
+/******/ var getter = module && module.__esModule ?
+/******/ () => (module['default']) :
+/******/ () => (module);
+/******/ __webpack_require__.d(getter, { a: getter });
+/******/ return getter;
+/******/ };
+/******/ })();
+/******/
+/******/ /* webpack/runtime/define property getters */
+/******/ (() => {
+/******/ // define getter functions for harmony exports
+/******/ __webpack_require__.d = (exports, definition) => {
+/******/ for(var key in definition) {
+/******/ if(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {
+/******/ Object.defineProperty(exports, key, { enumerable: true, get: definition[key] });
+/******/ }
+/******/ }
+/******/ };
+/******/ })();
+/******/
+/******/ /* webpack/runtime/hasOwnProperty shorthand */
+/******/ (() => {
+/******/ __webpack_require__.o = (obj, prop) => (Object.prototype.hasOwnProperty.call(obj, prop))
+/******/ })();
+/******/
+/******/ /* webpack/runtime/make namespace object */
+/******/ (() => {
+/******/ // define __esModule on exports
+/******/ __webpack_require__.r = (exports) => {
+/******/ if(typeof Symbol !== 'undefined' && Symbol.toStringTag) {
+/******/ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+/******/ }
+/******/ Object.defineProperty(exports, '__esModule', { value: true });
+/******/ };
+/******/ })();
+/******/
+/************************************************************************/
+var __webpack_exports__ = {};
+// This entry need to be wrapped in an IIFE because it need to be isolated against other modules in the chunk.
+(() => {
+/*!************************************************!*\
+ !*** ./lib-esnext/scripts/install-run-rush.js ***!
+ \************************************************/
+__webpack_require__.r(__webpack_exports__);
+/* harmony import */ var path__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! path */ 371017);
+/* harmony import */ var path__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__webpack_require__.n(path__WEBPACK_IMPORTED_MODULE_0__);
+/* harmony import */ var fs__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! fs */ 657147);
+/* harmony import */ var fs__WEBPACK_IMPORTED_MODULE_1___default = /*#__PURE__*/__webpack_require__.n(fs__WEBPACK_IMPORTED_MODULE_1__);
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See the @microsoft/rush package's LICENSE file for license information.
+
+
+const { installAndRun, findRushJsonFolder, RUSH_JSON_FILENAME, runWithErrorAndStatusCode } = require('./install-run');
const PACKAGE_NAME = '@microsoft/rush';
const RUSH_PREVIEW_VERSION = 'RUSH_PREVIEW_VERSION';
+const INSTALL_RUN_RUSH_LOCKFILE_PATH_VARIABLE = 'INSTALL_RUN_RUSH_LOCKFILE_PATH';
function _getRushVersion(logger) {
const rushPreviewVersion = process.env[RUSH_PREVIEW_VERSION];
if (rushPreviewVersion !== undefined) {
logger.info(`Using Rush version from environment variable ${RUSH_PREVIEW_VERSION}=${rushPreviewVersion}`);
return rushPreviewVersion;
}
- const rushJsonFolder = (0, install_run_1.findRushJsonFolder)();
- const rushJsonPath = path.join(rushJsonFolder, install_run_1.RUSH_JSON_FILENAME);
+ const rushJsonFolder = findRushJsonFolder();
+ const rushJsonPath = path__WEBPACK_IMPORTED_MODULE_0__.join(rushJsonFolder, RUSH_JSON_FILENAME);
try {
- const rushJsonContents = fs.readFileSync(rushJsonPath, 'utf-8');
+ const rushJsonContents = fs__WEBPACK_IMPORTED_MODULE_1__.readFileSync(rushJsonPath, 'utf-8');
// Use a regular expression to parse out the rushVersion value because rush.json supports comments,
// but JSON.parse does not and we don't want to pull in more dependencies than we need to in this script.
const rushJsonMatches = rushJsonContents.match(/\"rushVersion\"\s*\:\s*\"([0-9a-zA-Z.+\-]+)\"/);
@@ -61,12 +141,22 @@ function _getRushVersion(logger) {
'using an unexpected syntax.');
}
}
+function _getBin(scriptName) {
+ switch (scriptName.toLowerCase()) {
+ case 'install-run-rush-pnpm.js':
+ return 'rush-pnpm';
+ case 'install-run-rushx.js':
+ return 'rushx';
+ default:
+ return 'rush';
+ }
+}
function _run() {
const [nodePath /* Ex: /bin/node */, scriptPath /* /repo/common/scripts/install-run-rush.js */, ...packageBinArgs /* [build, --to, myproject] */] = process.argv;
// Detect if this script was directly invoked, or if the install-run-rushx script was invokved to select the
// appropriate binary inside the rush package to run
- const scriptName = path.basename(scriptPath);
- const bin = scriptName.toLowerCase() === 'install-run-rushx.js' ? 'rushx' : 'rush';
+ const scriptName = path__WEBPACK_IMPORTED_MODULE_0__.basename(scriptPath);
+ const bin = _getBin(scriptName);
if (!nodePath || !scriptPath) {
throw new Error('Unexpected exception: could not detect node path or script path');
}
@@ -93,7 +183,10 @@ function _run() {
}
if (!commandFound) {
console.log(`Usage: ${scriptName} [args...]`);
- if (scriptName === 'install-run-rush.js') {
+ if (scriptName === 'install-run-rush-pnpm.js') {
+ console.log(`Example: ${scriptName} pnpm-command`);
+ }
+ else if (scriptName === 'install-run-rush.js') {
console.log(`Example: ${scriptName} build --to myproject`);
}
else {
@@ -101,11 +194,21 @@ function _run() {
}
process.exit(1);
}
- (0, install_run_1.runWithErrorAndStatusCode)(logger, () => {
+ runWithErrorAndStatusCode(logger, () => {
const version = _getRushVersion(logger);
logger.info(`The rush.json configuration requests Rush version ${version}`);
- return (0, install_run_1.installAndRun)(logger, PACKAGE_NAME, version, bin, packageBinArgs);
+ const lockFilePath = process.env[INSTALL_RUN_RUSH_LOCKFILE_PATH_VARIABLE];
+ if (lockFilePath) {
+ logger.info(`Found ${INSTALL_RUN_RUSH_LOCKFILE_PATH_VARIABLE}="${lockFilePath}", installing with lockfile.`);
+ }
+ return installAndRun(logger, PACKAGE_NAME, version, bin, packageBinArgs, lockFilePath);
});
}
_run();
+//# sourceMappingURL=install-run-rush.js.map
+})();
+
+module.exports = __webpack_exports__;
+/******/ })()
+;
//# sourceMappingURL=install-run-rush.js.map
\ No newline at end of file
diff --git a/common/scripts/install-run-rushx.js b/common/scripts/install-run-rushx.js
index bf26eb5e50a..b05df262bc2 100644
--- a/common/scripts/install-run-rushx.js
+++ b/common/scripts/install-run-rushx.js
@@ -1,7 +1,3 @@
-"use strict";
-// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
-// See the @microsoft/rush package's LICENSE file for license information.
-Object.defineProperty(exports, "__esModule", { value: true });
// THIS FILE WAS GENERATED BY A TOOL. ANY MANUAL MODIFICATIONS WILL GET OVERWRITTEN WHENEVER RUSH IS UPGRADED.
//
// This script is intended for usage in an automated build environment where the Rush command may not have
@@ -14,5 +10,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
// node common/scripts/install-run-rushx.js custom-command
//
// For more information, see: https://rushjs.io/pages/maintainer/setup_new_repo/
-require("./install-run-rush");
+
+/******/ (() => { // webpackBootstrap
+/******/ "use strict";
+var __webpack_exports__ = {};
+/*!*************************************************!*\
+ !*** ./lib-esnext/scripts/install-run-rushx.js ***!
+ \*************************************************/
+
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See the @microsoft/rush package's LICENSE file for license information.
+require('./install-run-rush');
+//# sourceMappingURL=install-run-rushx.js.map
+module.exports = __webpack_exports__;
+/******/ })()
+;
//# sourceMappingURL=install-run-rushx.js.map
\ No newline at end of file
diff --git a/common/scripts/install-run.js b/common/scripts/install-run.js
index 208b99c83ce..68b1b56fc58 100644
--- a/common/scripts/install-run.js
+++ b/common/scripts/install-run.js
@@ -1,31 +1,3 @@
-"use strict";
-// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
-// See the @microsoft/rush package's LICENSE file for license information.
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
- if (k2 === undefined) k2 = k;
- var desc = Object.getOwnPropertyDescriptor(m, k);
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
- desc = { enumerable: true, get: function() { return m[k]; } };
- }
- Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
- if (k2 === undefined) k2 = k;
- o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
- Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
- o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
- if (mod && mod.__esModule) return mod;
- var result = {};
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
- __setModuleDefault(result, mod);
- return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.runWithErrorAndStatusCode = exports.installAndRun = exports.findRushJsonFolder = exports.getNpmPath = exports.RUSH_JSON_FILENAME = void 0;
// THIS FILE WAS GENERATED BY A TOOL. ANY MANUAL MODIFICATIONS WILL GET OVERWRITTEN WHENEVER RUSH IS UPGRADED.
//
// This script is intended for usage in an automated build environment where a Node tool may not have
@@ -36,40 +8,30 @@ exports.runWithErrorAndStatusCode = exports.installAndRun = exports.findRushJson
// node common/scripts/install-run.js qrcode@1.2.2 qrcode https://rushjs.io
//
// For more information, see: https://rushjs.io/pages/maintainer/setup_new_repo/
-const childProcess = __importStar(require("child_process"));
-const fs = __importStar(require("fs"));
-const os = __importStar(require("os"));
-const path = __importStar(require("path"));
-exports.RUSH_JSON_FILENAME = 'rush.json';
-const RUSH_TEMP_FOLDER_ENV_VARIABLE_NAME = 'RUSH_TEMP_FOLDER';
-const INSTALLED_FLAG_FILENAME = 'installed.flag';
-const NODE_MODULES_FOLDER_NAME = 'node_modules';
-const PACKAGE_JSON_FILENAME = 'package.json';
-/**
- * Parse a package specifier (in the form of name\@version) into name and version parts.
- */
-function _parsePackageSpecifier(rawPackageSpecifier) {
- rawPackageSpecifier = (rawPackageSpecifier || '').trim();
- const separatorIndex = rawPackageSpecifier.lastIndexOf('@');
- let name;
- let version = undefined;
- if (separatorIndex === 0) {
- // The specifier starts with a scope and doesn't have a version specified
- name = rawPackageSpecifier;
- }
- else if (separatorIndex === -1) {
- // The specifier doesn't have a version
- name = rawPackageSpecifier;
- }
- else {
- name = rawPackageSpecifier.substring(0, separatorIndex);
- version = rawPackageSpecifier.substring(separatorIndex + 1);
- }
- if (!name) {
- throw new Error(`Invalid package specifier: ${rawPackageSpecifier}`);
- }
- return { name, version };
-}
+
+/******/ (() => { // webpackBootstrap
+/******/ "use strict";
+/******/ var __webpack_modules__ = ({
+
+/***/ 679877:
+/*!************************************************!*\
+ !*** ./lib-esnext/utilities/npmrcUtilities.js ***!
+ \************************************************/
+/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
+
+__webpack_require__.r(__webpack_exports__);
+/* harmony export */ __webpack_require__.d(__webpack_exports__, {
+/* harmony export */ "syncNpmrc": () => (/* binding */ syncNpmrc)
+/* harmony export */ });
+/* harmony import */ var fs__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! fs */ 657147);
+/* harmony import */ var fs__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__webpack_require__.n(fs__WEBPACK_IMPORTED_MODULE_0__);
+/* harmony import */ var path__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! path */ 371017);
+/* harmony import */ var path__WEBPACK_IMPORTED_MODULE_1___default = /*#__PURE__*/__webpack_require__.n(path__WEBPACK_IMPORTED_MODULE_1__);
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+// IMPORTANT - do not use any non-built-in libraries in this file
+
+
/**
* As a workaround, copyAndTrimNpmrcFile() copies the .npmrc file to the target folder, and also trims
* unusable lines from the .npmrc file.
@@ -81,12 +43,13 @@ function _parsePackageSpecifier(rawPackageSpecifier) {
* we'd prefer to skip that line and continue looking in other places such as the user's
* home directory.
*
- * IMPORTANT: THIS CODE SHOULD BE KEPT UP TO DATE WITH Utilities.copyAndTrimNpmrcFile()
+ * @returns
+ * The text of the the .npmrc.
*/
function _copyAndTrimNpmrcFile(logger, sourceNpmrcPath, targetNpmrcPath) {
logger.info(`Transforming ${sourceNpmrcPath}`); // Verbose
logger.info(` --> "${targetNpmrcPath}"`);
- let npmrcFileLines = fs.readFileSync(sourceNpmrcPath).toString().split('\n');
+ let npmrcFileLines = fs__WEBPACK_IMPORTED_MODULE_0__.readFileSync(sourceNpmrcPath).toString().split('\n');
npmrcFileLines = npmrcFileLines.map((line) => (line || '').trim());
const resultLines = [];
// This finds environment variable tokens that look like "${VAR_NAME}"
@@ -121,31 +84,212 @@ function _copyAndTrimNpmrcFile(logger, sourceNpmrcPath, targetNpmrcPath) {
resultLines.push(line);
}
}
- fs.writeFileSync(targetNpmrcPath, resultLines.join(os.EOL));
+ const combinedNpmrc = resultLines.join('\n');
+ fs__WEBPACK_IMPORTED_MODULE_0__.writeFileSync(targetNpmrcPath, combinedNpmrc);
+ return combinedNpmrc;
}
/**
* syncNpmrc() copies the .npmrc file to the target folder, and also trims unusable lines from the .npmrc file.
* If the source .npmrc file not exist, then syncNpmrc() will delete an .npmrc that is found in the target folder.
*
* IMPORTANT: THIS CODE SHOULD BE KEPT UP TO DATE WITH Utilities._syncNpmrc()
+ *
+ * @returns
+ * The text of the the synced .npmrc, if one exists. If one does not exist, then undefined is returned.
*/
-function _syncNpmrc(logger, sourceNpmrcFolder, targetNpmrcFolder, useNpmrcPublish) {
- const sourceNpmrcPath = path.join(sourceNpmrcFolder, !useNpmrcPublish ? '.npmrc' : '.npmrc-publish');
- const targetNpmrcPath = path.join(targetNpmrcFolder, '.npmrc');
+function syncNpmrc(sourceNpmrcFolder, targetNpmrcFolder, useNpmrcPublish, logger = {
+ info: console.log,
+ error: console.error
+}) {
+ const sourceNpmrcPath = path__WEBPACK_IMPORTED_MODULE_1__.join(sourceNpmrcFolder, !useNpmrcPublish ? '.npmrc' : '.npmrc-publish');
+ const targetNpmrcPath = path__WEBPACK_IMPORTED_MODULE_1__.join(targetNpmrcFolder, '.npmrc');
try {
- if (fs.existsSync(sourceNpmrcPath)) {
- _copyAndTrimNpmrcFile(logger, sourceNpmrcPath, targetNpmrcPath);
+ if (fs__WEBPACK_IMPORTED_MODULE_0__.existsSync(sourceNpmrcPath)) {
+ return _copyAndTrimNpmrcFile(logger, sourceNpmrcPath, targetNpmrcPath);
}
- else if (fs.existsSync(targetNpmrcPath)) {
+ else if (fs__WEBPACK_IMPORTED_MODULE_0__.existsSync(targetNpmrcPath)) {
// If the source .npmrc doesn't exist and there is one in the target, delete the one in the target
logger.info(`Deleting ${targetNpmrcPath}`); // Verbose
- fs.unlinkSync(targetNpmrcPath);
+ fs__WEBPACK_IMPORTED_MODULE_0__.unlinkSync(targetNpmrcPath);
}
}
catch (e) {
throw new Error(`Error syncing .npmrc file: ${e}`);
}
}
+//# sourceMappingURL=npmrcUtilities.js.map
+
+/***/ }),
+
+/***/ 532081:
+/*!********************************!*\
+ !*** external "child_process" ***!
+ \********************************/
+/***/ ((module) => {
+
+module.exports = require("child_process");
+
+/***/ }),
+
+/***/ 657147:
+/*!*********************!*\
+ !*** external "fs" ***!
+ \*********************/
+/***/ ((module) => {
+
+module.exports = require("fs");
+
+/***/ }),
+
+/***/ 822037:
+/*!*********************!*\
+ !*** external "os" ***!
+ \*********************/
+/***/ ((module) => {
+
+module.exports = require("os");
+
+/***/ }),
+
+/***/ 371017:
+/*!***********************!*\
+ !*** external "path" ***!
+ \***********************/
+/***/ ((module) => {
+
+module.exports = require("path");
+
+/***/ })
+
+/******/ });
+/************************************************************************/
+/******/ // The module cache
+/******/ var __webpack_module_cache__ = {};
+/******/
+/******/ // The require function
+/******/ function __webpack_require__(moduleId) {
+/******/ // Check if module is in cache
+/******/ var cachedModule = __webpack_module_cache__[moduleId];
+/******/ if (cachedModule !== undefined) {
+/******/ return cachedModule.exports;
+/******/ }
+/******/ // Create a new module (and put it into the cache)
+/******/ var module = __webpack_module_cache__[moduleId] = {
+/******/ // no module.id needed
+/******/ // no module.loaded needed
+/******/ exports: {}
+/******/ };
+/******/
+/******/ // Execute the module function
+/******/ __webpack_modules__[moduleId](module, module.exports, __webpack_require__);
+/******/
+/******/ // Return the exports of the module
+/******/ return module.exports;
+/******/ }
+/******/
+/************************************************************************/
+/******/ /* webpack/runtime/compat get default export */
+/******/ (() => {
+/******/ // getDefaultExport function for compatibility with non-harmony modules
+/******/ __webpack_require__.n = (module) => {
+/******/ var getter = module && module.__esModule ?
+/******/ () => (module['default']) :
+/******/ () => (module);
+/******/ __webpack_require__.d(getter, { a: getter });
+/******/ return getter;
+/******/ };
+/******/ })();
+/******/
+/******/ /* webpack/runtime/define property getters */
+/******/ (() => {
+/******/ // define getter functions for harmony exports
+/******/ __webpack_require__.d = (exports, definition) => {
+/******/ for(var key in definition) {
+/******/ if(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {
+/******/ Object.defineProperty(exports, key, { enumerable: true, get: definition[key] });
+/******/ }
+/******/ }
+/******/ };
+/******/ })();
+/******/
+/******/ /* webpack/runtime/hasOwnProperty shorthand */
+/******/ (() => {
+/******/ __webpack_require__.o = (obj, prop) => (Object.prototype.hasOwnProperty.call(obj, prop))
+/******/ })();
+/******/
+/******/ /* webpack/runtime/make namespace object */
+/******/ (() => {
+/******/ // define __esModule on exports
+/******/ __webpack_require__.r = (exports) => {
+/******/ if(typeof Symbol !== 'undefined' && Symbol.toStringTag) {
+/******/ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+/******/ }
+/******/ Object.defineProperty(exports, '__esModule', { value: true });
+/******/ };
+/******/ })();
+/******/
+/************************************************************************/
+var __webpack_exports__ = {};
+// This entry need to be wrapped in an IIFE because it need to be isolated against other modules in the chunk.
+(() => {
+/*!*******************************************!*\
+ !*** ./lib-esnext/scripts/install-run.js ***!
+ \*******************************************/
+__webpack_require__.r(__webpack_exports__);
+/* harmony export */ __webpack_require__.d(__webpack_exports__, {
+/* harmony export */ "RUSH_JSON_FILENAME": () => (/* binding */ RUSH_JSON_FILENAME),
+/* harmony export */ "findRushJsonFolder": () => (/* binding */ findRushJsonFolder),
+/* harmony export */ "getNpmPath": () => (/* binding */ getNpmPath),
+/* harmony export */ "installAndRun": () => (/* binding */ installAndRun),
+/* harmony export */ "runWithErrorAndStatusCode": () => (/* binding */ runWithErrorAndStatusCode)
+/* harmony export */ });
+/* harmony import */ var child_process__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! child_process */ 532081);
+/* harmony import */ var child_process__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__webpack_require__.n(child_process__WEBPACK_IMPORTED_MODULE_0__);
+/* harmony import */ var fs__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! fs */ 657147);
+/* harmony import */ var fs__WEBPACK_IMPORTED_MODULE_1___default = /*#__PURE__*/__webpack_require__.n(fs__WEBPACK_IMPORTED_MODULE_1__);
+/* harmony import */ var os__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(/*! os */ 822037);
+/* harmony import */ var os__WEBPACK_IMPORTED_MODULE_2___default = /*#__PURE__*/__webpack_require__.n(os__WEBPACK_IMPORTED_MODULE_2__);
+/* harmony import */ var path__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(/*! path */ 371017);
+/* harmony import */ var path__WEBPACK_IMPORTED_MODULE_3___default = /*#__PURE__*/__webpack_require__.n(path__WEBPACK_IMPORTED_MODULE_3__);
+/* harmony import */ var _utilities_npmrcUtilities__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(/*! ../utilities/npmrcUtilities */ 679877);
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See the @microsoft/rush package's LICENSE file for license information.
+
+
+
+
+
+const RUSH_JSON_FILENAME = 'rush.json';
+const RUSH_TEMP_FOLDER_ENV_VARIABLE_NAME = 'RUSH_TEMP_FOLDER';
+const INSTALL_RUN_LOCKFILE_PATH_VARIABLE = 'INSTALL_RUN_LOCKFILE_PATH';
+const INSTALLED_FLAG_FILENAME = 'installed.flag';
+const NODE_MODULES_FOLDER_NAME = 'node_modules';
+const PACKAGE_JSON_FILENAME = 'package.json';
+/**
+ * Parse a package specifier (in the form of name\@version) into name and version parts.
+ */
+function _parsePackageSpecifier(rawPackageSpecifier) {
+ rawPackageSpecifier = (rawPackageSpecifier || '').trim();
+ const separatorIndex = rawPackageSpecifier.lastIndexOf('@');
+ let name;
+ let version = undefined;
+ if (separatorIndex === 0) {
+ // The specifier starts with a scope and doesn't have a version specified
+ name = rawPackageSpecifier;
+ }
+ else if (separatorIndex === -1) {
+ // The specifier doesn't have a version
+ name = rawPackageSpecifier;
+ }
+ else {
+ name = rawPackageSpecifier.substring(0, separatorIndex);
+ version = rawPackageSpecifier.substring(separatorIndex + 1);
+ }
+ if (!name) {
+ throw new Error(`Invalid package specifier: ${rawPackageSpecifier}`);
+ }
+ return { name, version };
+}
let _npmPath = undefined;
/**
* Get the absolute path to the npm executable
@@ -153,35 +297,34 @@ let _npmPath = undefined;
function getNpmPath() {
if (!_npmPath) {
try {
- if (os.platform() === 'win32') {
+ if (os__WEBPACK_IMPORTED_MODULE_2__.platform() === 'win32') {
// We're on Windows
- const whereOutput = childProcess.execSync('where npm', { stdio: [] }).toString();
- const lines = whereOutput.split(os.EOL).filter((line) => !!line);
+ const whereOutput = child_process__WEBPACK_IMPORTED_MODULE_0__.execSync('where npm', { stdio: [] }).toString();
+ const lines = whereOutput.split(os__WEBPACK_IMPORTED_MODULE_2__.EOL).filter((line) => !!line);
// take the last result, we are looking for a .cmd command
// see https://github.com/microsoft/rushstack/issues/759
_npmPath = lines[lines.length - 1];
}
else {
// We aren't on Windows - assume we're on *NIX or Darwin
- _npmPath = childProcess.execSync('command -v npm', { stdio: [] }).toString();
+ _npmPath = child_process__WEBPACK_IMPORTED_MODULE_0__.execSync('command -v npm', { stdio: [] }).toString();
}
}
catch (e) {
throw new Error(`Unable to determine the path to the NPM tool: ${e}`);
}
_npmPath = _npmPath.trim();
- if (!fs.existsSync(_npmPath)) {
+ if (!fs__WEBPACK_IMPORTED_MODULE_1__.existsSync(_npmPath)) {
throw new Error('The NPM executable does not exist');
}
}
return _npmPath;
}
-exports.getNpmPath = getNpmPath;
function _ensureFolder(folderPath) {
- if (!fs.existsSync(folderPath)) {
- const parentDir = path.dirname(folderPath);
+ if (!fs__WEBPACK_IMPORTED_MODULE_1__.existsSync(folderPath)) {
+ const parentDir = path__WEBPACK_IMPORTED_MODULE_3__.dirname(folderPath);
_ensureFolder(parentDir);
- fs.mkdirSync(folderPath);
+ fs__WEBPACK_IMPORTED_MODULE_1__.mkdirSync(folderPath);
}
}
/**
@@ -195,14 +338,14 @@ function _ensureAndJoinPath(baseFolder, ...pathSegments) {
try {
for (let pathSegment of pathSegments) {
pathSegment = pathSegment.replace(/[\\\/]/g, '+');
- joinedPath = path.join(joinedPath, pathSegment);
- if (!fs.existsSync(joinedPath)) {
- fs.mkdirSync(joinedPath);
+ joinedPath = path__WEBPACK_IMPORTED_MODULE_3__.join(joinedPath, pathSegment);
+ if (!fs__WEBPACK_IMPORTED_MODULE_1__.existsSync(joinedPath)) {
+ fs__WEBPACK_IMPORTED_MODULE_1__.mkdirSync(joinedPath);
}
}
}
catch (e) {
- throw new Error(`Error building local installation folder (${path.join(baseFolder, ...pathSegments)}): ${e}`);
+ throw new Error(`Error building local installation folder (${path__WEBPACK_IMPORTED_MODULE_3__.join(baseFolder, ...pathSegments)}): ${e}`);
}
return joinedPath;
}
@@ -232,8 +375,8 @@ function _resolvePackageVersion(logger, rushCommonFolder, { name, version }) {
// version resolves to
try {
const rushTempFolder = _getRushTempFolder(rushCommonFolder);
- const sourceNpmrcFolder = path.join(rushCommonFolder, 'config', 'rush');
- _syncNpmrc(logger, sourceNpmrcFolder, rushTempFolder);
+ const sourceNpmrcFolder = path__WEBPACK_IMPORTED_MODULE_3__.join(rushCommonFolder, 'config', 'rush');
+ (0,_utilities_npmrcUtilities__WEBPACK_IMPORTED_MODULE_4__.syncNpmrc)(sourceNpmrcFolder, rushTempFolder, undefined, logger);
const npmPath = getNpmPath();
// This returns something that looks like:
// @microsoft/rush@3.0.0 '3.0.0'
@@ -241,7 +384,7 @@ function _resolvePackageVersion(logger, rushCommonFolder, { name, version }) {
// ...
// @microsoft/rush@3.0.20 '3.0.20'
//
- const npmVersionSpawnResult = childProcess.spawnSync(npmPath, ['view', `${name}@${version}`, 'version', '--no-update-notifier'], {
+ const npmVersionSpawnResult = child_process__WEBPACK_IMPORTED_MODULE_0__.spawnSync(npmPath, ['view', `${name}@${version}`, 'version', '--no-update-notifier'], {
cwd: rushTempFolder,
stdio: []
});
@@ -274,58 +417,72 @@ function findRushJsonFolder() {
let basePath = __dirname;
let tempPath = __dirname;
do {
- const testRushJsonPath = path.join(basePath, exports.RUSH_JSON_FILENAME);
- if (fs.existsSync(testRushJsonPath)) {
+ const testRushJsonPath = path__WEBPACK_IMPORTED_MODULE_3__.join(basePath, RUSH_JSON_FILENAME);
+ if (fs__WEBPACK_IMPORTED_MODULE_1__.existsSync(testRushJsonPath)) {
_rushJsonFolder = basePath;
break;
}
else {
basePath = tempPath;
}
- } while (basePath !== (tempPath = path.dirname(basePath))); // Exit the loop when we hit the disk root
+ } while (basePath !== (tempPath = path__WEBPACK_IMPORTED_MODULE_3__.dirname(basePath))); // Exit the loop when we hit the disk root
if (!_rushJsonFolder) {
throw new Error('Unable to find rush.json.');
}
}
return _rushJsonFolder;
}
-exports.findRushJsonFolder = findRushJsonFolder;
/**
* Detects if the package in the specified directory is installed
*/
function _isPackageAlreadyInstalled(packageInstallFolder) {
try {
- const flagFilePath = path.join(packageInstallFolder, INSTALLED_FLAG_FILENAME);
- if (!fs.existsSync(flagFilePath)) {
+ const flagFilePath = path__WEBPACK_IMPORTED_MODULE_3__.join(packageInstallFolder, INSTALLED_FLAG_FILENAME);
+ if (!fs__WEBPACK_IMPORTED_MODULE_1__.existsSync(flagFilePath)) {
return false;
}
- const fileContents = fs.readFileSync(flagFilePath).toString();
+ const fileContents = fs__WEBPACK_IMPORTED_MODULE_1__.readFileSync(flagFilePath).toString();
return fileContents.trim() === process.version;
}
catch (e) {
return false;
}
}
+/**
+ * Delete a file. Fail silently if it does not exist.
+ */
+function _deleteFile(file) {
+ try {
+ fs__WEBPACK_IMPORTED_MODULE_1__.unlinkSync(file);
+ }
+ catch (err) {
+ if (err.code !== 'ENOENT' && err.code !== 'ENOTDIR') {
+ throw err;
+ }
+ }
+}
/**
* Removes the following files and directories under the specified folder path:
* - installed.flag
* -
* - node_modules
*/
-function _cleanInstallFolder(rushTempFolder, packageInstallFolder) {
+function _cleanInstallFolder(rushTempFolder, packageInstallFolder, lockFilePath) {
try {
- const flagFile = path.resolve(packageInstallFolder, INSTALLED_FLAG_FILENAME);
- if (fs.existsSync(flagFile)) {
- fs.unlinkSync(flagFile);
- }
- const packageLockFile = path.resolve(packageInstallFolder, 'package-lock.json');
- if (fs.existsSync(packageLockFile)) {
- fs.unlinkSync(packageLockFile);
+ const flagFile = path__WEBPACK_IMPORTED_MODULE_3__.resolve(packageInstallFolder, INSTALLED_FLAG_FILENAME);
+ _deleteFile(flagFile);
+ const packageLockFile = path__WEBPACK_IMPORTED_MODULE_3__.resolve(packageInstallFolder, 'package-lock.json');
+ if (lockFilePath) {
+ fs__WEBPACK_IMPORTED_MODULE_1__.copyFileSync(lockFilePath, packageLockFile);
}
- const nodeModulesFolder = path.resolve(packageInstallFolder, NODE_MODULES_FOLDER_NAME);
- if (fs.existsSync(nodeModulesFolder)) {
- const rushRecyclerFolder = _ensureAndJoinPath(rushTempFolder, 'rush-recycler');
- fs.renameSync(nodeModulesFolder, path.join(rushRecyclerFolder, `install-run-${Date.now().toString()}`));
+ else {
+ // Not running `npm ci`, so need to cleanup
+ _deleteFile(packageLockFile);
+ const nodeModulesFolder = path__WEBPACK_IMPORTED_MODULE_3__.resolve(packageInstallFolder, NODE_MODULES_FOLDER_NAME);
+ if (fs__WEBPACK_IMPORTED_MODULE_1__.existsSync(nodeModulesFolder)) {
+ const rushRecyclerFolder = _ensureAndJoinPath(rushTempFolder, 'rush-recycler');
+ fs__WEBPACK_IMPORTED_MODULE_1__.renameSync(nodeModulesFolder, path__WEBPACK_IMPORTED_MODULE_3__.join(rushRecyclerFolder, `install-run-${Date.now().toString()}`));
+ }
}
}
catch (e) {
@@ -344,8 +501,8 @@ function _createPackageJson(packageInstallFolder, name, version) {
repository: "DON'T WARN",
license: 'MIT'
};
- const packageJsonPath = path.join(packageInstallFolder, PACKAGE_JSON_FILENAME);
- fs.writeFileSync(packageJsonPath, JSON.stringify(packageJsonContents, undefined, 2));
+ const packageJsonPath = path__WEBPACK_IMPORTED_MODULE_3__.join(packageInstallFolder, PACKAGE_JSON_FILENAME);
+ fs__WEBPACK_IMPORTED_MODULE_1__.writeFileSync(packageJsonPath, JSON.stringify(packageJsonContents, undefined, 2));
}
catch (e) {
throw new Error(`Unable to create package.json: ${e}`);
@@ -354,17 +511,17 @@ function _createPackageJson(packageInstallFolder, name, version) {
/**
* Run "npm install" in the package install folder.
*/
-function _installPackage(logger, packageInstallFolder, name, version) {
+function _installPackage(logger, packageInstallFolder, name, version, command) {
try {
logger.info(`Installing ${name}...`);
const npmPath = getNpmPath();
- const result = childProcess.spawnSync(npmPath, ['install'], {
+ const result = child_process__WEBPACK_IMPORTED_MODULE_0__.spawnSync(npmPath, [command], {
stdio: 'inherit',
cwd: packageInstallFolder,
env: process.env
});
if (result.status !== 0) {
- throw new Error('"npm install" encountered an error');
+ throw new Error(`"npm ${command}" encountered an error`);
}
logger.info(`Successfully installed ${name}@${version}`);
}
@@ -376,41 +533,42 @@ function _installPackage(logger, packageInstallFolder, name, version) {
* Get the ".bin" path for the package.
*/
function _getBinPath(packageInstallFolder, binName) {
- const binFolderPath = path.resolve(packageInstallFolder, NODE_MODULES_FOLDER_NAME, '.bin');
- const resolvedBinName = os.platform() === 'win32' ? `${binName}.cmd` : binName;
- return path.resolve(binFolderPath, resolvedBinName);
+ const binFolderPath = path__WEBPACK_IMPORTED_MODULE_3__.resolve(packageInstallFolder, NODE_MODULES_FOLDER_NAME, '.bin');
+ const resolvedBinName = os__WEBPACK_IMPORTED_MODULE_2__.platform() === 'win32' ? `${binName}.cmd` : binName;
+ return path__WEBPACK_IMPORTED_MODULE_3__.resolve(binFolderPath, resolvedBinName);
}
/**
* Write a flag file to the package's install directory, signifying that the install was successful.
*/
function _writeFlagFile(packageInstallFolder) {
try {
- const flagFilePath = path.join(packageInstallFolder, INSTALLED_FLAG_FILENAME);
- fs.writeFileSync(flagFilePath, process.version);
+ const flagFilePath = path__WEBPACK_IMPORTED_MODULE_3__.join(packageInstallFolder, INSTALLED_FLAG_FILENAME);
+ fs__WEBPACK_IMPORTED_MODULE_1__.writeFileSync(flagFilePath, process.version);
}
catch (e) {
throw new Error(`Unable to create installed.flag file in ${packageInstallFolder}`);
}
}
-function installAndRun(logger, packageName, packageVersion, packageBinName, packageBinArgs) {
+function installAndRun(logger, packageName, packageVersion, packageBinName, packageBinArgs, lockFilePath = process.env[INSTALL_RUN_LOCKFILE_PATH_VARIABLE]) {
const rushJsonFolder = findRushJsonFolder();
- const rushCommonFolder = path.join(rushJsonFolder, 'common');
+ const rushCommonFolder = path__WEBPACK_IMPORTED_MODULE_3__.join(rushJsonFolder, 'common');
const rushTempFolder = _getRushTempFolder(rushCommonFolder);
const packageInstallFolder = _ensureAndJoinPath(rushTempFolder, 'install-run', `${packageName}@${packageVersion}`);
if (!_isPackageAlreadyInstalled(packageInstallFolder)) {
// The package isn't already installed
- _cleanInstallFolder(rushTempFolder, packageInstallFolder);
- const sourceNpmrcFolder = path.join(rushCommonFolder, 'config', 'rush');
- _syncNpmrc(logger, sourceNpmrcFolder, packageInstallFolder);
+ _cleanInstallFolder(rushTempFolder, packageInstallFolder, lockFilePath);
+ const sourceNpmrcFolder = path__WEBPACK_IMPORTED_MODULE_3__.join(rushCommonFolder, 'config', 'rush');
+ (0,_utilities_npmrcUtilities__WEBPACK_IMPORTED_MODULE_4__.syncNpmrc)(sourceNpmrcFolder, packageInstallFolder, undefined, logger);
_createPackageJson(packageInstallFolder, packageName, packageVersion);
- _installPackage(logger, packageInstallFolder, packageName, packageVersion);
+ const command = lockFilePath ? 'ci' : 'install';
+ _installPackage(logger, packageInstallFolder, packageName, packageVersion, command);
_writeFlagFile(packageInstallFolder);
}
const statusMessage = `Invoking "${packageBinName} ${packageBinArgs.join(' ')}"`;
const statusMessageLine = new Array(statusMessage.length + 1).join('-');
- logger.info(os.EOL + statusMessage + os.EOL + statusMessageLine + os.EOL);
+ logger.info('\n' + statusMessage + '\n' + statusMessageLine + '\n');
const binPath = _getBinPath(packageInstallFolder, packageBinName);
- const binFolderPath = path.resolve(packageInstallFolder, NODE_MODULES_FOLDER_NAME, '.bin');
+ const binFolderPath = path__WEBPACK_IMPORTED_MODULE_3__.resolve(packageInstallFolder, NODE_MODULES_FOLDER_NAME, '.bin');
// Windows environment variables are case-insensitive. Instead of using SpawnSyncOptions.env, we need to
// assign via the process.env proxy to ensure that we append to the right PATH key.
const originalEnvPath = process.env.PATH || '';
@@ -418,10 +576,10 @@ function installAndRun(logger, packageName, packageVersion, packageBinName, pack
try {
// Node.js on Windows can not spawn a file when the path has a space on it
// unless the path gets wrapped in a cmd friendly way and shell mode is used
- const shouldUseShell = binPath.includes(' ') && os.platform() === 'win32';
+ const shouldUseShell = binPath.includes(' ') && os__WEBPACK_IMPORTED_MODULE_2__.platform() === 'win32';
const platformBinPath = shouldUseShell ? `"${binPath}"` : binPath;
- process.env.PATH = [binFolderPath, originalEnvPath].join(path.delimiter);
- result = childProcess.spawnSync(platformBinPath, packageBinArgs, {
+ process.env.PATH = [binFolderPath, originalEnvPath].join(path__WEBPACK_IMPORTED_MODULE_3__.delimiter);
+ result = child_process__WEBPACK_IMPORTED_MODULE_0__.spawnSync(platformBinPath, packageBinArgs, {
stdio: 'inherit',
windowsVerbatimArguments: false,
shell: shouldUseShell,
@@ -439,7 +597,6 @@ function installAndRun(logger, packageName, packageVersion, packageBinName, pack
throw result.error || new Error('An unknown error occurred.');
}
}
-exports.installAndRun = installAndRun;
function runWithErrorAndStatusCode(logger, fn) {
process.exitCode = 1;
try {
@@ -447,16 +604,15 @@ function runWithErrorAndStatusCode(logger, fn) {
process.exitCode = exitCode;
}
catch (e) {
- logger.error(os.EOL + os.EOL + e.toString() + os.EOL + os.EOL);
+ logger.error('\n\n' + e.toString() + '\n\n');
}
}
-exports.runWithErrorAndStatusCode = runWithErrorAndStatusCode;
function _run() {
const [nodePath /* Ex: /bin/node */, scriptPath /* /repo/common/scripts/install-run-rush.js */, rawPackageSpecifier /* qrcode@^1.2.0 */, packageBinName /* qrcode */, ...packageBinArgs /* [-f, myproject/lib] */] = process.argv;
if (!nodePath) {
throw new Error('Unexpected exception: could not detect node path');
}
- if (path.basename(scriptPath).toLowerCase() !== 'install-run.js') {
+ if (path__WEBPACK_IMPORTED_MODULE_3__.basename(scriptPath).toLowerCase() !== 'install-run.js') {
// If install-run.js wasn't directly invoked, don't execute the rest of this function. Return control
// to the script that (presumably) imported this file
return;
@@ -480,4 +636,10 @@ function _run() {
});
}
_run();
+//# sourceMappingURL=install-run.js.map
+})();
+
+module.exports = __webpack_exports__;
+/******/ })()
+;
//# sourceMappingURL=install-run.js.map
\ No newline at end of file
diff --git a/eslint/eslint-config/CHANGELOG.json b/eslint/eslint-config/CHANGELOG.json
index f6b8b2d2199..2f3d30f95c6 100644
--- a/eslint/eslint-config/CHANGELOG.json
+++ b/eslint/eslint-config/CHANGELOG.json
@@ -1,6 +1,18 @@
{
"name": "@rushstack/eslint-config",
"entries": [
+ {
+ "version": "3.2.0",
+ "tag": "@rushstack/eslint-config_v3.2.0",
+ "date": "Fri, 10 Feb 2023 01:18:50 GMT",
+ "comments": {
+ "minor": [
+ {
+ "comment": "Replace the @typescript-eslint/no-parameter-properties rule with the replacement rule (@typescript-eslint/parameter-properties)."
+ }
+ ]
+ }
+ },
{
"version": "3.1.1",
"tag": "@rushstack/eslint-config_v3.1.1",
diff --git a/eslint/eslint-config/CHANGELOG.md b/eslint/eslint-config/CHANGELOG.md
index d7aed501e5f..6035ec8f9cd 100644
--- a/eslint/eslint-config/CHANGELOG.md
+++ b/eslint/eslint-config/CHANGELOG.md
@@ -1,6 +1,13 @@
# Change Log - @rushstack/eslint-config
-This log was last generated on Mon, 10 Oct 2022 15:23:44 GMT and should not be manually modified.
+This log was last generated on Fri, 10 Feb 2023 01:18:50 GMT and should not be manually modified.
+
+## 3.2.0
+Fri, 10 Feb 2023 01:18:50 GMT
+
+### Minor changes
+
+- Replace the @typescript-eslint/no-parameter-properties rule with the replacement rule (@typescript-eslint/parameter-properties).
## 3.1.1
Mon, 10 Oct 2022 15:23:44 GMT
diff --git a/eslint/eslint-config/package.json b/eslint/eslint-config/package.json
index 440c294f827..24792c82842 100644
--- a/eslint/eslint-config/package.json
+++ b/eslint/eslint-config/package.json
@@ -1,6 +1,6 @@
{
"name": "@rushstack/eslint-config",
- "version": "3.1.1",
+ "version": "3.2.0",
"description": "A TypeScript ESLint ruleset designed for large teams and projects",
"license": "MIT",
"repository": {
diff --git a/eslint/eslint-config/profile/_common.js b/eslint/eslint-config/profile/_common.js
index b9cbd0282cb..d2cec825c88 100644
--- a/eslint/eslint-config/profile/_common.js
+++ b/eslint/eslint-config/profile/_common.js
@@ -418,7 +418,7 @@ function buildRules(profile) {
// just to save some typing.
//
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
- '@typescript-eslint/no-parameter-properties': 'warn',
+ '@typescript-eslint/parameter-properties': 'warn',
// RATIONALE: When left in shipping code, unused variables often indicate a mistake. Dead code
// may impact performance.
diff --git a/eslint/eslint-patch/package.json b/eslint/eslint-patch/package.json
index ed0f717d8b2..ccff31cbf91 100644
--- a/eslint/eslint-patch/package.json
+++ b/eslint/eslint-patch/package.json
@@ -25,8 +25,8 @@
"package"
],
"devDependencies": {
- "@rushstack/heft": "0.48.0",
- "@rushstack/heft-node-rig": "1.11.0",
- "@types/node": "12.20.24"
+ "@rushstack/heft": "0.49.3",
+ "@rushstack/heft-node-rig": "1.11.14",
+ "@types/node": "14.18.36"
}
}
diff --git a/eslint/eslint-plugin-packlets/package.json b/eslint/eslint-plugin-packlets/package.json
index ce29b99c614..2a5e234ffc5 100644
--- a/eslint/eslint-plugin-packlets/package.json
+++ b/eslint/eslint-plugin-packlets/package.json
@@ -30,12 +30,12 @@
"eslint": "^6.0.0 || ^7.0.0 || ^8.0.0"
},
"devDependencies": {
- "@rushstack/heft": "0.48.0",
- "@rushstack/heft-node-rig": "1.11.0",
+ "@rushstack/heft": "0.49.3",
+ "@rushstack/heft-node-rig": "1.11.14",
"@types/eslint": "8.2.0",
"@types/estree": "0.0.50",
"@types/heft-jest": "1.0.1",
- "@types/node": "12.20.24",
+ "@types/node": "14.18.36",
"@typescript-eslint/parser": "~5.38.0",
"@typescript-eslint/typescript-estree": "~5.38.0",
"eslint": "~8.7.0",
diff --git a/eslint/eslint-plugin-security/package.json b/eslint/eslint-plugin-security/package.json
index 9cb43c5decc..f966cd7b28d 100644
--- a/eslint/eslint-plugin-security/package.json
+++ b/eslint/eslint-plugin-security/package.json
@@ -29,12 +29,12 @@
"eslint": "^6.0.0 || ^7.0.0 || ^8.0.0"
},
"devDependencies": {
- "@rushstack/heft": "0.48.0",
- "@rushstack/heft-node-rig": "1.11.0",
+ "@rushstack/heft": "0.49.3",
+ "@rushstack/heft-node-rig": "1.11.14",
"@types/eslint": "8.2.0",
"@types/estree": "0.0.50",
"@types/heft-jest": "1.0.1",
- "@types/node": "12.20.24",
+ "@types/node": "14.18.36",
"@typescript-eslint/parser": "~5.38.0",
"@typescript-eslint/typescript-estree": "~5.38.0",
"eslint": "~8.7.0",
diff --git a/eslint/eslint-plugin/package.json b/eslint/eslint-plugin/package.json
index 194171f5afd..3790d007be3 100644
--- a/eslint/eslint-plugin/package.json
+++ b/eslint/eslint-plugin/package.json
@@ -33,12 +33,12 @@
"eslint": "^6.0.0 || ^7.0.0 || ^8.0.0"
},
"devDependencies": {
- "@rushstack/heft": "0.48.0",
- "@rushstack/heft-node-rig": "1.11.0",
+ "@rushstack/heft": "0.49.3",
+ "@rushstack/heft-node-rig": "1.11.14",
"@types/eslint": "8.2.0",
"@types/estree": "0.0.50",
"@types/heft-jest": "1.0.1",
- "@types/node": "12.20.24",
+ "@types/node": "14.18.36",
"@typescript-eslint/parser": "~5.38.0",
"@typescript-eslint/typescript-estree": "~5.38.0",
"eslint": "~8.7.0",
diff --git a/heft-plugins/heft-dev-cert-plugin/CHANGELOG.json b/heft-plugins/heft-dev-cert-plugin/CHANGELOG.json
index e6f7cf4f8fb..e18d2fac841 100644
--- a/heft-plugins/heft-dev-cert-plugin/CHANGELOG.json
+++ b/heft-plugins/heft-dev-cert-plugin/CHANGELOG.json
@@ -2,70 +2,246 @@
"name": "@rushstack/heft-dev-cert-plugin",
"entries": [
{
- "version": "0.3.0-rc.4",
- "tag": "@rushstack/heft-dev-cert-plugin_v0.3.0-rc.4",
- "date": "Wed, 15 Mar 2023 20:22:44 GMT",
+ "version": "0.2.20",
+ "tag": "@rushstack/heft-dev-cert-plugin_v0.2.20",
+ "date": "Mon, 20 Mar 2023 20:14:20 GMT",
"comments": {
- "minor": [
+ "dependency": [
{
- "comment": "Fix an issue with `watchGlobAsync`"
+ "comment": "Updating dependency \"@rushstack/debug-certificate-manager\" to `1.2.19`"
}
]
}
},
{
- "version": "0.3.0-rc.3",
- "tag": "@rushstack/heft-dev-cert-plugin_v0.3.0-rc.3",
- "date": "Fri, 20 Jan 2023 20:13:16 GMT",
+ "version": "0.2.19",
+ "tag": "@rushstack/heft-dev-cert-plugin_v0.2.19",
+ "date": "Sat, 18 Mar 2023 00:20:56 GMT",
"comments": {
- "minor": [
+ "dependency": [
{
- "comment": "Fix issues with SASS incremental builds."
+ "comment": "Updating dependency \"@rushstack/debug-certificate-manager\" to `1.2.18`"
},
{
- "comment": "Add support for TypeScript solution incremental builds."
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.5`"
},
{
- "comment": "Improve responsiveness of watcher loop."
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.50.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.7` to `^0.50.0`"
}
]
}
},
{
- "version": "0.3.0-rc.2",
- "tag": "@rushstack/heft-dev-cert-plugin_v0.3.0-rc.2",
- "date": "Fri, 2 Dec 2022 05:28:24 GMT",
+ "version": "0.2.18",
+ "tag": "@rushstack/heft-dev-cert-plugin_v0.2.18",
+ "date": "Fri, 03 Mar 2023 04:11:20 GMT",
"comments": {
- "minor": [
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/debug-certificate-manager\" to `1.2.17`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.2.17",
+ "tag": "@rushstack/heft-dev-cert-plugin_v0.2.17",
+ "date": "Fri, 10 Feb 2023 01:18:50 GMT",
+ "comments": {
+ "dependency": [
{
- "comment": "Improve watch mode performance."
+ "comment": "Updating dependency \"@rushstack/debug-certificate-manager\" to `1.2.16`"
},
{
- "comment": "Improve logging output."
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.2`"
+ },
+ {
+ "comment": "Updating dependency \"@microsoft/api-extractor\" to `7.34.4`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/eslint-config\" to `3.2.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.4`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.7`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.6` to `^0.49.7`"
}
]
}
},
{
- "version": "0.3.0-rc.1",
- "tag": "@rushstack/heft-dev-cert-plugin_v0.3.0-rc.1",
- "date": "Fri, 18 Nov 2022 02:34:26 GMT",
+ "version": "0.2.16",
+ "tag": "@rushstack/heft-dev-cert-plugin_v0.2.16",
+ "date": "Sun, 05 Feb 2023 03:02:02 GMT",
"comments": {
- "minor": [
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/debug-certificate-manager\" to `1.2.15`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.1`"
+ },
{
- "comment": "Fix incremental TypeScript compilation."
+ "comment": "Updating dependency \"@microsoft/api-extractor\" to `7.34.3`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.3`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.6`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.5` to `^0.49.6`"
}
]
}
},
{
- "version": "0.3.0-rc.0",
- "tag": "@rushstack/heft-dev-cert-plugin_v0.3.0-rc.0",
- "date": "Tue, 15 Nov 2022 22:59:35 GMT",
+ "version": "0.2.15",
+ "tag": "@rushstack/heft-dev-cert-plugin_v0.2.15",
+ "date": "Wed, 01 Feb 2023 02:16:34 GMT",
"comments": {
- "minor": [
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/debug-certificate-manager\" to `1.2.14`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.0`"
+ },
+ {
+ "comment": "Updating dependency \"@microsoft/api-extractor\" to `7.34.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.5`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.4` to `^0.49.5`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.2.14",
+ "tag": "@rushstack/heft-dev-cert-plugin_v0.2.14",
+ "date": "Mon, 30 Jan 2023 16:22:31 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/debug-certificate-manager\" to `1.2.13`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.54.0`"
+ },
+ {
+ "comment": "Updating dependency \"@microsoft/api-extractor\" to `7.34.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.4`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.3` to `^0.49.4`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.2.13",
+ "tag": "@rushstack/heft-dev-cert-plugin_v0.2.13",
+ "date": "Mon, 30 Jan 2023 00:55:44 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/debug-certificate-manager\" to `1.2.12`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.0`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.2.12",
+ "tag": "@rushstack/heft-dev-cert-plugin_v0.2.12",
+ "date": "Thu, 26 Jan 2023 02:55:09 GMT",
+ "comments": {
+ "patch": [
+ {
+ "comment": "Upgrade to webpack 5.75.0"
+ }
+ ],
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/debug-certificate-manager\" to `1.2.11`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.14`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.3`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.2` to `^0.49.3`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.2.11",
+ "tag": "@rushstack/heft-dev-cert-plugin_v0.2.11",
+ "date": "Wed, 25 Jan 2023 07:26:55 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/debug-certificate-manager\" to `1.2.10`"
+ },
+ {
+ "comment": "Updating dependency \"@microsoft/api-extractor\" to `7.34.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.13`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.1` to `^0.49.2`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.2.10",
+ "tag": "@rushstack/heft-dev-cert-plugin_v0.2.10",
+ "date": "Wed, 18 Jan 2023 22:44:12 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/debug-certificate-manager\" to `1.2.9`"
+ },
+ {
+ "comment": "Updating dependency \"@microsoft/api-extractor\" to `7.33.8`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.12`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.1`"
+ },
{
- "comment": "General fixes and improvements, in preparation for a general release."
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.0` to `^0.49.1`"
}
]
}
diff --git a/heft-plugins/heft-dev-cert-plugin/CHANGELOG.md b/heft-plugins/heft-dev-cert-plugin/CHANGELOG.md
index 5069166af90..31f084f05a5 100644
--- a/heft-plugins/heft-dev-cert-plugin/CHANGELOG.md
+++ b/heft-plugins/heft-dev-cert-plugin/CHANGELOG.md
@@ -1,44 +1,63 @@
# Change Log - @rushstack/heft-dev-cert-plugin
-This log was last generated on Wed, 15 Mar 2023 20:22:44 GMT and should not be manually modified.
+This log was last generated on Mon, 20 Mar 2023 20:14:20 GMT and should not be manually modified.
-## 0.3.0-rc.4
-Wed, 15 Mar 2023 20:22:44 GMT
+## 0.2.20
+Mon, 20 Mar 2023 20:14:20 GMT
-### Prerelease Changes
+_Version update only_
+
+## 0.2.19
+Sat, 18 Mar 2023 00:20:56 GMT
-- Fix an issue with `watchGlobAsync`
+_Version update only_
-## 0.3.0-rc.3
-Fri, 20 Jan 2023 20:13:16 GMT
+## 0.2.18
+Fri, 03 Mar 2023 04:11:20 GMT
+
+_Version update only_
-### Prerelease Changes
+## 0.2.17
+Fri, 10 Feb 2023 01:18:50 GMT
-- Fix issues with SASS incremental builds.
-- Add support for TypeScript solution incremental builds.
-- Improve responsiveness of watcher loop.
+_Version update only_
-## 0.3.0-rc.2
-Fri, 2 Dec 2022 05:28:24 GMT
+## 0.2.16
+Sun, 05 Feb 2023 03:02:02 GMT
-### Prerelease Changes
+_Version update only_
-- Improve watch mode performance.
-- Improve logging output.
+## 0.2.15
+Wed, 01 Feb 2023 02:16:34 GMT
-## 0.3.0-rc.1
-Fri, 18 Nov 2022 02:34:26 GMT
+_Version update only_
-### Prerelease Changes
+## 0.2.14
+Mon, 30 Jan 2023 16:22:31 GMT
-- Fix incremental TypeScript compilation.
+_Version update only_
-## 0.3.0-rc.0
-Tue, 15 Nov 2022 22:59:35 GMT
+## 0.2.13
+Mon, 30 Jan 2023 00:55:44 GMT
-### Prerelease Changes
+_Version update only_
-- General fixes and improvements, in preparation for a general release.
+## 0.2.12
+Thu, 26 Jan 2023 02:55:09 GMT
+
+### Patches
+
+- Upgrade to webpack 5.75.0
+
+## 0.2.11
+Wed, 25 Jan 2023 07:26:55 GMT
+
+_Version update only_
+
+## 0.2.10
+Wed, 18 Jan 2023 22:44:12 GMT
+
+_Version update only_
## 0.2.9
Tue, 20 Dec 2022 01:18:22 GMT
diff --git a/heft-plugins/heft-dev-cert-plugin/package.json b/heft-plugins/heft-dev-cert-plugin/package.json
index 8b01756d74a..001ddef270e 100644
--- a/heft-plugins/heft-dev-cert-plugin/package.json
+++ b/heft-plugins/heft-dev-cert-plugin/package.json
@@ -1,6 +1,6 @@
{
"name": "@rushstack/heft-dev-cert-plugin",
- "version": "0.3.0-rc.4",
+ "version": "0.2.20",
"description": "A Heft plugin for generating and using local development certificates",
"repository": {
"type": "git",
@@ -16,7 +16,7 @@
"_phase:test": "heft run --only test -- --clean"
},
"peerDependencies": {
- "@rushstack/heft": "0.50.0-rc.4"
+ "@rushstack/heft": "^0.50.0"
},
"dependencies": {
"@rushstack/debug-certificate-manager": "workspace:*"
@@ -26,7 +26,8 @@
"@rushstack/eslint-config": "workspace:*",
"@rushstack/heft-node-rig": "workspace:*",
"@rushstack/heft": "workspace:*",
- "@types/node": "12.20.24",
+ "@types/heft-jest": "1.0.1",
+ "@types/node": "14.18.36",
"eslint": "~8.7.0"
}
}
diff --git a/heft-plugins/heft-jest-plugin/CHANGELOG.json b/heft-plugins/heft-jest-plugin/CHANGELOG.json
index de2664a2a7d..d1565b29ef8 100644
--- a/heft-plugins/heft-jest-plugin/CHANGELOG.json
+++ b/heft-plugins/heft-jest-plugin/CHANGELOG.json
@@ -2,70 +2,181 @@
"name": "@rushstack/heft-jest-plugin",
"entries": [
{
- "version": "0.5.0-rc.4",
- "tag": "@rushstack/heft-jest-plugin_v0.5.0-rc.4",
- "date": "Wed, 15 Mar 2023 20:22:44 GMT",
+ "version": "0.5.5",
+ "tag": "@rushstack/heft-jest-plugin_v0.5.5",
+ "date": "Sat, 18 Mar 2023 00:20:56 GMT",
"comments": {
- "minor": [
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.50.0`"
+ },
{
- "comment": "Fix an issue with `watchGlobAsync`"
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.7` to `^0.50.0`"
}
]
}
},
{
- "version": "0.5.0-rc.3",
- "tag": "@rushstack/heft-jest-plugin_v0.5.0-rc.3",
- "date": "Fri, 20 Jan 2023 20:13:16 GMT",
+ "version": "0.5.4",
+ "tag": "@rushstack/heft-jest-plugin_v0.5.4",
+ "date": "Fri, 10 Feb 2023 01:18:50 GMT",
"comments": {
- "minor": [
+ "dependency": [
{
- "comment": "Fix issues with SASS incremental builds."
+ "comment": "Updating dependency \"@rushstack/heft-config-file\" to `0.11.9`"
},
{
- "comment": "Add support for TypeScript solution incremental builds."
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.2`"
},
{
- "comment": "Improve responsiveness of watcher loop."
+ "comment": "Updating dependency \"@microsoft/api-extractor\" to `7.34.4`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/eslint-config\" to `3.2.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.7`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.6` to `^0.49.7`"
}
]
}
},
{
- "version": "0.4.0-rc.2",
- "tag": "@rushstack/heft-jest-plugin_v0.4.0-rc.2",
- "date": "Fri, 2 Dec 2022 05:28:24 GMT",
+ "version": "0.5.3",
+ "tag": "@rushstack/heft-jest-plugin_v0.5.3",
+ "date": "Sun, 05 Feb 2023 03:02:02 GMT",
"comments": {
- "minor": [
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-config-file\" to `0.11.8`"
+ },
{
- "comment": "Improve watch mode performance."
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.1`"
},
{
- "comment": "Improve logging output."
+ "comment": "Updating dependency \"@microsoft/api-extractor\" to `7.34.3`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.6`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.5` to `^0.49.6`"
}
]
}
},
{
- "version": "0.4.0-rc.1",
- "tag": "@rushstack/heft-jest-plugin_v0.4.0-rc.1",
- "date": "Fri, 18 Nov 2022 02:34:26 GMT",
+ "version": "0.5.2",
+ "tag": "@rushstack/heft-jest-plugin_v0.5.2",
+ "date": "Wed, 01 Feb 2023 02:16:34 GMT",
"comments": {
- "minor": [
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-config-file\" to `0.11.7`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.0`"
+ },
+ {
+ "comment": "Updating dependency \"@microsoft/api-extractor\" to `7.34.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.5`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.4` to `^0.49.5`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.5.1",
+ "tag": "@rushstack/heft-jest-plugin_v0.5.1",
+ "date": "Mon, 30 Jan 2023 16:22:31 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-config-file\" to `0.11.6`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.54.0`"
+ },
+ {
+ "comment": "Updating dependency \"@microsoft/api-extractor\" to `7.34.1`"
+ },
{
- "comment": "Fix incremental TypeScript compilation."
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.4`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.3` to `^0.49.4`"
}
]
}
},
{
- "version": "0.4.0-rc.0",
- "tag": "@rushstack/heft-jest-plugin_v0.4.0-rc.0",
- "date": "Tue, 15 Nov 2022 22:59:35 GMT",
+ "version": "0.5.0",
+ "tag": "@rushstack/heft-jest-plugin_v0.5.0",
+ "date": "Mon, 30 Jan 2023 00:55:44 GMT",
"comments": {
"minor": [
{
- "comment": "General fixes and improvements, in preparation for a general release."
+ "comment": "Upgrade Jest from `~27.4.2` to `~29.3.1`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.4.5",
+ "tag": "@rushstack/heft-jest-plugin_v0.4.5",
+ "date": "Thu, 26 Jan 2023 02:55:10 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-config-file\" to `0.11.5`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.3`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.2` to `^0.49.3`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.4.4",
+ "tag": "@rushstack/heft-jest-plugin_v0.4.4",
+ "date": "Wed, 25 Jan 2023 07:26:55 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@microsoft/api-extractor\" to `7.34.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.1` to `^0.49.2`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.4.3",
+ "tag": "@rushstack/heft-jest-plugin_v0.4.3",
+ "date": "Wed, 18 Jan 2023 22:44:12 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@microsoft/api-extractor\" to `7.33.8`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.0` to `^0.49.1`"
}
]
}
diff --git a/heft-plugins/heft-jest-plugin/CHANGELOG.md b/heft-plugins/heft-jest-plugin/CHANGELOG.md
index 0aa29adc3c6..debf9c0542a 100644
--- a/heft-plugins/heft-jest-plugin/CHANGELOG.md
+++ b/heft-plugins/heft-jest-plugin/CHANGELOG.md
@@ -1,44 +1,53 @@
# Change Log - @rushstack/heft-jest-plugin
-This log was last generated on Wed, 15 Mar 2023 20:22:44 GMT and should not be manually modified.
+This log was last generated on Sat, 18 Mar 2023 00:20:56 GMT and should not be manually modified.
-## 0.5.0-rc.4
-Wed, 15 Mar 2023 20:22:44 GMT
+## 0.5.5
+Sat, 18 Mar 2023 00:20:56 GMT
-### Prerelease Changes
+_Version update only_
-- Fix an issue with `watchGlobAsync`
+## 0.5.4
+Fri, 10 Feb 2023 01:18:50 GMT
-## 0.5.0-rc.3
-Fri, 20 Jan 2023 20:13:16 GMT
+_Version update only_
-### Prerelease Changes
+## 0.5.3
+Sun, 05 Feb 2023 03:02:02 GMT
-- Fix issues with SASS incremental builds.
-- Add support for TypeScript solution incremental builds.
-- Improve responsiveness of watcher loop.
+_Version update only_
-## 0.4.0-rc.2
-Fri, 2 Dec 2022 05:28:24 GMT
+## 0.5.2
+Wed, 01 Feb 2023 02:16:34 GMT
-### Prerelease Changes
+_Version update only_
-- Improve watch mode performance.
-- Improve logging output.
+## 0.5.1
+Mon, 30 Jan 2023 16:22:31 GMT
-## 0.4.0-rc.1
-Fri, 18 Nov 2022 02:34:26 GMT
+_Version update only_
-### Prerelease Changes
+## 0.5.0
+Mon, 30 Jan 2023 00:55:44 GMT
-- Fix incremental TypeScript compilation.
+### Minor changes
-## 0.4.0-rc.0
-Tue, 15 Nov 2022 22:59:35 GMT
+- Upgrade Jest from `~27.4.2` to `~29.3.1`
-### Prerelease Changes
+## 0.4.5
+Thu, 26 Jan 2023 02:55:10 GMT
-- General fixes and improvements, in preparation for a general release.
+_Version update only_
+
+## 0.4.4
+Wed, 25 Jan 2023 07:26:55 GMT
+
+_Version update only_
+
+## 0.4.3
+Wed, 18 Jan 2023 22:44:12 GMT
+
+_Version update only_
## 0.4.2
Tue, 20 Dec 2022 01:18:22 GMT
diff --git a/heft-plugins/heft-jest-plugin/package.json b/heft-plugins/heft-jest-plugin/package.json
index 588bb092d6b..57a6ca339ce 100644
--- a/heft-plugins/heft-jest-plugin/package.json
+++ b/heft-plugins/heft-jest-plugin/package.json
@@ -1,6 +1,6 @@
{
"name": "@rushstack/heft-jest-plugin",
- "version": "0.5.0-rc.4",
+ "version": "0.5.5",
"description": "Heft plugin for Jest",
"repository": {
"type": "git",
@@ -16,7 +16,7 @@
"_phase:test": "node ./node_modules/@rushstack/heft-legacy/bin/heft --unmanaged test --no-build"
},
"peerDependencies": {
- "@rushstack/heft": "0.50.0-rc.4",
+ "@rushstack/heft": "^0.50.0",
"@rushstack/heft-typescript-plugin": "^0.1.0"
},
"peerDependenciesMeta": {
@@ -44,7 +44,7 @@
"@rushstack/heft-typescript-plugin": "workspace:*",
"@types/heft-jest": "1.0.1",
"@types/lodash": "4.14.116",
- "@types/node": "12.20.24",
+ "@types/node": "14.18.36",
"eslint": "~8.7.0",
"jest-environment-jsdom": "~29.3.1",
"jest-environment-node": "~29.3.1",
diff --git a/heft-plugins/heft-sass-plugin/CHANGELOG.json b/heft-plugins/heft-sass-plugin/CHANGELOG.json
index 2a00295eb2d..038196f0743 100644
--- a/heft-plugins/heft-sass-plugin/CHANGELOG.json
+++ b/heft-plugins/heft-sass-plugin/CHANGELOG.json
@@ -2,70 +2,244 @@
"name": "@rushstack/heft-sass-plugin",
"entries": [
{
- "version": "0.8.0-rc.4",
- "tag": "@rushstack/heft-sass-plugin_v0.8.0-rc.4",
- "date": "Wed, 15 Mar 2023 20:22:44 GMT",
+ "version": "0.8.4",
+ "tag": "@rushstack/heft-sass-plugin_v0.8.4",
+ "date": "Sat, 18 Mar 2023 00:20:56 GMT",
"comments": {
- "minor": [
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/typings-generator\" to `0.10.3`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.50.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.5`"
+ },
{
- "comment": "Fix an issue with `watchGlobAsync`"
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.7` to `^0.50.0`"
}
]
}
},
{
- "version": "0.8.0-rc.3",
- "tag": "@rushstack/heft-sass-plugin_v0.8.0-rc.3",
- "date": "Fri, 20 Jan 2023 20:13:16 GMT",
+ "version": "0.8.3",
+ "tag": "@rushstack/heft-sass-plugin_v0.8.3",
+ "date": "Fri, 10 Feb 2023 01:18:50 GMT",
"comments": {
- "minor": [
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-config-file\" to `0.11.9`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/typings-generator\" to `0.10.2`"
+ },
{
- "comment": "Fix issues with SASS incremental builds."
+ "comment": "Updating dependency \"@microsoft/api-extractor\" to `7.34.4`"
},
{
- "comment": "Add support for TypeScript solution incremental builds."
+ "comment": "Updating dependency \"@rushstack/eslint-config\" to `3.2.0`"
},
{
- "comment": "Improve responsiveness of watcher loop."
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.7`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.4`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.6` to `^0.49.7`"
}
]
}
},
{
- "version": "0.8.0-rc.2",
- "tag": "@rushstack/heft-sass-plugin_v0.8.0-rc.2",
- "date": "Fri, 2 Dec 2022 05:28:24 GMT",
+ "version": "0.8.2",
+ "tag": "@rushstack/heft-sass-plugin_v0.8.2",
+ "date": "Sun, 05 Feb 2023 03:02:02 GMT",
"comments": {
- "minor": [
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-config-file\" to `0.11.8`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/typings-generator\" to `0.10.1`"
+ },
+ {
+ "comment": "Updating dependency \"@microsoft/api-extractor\" to `7.34.3`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.6`"
+ },
{
- "comment": "Improve watch mode performance."
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.3`"
},
{
- "comment": "Improve logging output."
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.5` to `^0.49.6`"
}
]
}
},
{
- "version": "0.8.0-rc.1",
- "tag": "@rushstack/heft-sass-plugin_v0.8.0-rc.1",
- "date": "Fri, 18 Nov 2022 02:34:26 GMT",
+ "version": "0.8.1",
+ "tag": "@rushstack/heft-sass-plugin_v0.8.1",
+ "date": "Wed, 01 Feb 2023 02:16:34 GMT",
"comments": {
- "minor": [
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-config-file\" to `0.11.7`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/typings-generator\" to `0.10.0`"
+ },
+ {
+ "comment": "Updating dependency \"@microsoft/api-extractor\" to `7.34.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.5`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.2`"
+ },
{
- "comment": "Fix incremental TypeScript compilation."
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.4` to `^0.49.5`"
}
]
}
},
{
- "version": "0.8.0-rc.0",
- "tag": "@rushstack/heft-sass-plugin_v0.8.0-rc.0",
- "date": "Tue, 15 Nov 2022 22:59:35 GMT",
+ "version": "0.8.0",
+ "tag": "@rushstack/heft-sass-plugin_v0.8.0",
+ "date": "Tue, 31 Jan 2023 01:23:23 GMT",
"comments": {
"minor": [
{
- "comment": "General fixes and improvements, in preparation for a general release."
+ "comment": "Add \"preserveSCSSExtension\" flag for backwards compatibility with build flows that cannot be expected to alter import resolution."
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.7.10",
+ "tag": "@rushstack/heft-sass-plugin_v0.7.10",
+ "date": "Mon, 30 Jan 2023 16:22:31 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-config-file\" to `0.11.6`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.54.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/typings-generator\" to `0.9.0`"
+ },
+ {
+ "comment": "Updating dependency \"@microsoft/api-extractor\" to `7.34.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.4`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.3` to `^0.49.4`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.7.9",
+ "tag": "@rushstack/heft-sass-plugin_v0.7.9",
+ "date": "Mon, 30 Jan 2023 00:55:44 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/typings-generator\" to `0.8.18`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.0`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.7.8",
+ "tag": "@rushstack/heft-sass-plugin_v0.7.8",
+ "date": "Thu, 26 Jan 2023 02:55:10 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-config-file\" to `0.11.5`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/typings-generator\" to `0.8.17`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.3`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.14`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.2` to `^0.49.3`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.7.7",
+ "tag": "@rushstack/heft-sass-plugin_v0.7.7",
+ "date": "Wed, 25 Jan 2023 07:26:55 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/typings-generator\" to `0.8.16`"
+ },
+ {
+ "comment": "Updating dependency \"@microsoft/api-extractor\" to `7.34.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.13`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.1` to `^0.49.2`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.7.6",
+ "tag": "@rushstack/heft-sass-plugin_v0.7.6",
+ "date": "Wed, 18 Jan 2023 22:44:12 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/typings-generator\" to `0.8.15`"
+ },
+ {
+ "comment": "Updating dependency \"@microsoft/api-extractor\" to `7.33.8`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.12`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.0` to `^0.49.1`"
}
]
}
diff --git a/heft-plugins/heft-sass-plugin/CHANGELOG.md b/heft-plugins/heft-sass-plugin/CHANGELOG.md
index 878a2687e5a..603873737a7 100644
--- a/heft-plugins/heft-sass-plugin/CHANGELOG.md
+++ b/heft-plugins/heft-sass-plugin/CHANGELOG.md
@@ -1,44 +1,58 @@
# Change Log - @rushstack/heft-sass-plugin
-This log was last generated on Wed, 15 Mar 2023 20:22:44 GMT and should not be manually modified.
+This log was last generated on Sat, 18 Mar 2023 00:20:56 GMT and should not be manually modified.
-## 0.8.0-rc.4
-Wed, 15 Mar 2023 20:22:44 GMT
+## 0.8.4
+Sat, 18 Mar 2023 00:20:56 GMT
-### Prerelease Changes
+_Version update only_
+
+## 0.8.3
+Fri, 10 Feb 2023 01:18:50 GMT
+
+_Version update only_
+
+## 0.8.2
+Sun, 05 Feb 2023 03:02:02 GMT
+
+_Version update only_
+
+## 0.8.1
+Wed, 01 Feb 2023 02:16:34 GMT
-- Fix an issue with `watchGlobAsync`
+_Version update only_
+
+## 0.8.0
+Tue, 31 Jan 2023 01:23:23 GMT
-## 0.8.0-rc.3
-Fri, 20 Jan 2023 20:13:16 GMT
+### Minor changes
-### Prerelease Changes
+- Add "preserveSCSSExtension" flag for backwards compatibility with build flows that cannot be expected to alter import resolution.
-- Fix issues with SASS incremental builds.
-- Add support for TypeScript solution incremental builds.
-- Improve responsiveness of watcher loop.
+## 0.7.10
+Mon, 30 Jan 2023 16:22:31 GMT
-## 0.8.0-rc.2
-Fri, 2 Dec 2022 05:28:24 GMT
+_Version update only_
-### Prerelease Changes
+## 0.7.9
+Mon, 30 Jan 2023 00:55:44 GMT
-- Improve watch mode performance.
-- Improve logging output.
+_Version update only_
-## 0.8.0-rc.1
-Fri, 18 Nov 2022 02:34:26 GMT
+## 0.7.8
+Thu, 26 Jan 2023 02:55:10 GMT
-### Prerelease Changes
+_Version update only_
-- Fix incremental TypeScript compilation.
+## 0.7.7
+Wed, 25 Jan 2023 07:26:55 GMT
-## 0.8.0-rc.0
-Tue, 15 Nov 2022 22:59:35 GMT
+_Version update only_
-### Prerelease Changes
+## 0.7.6
+Wed, 18 Jan 2023 22:44:12 GMT
-- General fixes and improvements, in preparation for a general release.
+_Version update only_
## 0.7.5
Tue, 20 Dec 2022 01:18:22 GMT
diff --git a/heft-plugins/heft-sass-plugin/package.json b/heft-plugins/heft-sass-plugin/package.json
index 81a97b563dc..0ae25b4c719 100644
--- a/heft-plugins/heft-sass-plugin/package.json
+++ b/heft-plugins/heft-sass-plugin/package.json
@@ -1,6 +1,6 @@
{
"name": "@rushstack/heft-sass-plugin",
- "version": "0.8.0-rc.4",
+ "version": "0.8.4",
"description": "Heft plugin for SASS",
"repository": {
"type": "git",
@@ -16,7 +16,7 @@
"_phase:test": "heft run --only test -- --clean"
},
"peerDependencies": {
- "@rushstack/heft": "0.50.0-rc.4"
+ "@rushstack/heft": "^0.50.0"
},
"dependencies": {
"@rushstack/heft-config-file": "workspace:*",
@@ -31,7 +31,8 @@
"@rushstack/eslint-config": "workspace:*",
"@rushstack/heft": "workspace:*",
"@rushstack/heft-node-rig": "workspace:*",
- "@types/node": "12.20.24",
+ "@types/heft-jest": "1.0.1",
+ "@types/node": "14.18.36",
"eslint": "~8.7.0"
}
}
diff --git a/heft-plugins/heft-sass-plugin/src/SassProcessor.ts b/heft-plugins/heft-sass-plugin/src/SassProcessor.ts
index 26bc709e63a..1e9d1b7ff14 100644
--- a/heft-plugins/heft-sass-plugin/src/SassProcessor.ts
+++ b/heft-plugins/heft-sass-plugin/src/SassProcessor.ts
@@ -36,6 +36,11 @@ export interface ISassConfiguration {
*/
cssOutputFolders?: string[] | undefined;
+ /**
+ * If `true`, when emitting compiled CSS from a file with a ".scss" extension, the emitted CSS will have the extension ".scss" instead of ".scss.css"
+ */
+ preserveSCSSExtension?: boolean | undefined;
+
/**
* Determines whether export values are wrapped in a default property, or not.
* Defaults to true.
@@ -101,14 +106,22 @@ export class SassProcessor extends StringValuesTypingsGenerator {
const { allFileExtensions, isFileModule } = buildExtensionClassifier(sassConfiguration);
- const { cssOutputFolders } = sassConfiguration;
+ const { cssOutputFolders, preserveSCSSExtension = false } = sassConfiguration;
const getCssPaths: ((relativePath: string) => string[]) | undefined = cssOutputFolders
? (relativePath: string): string[] => {
- return cssOutputFolders.map(
- (folder: string) =>
- `${folder}/${relativePath.endsWith('.css') ? relativePath : `${relativePath}.css`}`
- );
+ const lastDot: number = relativePath.lastIndexOf('.');
+ const oldExtension: string = relativePath.slice(lastDot);
+ const cssRelativePath: string =
+ oldExtension === '.css' || (oldExtension === '.scss' && preserveSCSSExtension)
+ ? relativePath
+ : `${relativePath}.css`;
+
+ const cssPaths: string[] = [];
+ for (const outputFolder of cssOutputFolders) {
+ cssPaths.push(`${outputFolder}/${cssRelativePath}`);
+ }
+ return cssPaths;
}
: undefined;
diff --git a/heft-plugins/heft-sass-plugin/src/schemas/heft-sass-plugin.schema.json b/heft-plugins/heft-sass-plugin/src/schemas/heft-sass-plugin.schema.json
index 3abb457addb..fac89a9a617 100644
--- a/heft-plugins/heft-sass-plugin/src/schemas/heft-sass-plugin.schema.json
+++ b/heft-plugins/heft-sass-plugin/src/schemas/heft-sass-plugin.schema.json
@@ -42,13 +42,18 @@
"cssOutputFolders": {
"type": "array",
- "description": "If specified, folders where compiled CSS files will be emitted to. They will be named by appending \".css\" to the source file name for ease of reference translation.",
+ "description": "If specified, folders where compiled CSS files will be emitted to. They will be named by appending \".css\" to the source file name for ease of reference translation, unless \"preserveSCSSExtension\" is set.",
"items": {
"type": "string",
"pattern": "[^\\\\]"
}
},
+ "preserveSCSSExtension": {
+ "type": "boolean",
+ "description": "If set, when emitting compiled CSS from a file with a \".scss\" extension, the emitted CSS will have the extension \".scss\" instead of \".scss.css\"."
+ },
+
"fileExtensions": {
"type": "array",
"description": "Files with these extensions will be treated as SCSS modules and pass through the Sass transpiler for typings generation.",
diff --git a/heft-plugins/heft-sass-plugin/src/templates/sass.json b/heft-plugins/heft-sass-plugin/src/templates/sass.json
index 1f3721b8ed8..05fc5a3a63a 100644
--- a/heft-plugins/heft-sass-plugin/src/templates/sass.json
+++ b/heft-plugins/heft-sass-plugin/src/templates/sass.json
@@ -38,12 +38,20 @@
/**
* If specified, folders where compiled CSS files will be emitted to. They will be named by appending
- * ".css" to the source file name for ease of reference translation.
+ * ".css" to the source file name for ease of reference translation, unless "preserveSCSSExtension" is set.
*
* Default value: undefined
*/
// "cssOutputFolders": [],
+ /**
+ * If set, when emitting compiled CSS from a file with a ".scss" extension, the emitted CSS will have
+ * the extension ".scss" instead of ".scss.css".
+ *
+ * Default value: false
+ */
+ // "preserveSCSSExtension": true,
+
/**
* Files with these extensions will pass through the Sass transpiler for typings generation.
*
diff --git a/heft-plugins/heft-serverless-stack-plugin/CHANGELOG.json b/heft-plugins/heft-serverless-stack-plugin/CHANGELOG.json
index c740780a98e..f4702bec789 100644
--- a/heft-plugins/heft-serverless-stack-plugin/CHANGELOG.json
+++ b/heft-plugins/heft-serverless-stack-plugin/CHANGELOG.json
@@ -2,70 +2,172 @@
"name": "@rushstack/heft-serverless-stack-plugin",
"entries": [
{
- "version": "0.2.0-rc.4",
- "tag": "@rushstack/heft-serverless-stack-plugin_v0.2.0-rc.4",
- "date": "Wed, 15 Mar 2023 20:22:44 GMT",
+ "version": "0.1.69",
+ "tag": "@rushstack/heft-serverless-stack-plugin_v0.1.69",
+ "date": "Sat, 18 Mar 2023 00:20:56 GMT",
"comments": {
- "minor": [
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.50.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.5`"
+ },
{
- "comment": "Fix an issue with `watchGlobAsync`"
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.7` to `^0.50.0`"
}
]
}
},
{
- "version": "0.2.0-rc.3",
- "tag": "@rushstack/heft-serverless-stack-plugin_v0.2.0-rc.3",
- "date": "Fri, 20 Jan 2023 20:13:16 GMT",
+ "version": "0.1.68",
+ "tag": "@rushstack/heft-serverless-stack-plugin_v0.1.68",
+ "date": "Fri, 10 Feb 2023 01:18:51 GMT",
"comments": {
- "minor": [
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.2`"
+ },
{
- "comment": "Fix issues with SASS incremental builds."
+ "comment": "Updating dependency \"@rushstack/eslint-config\" to `3.2.0`"
},
{
- "comment": "Add support for TypeScript solution incremental builds."
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.7`"
},
{
- "comment": "Improve responsiveness of watcher loop."
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.4`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.6` to `^0.49.7`"
}
]
}
},
{
- "version": "0.2.0-rc.2",
- "tag": "@rushstack/heft-serverless-stack-plugin_v0.2.0-rc.2",
- "date": "Fri, 2 Dec 2022 05:28:24 GMT",
+ "version": "0.1.67",
+ "tag": "@rushstack/heft-serverless-stack-plugin_v0.1.67",
+ "date": "Sun, 05 Feb 2023 03:02:02 GMT",
"comments": {
- "minor": [
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.6`"
+ },
{
- "comment": "Improve watch mode performance."
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.3`"
},
{
- "comment": "Improve logging output."
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.5` to `^0.49.6`"
}
]
}
},
{
- "version": "0.2.0-rc.1",
- "tag": "@rushstack/heft-serverless-stack-plugin_v0.2.0-rc.1",
- "date": "Fri, 18 Nov 2022 02:34:26 GMT",
+ "version": "0.1.66",
+ "tag": "@rushstack/heft-serverless-stack-plugin_v0.1.66",
+ "date": "Wed, 01 Feb 2023 02:16:34 GMT",
"comments": {
- "minor": [
+ "dependency": [
{
- "comment": "Fix incremental TypeScript compilation."
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.5`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.4` to `^0.49.5`"
}
]
}
},
{
- "version": "0.2.0-rc.0",
- "tag": "@rushstack/heft-serverless-stack-plugin_v0.2.0-rc.0",
- "date": "Tue, 15 Nov 2022 22:59:35 GMT",
+ "version": "0.1.65",
+ "tag": "@rushstack/heft-serverless-stack-plugin_v0.1.65",
+ "date": "Mon, 30 Jan 2023 16:22:31 GMT",
"comments": {
- "minor": [
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.54.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.4`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.3` to `^0.49.4`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.1.64",
+ "tag": "@rushstack/heft-serverless-stack-plugin_v0.1.64",
+ "date": "Mon, 30 Jan 2023 00:55:44 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.0`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.1.63",
+ "tag": "@rushstack/heft-serverless-stack-plugin_v0.1.63",
+ "date": "Thu, 26 Jan 2023 02:55:10 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.3`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.14`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.2` to `^0.49.3`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.1.62",
+ "tag": "@rushstack/heft-serverless-stack-plugin_v0.1.62",
+ "date": "Wed, 25 Jan 2023 07:26:55 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.13`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.1` to `^0.49.2`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.1.61",
+ "tag": "@rushstack/heft-serverless-stack-plugin_v0.1.61",
+ "date": "Wed, 18 Jan 2023 22:44:12 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.12`"
+ },
{
- "comment": "General fixes and improvements, in preparation for a general release."
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.0` to `^0.49.1`"
}
]
}
diff --git a/heft-plugins/heft-serverless-stack-plugin/CHANGELOG.md b/heft-plugins/heft-serverless-stack-plugin/CHANGELOG.md
index bf1cfce63b0..771d8e97e7c 100644
--- a/heft-plugins/heft-serverless-stack-plugin/CHANGELOG.md
+++ b/heft-plugins/heft-serverless-stack-plugin/CHANGELOG.md
@@ -1,44 +1,51 @@
# Change Log - @rushstack/heft-serverless-stack-plugin
-This log was last generated on Wed, 15 Mar 2023 20:22:44 GMT and should not be manually modified.
+This log was last generated on Sat, 18 Mar 2023 00:20:56 GMT and should not be manually modified.
-## 0.2.0-rc.4
-Wed, 15 Mar 2023 20:22:44 GMT
+## 0.1.69
+Sat, 18 Mar 2023 00:20:56 GMT
-### Prerelease Changes
+_Version update only_
+
+## 0.1.68
+Fri, 10 Feb 2023 01:18:51 GMT
+
+_Version update only_
+
+## 0.1.67
+Sun, 05 Feb 2023 03:02:02 GMT
-- Fix an issue with `watchGlobAsync`
+_Version update only_
-## 0.2.0-rc.3
-Fri, 20 Jan 2023 20:13:16 GMT
+## 0.1.66
+Wed, 01 Feb 2023 02:16:34 GMT
-### Prerelease Changes
+_Version update only_
-- Fix issues with SASS incremental builds.
-- Add support for TypeScript solution incremental builds.
-- Improve responsiveness of watcher loop.
+## 0.1.65
+Mon, 30 Jan 2023 16:22:31 GMT
-## 0.2.0-rc.2
-Fri, 2 Dec 2022 05:28:24 GMT
+_Version update only_
-### Prerelease Changes
+## 0.1.64
+Mon, 30 Jan 2023 00:55:44 GMT
-- Improve watch mode performance.
-- Improve logging output.
+_Version update only_
-## 0.2.0-rc.1
-Fri, 18 Nov 2022 02:34:26 GMT
+## 0.1.63
+Thu, 26 Jan 2023 02:55:10 GMT
-### Prerelease Changes
+_Version update only_
-- Fix incremental TypeScript compilation.
+## 0.1.62
+Wed, 25 Jan 2023 07:26:55 GMT
-## 0.2.0-rc.0
-Tue, 15 Nov 2022 22:59:35 GMT
+_Version update only_
-### Prerelease Changes
+## 0.1.61
+Wed, 18 Jan 2023 22:44:12 GMT
-- General fixes and improvements, in preparation for a general release.
+_Version update only_
## 0.1.60
Tue, 20 Dec 2022 01:18:22 GMT
diff --git a/heft-plugins/heft-serverless-stack-plugin/package.json b/heft-plugins/heft-serverless-stack-plugin/package.json
index 6811433d39a..f34c7c8ad4c 100644
--- a/heft-plugins/heft-serverless-stack-plugin/package.json
+++ b/heft-plugins/heft-serverless-stack-plugin/package.json
@@ -1,6 +1,6 @@
{
"name": "@rushstack/heft-serverless-stack-plugin",
- "version": "0.2.0-rc.4",
+ "version": "0.1.69",
"description": "Heft plugin for building apps using the Serverless Stack (SST) framework",
"repository": {
"type": "git",
@@ -15,7 +15,7 @@
"_phase:test": "heft run --only test -- --clean"
},
"peerDependencies": {
- "@rushstack/heft": "0.50.0-rc.4"
+ "@rushstack/heft": "^0.50.0"
},
"dependencies": {
"@rushstack/node-core-library": "workspace:*"
@@ -26,6 +26,6 @@
"@rushstack/heft-node-rig": "workspace:*",
"@rushstack/heft-webpack4-plugin": "workspace:*",
"@rushstack/heft-webpack5-plugin": "workspace:*",
- "@types/node": "12.20.24"
+ "@types/node": "14.18.36"
}
}
diff --git a/heft-plugins/heft-storybook-plugin/CHANGELOG.json b/heft-plugins/heft-storybook-plugin/CHANGELOG.json
index 3d6a0ee4b03..a63222a7ad3 100644
--- a/heft-plugins/heft-storybook-plugin/CHANGELOG.json
+++ b/heft-plugins/heft-storybook-plugin/CHANGELOG.json
@@ -2,70 +2,189 @@
"name": "@rushstack/heft-storybook-plugin",
"entries": [
{
- "version": "0.2.0-rc.4",
- "tag": "@rushstack/heft-storybook-plugin_v0.2.0-rc.4",
- "date": "Wed, 15 Mar 2023 20:22:44 GMT",
+ "version": "0.2.4",
+ "tag": "@rushstack/heft-storybook-plugin_v0.2.4",
+ "date": "Sat, 18 Mar 2023 00:20:56 GMT",
"comments": {
- "minor": [
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.50.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.5`"
+ },
{
- "comment": "Fix an issue with `watchGlobAsync`"
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.7` to `^0.50.0`"
}
]
}
},
{
- "version": "0.2.0-rc.3",
- "tag": "@rushstack/heft-storybook-plugin_v0.2.0-rc.3",
- "date": "Fri, 20 Jan 2023 20:13:16 GMT",
+ "version": "0.2.3",
+ "tag": "@rushstack/heft-storybook-plugin_v0.2.3",
+ "date": "Wed, 22 Feb 2023 16:26:55 GMT",
"comments": {
- "minor": [
+ "patch": [
+ {
+ "comment": "Fix an issue where static build output ends up in the wrong folder."
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.2.2",
+ "tag": "@rushstack/heft-storybook-plugin_v0.2.2",
+ "date": "Fri, 10 Feb 2023 01:18:51 GMT",
+ "comments": {
+ "dependency": [
{
- "comment": "Fix issues with SASS incremental builds."
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.2`"
},
{
- "comment": "Add support for TypeScript solution incremental builds."
+ "comment": "Updating dependency \"@rushstack/eslint-config\" to `3.2.0`"
},
{
- "comment": "Improve responsiveness of watcher loop."
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.7`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.4`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.6` to `^0.49.7`"
}
]
}
},
{
- "version": "0.2.0-rc.2",
- "tag": "@rushstack/heft-storybook-plugin_v0.2.0-rc.2",
- "date": "Fri, 2 Dec 2022 05:28:24 GMT",
+ "version": "0.2.1",
+ "tag": "@rushstack/heft-storybook-plugin_v0.2.1",
+ "date": "Sun, 05 Feb 2023 03:02:02 GMT",
"comments": {
- "minor": [
+ "dependency": [
{
- "comment": "Improve watch mode performance."
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.1`"
},
{
- "comment": "Improve logging output."
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.6`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.3`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.5` to `^0.49.6`"
}
]
}
},
{
- "version": "0.2.0-rc.1",
- "tag": "@rushstack/heft-storybook-plugin_v0.2.0-rc.1",
- "date": "Fri, 18 Nov 2022 02:34:26 GMT",
+ "version": "0.2.0",
+ "tag": "@rushstack/heft-storybook-plugin_v0.2.0",
+ "date": "Wed, 01 Feb 2023 02:16:34 GMT",
"comments": {
"minor": [
{
- "comment": "Fix incremental TypeScript compilation."
+ "comment": "Add support for storybook static build"
+ }
+ ],
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.5`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.4` to `^0.49.5`"
}
]
}
},
{
- "version": "0.2.0-rc.0",
- "tag": "@rushstack/heft-storybook-plugin_v0.2.0-rc.0",
- "date": "Tue, 15 Nov 2022 22:59:35 GMT",
+ "version": "0.1.99",
+ "tag": "@rushstack/heft-storybook-plugin_v0.1.99",
+ "date": "Mon, 30 Jan 2023 16:22:31 GMT",
"comments": {
- "minor": [
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.54.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.4`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.3` to `^0.49.4`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.1.98",
+ "tag": "@rushstack/heft-storybook-plugin_v0.1.98",
+ "date": "Mon, 30 Jan 2023 00:55:44 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.0`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.1.97",
+ "tag": "@rushstack/heft-storybook-plugin_v0.1.97",
+ "date": "Thu, 26 Jan 2023 02:55:10 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.3`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.14`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.2` to `^0.49.3`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.1.96",
+ "tag": "@rushstack/heft-storybook-plugin_v0.1.96",
+ "date": "Wed, 25 Jan 2023 07:26:55 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.13`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.1` to `^0.49.2`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.1.95",
+ "tag": "@rushstack/heft-storybook-plugin_v0.1.95",
+ "date": "Wed, 18 Jan 2023 22:44:12 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.12`"
+ },
{
- "comment": "General fixes and improvements, in preparation for a general release."
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.0` to `^0.49.1`"
}
]
}
diff --git a/heft-plugins/heft-storybook-plugin/CHANGELOG.md b/heft-plugins/heft-storybook-plugin/CHANGELOG.md
index 1109bf1d964..de2e055ce76 100644
--- a/heft-plugins/heft-storybook-plugin/CHANGELOG.md
+++ b/heft-plugins/heft-storybook-plugin/CHANGELOG.md
@@ -1,44 +1,60 @@
# Change Log - @rushstack/heft-storybook-plugin
-This log was last generated on Wed, 15 Mar 2023 20:22:44 GMT and should not be manually modified.
+This log was last generated on Sat, 18 Mar 2023 00:20:56 GMT and should not be manually modified.
-## 0.2.0-rc.4
-Wed, 15 Mar 2023 20:22:44 GMT
+## 0.2.4
+Sat, 18 Mar 2023 00:20:56 GMT
-### Prerelease Changes
+_Version update only_
-- Fix an issue with `watchGlobAsync`
+## 0.2.3
+Wed, 22 Feb 2023 16:26:55 GMT
-## 0.2.0-rc.3
-Fri, 20 Jan 2023 20:13:16 GMT
+### Patches
-### Prerelease Changes
+- Fix an issue where static build output ends up in the wrong folder.
-- Fix issues with SASS incremental builds.
-- Add support for TypeScript solution incremental builds.
-- Improve responsiveness of watcher loop.
+## 0.2.2
+Fri, 10 Feb 2023 01:18:51 GMT
-## 0.2.0-rc.2
-Fri, 2 Dec 2022 05:28:24 GMT
+_Version update only_
-### Prerelease Changes
+## 0.2.1
+Sun, 05 Feb 2023 03:02:02 GMT
-- Improve watch mode performance.
-- Improve logging output.
+_Version update only_
-## 0.2.0-rc.1
-Fri, 18 Nov 2022 02:34:26 GMT
+## 0.2.0
+Wed, 01 Feb 2023 02:16:34 GMT
-### Prerelease Changes
+### Minor changes
-- Fix incremental TypeScript compilation.
+- Add support for storybook static build
-## 0.2.0-rc.0
-Tue, 15 Nov 2022 22:59:35 GMT
+## 0.1.99
+Mon, 30 Jan 2023 16:22:31 GMT
-### Prerelease Changes
+_Version update only_
+
+## 0.1.98
+Mon, 30 Jan 2023 00:55:44 GMT
+
+_Version update only_
-- General fixes and improvements, in preparation for a general release.
+## 0.1.97
+Thu, 26 Jan 2023 02:55:10 GMT
+
+_Version update only_
+
+## 0.1.96
+Wed, 25 Jan 2023 07:26:55 GMT
+
+_Version update only_
+
+## 0.1.95
+Wed, 18 Jan 2023 22:44:12 GMT
+
+_Version update only_
## 0.1.94
Tue, 20 Dec 2022 01:18:22 GMT
diff --git a/heft-plugins/heft-storybook-plugin/package.json b/heft-plugins/heft-storybook-plugin/package.json
index ac266a681a2..e8921bb119f 100644
--- a/heft-plugins/heft-storybook-plugin/package.json
+++ b/heft-plugins/heft-storybook-plugin/package.json
@@ -1,6 +1,6 @@
{
"name": "@rushstack/heft-storybook-plugin",
- "version": "0.2.0-rc.4",
+ "version": "0.2.4",
"description": "Heft plugin for supporting UI development using Storybook",
"repository": {
"type": "git",
@@ -16,7 +16,7 @@
"_phase:test": "heft run --only test -- --clean"
},
"peerDependencies": {
- "@rushstack/heft": "0.50.0-rc.4"
+ "@rushstack/heft": "^0.50.0"
},
"dependencies": {
"@rushstack/node-core-library": "workspace:*"
@@ -27,6 +27,6 @@
"@rushstack/heft-node-rig": "workspace:*",
"@rushstack/heft-webpack4-plugin": "workspace:*",
"@rushstack/heft-webpack5-plugin": "workspace:*",
- "@types/node": "12.20.24"
+ "@types/node": "14.18.36"
}
}
diff --git a/heft-plugins/heft-storybook-plugin/src/StorybookPlugin.ts b/heft-plugins/heft-storybook-plugin/src/StorybookPlugin.ts
index 9d1a3fc16cf..362cd02868e 100644
--- a/heft-plugins/heft-storybook-plugin/src/StorybookPlugin.ts
+++ b/heft-plugins/heft-storybook-plugin/src/StorybookPlugin.ts
@@ -6,6 +6,7 @@ import {
FileSystem,
Import,
IParsedPackageNameOrError,
+ JsonSchema,
PackageName
} from '@rushstack/node-core-library';
import type {
@@ -60,20 +61,48 @@ export interface IStorybookPluginOptions {
storykitPackageName: string;
/**
- * The module entry point that Heft should use to launch the Storybook toolchain. Typically it
- * is the path loaded the `start-storybook` shell script.
+ * The module entry point that Heft serve mode should use to launch the Storybook toolchain.
+ * Typically it is the path loaded the `start-storybook` shell script.
*
* @example
* If you are using `@storybook/react`, then the startup path would be:
*
* `"startupModulePath": "@storybook/react/bin/index.js"`
*/
- startupModulePath: string;
+ startupModulePath?: string;
+
+ /**
+ * The module entry point that Heft non-serve mode should use to launch the Storybook toolchain.
+ * Typically it is the path loaded the `build-storybook` shell script.
+ *
+ * @example
+ * If you are using `@storybook/react`, then the static build path would be:
+ *
+ * `"staticBuildModulePath": "@storybook/react/bin/build.js"`
+ */
+ staticBuildModulePath?: string;
+
+ /**
+ * The customized output dir for storybook static build.
+ * If this is empty, then it will use the storybook default output dir.
+ *
+ * @example
+ * If you want to change the static build output dir to staticBuildDir, then the static build output dir would be:
+ *
+ * `"staticBuildOutputFolder": "newStaticBuildDir"`
+ */
+ staticBuildOutputFolder?: string;
+}
+
+interface IRunStorybookOptions {
+ resolvedModulePath: string;
+ outputFolder: string | undefined;
}
/** @public */
export default class StorybookPlugin implements IHeftTaskPlugin {
private _logger!: IScopedLogger;
+ private _isServeMode: boolean = false;
/**
* Generate typings for Sass files before TypeScript compilation.
@@ -96,6 +125,13 @@ export default class StorybookPlugin implements IHeftTaskPlugin Promise = async () => {
@@ -109,24 +145,34 @@ export default class StorybookPlugin implements IHeftTaskPlugin
- accessor.hooks.onLoadConfiguration.tapPromise(PLUGIN_NAME, configureWebpackTap)
+ (accessor: IWebpack4PluginAccessor) => {
+ // Discard Webpack's configuration to prevent Webpack from running only when starting a storybook server
+ if (accessor.parameters.isServeMode) {
+ this._isServeMode = true;
+ accessor.hooks.onLoadConfiguration.tapPromise(PLUGIN_NAME, configureWebpackTap);
+ }
+ }
);
taskSession.requestAccessToPluginByName(
'@rushstack/heft-webpack5-plugin',
WEBPACK5_PLUGIN_NAME,
- (accessor: IWebpack5PluginAccessor) =>
- accessor.hooks.onLoadConfiguration.tapPromise(PLUGIN_NAME, configureWebpackTap)
+ (accessor: IWebpack5PluginAccessor) => {
+ // Discard Webpack's configuration to prevent Webpack from running only when starting a storybook server
+ if (accessor.parameters.isServeMode) {
+ this._isServeMode = true;
+ accessor.hooks.onLoadConfiguration.tapPromise(PLUGIN_NAME, configureWebpackTap);
+ }
+ }
);
taskSession.hooks.run.tapPromise(PLUGIN_NAME, async (runOptions: IHeftTaskRunHookOptions) => {
- const resolvedStartupModulePath: string = await this._prepareStorybookAsync(
+ const runStorybookOptions: IRunStorybookOptions = await this._prepareStorybookAsync(
taskSession,
heftConfiguration,
options
);
- await this._runStorybookAsync(resolvedStartupModulePath);
+ await this._runStorybookAsync(runStorybookOptions);
});
}
}
@@ -135,7 +181,7 @@ export default class StorybookPlugin implements IHeftTaskPlugin {
+ ): Promise {
const { storykitPackageName, startupModulePath } = options;
this._logger.terminal.writeVerboseLine(`Probing for "${storykitPackageName}"`);
@@ -163,18 +209,28 @@ export default class StorybookPlugin implements IHeftTaskPlugin {
+ private async _runStorybookAsync(runStorybookOptions: IRunStorybookOptions): Promise {
+ const { resolvedModulePath, outputFolder } = runStorybookOptions;
this._logger.terminal.writeLine('Starting Storybook...');
- this._logger.terminal.writeLine(`Launching "${resolvedStartupModulePath}"`);
+ this._logger.terminal.writeLine(`Launching "${resolvedModulePath}"`);
+
+ if (outputFolder) {
+ const originalArgv: string[] = process.argv;
+ process.argv.push(`--output-dir=${outputFolder}`);
+ process.argv = originalArgv;
+ }
- require(resolvedStartupModulePath);
+ require(resolvedModulePath);
this._logger.terminal.writeVerboseLine('Completed synchronous portion of launching startupModulePath');
}
diff --git a/heft-plugins/heft-storybook-plugin/src/schemas/heft-storybook-plugin.schema.json b/heft-plugins/heft-storybook-plugin/src/schemas/heft-storybook-plugin.schema.json
new file mode 100644
index 00000000000..489b4fd0a59
--- /dev/null
+++ b/heft-plugins/heft-storybook-plugin/src/schemas/heft-storybook-plugin.schema.json
@@ -0,0 +1,30 @@
+{
+ "$schema": "http://json-schema.org/draft-04/schema#",
+ "title": "Heft Storybook Plugin Options Configuration",
+ "description": "This schema describes the \"options\" field that can be specified in heft.json when loading \"@rushstack/heft-storybook-plugin\".",
+ "type": "object",
+ "additionalProperties": false,
+
+ "properties": {
+ "storykitPackageName": {
+ "title": "Specifies an NPM package that will provide the Storybook dependencies for the project.",
+ "description": "Storybook's conventional approach is for your app project to have direct dependencies on NPM packages such as `@storybook/react` and `@storybook/addon-essentials`. These packages have heavyweight dependencies such as Babel, Webpack, and the associated loaders and plugins needed to build the Storybook app (which is bundled completely independently from Heft). Naively adding these dependencies to your app's package.json muddies the waters of two radically different toolchains, and is likely to lead to dependency conflicts, for example if Heft installs Webpack 5 but `@storybook/react` installs Webpack 4. To solve this problem, `heft-storybook-plugin` introduces the concept of a separate \"storykit package\". All of your Storybook NPM packages are moved to be dependencies of the storykit. Storybook's browser API unfortunately isn't separated into dedicated NPM packages, but instead is exported by the Node.js toolchain packages such as `@storybook/react`. For an even cleaner separation the storykit package can simply reexport such APIs.",
+ "type": "string"
+ },
+ "startupModulePath": {
+ "title": "The module entry point that Heft serve mode should use to launch the Storybook toolchain.",
+ "description": "Typically it is the path loaded the `start-storybook` shell script. For example, If you are using `@storybook/react`, then the startup path would be: `\"startupModulePath\": \"@storybook/react/bin/index.js\"`",
+ "type": "string"
+ },
+ "staticBuildModulePath": {
+ "title": "The module entry point that Heft non-serve mode should use to launch the Storybook toolchain.",
+ "description": "Typically it is the path loaded the `build-storybook` shell script. For example, If you are using `@storybook/react`, then the static build path would be: `\"staticBuildModulePath\": \"@storybook/react/bin/build.js\"`",
+ "type": "string"
+ },
+ "staticBuildOutputFolder": {
+ "title": "The customized output dir for storybook static build.",
+ "description": "If this is empty, then it will use the storybook default output dir. If you want to change the static build output dir to staticBuildDir, then the static build output dir would be: `\"staticBuildOutputFolder\": \"staticBuildDir\"`",
+ "type": "string"
+ }
+ }
+}
diff --git a/heft-plugins/heft-typescript-plugin/src/internalTypings/TypeScriptInternals.ts b/heft-plugins/heft-typescript-plugin/src/internalTypings/TypeScriptInternals.ts
index 79494e03432..a4d78dbfbdf 100644
--- a/heft-plugins/heft-typescript-plugin/src/internalTypings/TypeScriptInternals.ts
+++ b/heft-plugins/heft-typescript-plugin/src/internalTypings/TypeScriptInternals.ts
@@ -18,6 +18,7 @@ export interface IExtendedTypeScript {
* https://github.com/microsoft/TypeScript/blob/5f597e69b2e3b48d788cb548df40bcb703c8adb1/src/compiler/performance.ts#L119-L121
*/
disable(): void;
+
/**
* https://github.com/microsoft/TypeScript/blob/5f597e69b2e3b48d788cb548df40bcb703c8adb1/src/compiler/performance.ts#L110-L116
*/
diff --git a/heft-plugins/heft-webpack4-plugin/CHANGELOG.json b/heft-plugins/heft-webpack4-plugin/CHANGELOG.json
index 09dbaaa193c..3a225f70358 100644
--- a/heft-plugins/heft-webpack4-plugin/CHANGELOG.json
+++ b/heft-plugins/heft-webpack4-plugin/CHANGELOG.json
@@ -2,70 +2,172 @@
"name": "@rushstack/heft-webpack4-plugin",
"entries": [
{
- "version": "0.6.0-rc.4",
- "tag": "@rushstack/heft-webpack4-plugin_v0.6.0-rc.4",
- "date": "Wed, 15 Mar 2023 20:22:44 GMT",
+ "version": "0.5.40",
+ "tag": "@rushstack/heft-webpack4-plugin_v0.5.40",
+ "date": "Sat, 18 Mar 2023 00:20:56 GMT",
"comments": {
- "minor": [
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.5`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.50.0`"
+ },
{
- "comment": "Fix an issue with `watchGlobAsync`"
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.7` to `^0.50.0`"
}
]
}
},
{
- "version": "0.6.0-rc.3",
- "tag": "@rushstack/heft-webpack4-plugin_v0.6.0-rc.3",
- "date": "Fri, 20 Jan 2023 20:13:16 GMT",
+ "version": "0.5.39",
+ "tag": "@rushstack/heft-webpack4-plugin_v0.5.39",
+ "date": "Fri, 10 Feb 2023 01:18:51 GMT",
"comments": {
- "minor": [
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.2`"
+ },
{
- "comment": "Fix issues with SASS incremental builds."
+ "comment": "Updating dependency \"@rushstack/eslint-config\" to `3.2.0`"
},
{
- "comment": "Add support for TypeScript solution incremental builds."
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.4`"
},
{
- "comment": "Improve responsiveness of watcher loop."
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.7`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.6` to `^0.49.7`"
}
]
}
},
{
- "version": "0.6.0-rc.2",
- "tag": "@rushstack/heft-webpack4-plugin_v0.6.0-rc.2",
- "date": "Fri, 2 Dec 2022 05:28:24 GMT",
+ "version": "0.5.38",
+ "tag": "@rushstack/heft-webpack4-plugin_v0.5.38",
+ "date": "Sun, 05 Feb 2023 03:02:02 GMT",
"comments": {
- "minor": [
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.3`"
+ },
{
- "comment": "Improve watch mode performance."
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.6`"
},
{
- "comment": "Improve logging output."
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.5` to `^0.49.6`"
}
]
}
},
{
- "version": "0.6.0-rc.1",
- "tag": "@rushstack/heft-webpack4-plugin_v0.6.0-rc.1",
- "date": "Fri, 18 Nov 2022 02:34:26 GMT",
+ "version": "0.5.37",
+ "tag": "@rushstack/heft-webpack4-plugin_v0.5.37",
+ "date": "Wed, 01 Feb 2023 02:16:34 GMT",
"comments": {
- "minor": [
+ "dependency": [
{
- "comment": "Fix incremental TypeScript compilation."
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.5`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.4` to `^0.49.5`"
}
]
}
},
{
- "version": "0.6.0-rc.0",
- "tag": "@rushstack/heft-webpack4-plugin_v0.6.0-rc.0",
- "date": "Tue, 15 Nov 2022 22:59:35 GMT",
+ "version": "0.5.36",
+ "tag": "@rushstack/heft-webpack4-plugin_v0.5.36",
+ "date": "Mon, 30 Jan 2023 16:22:31 GMT",
"comments": {
- "minor": [
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.54.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.4`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.3` to `^0.49.4`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.5.35",
+ "tag": "@rushstack/heft-webpack4-plugin_v0.5.35",
+ "date": "Mon, 30 Jan 2023 00:55:44 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.0`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.5.34",
+ "tag": "@rushstack/heft-webpack4-plugin_v0.5.34",
+ "date": "Thu, 26 Jan 2023 02:55:10 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.14`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.3`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.2` to `^0.49.3`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.5.33",
+ "tag": "@rushstack/heft-webpack4-plugin_v0.5.33",
+ "date": "Wed, 25 Jan 2023 07:26:55 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.13`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.1` to `^0.49.2`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.5.32",
+ "tag": "@rushstack/heft-webpack4-plugin_v0.5.32",
+ "date": "Wed, 18 Jan 2023 22:44:12 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.12`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.1`"
+ },
{
- "comment": "General fixes and improvements, in preparation for a general release."
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.0` to `^0.49.1`"
}
]
}
diff --git a/heft-plugins/heft-webpack4-plugin/CHANGELOG.md b/heft-plugins/heft-webpack4-plugin/CHANGELOG.md
index 341ef10969d..8929c037c4d 100644
--- a/heft-plugins/heft-webpack4-plugin/CHANGELOG.md
+++ b/heft-plugins/heft-webpack4-plugin/CHANGELOG.md
@@ -1,44 +1,51 @@
# Change Log - @rushstack/heft-webpack4-plugin
-This log was last generated on Wed, 15 Mar 2023 20:22:44 GMT and should not be manually modified.
+This log was last generated on Sat, 18 Mar 2023 00:20:56 GMT and should not be manually modified.
-## 0.6.0-rc.4
-Wed, 15 Mar 2023 20:22:44 GMT
+## 0.5.40
+Sat, 18 Mar 2023 00:20:56 GMT
-### Prerelease Changes
+_Version update only_
+
+## 0.5.39
+Fri, 10 Feb 2023 01:18:51 GMT
+
+_Version update only_
+
+## 0.5.38
+Sun, 05 Feb 2023 03:02:02 GMT
-- Fix an issue with `watchGlobAsync`
+_Version update only_
-## 0.6.0-rc.3
-Fri, 20 Jan 2023 20:13:16 GMT
+## 0.5.37
+Wed, 01 Feb 2023 02:16:34 GMT
-### Prerelease Changes
+_Version update only_
-- Fix issues with SASS incremental builds.
-- Add support for TypeScript solution incremental builds.
-- Improve responsiveness of watcher loop.
+## 0.5.36
+Mon, 30 Jan 2023 16:22:31 GMT
-## 0.6.0-rc.2
-Fri, 2 Dec 2022 05:28:24 GMT
+_Version update only_
-### Prerelease Changes
+## 0.5.35
+Mon, 30 Jan 2023 00:55:44 GMT
-- Improve watch mode performance.
-- Improve logging output.
+_Version update only_
-## 0.6.0-rc.1
-Fri, 18 Nov 2022 02:34:26 GMT
+## 0.5.34
+Thu, 26 Jan 2023 02:55:10 GMT
-### Prerelease Changes
+_Version update only_
-- Fix incremental TypeScript compilation.
+## 0.5.33
+Wed, 25 Jan 2023 07:26:55 GMT
-## 0.6.0-rc.0
-Tue, 15 Nov 2022 22:59:35 GMT
+_Version update only_
-### Prerelease Changes
+## 0.5.32
+Wed, 18 Jan 2023 22:44:12 GMT
-- General fixes and improvements, in preparation for a general release.
+_Version update only_
## 0.5.31
Tue, 20 Dec 2022 01:18:22 GMT
diff --git a/heft-plugins/heft-webpack4-plugin/package.json b/heft-plugins/heft-webpack4-plugin/package.json
index 48d2c17a0df..e37cd8c569a 100644
--- a/heft-plugins/heft-webpack4-plugin/package.json
+++ b/heft-plugins/heft-webpack4-plugin/package.json
@@ -1,6 +1,6 @@
{
"name": "@rushstack/heft-webpack4-plugin",
- "version": "0.6.0-rc.4",
+ "version": "0.5.40",
"description": "Heft plugin for Webpack 4",
"repository": {
"type": "git",
@@ -23,7 +23,7 @@
}
},
"peerDependencies": {
- "@rushstack/heft": "0.50.0-rc.4",
+ "@rushstack/heft": "^0.50.0",
"@types/webpack": "^4",
"webpack": "~4.44.2"
},
@@ -39,7 +39,7 @@
"@rushstack/eslint-config": "workspace:*",
"@rushstack/heft-node-rig": "workspace:*",
"@rushstack/heft": "workspace:*",
- "@types/node": "12.20.24",
+ "@types/node": "14.18.36",
"@types/watchpack": "2.4.0",
"@types/webpack": "4.41.32",
"webpack": "~4.44.2"
diff --git a/heft-plugins/heft-webpack5-plugin/CHANGELOG.json b/heft-plugins/heft-webpack5-plugin/CHANGELOG.json
index 684f4e0672d..0d6c31b2095 100644
--- a/heft-plugins/heft-webpack5-plugin/CHANGELOG.json
+++ b/heft-plugins/heft-webpack5-plugin/CHANGELOG.json
@@ -2,70 +2,189 @@
"name": "@rushstack/heft-webpack5-plugin",
"entries": [
{
- "version": "0.6.0-rc.4",
- "tag": "@rushstack/heft-webpack5-plugin_v0.6.0-rc.4",
- "date": "Wed, 15 Mar 2023 20:22:44 GMT",
+ "version": "0.6.1",
+ "tag": "@rushstack/heft-webpack5-plugin_v0.6.1",
+ "date": "Sat, 18 Mar 2023 00:20:56 GMT",
"comments": {
- "minor": [
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.50.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.5`"
+ },
{
- "comment": "Fix an issue with `watchGlobAsync`"
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.7` to `^0.50.0`"
}
]
}
},
{
- "version": "0.6.0-rc.3",
- "tag": "@rushstack/heft-webpack5-plugin_v0.6.0-rc.3",
- "date": "Fri, 20 Jan 2023 20:13:16 GMT",
+ "version": "0.6.0",
+ "tag": "@rushstack/heft-webpack5-plugin_v0.6.0",
+ "date": "Sat, 11 Mar 2023 01:24:51 GMT",
"comments": {
"minor": [
{
- "comment": "Fix issues with SASS incremental builds."
+ "comment": "Add support for `.cjs` and `.mjs` file extensions for webpack config files, in addition to the `.js` file extension."
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.5.73",
+ "tag": "@rushstack/heft-webpack5-plugin_v0.5.73",
+ "date": "Fri, 10 Feb 2023 01:18:51 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.2`"
},
{
- "comment": "Add support for TypeScript solution incremental builds."
+ "comment": "Updating dependency \"@rushstack/eslint-config\" to `3.2.0`"
},
{
- "comment": "Improve responsiveness of watcher loop."
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.7`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.4`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.6` to `^0.49.7`"
}
]
}
},
{
- "version": "0.6.0-rc.2",
- "tag": "@rushstack/heft-webpack5-plugin_v0.6.0-rc.2",
- "date": "Fri, 2 Dec 2022 05:28:24 GMT",
+ "version": "0.5.72",
+ "tag": "@rushstack/heft-webpack5-plugin_v0.5.72",
+ "date": "Sun, 05 Feb 2023 03:02:02 GMT",
"comments": {
- "minor": [
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.1`"
+ },
{
- "comment": "Improve watch mode performance."
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.6`"
},
{
- "comment": "Improve logging output."
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.3`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.5` to `^0.49.6`"
}
]
}
},
{
- "version": "0.6.0-rc.1",
- "tag": "@rushstack/heft-webpack5-plugin_v0.6.0-rc.1",
- "date": "Fri, 18 Nov 2022 02:34:26 GMT",
+ "version": "0.5.71",
+ "tag": "@rushstack/heft-webpack5-plugin_v0.5.71",
+ "date": "Wed, 01 Feb 2023 02:16:34 GMT",
"comments": {
- "minor": [
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.0`"
+ },
{
- "comment": "Fix incremental TypeScript compilation."
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.5`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.4` to `^0.49.5`"
}
]
}
},
{
- "version": "0.6.0-rc.0",
- "tag": "@rushstack/heft-webpack5-plugin_v0.6.0-rc.0",
- "date": "Tue, 15 Nov 2022 22:59:35 GMT",
+ "version": "0.5.70",
+ "tag": "@rushstack/heft-webpack5-plugin_v0.5.70",
+ "date": "Mon, 30 Jan 2023 16:22:31 GMT",
"comments": {
- "minor": [
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.54.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.4`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.3` to `^0.49.4`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.5.69",
+ "tag": "@rushstack/heft-webpack5-plugin_v0.5.69",
+ "date": "Mon, 30 Jan 2023 00:55:44 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.0`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.5.68",
+ "tag": "@rushstack/heft-webpack5-plugin_v0.5.68",
+ "date": "Thu, 26 Jan 2023 02:55:10 GMT",
+ "comments": {
+ "patch": [
+ {
+ "comment": "Upgrade to webpack 5.75.0"
+ }
+ ],
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.3`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.14`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.2` to `^0.49.3`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.5.67",
+ "tag": "@rushstack/heft-webpack5-plugin_v0.5.67",
+ "date": "Wed, 25 Jan 2023 07:26:55 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.13`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.1` to `^0.49.2`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.5.66",
+ "tag": "@rushstack/heft-webpack5-plugin_v0.5.66",
+ "date": "Wed, 18 Jan 2023 22:44:12 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.12`"
+ },
{
- "comment": "General fixes and improvements, in preparation for a general release."
+ "comment": "Updating dependency \"@rushstack/heft\" from `^0.49.0` to `^0.49.1`"
}
]
}
diff --git a/heft-plugins/heft-webpack5-plugin/CHANGELOG.md b/heft-plugins/heft-webpack5-plugin/CHANGELOG.md
index 7ef55fd6bc7..da2cf4b3988 100644
--- a/heft-plugins/heft-webpack5-plugin/CHANGELOG.md
+++ b/heft-plugins/heft-webpack5-plugin/CHANGELOG.md
@@ -1,44 +1,60 @@
# Change Log - @rushstack/heft-webpack5-plugin
-This log was last generated on Wed, 15 Mar 2023 20:22:44 GMT and should not be manually modified.
+This log was last generated on Sat, 18 Mar 2023 00:20:56 GMT and should not be manually modified.
-## 0.6.0-rc.4
-Wed, 15 Mar 2023 20:22:44 GMT
+## 0.6.1
+Sat, 18 Mar 2023 00:20:56 GMT
-### Prerelease Changes
+_Version update only_
-- Fix an issue with `watchGlobAsync`
+## 0.6.0
+Sat, 11 Mar 2023 01:24:51 GMT
-## 0.6.0-rc.3
-Fri, 20 Jan 2023 20:13:16 GMT
+### Minor changes
-### Prerelease Changes
+- Add support for `.cjs` and `.mjs` file extensions for webpack config files, in addition to the `.js` file extension.
-- Fix issues with SASS incremental builds.
-- Add support for TypeScript solution incremental builds.
-- Improve responsiveness of watcher loop.
+## 0.5.73
+Fri, 10 Feb 2023 01:18:51 GMT
-## 0.6.0-rc.2
-Fri, 2 Dec 2022 05:28:24 GMT
+_Version update only_
-### Prerelease Changes
+## 0.5.72
+Sun, 05 Feb 2023 03:02:02 GMT
-- Improve watch mode performance.
-- Improve logging output.
+_Version update only_
-## 0.6.0-rc.1
-Fri, 18 Nov 2022 02:34:26 GMT
+## 0.5.71
+Wed, 01 Feb 2023 02:16:34 GMT
-### Prerelease Changes
+_Version update only_
-- Fix incremental TypeScript compilation.
+## 0.5.70
+Mon, 30 Jan 2023 16:22:31 GMT
-## 0.6.0-rc.0
-Tue, 15 Nov 2022 22:59:35 GMT
+_Version update only_
+
+## 0.5.69
+Mon, 30 Jan 2023 00:55:44 GMT
+
+_Version update only_
-### Prerelease Changes
+## 0.5.68
+Thu, 26 Jan 2023 02:55:10 GMT
-- General fixes and improvements, in preparation for a general release.
+### Patches
+
+- Upgrade to webpack 5.75.0
+
+## 0.5.67
+Wed, 25 Jan 2023 07:26:55 GMT
+
+_Version update only_
+
+## 0.5.66
+Wed, 18 Jan 2023 22:44:12 GMT
+
+_Version update only_
## 0.5.65
Tue, 20 Dec 2022 01:18:22 GMT
diff --git a/heft-plugins/heft-webpack5-plugin/package.json b/heft-plugins/heft-webpack5-plugin/package.json
index d46d292f183..d0364fdab4f 100644
--- a/heft-plugins/heft-webpack5-plugin/package.json
+++ b/heft-plugins/heft-webpack5-plugin/package.json
@@ -1,6 +1,6 @@
{
"name": "@rushstack/heft-webpack5-plugin",
- "version": "0.6.0-rc.4",
+ "version": "0.6.1",
"description": "Heft plugin for Webpack 5",
"repository": {
"type": "git",
@@ -18,8 +18,8 @@
"_phase:test": "heft run --only test -- --clean"
},
"peerDependencies": {
- "@rushstack/heft": "0.50.0-rc.4",
- "webpack": "~5.68.0"
+ "@rushstack/heft": "^0.50.0",
+ "webpack": "~5.75.0"
},
"dependencies": {
"@rushstack/debug-certificate-manager": "workspace:*",
@@ -33,8 +33,8 @@
"@rushstack/eslint-config": "workspace:*",
"@rushstack/heft": "workspace:*",
"@rushstack/heft-node-rig": "workspace:*",
- "@types/node": "12.20.24",
+ "@types/node": "14.18.36",
"@types/watchpack": "2.4.0",
- "webpack": "~5.68.0"
+ "webpack": "~5.75.0"
}
}
diff --git a/libraries/api-extractor-model/CHANGELOG.json b/libraries/api-extractor-model/CHANGELOG.json
index eff8e4b43a6..1d2a4295f72 100644
--- a/libraries/api-extractor-model/CHANGELOG.json
+++ b/libraries/api-extractor-model/CHANGELOG.json
@@ -1,6 +1,69 @@
{
"name": "@microsoft/api-extractor-model",
"entries": [
+ {
+ "version": "7.26.4",
+ "tag": "@microsoft/api-extractor-model_v7.26.4",
+ "date": "Fri, 10 Feb 2023 01:18:51 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/eslint-config\" to `3.2.0`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "7.26.3",
+ "tag": "@microsoft/api-extractor-model_v7.26.3",
+ "date": "Sun, 05 Feb 2023 03:02:02 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.1`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "7.26.2",
+ "tag": "@microsoft/api-extractor-model_v7.26.2",
+ "date": "Wed, 01 Feb 2023 02:16:34 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.0`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "7.26.1",
+ "tag": "@microsoft/api-extractor-model_v7.26.1",
+ "date": "Mon, 30 Jan 2023 16:22:30 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.54.0`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "7.26.0",
+ "tag": "@microsoft/api-extractor-model_v7.26.0",
+ "date": "Wed, 25 Jan 2023 07:26:55 GMT",
+ "comments": {
+ "minor": [
+ {
+ "comment": "Add new .api.json field `isAbstract` to track `abstract` modifier in ApiClass, ApiMethod, and ApiProperty via ApiAbstractMixin (GitHub #3661)"
+ }
+ ]
+ }
+ },
{
"version": "7.25.3",
"tag": "@microsoft/api-extractor-model_v7.25.3",
diff --git a/libraries/api-extractor-model/CHANGELOG.md b/libraries/api-extractor-model/CHANGELOG.md
index b9c12549057..5591e88453b 100644
--- a/libraries/api-extractor-model/CHANGELOG.md
+++ b/libraries/api-extractor-model/CHANGELOG.md
@@ -1,6 +1,33 @@
# Change Log - @microsoft/api-extractor-model
-This log was last generated on Fri, 09 Dec 2022 16:18:28 GMT and should not be manually modified.
+This log was last generated on Fri, 10 Feb 2023 01:18:51 GMT and should not be manually modified.
+
+## 7.26.4
+Fri, 10 Feb 2023 01:18:51 GMT
+
+_Version update only_
+
+## 7.26.3
+Sun, 05 Feb 2023 03:02:02 GMT
+
+_Version update only_
+
+## 7.26.2
+Wed, 01 Feb 2023 02:16:34 GMT
+
+_Version update only_
+
+## 7.26.1
+Mon, 30 Jan 2023 16:22:30 GMT
+
+_Version update only_
+
+## 7.26.0
+Wed, 25 Jan 2023 07:26:55 GMT
+
+### Minor changes
+
+- Add new .api.json field `isAbstract` to track `abstract` modifier in ApiClass, ApiMethod, and ApiProperty via ApiAbstractMixin (GitHub #3661)
## 7.25.3
Fri, 09 Dec 2022 16:18:28 GMT
diff --git a/libraries/api-extractor-model/package.json b/libraries/api-extractor-model/package.json
index 28a15e381f6..0e647f3744e 100644
--- a/libraries/api-extractor-model/package.json
+++ b/libraries/api-extractor-model/package.json
@@ -1,6 +1,6 @@
{
"name": "@microsoft/api-extractor-model",
- "version": "7.25.3",
+ "version": "7.26.4",
"description": "A helper library for loading and saving the .api.json files created by API Extractor",
"repository": {
"type": "git",
@@ -23,9 +23,9 @@
},
"devDependencies": {
"@rushstack/eslint-config": "workspace:*",
- "@rushstack/heft": "0.48.0",
- "@rushstack/heft-node-rig": "1.11.0",
+ "@rushstack/heft": "0.49.3",
+ "@rushstack/heft-node-rig": "1.11.14",
"@types/heft-jest": "1.0.1",
- "@types/node": "12.20.24"
+ "@types/node": "14.18.36"
}
}
diff --git a/libraries/api-extractor-model/src/index.ts b/libraries/api-extractor-model/src/index.ts
index 02f91849e19..be473904f9e 100644
--- a/libraries/api-extractor-model/src/index.ts
+++ b/libraries/api-extractor-model/src/index.ts
@@ -30,6 +30,7 @@ export {
IApiTypeParameterListMixinOptions,
ApiTypeParameterListMixin
} from './mixins/ApiTypeParameterListMixin';
+export { IApiAbstractMixinOptions, ApiAbstractMixin } from './mixins/ApiAbstractMixin';
export { IApiItemContainerMixinOptions, ApiItemContainerMixin } from './mixins/ApiItemContainerMixin';
export { IApiProtectedMixinOptions, ApiProtectedMixin } from './mixins/ApiProtectedMixin';
export { IApiReleaseTagMixinOptions, ApiReleaseTagMixin } from './mixins/ApiReleaseTagMixin';
diff --git a/libraries/api-extractor-model/src/mixins/ApiAbstractMixin.ts b/libraries/api-extractor-model/src/mixins/ApiAbstractMixin.ts
new file mode 100644
index 00000000000..f73aa84cb50
--- /dev/null
+++ b/libraries/api-extractor-model/src/mixins/ApiAbstractMixin.ts
@@ -0,0 +1,113 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.s
+
+import { ApiItem, IApiItemJson, IApiItemConstructor, IApiItemOptions } from '../items/ApiItem';
+import { DeserializerContext } from '../model/DeserializerContext';
+
+/**
+ * Constructor options for {@link (ApiAbstractMixin:interface)}.
+ * @public
+ */
+export interface IApiAbstractMixinOptions extends IApiItemOptions {
+ isAbstract: boolean;
+}
+
+export interface IApiAbstractMixinJson extends IApiItemJson {
+ isAbstract: boolean;
+}
+
+const _isAbstract: unique symbol = Symbol('ApiAbstractMixin._isAbstract');
+
+/**
+ * The mixin base class for API items that have an abstract modifier.
+ *
+ * @remarks
+ *
+ * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of
+ * API declarations. The non-abstract classes (e.g. `ApiClass`, `ApiEnum`, `ApiInterface`, etc.) use
+ * TypeScript "mixin" functions (e.g. `ApiDeclaredItem`, `ApiItemContainerMixin`, etc.) to add various
+ * features that cannot be represented as a normal inheritance chain (since TypeScript does not allow a child class
+ * to extend more than one base class). The "mixin" is a TypeScript merged declaration with three components:
+ * the function that generates a subclass, an interface that describes the members of the subclass, and
+ * a namespace containing static members of the class.
+ *
+ * @public
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export interface ApiAbstractMixin extends ApiItem {
+ /**
+ * Indicates that the API item's value has an 'abstract' modifier.
+ */
+ readonly isAbstract: boolean;
+
+ serializeInto(jsonObject: Partial): void;
+}
+
+/**
+ * Mixin function for {@link (ApiAbstractMixin:interface)}.
+ *
+ * @param baseClass - The base class to be extended
+ * @returns A child class that extends baseClass, adding the {@link (ApiAbstractMixin:interface)}
+ * functionality.
+ *
+ * @public
+ */
+export function ApiAbstractMixin(
+ baseClass: TBaseClass
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+): TBaseClass & (new (...args: any[]) => ApiAbstractMixin) {
+ class MixedClass extends baseClass implements ApiAbstractMixin {
+ public [_isAbstract]: boolean;
+
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ public constructor(...args: any[]) {
+ super(...args);
+
+ const options: IApiAbstractMixinOptions = args[0];
+ this[_isAbstract] = options.isAbstract;
+ }
+
+ /** @override */
+ public static onDeserializeInto(
+ options: Partial,
+ context: DeserializerContext,
+ jsonObject: IApiAbstractMixinJson
+ ): void {
+ baseClass.onDeserializeInto(options, context, jsonObject);
+
+ options.isAbstract = jsonObject.isAbstract || false;
+ }
+
+ public get isAbstract(): boolean {
+ return this[_isAbstract];
+ }
+
+ /** @override */
+ public serializeInto(jsonObject: Partial): void {
+ super.serializeInto(jsonObject);
+
+ jsonObject.isAbstract = this.isAbstract;
+ }
+ }
+
+ return MixedClass;
+}
+
+/**
+ * Static members for {@link (ApiAbstractMixin:interface)}.
+ * @public
+ */
+export namespace ApiAbstractMixin {
+ /**
+ * A type guard that tests whether the specified `ApiItem` subclass extends the `ApiAbstractMixin` mixin.
+ *
+ * @remarks
+ *
+ * The JavaScript `instanceof` operator cannot be used to test for mixin inheritance, because each invocation of
+ * the mixin function produces a different subclass. (This could be mitigated by `Symbol.hasInstance`, however
+ * the TypeScript type system cannot invoke a runtime test.)
+ */
+ export function isBaseClassOf(apiItem: ApiItem): apiItem is ApiAbstractMixin {
+ return apiItem.hasOwnProperty(_isAbstract);
+ }
+}
diff --git a/libraries/api-extractor-model/src/model/ApiClass.ts b/libraries/api-extractor-model/src/model/ApiClass.ts
index d207d96a6b9..6fc51b4bc83 100644
--- a/libraries/api-extractor-model/src/model/ApiClass.ts
+++ b/libraries/api-extractor-model/src/model/ApiClass.ts
@@ -25,6 +25,11 @@ import {
IApiExportedMixinOptions,
ApiExportedMixin
} from '../mixins/ApiExportedMixin';
+import {
+ ApiAbstractMixin,
+ IApiAbstractMixinJson,
+ IApiAbstractMixinOptions
+} from '../mixins/ApiAbstractMixin';
/**
* Constructor options for {@link ApiClass}.
@@ -33,6 +38,7 @@ import {
export interface IApiClassOptions
extends IApiItemContainerMixinOptions,
IApiNameMixinOptions,
+ IApiAbstractMixinOptions,
IApiReleaseTagMixinOptions,
IApiDeclaredItemOptions,
IApiTypeParameterListMixinOptions,
@@ -43,6 +49,7 @@ export interface IApiClassOptions
export interface IApiClassJson
extends IApiDeclaredItemJson,
+ IApiAbstractMixinJson,
IApiTypeParameterListMixinJson,
IApiExportedMixinJson {
extendsTokenRange?: IExcerptTokenRange;
@@ -66,7 +73,9 @@ export interface IApiClassJson
* @public
*/
export class ApiClass extends ApiItemContainerMixin(
- ApiNameMixin(ApiTypeParameterListMixin(ApiReleaseTagMixin(ApiExportedMixin(ApiDeclaredItem))))
+ ApiNameMixin(
+ ApiAbstractMixin(ApiTypeParameterListMixin(ApiReleaseTagMixin(ApiExportedMixin(ApiDeclaredItem))))
+ )
) {
/**
* The base class that this class inherits from (using the `extends` keyword), or undefined if there is no base class.
diff --git a/libraries/api-extractor-model/src/model/ApiMethod.ts b/libraries/api-extractor-model/src/model/ApiMethod.ts
index c5b71ae03a5..ea3a5fd576d 100644
--- a/libraries/api-extractor-model/src/model/ApiMethod.ts
+++ b/libraries/api-extractor-model/src/model/ApiMethod.ts
@@ -15,6 +15,7 @@ import { IApiParameterListMixinOptions, ApiParameterListMixin } from '../mixins/
import { IApiReleaseTagMixinOptions, ApiReleaseTagMixin } from '../mixins/ApiReleaseTagMixin';
import { ApiReturnTypeMixin, IApiReturnTypeMixinOptions } from '../mixins/ApiReturnTypeMixin';
import { IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin';
+import { IApiAbstractMixinOptions, ApiAbstractMixin } from '../mixins/ApiAbstractMixin';
import {
ApiTypeParameterListMixin,
IApiTypeParameterListMixinOptions
@@ -27,6 +28,7 @@ import { ApiOptionalMixin, IApiOptionalMixinOptions } from '../mixins/ApiOptiona
*/
export interface IApiMethodOptions
extends IApiNameMixinOptions,
+ IApiAbstractMixinOptions,
IApiOptionalMixinOptions,
IApiParameterListMixinOptions,
IApiProtectedMixinOptions,
@@ -58,10 +60,12 @@ export interface IApiMethodOptions
* @public
*/
export class ApiMethod extends ApiNameMixin(
- ApiOptionalMixin(
- ApiParameterListMixin(
- ApiProtectedMixin(
- ApiReleaseTagMixin(ApiReturnTypeMixin(ApiStaticMixin(ApiTypeParameterListMixin(ApiDeclaredItem))))
+ ApiAbstractMixin(
+ ApiOptionalMixin(
+ ApiParameterListMixin(
+ ApiProtectedMixin(
+ ApiReleaseTagMixin(ApiReturnTypeMixin(ApiStaticMixin(ApiTypeParameterListMixin(ApiDeclaredItem))))
+ )
)
)
)
diff --git a/libraries/api-extractor-model/src/model/ApiProperty.ts b/libraries/api-extractor-model/src/model/ApiProperty.ts
index 23aa832ffb1..f198a96dd5b 100644
--- a/libraries/api-extractor-model/src/model/ApiProperty.ts
+++ b/libraries/api-extractor-model/src/model/ApiProperty.ts
@@ -8,6 +8,7 @@ import {
Component
} from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';
import { ApiItemKind } from '../items/ApiItem';
+import { ApiAbstractMixin, IApiAbstractMixinOptions } from '../mixins/ApiAbstractMixin';
import { ApiProtectedMixin, IApiProtectedMixinOptions } from '../mixins/ApiProtectedMixin';
import { ApiStaticMixin, IApiStaticMixinOptions } from '../mixins/ApiStaticMixin';
import { ApiInitializerMixin, IApiInitializerMixinOptions } from '../mixins/ApiInitializerMixin';
@@ -19,6 +20,7 @@ import { ApiPropertyItem, IApiPropertyItemOptions } from '../items/ApiPropertyIt
*/
export interface IApiPropertyOptions
extends IApiPropertyItemOptions,
+ IApiAbstractMixinOptions,
IApiProtectedMixinOptions,
IApiStaticMixinOptions,
IApiInitializerMixinOptions {}
@@ -57,7 +59,9 @@ export interface IApiPropertyOptions
*
* @public
*/
-export class ApiProperty extends ApiProtectedMixin(ApiStaticMixin(ApiInitializerMixin(ApiPropertyItem))) {
+export class ApiProperty extends ApiAbstractMixin(
+ ApiProtectedMixin(ApiStaticMixin(ApiInitializerMixin(ApiPropertyItem)))
+) {
public constructor(options: IApiPropertyOptions) {
super(options);
}
diff --git a/libraries/api-extractor-model/src/model/DeserializerContext.ts b/libraries/api-extractor-model/src/model/DeserializerContext.ts
index 6c1d6fab487..b50aa8b1a68 100644
--- a/libraries/api-extractor-model/src/model/DeserializerContext.ts
+++ b/libraries/api-extractor-model/src/model/DeserializerContext.ts
@@ -82,13 +82,21 @@ export enum ApiJsonSchemaVersion {
*/
V_1010 = 1010,
+ /**
+ * Add an `isAbstract` field to `ApiClass`, `ApiMethod`, and `ApiProperty` to
+ * track whether the item is abstract.
+ *
+ * When loading older JSON files, the value defaults to `false`.
+ */
+ V_1011 = 1011,
+
/**
* The current latest .api.json schema version.
*
* IMPORTANT: When incrementing this number, consider whether `OLDEST_SUPPORTED` or `OLDEST_FORWARDS_COMPATIBLE`
* should be updated.
*/
- LATEST = V_1010,
+ LATEST = V_1011,
/**
* The oldest .api.json schema version that is still supported for backwards compatibility.
diff --git a/libraries/debug-certificate-manager/CHANGELOG.json b/libraries/debug-certificate-manager/CHANGELOG.json
index 96939d4a332..cdd41917cb1 100644
--- a/libraries/debug-certificate-manager/CHANGELOG.json
+++ b/libraries/debug-certificate-manager/CHANGELOG.json
@@ -1,6 +1,177 @@
{
"name": "@rushstack/debug-certificate-manager",
"entries": [
+ {
+ "version": "1.2.19",
+ "tag": "@rushstack/debug-certificate-manager_v1.2.19",
+ "date": "Mon, 20 Mar 2023 20:14:20 GMT",
+ "comments": {
+ "patch": [
+ {
+ "comment": "Force certificates with a validity period longer than the expected validity period to be refreshed."
+ }
+ ]
+ }
+ },
+ {
+ "version": "1.2.18",
+ "tag": "@rushstack/debug-certificate-manager_v1.2.18",
+ "date": "Sat, 18 Mar 2023 00:20:56 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.50.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.5`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "1.2.17",
+ "tag": "@rushstack/debug-certificate-manager_v1.2.17",
+ "date": "Fri, 03 Mar 2023 04:11:20 GMT",
+ "comments": {
+ "patch": [
+ {
+ "comment": "Fix an issue where certificate expiration was calculated incorrectly and certificates were set to expire too late."
+ }
+ ]
+ }
+ },
+ {
+ "version": "1.2.16",
+ "tag": "@rushstack/debug-certificate-manager_v1.2.16",
+ "date": "Fri, 10 Feb 2023 01:18:50 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/eslint-config\" to `3.2.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.7`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.4`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "1.2.15",
+ "tag": "@rushstack/debug-certificate-manager_v1.2.15",
+ "date": "Sun, 05 Feb 2023 03:02:02 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.6`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.3`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "1.2.14",
+ "tag": "@rushstack/debug-certificate-manager_v1.2.14",
+ "date": "Wed, 01 Feb 2023 02:16:34 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.5`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.2`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "1.2.13",
+ "tag": "@rushstack/debug-certificate-manager_v1.2.13",
+ "date": "Mon, 30 Jan 2023 16:22:31 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.54.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.4`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.1`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "1.2.12",
+ "tag": "@rushstack/debug-certificate-manager_v1.2.12",
+ "date": "Mon, 30 Jan 2023 00:55:44 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.0`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "1.2.11",
+ "tag": "@rushstack/debug-certificate-manager_v1.2.11",
+ "date": "Thu, 26 Jan 2023 02:55:10 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.3`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.14`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "1.2.10",
+ "tag": "@rushstack/debug-certificate-manager_v1.2.10",
+ "date": "Wed, 25 Jan 2023 07:26:55 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.13`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "1.2.9",
+ "tag": "@rushstack/debug-certificate-manager_v1.2.9",
+ "date": "Wed, 18 Jan 2023 22:44:12 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.12`"
+ }
+ ]
+ }
+ },
{
"version": "1.2.8",
"tag": "@rushstack/debug-certificate-manager_v1.2.8",
diff --git a/libraries/debug-certificate-manager/CHANGELOG.md b/libraries/debug-certificate-manager/CHANGELOG.md
index 38e0e443d03..355714dd147 100644
--- a/libraries/debug-certificate-manager/CHANGELOG.md
+++ b/libraries/debug-certificate-manager/CHANGELOG.md
@@ -1,6 +1,65 @@
# Change Log - @rushstack/debug-certificate-manager
-This log was last generated on Tue, 20 Dec 2022 01:18:22 GMT and should not be manually modified.
+This log was last generated on Mon, 20 Mar 2023 20:14:20 GMT and should not be manually modified.
+
+## 1.2.19
+Mon, 20 Mar 2023 20:14:20 GMT
+
+### Patches
+
+- Force certificates with a validity period longer than the expected validity period to be refreshed.
+
+## 1.2.18
+Sat, 18 Mar 2023 00:20:56 GMT
+
+_Version update only_
+
+## 1.2.17
+Fri, 03 Mar 2023 04:11:20 GMT
+
+### Patches
+
+- Fix an issue where certificate expiration was calculated incorrectly and certificates were set to expire too late.
+
+## 1.2.16
+Fri, 10 Feb 2023 01:18:50 GMT
+
+_Version update only_
+
+## 1.2.15
+Sun, 05 Feb 2023 03:02:02 GMT
+
+_Version update only_
+
+## 1.2.14
+Wed, 01 Feb 2023 02:16:34 GMT
+
+_Version update only_
+
+## 1.2.13
+Mon, 30 Jan 2023 16:22:31 GMT
+
+_Version update only_
+
+## 1.2.12
+Mon, 30 Jan 2023 00:55:44 GMT
+
+_Version update only_
+
+## 1.2.11
+Thu, 26 Jan 2023 02:55:10 GMT
+
+_Version update only_
+
+## 1.2.10
+Wed, 25 Jan 2023 07:26:55 GMT
+
+_Version update only_
+
+## 1.2.9
+Wed, 18 Jan 2023 22:44:12 GMT
+
+_Version update only_
## 1.2.8
Tue, 20 Dec 2022 01:18:22 GMT
diff --git a/libraries/debug-certificate-manager/package.json b/libraries/debug-certificate-manager/package.json
index 45ff0017043..575c1f133e1 100644
--- a/libraries/debug-certificate-manager/package.json
+++ b/libraries/debug-certificate-manager/package.json
@@ -1,6 +1,6 @@
{
"name": "@rushstack/debug-certificate-manager",
- "version": "1.2.8",
+ "version": "1.2.19",
"description": "Cross-platform functionality to create debug ssl certificates.",
"main": "lib/index.js",
"typings": "dist/debug-certificate-manager.d.ts",
@@ -23,7 +23,8 @@
"@rushstack/eslint-config": "workspace:*",
"@rushstack/heft": "workspace:*",
"@rushstack/heft-node-rig": "workspace:*",
- "@types/node": "12.20.24",
+ "@types/heft-jest": "1.0.1",
+ "@types/node": "14.18.36",
"@types/node-forge": "1.0.4"
}
}
diff --git a/libraries/debug-certificate-manager/src/CertificateManager.ts b/libraries/debug-certificate-manager/src/CertificateManager.ts
index 6838c2019ac..aa92262143a 100644
--- a/libraries/debug-certificate-manager/src/CertificateManager.ts
+++ b/libraries/debug-certificate-manager/src/CertificateManager.ts
@@ -15,6 +15,7 @@ const FRIENDLY_NAME: string = 'debug-certificate-manager Development Certificate
const MAC_KEYCHAIN: string = '/Library/Keychains/System.keychain';
const CERTUTIL_EXE_NAME: string = 'certutil';
const CA_ALT_NAME: string = 'rushstack-certificate-manager.localhost';
+const ONE_DAY_IN_MILLISECONDS: number = 24 * 60 * 60 * 1000;
/**
* The set of names the certificate should be generated for, by default.
@@ -85,6 +86,8 @@ export interface ICertificateGenerationOptions {
validityInDays?: number;
}
+const MAX_CERTIFICATE_VALIDITY_DAYS: 365 = 365;
+
/**
* A utility class to handle generating, trusting, and untrustring a debug certificate.
* Contains two public methods to `ensureCertificate` and `untrustCertificate`.
@@ -142,6 +145,24 @@ export class CertificateManager {
);
}
+ now.setUTCDate(now.getUTCDate() + optionsWithDefaults.validityInDays);
+ if (notAfter > now) {
+ messages.push(
+ `The existing development certificate's expiration date ${notAfter} exceeds the allowed limit ${now}. ` +
+ `This will be rejected by many browsers.`
+ );
+ }
+
+ if (
+ notBefore.getTime() - notAfter.getTime() >
+ optionsWithDefaults.validityInDays * ONE_DAY_IN_MILLISECONDS
+ ) {
+ messages.push(
+ "The existing development certificate's validity period is longer " +
+ `than ${optionsWithDefaults.validityInDays} days.`
+ );
+ }
+
const { caCertificateData } = this._certificateStore;
if (!caCertificateData) {
@@ -279,9 +300,11 @@ export class CertificateManager {
certificate.serialNumber = CA_SERIAL_NUMBER;
- const now: Date = new Date();
- certificate.validity.notBefore = now;
- certificate.validity.notAfter.setUTCDate(certificate.validity.notBefore.getUTCDate() + validityInDays);
+ const notBefore: Date = new Date();
+ const notAfter: Date = new Date(notBefore);
+ notAfter.setUTCDate(notBefore.getUTCDate() + validityInDays);
+ certificate.validity.notBefore = notBefore;
+ certificate.validity.notAfter = notAfter;
const attrs: pki.CertificateField[] = [
{
@@ -359,9 +382,11 @@ export class CertificateManager {
forge
);
- const now: Date = new Date();
- certificate.validity.notBefore = now;
- certificate.validity.notAfter.setUTCDate(certificate.validity.notBefore.getUTCDate() + validityInDays);
+ const notBefore: Date = new Date();
+ const notAfter: Date = new Date(notBefore);
+ notAfter.setUTCDate(notBefore.getUTCDate() + validityInDays);
+ certificate.validity.notBefore = notBefore;
+ certificate.validity.notAfter = notAfter;
const subjectAttrs: pki.CertificateField[] = [
{
@@ -709,6 +734,9 @@ function applyDefaultOptions(
const subjectNames: ReadonlyArray | undefined = options?.subjectAltNames;
return {
subjectAltNames: subjectNames?.length ? subjectNames : DEFAULT_CERTIFICATE_SUBJECT_NAMES,
- validityInDays: options?.validityInDays ?? 365
+ validityInDays: Math.min(
+ MAX_CERTIFICATE_VALIDITY_DAYS,
+ options?.validityInDays ?? MAX_CERTIFICATE_VALIDITY_DAYS
+ )
};
}
diff --git a/libraries/debug-certificate-manager/src/index.ts b/libraries/debug-certificate-manager/src/index.ts
index 383615f7026..c29f25d1bcc 100644
--- a/libraries/debug-certificate-manager/src/index.ts
+++ b/libraries/debug-certificate-manager/src/index.ts
@@ -3,15 +3,16 @@
/**
* This package is used to manage debug certificates for development servers.
- * It is used by
- * [\@microsoft/gulp-core-build-serve](https://www.npmjs.com/package/\@microsoft/gulp-core-build-serve)
- * to generate and trust a certificate when HTTPS is turned on.
*
* This package provides the following utilities:
+ *
* - `CertificateStore` to handle retrieving and saving a debug certificate.
+ *
* - `CertificateManager` is a utility class containing the following public methods:
- * | - `ensureCertificate` will find or optionally create a debug certificate and trust it.
- * | - `untrustCertificate` will untrust a debug certificate.
+ *
+ * - `ensureCertificate` will find or optionally create a debug certificate and trust it.
+ *
+ * - `untrustCertificate` will untrust a debug certificate.
*
* @packageDocumentation
*/
diff --git a/libraries/heft-config-file/CHANGELOG.json b/libraries/heft-config-file/CHANGELOG.json
index 095ad11a6d8..ef5850f570e 100644
--- a/libraries/heft-config-file/CHANGELOG.json
+++ b/libraries/heft-config-file/CHANGELOG.json
@@ -1,6 +1,72 @@
{
"name": "@rushstack/heft-config-file",
"entries": [
+ {
+ "version": "0.11.9",
+ "tag": "@rushstack/heft-config-file_v0.11.9",
+ "date": "Fri, 10 Feb 2023 01:18:51 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/rig-package\" to `0.3.18`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/eslint-config\" to `3.2.0`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.11.8",
+ "tag": "@rushstack/heft-config-file_v0.11.8",
+ "date": "Sun, 05 Feb 2023 03:02:02 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.1`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.11.7",
+ "tag": "@rushstack/heft-config-file_v0.11.7",
+ "date": "Wed, 01 Feb 2023 02:16:34 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.0`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.11.6",
+ "tag": "@rushstack/heft-config-file_v0.11.6",
+ "date": "Mon, 30 Jan 2023 16:22:30 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.54.0`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.11.5",
+ "tag": "@rushstack/heft-config-file_v0.11.5",
+ "date": "Thu, 26 Jan 2023 02:55:09 GMT",
+ "comments": {
+ "patch": [
+ {
+ "comment": "Upgrade to webpack 5.75.0"
+ }
+ ]
+ }
+ },
{
"version": "0.11.4",
"tag": "@rushstack/heft-config-file_v0.11.4",
diff --git a/libraries/heft-config-file/CHANGELOG.md b/libraries/heft-config-file/CHANGELOG.md
index e6913f94185..e94849b5242 100644
--- a/libraries/heft-config-file/CHANGELOG.md
+++ b/libraries/heft-config-file/CHANGELOG.md
@@ -1,6 +1,33 @@
# Change Log - @rushstack/heft-config-file
-This log was last generated on Fri, 09 Dec 2022 16:18:28 GMT and should not be manually modified.
+This log was last generated on Fri, 10 Feb 2023 01:18:51 GMT and should not be manually modified.
+
+## 0.11.9
+Fri, 10 Feb 2023 01:18:51 GMT
+
+_Version update only_
+
+## 0.11.8
+Sun, 05 Feb 2023 03:02:02 GMT
+
+_Version update only_
+
+## 0.11.7
+Wed, 01 Feb 2023 02:16:34 GMT
+
+_Version update only_
+
+## 0.11.6
+Mon, 30 Jan 2023 16:22:30 GMT
+
+_Version update only_
+
+## 0.11.5
+Thu, 26 Jan 2023 02:55:09 GMT
+
+### Patches
+
+- Upgrade to webpack 5.75.0
## 0.11.4
Fri, 09 Dec 2022 16:18:28 GMT
diff --git a/libraries/heft-config-file/package.json b/libraries/heft-config-file/package.json
index 11e6d4ae1f4..5bdbe4d73ab 100644
--- a/libraries/heft-config-file/package.json
+++ b/libraries/heft-config-file/package.json
@@ -1,6 +1,6 @@
{
"name": "@rushstack/heft-config-file",
- "version": "0.11.4",
+ "version": "0.11.9",
"description": "Configuration file loader for @rushstack/heft",
"repository": {
"type": "git",
@@ -27,9 +27,9 @@
},
"devDependencies": {
"@rushstack/eslint-config": "workspace:*",
- "@rushstack/heft": "0.48.0",
- "@rushstack/heft-node-rig": "1.11.0",
+ "@rushstack/heft": "0.49.3",
+ "@rushstack/heft-node-rig": "1.11.14",
"@types/heft-jest": "1.0.1",
- "@types/node": "12.20.24"
+ "@types/node": "14.18.36"
}
}
diff --git a/libraries/heft-config-file/src/index.ts b/libraries/heft-config-file/src/index.ts
index bc31b8e2177..884a30bce24 100644
--- a/libraries/heft-config-file/src/index.ts
+++ b/libraries/heft-config-file/src/index.ts
@@ -1,6 +1,13 @@
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
// See LICENSE in the project root for license information.
+/**
+ * A library for loading config files for use with the
+ * {@link https://rushstack.io/pages/heft/overview/ | Heft} build system.
+ *
+ * @packageDocumentation
+ */
+
export {
ConfigurationFile,
IConfigurationFileOptionsBase,
diff --git a/libraries/load-themed-styles/CHANGELOG.json b/libraries/load-themed-styles/CHANGELOG.json
index 3287617c0f7..1cc51f8cdfb 100644
--- a/libraries/load-themed-styles/CHANGELOG.json
+++ b/libraries/load-themed-styles/CHANGELOG.json
@@ -1,6 +1,177 @@
{
"name": "@microsoft/load-themed-styles",
"entries": [
+ {
+ "version": "2.0.31",
+ "tag": "@microsoft/load-themed-styles_v2.0.31",
+ "date": "Sat, 18 Mar 2023 00:20:56 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.50.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-web-rig\" to `0.14.7`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "2.0.30",
+ "tag": "@microsoft/load-themed-styles_v2.0.30",
+ "date": "Sat, 11 Mar 2023 01:24:51 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-web-rig\" to `0.14.6`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "2.0.29",
+ "tag": "@microsoft/load-themed-styles_v2.0.29",
+ "date": "Fri, 10 Feb 2023 01:18:50 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/eslint-config\" to `3.2.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.7`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-web-rig\" to `0.14.5`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "2.0.28",
+ "tag": "@microsoft/load-themed-styles_v2.0.28",
+ "date": "Sun, 05 Feb 2023 03:02:02 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.6`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-web-rig\" to `0.14.4`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "2.0.27",
+ "tag": "@microsoft/load-themed-styles_v2.0.27",
+ "date": "Wed, 01 Feb 2023 02:16:34 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.5`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-web-rig\" to `0.14.3`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "2.0.26",
+ "tag": "@microsoft/load-themed-styles_v2.0.26",
+ "date": "Tue, 31 Jan 2023 01:23:23 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-web-rig\" to `0.14.2`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "2.0.25",
+ "tag": "@microsoft/load-themed-styles_v2.0.25",
+ "date": "Mon, 30 Jan 2023 16:22:30 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.4`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-web-rig\" to `0.14.1`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "2.0.24",
+ "tag": "@microsoft/load-themed-styles_v2.0.24",
+ "date": "Mon, 30 Jan 2023 00:55:44 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-web-rig\" to `0.14.0`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "2.0.23",
+ "tag": "@microsoft/load-themed-styles_v2.0.23",
+ "date": "Thu, 26 Jan 2023 02:55:10 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.3`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-web-rig\" to `0.13.2`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "2.0.22",
+ "tag": "@microsoft/load-themed-styles_v2.0.22",
+ "date": "Wed, 25 Jan 2023 07:26:55 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-web-rig\" to `0.13.1`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "2.0.21",
+ "tag": "@microsoft/load-themed-styles_v2.0.21",
+ "date": "Sun, 22 Jan 2023 20:37:08 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-web-rig\" to `0.13.0`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "2.0.20",
+ "tag": "@microsoft/load-themed-styles_v2.0.20",
+ "date": "Wed, 18 Jan 2023 22:44:12 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-web-rig\" to `0.12.17`"
+ }
+ ]
+ }
+ },
{
"version": "2.0.19",
"tag": "@microsoft/load-themed-styles_v2.0.19",
diff --git a/libraries/load-themed-styles/CHANGELOG.md b/libraries/load-themed-styles/CHANGELOG.md
index 76ff4762a85..0a7ddc5e899 100644
--- a/libraries/load-themed-styles/CHANGELOG.md
+++ b/libraries/load-themed-styles/CHANGELOG.md
@@ -1,6 +1,66 @@
# Change Log - @microsoft/load-themed-styles
-This log was last generated on Tue, 20 Dec 2022 01:18:22 GMT and should not be manually modified.
+This log was last generated on Sat, 18 Mar 2023 00:20:56 GMT and should not be manually modified.
+
+## 2.0.31
+Sat, 18 Mar 2023 00:20:56 GMT
+
+_Version update only_
+
+## 2.0.30
+Sat, 11 Mar 2023 01:24:51 GMT
+
+_Version update only_
+
+## 2.0.29
+Fri, 10 Feb 2023 01:18:50 GMT
+
+_Version update only_
+
+## 2.0.28
+Sun, 05 Feb 2023 03:02:02 GMT
+
+_Version update only_
+
+## 2.0.27
+Wed, 01 Feb 2023 02:16:34 GMT
+
+_Version update only_
+
+## 2.0.26
+Tue, 31 Jan 2023 01:23:23 GMT
+
+_Version update only_
+
+## 2.0.25
+Mon, 30 Jan 2023 16:22:30 GMT
+
+_Version update only_
+
+## 2.0.24
+Mon, 30 Jan 2023 00:55:44 GMT
+
+_Version update only_
+
+## 2.0.23
+Thu, 26 Jan 2023 02:55:10 GMT
+
+_Version update only_
+
+## 2.0.22
+Wed, 25 Jan 2023 07:26:55 GMT
+
+_Version update only_
+
+## 2.0.21
+Sun, 22 Jan 2023 20:37:08 GMT
+
+_Version update only_
+
+## 2.0.20
+Wed, 18 Jan 2023 22:44:12 GMT
+
+_Version update only_
## 2.0.19
Tue, 20 Dec 2022 01:18:22 GMT
diff --git a/libraries/load-themed-styles/package.json b/libraries/load-themed-styles/package.json
index 19538bd1f0d..327f129246b 100644
--- a/libraries/load-themed-styles/package.json
+++ b/libraries/load-themed-styles/package.json
@@ -1,6 +1,6 @@
{
"name": "@microsoft/load-themed-styles",
- "version": "2.0.19",
+ "version": "2.0.31",
"description": "Loads themed styles.",
"license": "MIT",
"repository": {
@@ -20,6 +20,7 @@
"@rushstack/eslint-config": "workspace:*",
"@rushstack/heft": "workspace:*",
"@rushstack/heft-web-rig": "workspace:*",
- "@types/webpack-env": "1.13.0"
+ "@types/heft-jest": "1.0.1",
+ "@types/webpack-env": "1.18.0"
}
}
diff --git a/libraries/localization-utilities/CHANGELOG.json b/libraries/localization-utilities/CHANGELOG.json
index 92ed6732347..1915a617959 100644
--- a/libraries/localization-utilities/CHANGELOG.json
+++ b/libraries/localization-utilities/CHANGELOG.json
@@ -1,6 +1,180 @@
{
"name": "@rushstack/localization-utilities",
"entries": [
+ {
+ "version": "0.8.47",
+ "tag": "@rushstack/localization-utilities_v0.8.47",
+ "date": "Sat, 18 Mar 2023 00:20:56 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/typings-generator\" to `0.10.3`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.50.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.5`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.8.46",
+ "tag": "@rushstack/localization-utilities_v0.8.46",
+ "date": "Fri, 10 Feb 2023 01:18:51 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/typings-generator\" to `0.10.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/eslint-config\" to `3.2.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.7`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.4`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.8.45",
+ "tag": "@rushstack/localization-utilities_v0.8.45",
+ "date": "Sun, 05 Feb 2023 03:02:02 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/typings-generator\" to `0.10.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.6`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.3`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.8.44",
+ "tag": "@rushstack/localization-utilities_v0.8.44",
+ "date": "Wed, 01 Feb 2023 02:16:34 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/typings-generator\" to `0.10.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.5`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.2`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.8.43",
+ "tag": "@rushstack/localization-utilities_v0.8.43",
+ "date": "Mon, 30 Jan 2023 16:22:31 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.54.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/typings-generator\" to `0.9.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.4`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.1`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.8.42",
+ "tag": "@rushstack/localization-utilities_v0.8.42",
+ "date": "Mon, 30 Jan 2023 00:55:44 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/typings-generator\" to `0.8.18`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.0`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.8.41",
+ "tag": "@rushstack/localization-utilities_v0.8.41",
+ "date": "Thu, 26 Jan 2023 02:55:10 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/typings-generator\" to `0.8.17`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.3`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.14`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.8.40",
+ "tag": "@rushstack/localization-utilities_v0.8.40",
+ "date": "Wed, 25 Jan 2023 07:26:55 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/typings-generator\" to `0.8.16`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.13`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.8.39",
+ "tag": "@rushstack/localization-utilities_v0.8.39",
+ "date": "Wed, 18 Jan 2023 22:44:12 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/typings-generator\" to `0.8.15`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.12`"
+ }
+ ]
+ }
+ },
{
"version": "0.8.38",
"tag": "@rushstack/localization-utilities_v0.8.38",
diff --git a/libraries/localization-utilities/CHANGELOG.md b/libraries/localization-utilities/CHANGELOG.md
index 81bba60d764..56ca9b67e0f 100644
--- a/libraries/localization-utilities/CHANGELOG.md
+++ b/libraries/localization-utilities/CHANGELOG.md
@@ -1,6 +1,51 @@
# Change Log - @rushstack/localization-utilities
-This log was last generated on Tue, 20 Dec 2022 01:18:22 GMT and should not be manually modified.
+This log was last generated on Sat, 18 Mar 2023 00:20:56 GMT and should not be manually modified.
+
+## 0.8.47
+Sat, 18 Mar 2023 00:20:56 GMT
+
+_Version update only_
+
+## 0.8.46
+Fri, 10 Feb 2023 01:18:51 GMT
+
+_Version update only_
+
+## 0.8.45
+Sun, 05 Feb 2023 03:02:02 GMT
+
+_Version update only_
+
+## 0.8.44
+Wed, 01 Feb 2023 02:16:34 GMT
+
+_Version update only_
+
+## 0.8.43
+Mon, 30 Jan 2023 16:22:31 GMT
+
+_Version update only_
+
+## 0.8.42
+Mon, 30 Jan 2023 00:55:44 GMT
+
+_Version update only_
+
+## 0.8.41
+Thu, 26 Jan 2023 02:55:10 GMT
+
+_Version update only_
+
+## 0.8.40
+Wed, 25 Jan 2023 07:26:55 GMT
+
+_Version update only_
+
+## 0.8.39
+Wed, 18 Jan 2023 22:44:12 GMT
+
+_Version update only_
## 0.8.38
Tue, 20 Dec 2022 01:18:22 GMT
diff --git a/libraries/localization-utilities/package.json b/libraries/localization-utilities/package.json
index 96bd4381bf3..ee9611c55b9 100644
--- a/libraries/localization-utilities/package.json
+++ b/libraries/localization-utilities/package.json
@@ -1,6 +1,6 @@
{
"name": "@rushstack/localization-utilities",
- "version": "0.8.38",
+ "version": "0.8.47",
"description": "This plugin contains some useful functions for localization.",
"main": "lib/index.js",
"typings": "dist/localization-utilities.d.ts",
@@ -25,7 +25,8 @@
"@rushstack/eslint-config": "workspace:*",
"@rushstack/heft": "workspace:*",
"@rushstack/heft-node-rig": "workspace:*",
- "@types/node": "12.20.24",
+ "@types/heft-jest": "1.0.1",
+ "@types/node": "14.18.36",
"@types/xmldoc": "1.1.4"
}
}
diff --git a/libraries/localization-utilities/src/index.ts b/libraries/localization-utilities/src/index.ts
index e2d2edead6a..b8401bcae44 100644
--- a/libraries/localization-utilities/src/index.ts
+++ b/libraries/localization-utilities/src/index.ts
@@ -1,6 +1,12 @@
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
// See LICENSE in the project root for license information.
+/**
+ * Some utilities for working with Rush Stack localization files.
+ *
+ * @packageDocumentation
+ */
+
export type {
ILocalizationFile,
ILocalizedString,
diff --git a/libraries/module-minifier/CHANGELOG.json b/libraries/module-minifier/CHANGELOG.json
index d0eabbb98c3..3d03bb415e9 100644
--- a/libraries/module-minifier/CHANGELOG.json
+++ b/libraries/module-minifier/CHANGELOG.json
@@ -1,6 +1,200 @@
{
"name": "@rushstack/module-minifier",
"entries": [
+ {
+ "version": "0.3.3",
+ "tag": "@rushstack/module-minifier_v0.3.3",
+ "date": "Sat, 18 Mar 2023 00:20:56 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/worker-pool\" to `0.3.3`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.50.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.5`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.3.2",
+ "tag": "@rushstack/module-minifier_v0.3.2",
+ "date": "Fri, 10 Feb 2023 01:18:51 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/worker-pool\" to `0.3.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/eslint-config\" to `3.2.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.7`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.4`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.3.1",
+ "tag": "@rushstack/module-minifier_v0.3.1",
+ "date": "Sun, 05 Feb 2023 03:02:01 GMT",
+ "comments": {
+ "patch": [
+ {
+ "comment": "Change the peer dependency selector on `@types/node` to a wildcard (`*`)."
+ }
+ ],
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/worker-pool\" to `0.3.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.6`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.3`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.3.0",
+ "tag": "@rushstack/module-minifier_v0.3.0",
+ "date": "Wed, 01 Feb 2023 02:16:34 GMT",
+ "comments": {
+ "minor": [
+ {
+ "comment": "Bump @types/node peerDependency to ^14.18.36."
+ }
+ ],
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/worker-pool\" to `0.3.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.5`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.2`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.2.0",
+ "tag": "@rushstack/module-minifier_v0.2.0",
+ "date": "Mon, 30 Jan 2023 16:22:30 GMT",
+ "comments": {
+ "minor": [
+ {
+ "comment": "Move the @types/node dependency to an optional peerDependency."
+ }
+ ],
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/worker-pool\" to `0.2.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.4`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.1`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.1.49",
+ "tag": "@rushstack/module-minifier_v0.1.49",
+ "date": "Mon, 30 Jan 2023 00:55:44 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/worker-pool\" to `0.1.48`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.0`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.1.48",
+ "tag": "@rushstack/module-minifier_v0.1.48",
+ "date": "Sat, 28 Jan 2023 01:22:02 GMT",
+ "comments": {
+ "patch": [
+ {
+ "comment": "Ensure updates to the version of Terser trigger a hash change."
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.1.47",
+ "tag": "@rushstack/module-minifier_v0.1.47",
+ "date": "Thu, 26 Jan 2023 02:55:10 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/worker-pool\" to `0.1.47`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.3`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.14`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.1.46",
+ "tag": "@rushstack/module-minifier_v0.1.46",
+ "date": "Wed, 25 Jan 2023 07:26:55 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/worker-pool\" to `0.1.46`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.13`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "0.1.45",
+ "tag": "@rushstack/module-minifier_v0.1.45",
+ "date": "Wed, 18 Jan 2023 22:44:12 GMT",
+ "comments": {
+ "patch": [
+ {
+ "comment": "Update to terser 5.16.1"
+ }
+ ],
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/worker-pool\" to `0.1.45`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.12`"
+ }
+ ]
+ }
+ },
{
"version": "0.1.44",
"tag": "@rushstack/module-minifier_v0.1.44",
diff --git a/libraries/module-minifier/CHANGELOG.md b/libraries/module-minifier/CHANGELOG.md
index c208b81f2dd..7433d1b0416 100644
--- a/libraries/module-minifier/CHANGELOG.md
+++ b/libraries/module-minifier/CHANGELOG.md
@@ -1,6 +1,66 @@
# Change Log - @rushstack/module-minifier
-This log was last generated on Tue, 20 Dec 2022 01:18:22 GMT and should not be manually modified.
+This log was last generated on Sat, 18 Mar 2023 00:20:56 GMT and should not be manually modified.
+
+## 0.3.3
+Sat, 18 Mar 2023 00:20:56 GMT
+
+_Version update only_
+
+## 0.3.2
+Fri, 10 Feb 2023 01:18:51 GMT
+
+_Version update only_
+
+## 0.3.1
+Sun, 05 Feb 2023 03:02:01 GMT
+
+### Patches
+
+- Change the peer dependency selector on `@types/node` to a wildcard (`*`).
+
+## 0.3.0
+Wed, 01 Feb 2023 02:16:34 GMT
+
+### Minor changes
+
+- Bump @types/node peerDependency to ^14.18.36.
+
+## 0.2.0
+Mon, 30 Jan 2023 16:22:30 GMT
+
+### Minor changes
+
+- Move the @types/node dependency to an optional peerDependency.
+
+## 0.1.49
+Mon, 30 Jan 2023 00:55:44 GMT
+
+_Version update only_
+
+## 0.1.48
+Sat, 28 Jan 2023 01:22:02 GMT
+
+### Patches
+
+- Ensure updates to the version of Terser trigger a hash change.
+
+## 0.1.47
+Thu, 26 Jan 2023 02:55:10 GMT
+
+_Version update only_
+
+## 0.1.46
+Wed, 25 Jan 2023 07:26:55 GMT
+
+_Version update only_
+
+## 0.1.45
+Wed, 18 Jan 2023 22:44:12 GMT
+
+### Patches
+
+- Update to terser 5.16.1
## 0.1.44
Tue, 20 Dec 2022 01:18:22 GMT
diff --git a/libraries/module-minifier/package.json b/libraries/module-minifier/package.json
index 8060c04c505..5562ac2626f 100644
--- a/libraries/module-minifier/package.json
+++ b/libraries/module-minifier/package.json
@@ -1,6 +1,6 @@
{
"name": "@rushstack/module-minifier",
- "version": "0.1.44",
+ "version": "0.3.3",
"description": "Wrapper for terser to support bulk parallel minification.",
"main": "lib/index.js",
"typings": "dist/module-minifier.d.ts",
@@ -16,16 +16,25 @@
"_phase:test": "heft run --only test -- --clean"
},
"dependencies": {
- "@types/node": "12.20.24",
"@rushstack/worker-pool": "workspace:*",
"serialize-javascript": "6.0.0",
"source-map": "~0.7.3",
- "terser": "5.9.0"
+ "terser": "5.16.1"
},
"devDependencies": {
"@rushstack/eslint-config": "workspace:*",
"@rushstack/heft": "workspace:*",
"@rushstack/heft-node-rig": "workspace:*",
+ "@types/heft-jest": "1.0.1",
+ "@types/node": "14.18.36",
"@types/serialize-javascript": "5.0.2"
+ },
+ "peerDependencies": {
+ "@types/node": "*"
+ },
+ "peerDependenciesMeta": {
+ "@types/node": {
+ "optional": true
+ }
}
}
diff --git a/libraries/module-minifier/src/LocalMinifier.ts b/libraries/module-minifier/src/LocalMinifier.ts
index 0e2ac3cb2c6..231b8e3ea9b 100644
--- a/libraries/module-minifier/src/LocalMinifier.ts
+++ b/libraries/module-minifier/src/LocalMinifier.ts
@@ -44,8 +44,11 @@ export class LocalMinifier implements IModuleMinifier {
: {}
};
+ const { version: terserVersion } = require('terser/package.json');
+
this._configHash = createHash('sha256')
.update(LocalMinifier.name, 'utf8')
+ .update(`terser@${terserVersion}`)
.update(serialize(terserOptions))
.digest('base64');
diff --git a/libraries/module-minifier/src/WorkerPoolMinifier.ts b/libraries/module-minifier/src/WorkerPoolMinifier.ts
index 99a494a873f..c369f520839 100644
--- a/libraries/module-minifier/src/WorkerPoolMinifier.ts
+++ b/libraries/module-minifier/src/WorkerPoolMinifier.ts
@@ -66,8 +66,11 @@ export class WorkerPoolMinifier implements IModuleMinifier {
workerScriptPath: require.resolve('./MinifierWorker')
});
+ const { version: terserVersion } = require('terser/package.json');
+
this._configHash = createHash('sha256')
.update(WorkerPoolMinifier.name, 'utf8')
+ .update(`terser@${terserVersion}`)
.update(serialize(terserOptions))
.digest('base64');
diff --git a/libraries/module-minifier/src/index.ts b/libraries/module-minifier/src/index.ts
index 52caf8faecf..ca82f966b67 100644
--- a/libraries/module-minifier/src/index.ts
+++ b/libraries/module-minifier/src/index.ts
@@ -1,6 +1,14 @@
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
// See LICENSE in the project root for license information.
+/**
+ * This library wraps terser in convenient handles for parallelization.
+ * It powers `@rushstack/webpack4-module-minifier-plugin` and `@rushstack/webpack5-module-minifier-plugin`
+ * but has no coupling with webpack.
+ *
+ * @packageDocumentation
+ */
+
export type { MinifyOptions } from 'terser';
export type { ILocalMinifierOptions } from './LocalMinifier';
diff --git a/libraries/module-minifier/src/test/LocalMinifier.test.ts b/libraries/module-minifier/src/test/LocalMinifier.test.ts
new file mode 100644
index 00000000000..a135eb51272
--- /dev/null
+++ b/libraries/module-minifier/src/test/LocalMinifier.test.ts
@@ -0,0 +1,59 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+import type { IMinifierConnection } from '../types';
+
+let terserVersion: string = '1.0.0';
+jest.mock('terser/package.json', () => {
+ return {
+ get version(): string {
+ return terserVersion;
+ }
+ };
+});
+
+describe('LocalMinifier', () => {
+ it('Includes terserOptions in config hash', async () => {
+ const { LocalMinifier } = await import('../LocalMinifier');
+ type LocalMinifier = typeof LocalMinifier.prototype;
+
+ const minifier1: LocalMinifier = new LocalMinifier({
+ terserOptions: {
+ ecma: 5
+ }
+ });
+ const minifier2: LocalMinifier = new LocalMinifier({
+ terserOptions: {
+ ecma: 2015
+ }
+ });
+
+ const connection1: IMinifierConnection = await minifier1.connect();
+ await connection1.disconnect();
+ const connection2: IMinifierConnection = await minifier2.connect();
+ await connection2.disconnect();
+
+ expect(connection1.configHash).toMatchSnapshot('ecma5');
+ expect(connection2.configHash).toMatchSnapshot('ecma2015');
+ expect(connection1.configHash !== connection2.configHash);
+ });
+
+ it('Includes terser package version in config hash', async () => {
+ const { LocalMinifier } = await import('../LocalMinifier');
+ type LocalMinifier = typeof LocalMinifier.prototype;
+
+ terserVersion = '5.9.1';
+ const minifier1: LocalMinifier = new LocalMinifier({});
+ terserVersion = '5.16.2';
+ const minifier2: LocalMinifier = new LocalMinifier({});
+
+ const connection1: IMinifierConnection = await minifier1.connect();
+ await connection1.disconnect();
+ const connection2: IMinifierConnection = await minifier2.connect();
+ await connection2.disconnect();
+
+ expect(connection1.configHash).toMatchSnapshot('terser-5.9.1');
+ expect(connection2.configHash).toMatchSnapshot('terser-5.16.1');
+ expect(connection1.configHash !== connection2.configHash);
+ });
+});
diff --git a/libraries/module-minifier/src/test/WorkerPoolMinifier.test.ts b/libraries/module-minifier/src/test/WorkerPoolMinifier.test.ts
new file mode 100644
index 00000000000..89fd95cd326
--- /dev/null
+++ b/libraries/module-minifier/src/test/WorkerPoolMinifier.test.ts
@@ -0,0 +1,59 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+import type { IMinifierConnection } from '../types';
+
+let terserVersion: string = '1.0.0';
+jest.mock('terser/package.json', () => {
+ return {
+ get version(): string {
+ return terserVersion;
+ }
+ };
+});
+
+describe('WorkerPoolMinifier', () => {
+ it('Includes terserOptions in config hash', async () => {
+ const { WorkerPoolMinifier } = await import('../WorkerPoolMinifier');
+ type WorkerPoolMinifier = typeof WorkerPoolMinifier.prototype;
+
+ const minifier1: WorkerPoolMinifier = new WorkerPoolMinifier({
+ terserOptions: {
+ ecma: 5
+ }
+ });
+ const minifier2: WorkerPoolMinifier = new WorkerPoolMinifier({
+ terserOptions: {
+ ecma: 2015
+ }
+ });
+
+ const connection1: IMinifierConnection = await minifier1.connect();
+ await connection1.disconnect();
+ const connection2: IMinifierConnection = await minifier2.connect();
+ await connection2.disconnect();
+
+ expect(connection1.configHash).toMatchSnapshot('ecma5');
+ expect(connection2.configHash).toMatchSnapshot('ecma2015');
+ expect(connection1.configHash !== connection2.configHash);
+ });
+
+ it('Includes terser package version in config hash', async () => {
+ const { WorkerPoolMinifier } = await import('../WorkerPoolMinifier');
+ type WorkerPoolMinifier = typeof WorkerPoolMinifier.prototype;
+
+ terserVersion = '5.9.1';
+ const minifier1: WorkerPoolMinifier = new WorkerPoolMinifier({});
+ terserVersion = '5.16.2';
+ const minifier2: WorkerPoolMinifier = new WorkerPoolMinifier({});
+
+ const connection1: IMinifierConnection = await minifier1.connect();
+ await connection1.disconnect();
+ const connection2: IMinifierConnection = await minifier2.connect();
+ await connection2.disconnect();
+
+ expect(connection1.configHash).toMatchSnapshot('terser-5.9.1');
+ expect(connection2.configHash).toMatchSnapshot('terser-5.16.1');
+ expect(connection1.configHash !== connection2.configHash);
+ });
+});
diff --git a/libraries/module-minifier/src/test/__snapshots__/LocalMinifier.test.ts.snap b/libraries/module-minifier/src/test/__snapshots__/LocalMinifier.test.ts.snap
new file mode 100644
index 00000000000..a310d9b8a69
--- /dev/null
+++ b/libraries/module-minifier/src/test/__snapshots__/LocalMinifier.test.ts.snap
@@ -0,0 +1,9 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`LocalMinifier Includes terser package version in config hash: terser-5.9.1 1`] = `"4EVkVBAkdvF45JdRt44fWqn3HDW5t4dHo0zmzpQrWtc="`;
+
+exports[`LocalMinifier Includes terser package version in config hash: terser-5.16.1 1`] = `"3tk4bireIeb1adtnntg0kD4LU91VU+hweuk5GEkvX9A="`;
+
+exports[`LocalMinifier Includes terserOptions in config hash: ecma5 1`] = `"xpQ+VFd1iTb0qFjWnrRxNm25O1Z77Oy9Ppi+VG9SFEQ="`;
+
+exports[`LocalMinifier Includes terserOptions in config hash: ecma2015 1`] = `"IvCYjNIccj8xYkftaoV19M8WU5Vzy+06PL6gzGVUYxI="`;
diff --git a/libraries/module-minifier/src/test/__snapshots__/WorkerPoolMinifier.test.ts.snap b/libraries/module-minifier/src/test/__snapshots__/WorkerPoolMinifier.test.ts.snap
new file mode 100644
index 00000000000..78c3f7dafef
--- /dev/null
+++ b/libraries/module-minifier/src/test/__snapshots__/WorkerPoolMinifier.test.ts.snap
@@ -0,0 +1,9 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`WorkerPoolMinifier Includes terser package version in config hash: terser-5.9.1 1`] = `"0cjBnphY49XdxkmLxJLfNoRQbl3R6HdeT8WNl56oZWk="`;
+
+exports[`WorkerPoolMinifier Includes terser package version in config hash: terser-5.16.1 1`] = `"dYinCy9XUHWWDXSIwq7F/GvAYLxxv3WjZdHIpd2sZpc="`;
+
+exports[`WorkerPoolMinifier Includes terserOptions in config hash: ecma5 1`] = `"FcgklO/zYzwo0R2IM6OKH5uLA0hXVekjeqmFqKweKCg="`;
+
+exports[`WorkerPoolMinifier Includes terserOptions in config hash: ecma2015 1`] = `"Vku2B3kuB95N1Xo2q8J/nAJrmxwXV+fQmmUwp4xj+Xk="`;
diff --git a/libraries/node-core-library/CHANGELOG.json b/libraries/node-core-library/CHANGELOG.json
index 3357285f393..37f9e5220a5 100644
--- a/libraries/node-core-library/CHANGELOG.json
+++ b/libraries/node-core-library/CHANGELOG.json
@@ -1,6 +1,57 @@
{
"name": "@rushstack/node-core-library",
"entries": [
+ {
+ "version": "3.55.2",
+ "tag": "@rushstack/node-core-library_v3.55.2",
+ "date": "Fri, 10 Feb 2023 01:18:51 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/eslint-config\" to `3.2.0`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "3.55.1",
+ "tag": "@rushstack/node-core-library_v3.55.1",
+ "date": "Sun, 05 Feb 2023 03:02:02 GMT",
+ "comments": {
+ "patch": [
+ {
+ "comment": "Change the peer dependency selector on `@types/node` to a wildcard (`*`)."
+ }
+ ]
+ }
+ },
+ {
+ "version": "3.55.0",
+ "tag": "@rushstack/node-core-library_v3.55.0",
+ "date": "Wed, 01 Feb 2023 02:16:34 GMT",
+ "comments": {
+ "minor": [
+ {
+ "comment": "Bump @types/node peerDependency to ^14.18.36."
+ }
+ ]
+ }
+ },
+ {
+ "version": "3.54.0",
+ "tag": "@rushstack/node-core-library_v3.54.0",
+ "date": "Mon, 30 Jan 2023 16:22:30 GMT",
+ "comments": {
+ "minor": [
+ {
+ "comment": "Add a `peerDependenciesMeta` property to `IPackageJson`."
+ },
+ {
+ "comment": "Move the @types/node dependency to an optional peerDependency."
+ }
+ ]
+ }
+ },
{
"version": "3.53.3",
"tag": "@rushstack/node-core-library_v3.53.3",
diff --git a/libraries/node-core-library/CHANGELOG.md b/libraries/node-core-library/CHANGELOG.md
index 68fd923359a..9a05aa94687 100644
--- a/libraries/node-core-library/CHANGELOG.md
+++ b/libraries/node-core-library/CHANGELOG.md
@@ -1,6 +1,33 @@
# Change Log - @rushstack/node-core-library
-This log was last generated on Fri, 09 Dec 2022 16:18:27 GMT and should not be manually modified.
+This log was last generated on Fri, 10 Feb 2023 01:18:51 GMT and should not be manually modified.
+
+## 3.55.2
+Fri, 10 Feb 2023 01:18:51 GMT
+
+_Version update only_
+
+## 3.55.1
+Sun, 05 Feb 2023 03:02:02 GMT
+
+### Patches
+
+- Change the peer dependency selector on `@types/node` to a wildcard (`*`).
+
+## 3.55.0
+Wed, 01 Feb 2023 02:16:34 GMT
+
+### Minor changes
+
+- Bump @types/node peerDependency to ^14.18.36.
+
+## 3.54.0
+Mon, 30 Jan 2023 16:22:30 GMT
+
+### Minor changes
+
+- Add a `peerDependenciesMeta` property to `IPackageJson`.
+- Move the @types/node dependency to an optional peerDependency.
## 3.53.3
Fri, 09 Dec 2022 16:18:27 GMT
diff --git a/libraries/node-core-library/package.json b/libraries/node-core-library/package.json
index ddaffe961c5..f5162d8bb66 100644
--- a/libraries/node-core-library/package.json
+++ b/libraries/node-core-library/package.json
@@ -1,6 +1,6 @@
{
"name": "@rushstack/node-core-library",
- "version": "3.53.3",
+ "version": "3.55.2",
"description": "Core libraries that every NodeJS toolchain project should use",
"main": "lib/index.js",
"typings": "dist/node-core-library.d.ts",
@@ -16,7 +16,6 @@
"_phase:test": "heft test --no-build"
},
"dependencies": {
- "@types/node": "12.20.24",
"colors": "~1.2.1",
"fs-extra": "~7.0.1",
"import-lazy": "~4.0.0",
@@ -27,12 +26,21 @@
},
"devDependencies": {
"@rushstack/eslint-config": "workspace:*",
- "@rushstack/heft": "0.48.0",
- "@rushstack/heft-node-rig": "1.11.0",
+ "@rushstack/heft": "0.49.3",
+ "@rushstack/heft-node-rig": "1.11.14",
"@types/fs-extra": "7.0.0",
"@types/heft-jest": "1.0.1",
"@types/jju": "1.4.1",
+ "@types/node": "14.18.36",
"@types/resolve": "1.20.2",
"@types/semver": "7.3.5"
+ },
+ "peerDependencies": {
+ "@types/node": "*"
+ },
+ "peerDependenciesMeta": {
+ "@types/node": {
+ "optional": true
+ }
}
}
diff --git a/libraries/node-core-library/src/IPackageJson.ts b/libraries/node-core-library/src/IPackageJson.ts
index 7955552caa2..ab33d9a6f6f 100644
--- a/libraries/node-core-library/src/IPackageJson.ts
+++ b/libraries/node-core-library/src/IPackageJson.ts
@@ -2,7 +2,7 @@
// See LICENSE in the project root for license information.
/**
- * This interface is part of the IPackageJson file format. It is used for the
+ * This interface is part of the {@link IPackageJson} file format. It is used for the
* "dependencies", "optionalDependencies", and "devDependencies" fields.
* @public
*/
@@ -15,7 +15,7 @@ export interface IPackageJsonDependencyTable {
}
/**
- * This interface is part of the IPackageJson file format. It is used for the
+ * This interface is part of the {@link IPackageJson} file format. It is used for the
* "scripts" field.
* @public
*/
@@ -28,7 +28,7 @@ export interface IPackageJsonScriptTable {
}
/**
- * This interface is part of the IPackageJson file format. It is used for the
+ * This interface is part of the {@link IPackageJson} file format. It is used for the
* "repository" field.
* @public
*/
@@ -49,6 +49,17 @@ export interface IPackageJsonRepository {
directory?: string;
}
+/**
+ * This interface is part of the {@link IPackageJson} file format. It is used for the
+ * "peerDependenciesMeta" field.
+ * @public
+ */
+export interface IPeerDependenciesMetaTable {
+ [dependencyName: string]: {
+ optional?: boolean;
+ };
+}
+
/**
* An interface for accessing common fields from a package.json file whose version field may be missing.
*
@@ -155,6 +166,11 @@ export interface INodePackageJson {
*/
peerDependencies?: IPackageJsonDependencyTable;
+ /**
+ * An array of metadata about peer dependencies.
+ */
+ peerDependenciesMeta?: IPeerDependenciesMetaTable;
+
/**
* A table of script hooks that a package manager or build tool may invoke.
*/
diff --git a/libraries/node-core-library/src/index.ts b/libraries/node-core-library/src/index.ts
index 418f987ba55..8f444005417 100644
--- a/libraries/node-core-library/src/index.ts
+++ b/libraries/node-core-library/src/index.ts
@@ -28,7 +28,8 @@ export {
IPackageJson,
IPackageJsonDependencyTable,
IPackageJsonScriptTable,
- IPackageJsonRepository
+ IPackageJsonRepository,
+ IPeerDependenciesMetaTable
} from './IPackageJson';
export {
Import,
diff --git a/libraries/package-deps-hash/CHANGELOG.json b/libraries/package-deps-hash/CHANGELOG.json
index c50d888d71c..e23a8fa08dd 100644
--- a/libraries/package-deps-hash/CHANGELOG.json
+++ b/libraries/package-deps-hash/CHANGELOG.json
@@ -1,6 +1,201 @@
{
"name": "@rushstack/package-deps-hash",
"entries": [
+ {
+ "version": "4.0.10",
+ "tag": "@rushstack/package-deps-hash_v4.0.10",
+ "date": "Sat, 18 Mar 2023 00:20:56 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.50.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.5`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "4.0.9",
+ "tag": "@rushstack/package-deps-hash_v4.0.9",
+ "date": "Fri, 24 Feb 2023 01:24:17 GMT",
+ "comments": {
+ "patch": [
+ {
+ "comment": "Prevent network calls or maintenance tasks during local Git operations."
+ }
+ ]
+ }
+ },
+ {
+ "version": "4.0.8",
+ "tag": "@rushstack/package-deps-hash_v4.0.8",
+ "date": "Fri, 10 Feb 2023 01:18:51 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/eslint-config\" to `3.2.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.7`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.4`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.2`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "4.0.7",
+ "tag": "@rushstack/package-deps-hash_v4.0.7",
+ "date": "Sun, 05 Feb 2023 03:02:02 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.6`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.3`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.1`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "4.0.6",
+ "tag": "@rushstack/package-deps-hash_v4.0.6",
+ "date": "Wed, 01 Feb 2023 02:16:34 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.5`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.55.0`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "4.0.5",
+ "tag": "@rushstack/package-deps-hash_v4.0.5",
+ "date": "Mon, 30 Jan 2023 16:22:31 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.54.0`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.4`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/node-core-library\" to `3.54.0`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "4.0.4",
+ "tag": "@rushstack/package-deps-hash_v4.0.4",
+ "date": "Mon, 30 Jan 2023 00:55:44 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.12.0`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "4.0.3",
+ "tag": "@rushstack/package-deps-hash_v4.0.3",
+ "date": "Thu, 26 Jan 2023 02:55:10 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.3`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.14`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "4.0.2",
+ "tag": "@rushstack/package-deps-hash_v4.0.2",
+ "date": "Wed, 25 Jan 2023 07:26:55 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.2`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.13`"
+ }
+ ]
+ }
+ },
+ {
+ "version": "4.0.1",
+ "tag": "@rushstack/package-deps-hash_v4.0.1",
+ "date": "Tue, 24 Jan 2023 00:16:54 GMT",
+ "comments": {
+ "patch": [
+ {
+ "comment": "Fix bug in parseGitHashObject when 0 hashes are expected."
+ }
+ ]
+ }
+ },
+ {
+ "version": "4.0.0",
+ "tag": "@rushstack/package-deps-hash_v4.0.0",
+ "date": "Fri, 20 Jan 2023 16:19:50 GMT",
+ "comments": {
+ "major": [
+ {
+ "comment": "Add getRepoStateAsync API for faster repository state calculation. Remove synchronous getRepoState API."
+ }
+ ]
+ }
+ },
+ {
+ "version": "3.2.67",
+ "tag": "@rushstack/package-deps-hash_v3.2.67",
+ "date": "Wed, 18 Jan 2023 22:44:12 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/heft\" to `0.49.1`"
+ },
+ {
+ "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.11.12`"
+ }
+ ]
+ }
+ },
{
"version": "3.2.66",
"tag": "@rushstack/package-deps-hash_v3.2.66",
diff --git a/libraries/package-deps-hash/CHANGELOG.md b/libraries/package-deps-hash/CHANGELOG.md
index 70ba9b64e80..06cb9f0ba50 100644
--- a/libraries/package-deps-hash/CHANGELOG.md
+++ b/libraries/package-deps-hash/CHANGELOG.md
@@ -1,6 +1,72 @@
# Change Log - @rushstack/package-deps-hash
-This log was last generated on Tue, 20 Dec 2022 01:18:22 GMT and should not be manually modified.
+This log was last generated on Sat, 18 Mar 2023 00:20:56 GMT and should not be manually modified.
+
+## 4.0.10
+Sat, 18 Mar 2023 00:20:56 GMT
+
+_Version update only_
+
+## 4.0.9
+Fri, 24 Feb 2023 01:24:17 GMT
+
+### Patches
+
+- Prevent network calls or maintenance tasks during local Git operations.
+
+## 4.0.8
+Fri, 10 Feb 2023 01:18:51 GMT
+
+_Version update only_
+
+## 4.0.7
+Sun, 05 Feb 2023 03:02:02 GMT
+
+_Version update only_
+
+## 4.0.6
+Wed, 01 Feb 2023 02:16:34 GMT
+
+_Version update only_
+
+## 4.0.5
+Mon, 30 Jan 2023 16:22:31 GMT
+
+_Version update only_
+
+## 4.0.4
+Mon, 30 Jan 2023 00:55:44 GMT
+
+_Version update only_
+
+## 4.0.3
+Thu, 26 Jan 2023 02:55:10 GMT
+
+_Version update only_
+
+## 4.0.2
+Wed, 25 Jan 2023 07:26:55 GMT
+
+_Version update only_
+
+## 4.0.1
+Tue, 24 Jan 2023 00:16:54 GMT
+
+### Patches
+
+- Fix bug in parseGitHashObject when 0 hashes are expected.
+
+## 4.0.0
+Fri, 20 Jan 2023 16:19:50 GMT
+
+### Breaking changes
+
+- Add getRepoStateAsync API for faster repository state calculation. Remove synchronous getRepoState API.
+
+## 3.2.67
+Wed, 18 Jan 2023 22:44:12 GMT
+
+_Version update only_
## 3.2.66
Tue, 20 Dec 2022 01:18:22 GMT
diff --git a/libraries/package-deps-hash/package.json b/libraries/package-deps-hash/package.json
index d724924bd4a..3eb5e0689c2 100644
--- a/libraries/package-deps-hash/package.json
+++ b/libraries/package-deps-hash/package.json
@@ -1,6 +1,6 @@
{
"name": "@rushstack/package-deps-hash",
- "version": "3.2.66",
+ "version": "4.0.10",
"description": "",
"main": "lib/index.js",
"typings": "dist/package-deps-hash.d.ts",
@@ -20,7 +20,8 @@
"@rushstack/heft": "workspace:*",
"@rushstack/heft-node-rig": "workspace:*",
"@rushstack/node-core-library": "workspace:*",
- "@types/node": "12.20.24"
+ "@types/heft-jest": "1.0.1",
+ "@types/node": "14.18.36"
},
"dependencies": {
"@rushstack/node-core-library": "workspace:*"
diff --git a/libraries/package-deps-hash/src/getRepoState.ts b/libraries/package-deps-hash/src/getRepoState.ts
index ed316401d65..6016a4b1dde 100644
--- a/libraries/package-deps-hash/src/getRepoState.ts
+++ b/libraries/package-deps-hash/src/getRepoState.ts
@@ -2,7 +2,10 @@
// See LICENSE in the project root for license information.
import type * as child_process from 'child_process';
-import { Executable, FileSystem } from '@rushstack/node-core-library';
+import { once } from 'events';
+import { Readable } from 'stream';
+
+import { Executable, FileSystem, IExecutableSpawnOptions } from '@rushstack/node-core-library';
export interface IGitVersion {
major: number;
@@ -16,6 +19,14 @@ const MINIMUM_GIT_VERSION: IGitVersion = {
patch: 0
};
+const STANDARD_GIT_OPTIONS: readonly string[] = [
+ // Don't request any optional file locks
+ '--no-optional-locks',
+ // Ensure that commands don't run automatic maintenance, since performance of the command itself is paramount
+ '-c',
+ 'maintenance.auto=false'
+];
+
interface IGitTreeState {
files: Map; // type "blob"
submodules: Map; // type "commit"
@@ -72,6 +83,44 @@ export function parseGitLsTree(output: string): IGitTreeState {
};
}
+/**
+ * Parses the output of `git hash-object`
+ * yields [filePath, hash] pairs.
+ * @internal
+ */
+export function* parseGitHashObject(
+ output: string,
+ filePaths: ReadonlyArray
+): IterableIterator<[string, string]> {
+ const expected: number = filePaths.length;
+ if (expected === 0) {
+ return;
+ }
+
+ output = output.trim();
+
+ let last: number = 0;
+ let i: number = 0;
+ let index: number = output.indexOf('\n', last);
+ for (; i < expected && index > 0; i++) {
+ const hash: string = output.slice(last, index);
+ yield [filePaths[i], hash];
+ last = index + 1;
+ index = output.indexOf('\n', last);
+ }
+
+ // Handle last line. Will be non-empty to due trim() call.
+ if (index < 0) {
+ const hash: string = output.slice(last);
+ yield [filePaths[i], hash];
+ i++;
+ }
+
+ if (i !== expected) {
+ throw new Error(`Expected ${expected} hashes from "git hash-object" but received ${i}`);
+ }
+}
+
/**
* Information about the changes to a file.
* @beta
@@ -190,128 +239,170 @@ export function getRepoRoot(currentWorkingDirectory: string, gitPath?: string):
throw new Error(`git rev-parse exited with status ${result.status}: ${result.stderr}`);
}
- repoRootCache.set(currentWorkingDirectory, (cachedResult = result.stdout.trim()));
+ cachedResult = result.stdout.trim();
+
+ repoRootCache.set(currentWorkingDirectory, cachedResult);
+ // To ensure that calling getRepoRoot on the result is a no-op.
+ repoRootCache.set(cachedResult, cachedResult);
}
return cachedResult;
}
/**
- * Augments the state value with modifications that are not in the index.
- * @param rootDirectory - The root directory of the Git repository
- * @param state - The current map of git path -> object hash. Will be mutated.
- * @param gitPath - The path to the Git executable
- * @internal
+ * Helper function for async process invocation with optional stdin support.
+ * @param gitPath - Path to the Git executable
+ * @param args - The process arguments
+ * @param currentWorkingDirectory - The working directory. Should be the repository root.
+ * @param stdin - An optional Readable stream to use as stdin to the process.
*/
-export function applyWorkingTreeState(
- rootDirectory: string,
- state: Map,
- gitPath?: string
-): void {
- const statusResult: child_process.SpawnSyncReturns = Executable.spawnSync(
- gitPath || 'git',
- ['--no-optional-locks', 'status', '-z', '-u', '--no-renames', '--ignore-submodules', '--'],
- {
- currentWorkingDirectory: rootDirectory
- }
- );
+async function spawnGitAsync(
+ gitPath: string | undefined,
+ args: string[],
+ currentWorkingDirectory: string,
+ stdin?: Readable
+): Promise {
+ const spawnOptions: IExecutableSpawnOptions = {
+ currentWorkingDirectory,
+ stdio: ['pipe', 'pipe', 'pipe']
+ };
- if (statusResult.status !== 0) {
- ensureGitMinimumVersion(gitPath);
+ let stdout: string = '';
+ let stderr: string = '';
- throw new Error(`git status exited with status ${statusResult.status}: ${statusResult.stderr}`);
- }
+ const proc: child_process.ChildProcess = Executable.spawn(gitPath || 'git', args, spawnOptions);
+ proc.stdout!.setEncoding('utf-8');
+ proc.stderr!.setEncoding('utf-8');
- const locallyModified: Map = parseGitStatus(statusResult.stdout);
+ proc.stdout!.on('data', (chunk: string) => {
+ stdout += chunk.toString();
+ });
+ proc.stderr!.on('data', (chunk: string) => {
+ stderr += chunk.toString();
+ });
- const filesToHash: string[] = [];
- for (const [filePath, exists] of locallyModified) {
- if (exists) {
- filesToHash.push(filePath);
- } else {
- state.delete(filePath);
- }
+ if (stdin) {
+ stdin.pipe(proc.stdin!);
}
- if (filesToHash.length) {
- // Use --stdin-paths arg to pass the list of files to git in order to avoid issues with
- // command length
- const hashObjectResult: child_process.SpawnSyncReturns = Executable.spawnSync(
- gitPath || 'git',
- ['hash-object', '--stdin-paths'],
- { currentWorkingDirectory: rootDirectory, input: filesToHash.join('\n') }
- );
-
- if (hashObjectResult.status !== 0) {
- ensureGitMinimumVersion(gitPath);
-
- throw new Error(
- `git hash-object exited with status ${hashObjectResult.status}: ${hashObjectResult.stderr}`
- );
- }
-
- const hashStdout: string = hashObjectResult.stdout.trim();
-
- // The result of "git hash-object" will be a list of file hashes delimited by newlines
- const hashes: string[] = hashStdout.split('\n');
-
- if (hashes.length !== filesToHash.length) {
- throw new Error(
- `Passed ${filesToHash.length} file paths to Git to hash, but received ${hashes.length} hashes.`
- );
- }
-
- const len: number = hashes.length;
- for (let i: number = 0; i < len; i++) {
- const hash: string = hashes[i];
- const filePath: string = filesToHash[i];
- state.set(filePath, hash);
- }
+ const [status] = await once(proc, 'exit');
+ if (status !== 0) {
+ throw new Error(`git ${args[0]} exited with code ${status}: ${stderr}`);
}
+
+ return stdout;
}
/**
* Gets the object hashes for all files in the Git repo, combining the current commit with working tree state.
- * @param currentWorkingDirectory - The working directory. Only used to find the repository root.
+ * Uses async operations and runs all primary Git calls in parallel.
+ * @param rootDirectory - The root directory of the Git repository
+ * @param additionalRelativePathsToHash - Root-relative file paths to have Git hash and include in the results
* @param gitPath - The path to the Git executable
* @beta
*/
-export function getRepoState(currentWorkingDirectory: string, gitPath?: string): Map {
- const rootDirectory: string = getRepoRoot(currentWorkingDirectory, gitPath);
-
- const lsTreeResult: child_process.SpawnSyncReturns = Executable.spawnSync(
- gitPath || 'git',
- ['--no-optional-locks', 'ls-tree', '-r', '-z', '--full-name', 'HEAD', '--'],
- {
- currentWorkingDirectory: rootDirectory
+export async function getRepoStateAsync(
+ rootDirectory: string,
+ additionalRelativePathsToHash?: string[],
+ gitPath?: string
+): Promise> {
+ const statePromise: Promise = spawnGitAsync(
+ gitPath,
+ STANDARD_GIT_OPTIONS.concat([
+ 'ls-tree',
+ // Recursively expand trees
+ '-r',
+ // Use NUL as the separator
+ '-z',
+ // Specify the full path to files relative to the root
+ '--full-name',
+ // As of last commit
+ 'HEAD',
+ '--'
+ ]),
+ rootDirectory
+ ).then(parseGitLsTree);
+ const locallyModifiedPromise: Promise> = spawnGitAsync(
+ gitPath,
+ STANDARD_GIT_OPTIONS.concat([
+ 'status',
+ // Use NUL as the separator
+ '-z',
+ // Include untracked files
+ '-u',
+ // Disable rename detection so that renames show up as add + delete
+ '--no-renames',
+ // Don't process submodules with this command; they'll be handled individually
+ '--ignore-submodules',
+ // Don't compare against the remote
+ '--no-ahead-behind',
+ '--'
+ ]),
+ rootDirectory
+ ).then(parseGitStatus);
+
+ const hashPaths: string[] = [];
+ async function* getFilesToHash(): AsyncIterableIterator {
+ if (additionalRelativePathsToHash) {
+ for (const file of additionalRelativePathsToHash) {
+ hashPaths.push(file);
+ yield `${file}\n`;
+ }
}
- );
- if (lsTreeResult.status !== 0) {
- ensureGitMinimumVersion(gitPath);
+ const [{ files }, locallyModified] = await Promise.all([statePromise, locallyModifiedPromise]);
- throw new Error(`git ls-tree exited with status ${lsTreeResult.status}: ${lsTreeResult.stderr}`);
+ for (const [filePath, exists] of locallyModified) {
+ if (exists) {
+ hashPaths.push(filePath);
+ yield `${filePath}\n`;
+ } else {
+ files.delete(filePath);
+ }
+ }
}
- const { files, submodules } = parseGitLsTree(lsTreeResult.stdout);
+ const hashObjectPromise: Promise = spawnGitAsync(
+ gitPath,
+ STANDARD_GIT_OPTIONS.concat(['hash-object', '--stdin-paths']),
+ rootDirectory,
+ Readable.from(getFilesToHash(), {
+ encoding: 'utf-8',
+ objectMode: false,
+ autoDestroy: true
+ })
+ );
- applyWorkingTreeState(rootDirectory, files, gitPath);
+ const [{ files, submodules }, hashObject] = await Promise.all([
+ statePromise,
+ hashObjectPromise,
+ locallyModifiedPromise
+ ]);
- const state: Map = files;
+ // The result of "git hash-object" will be a list of file hashes delimited by newlines
+ for (const [filePath, hash] of parseGitHashObject(hashObject, hashPaths)) {
+ files.set(filePath, hash);
+ }
// Existence check for the .gitmodules file
const hasSubmodules: boolean = submodules.size > 0 && FileSystem.exists(`${rootDirectory}/.gitmodules`);
if (hasSubmodules) {
+ // Submodules are not the normal critical path. Accept serial performance rather than investing in complexity.
+ // Can revisit if submodules become more commonly used.
for (const submodulePath of submodules.keys()) {
- const submoduleState: Map = getRepoState(`${rootDirectory}/${submodulePath}`, gitPath);
+ const submoduleState: Map = await getRepoStateAsync(
+ `${rootDirectory}/${submodulePath}`,
+ [],
+ gitPath
+ );
for (const [filePath, hash] of submoduleState) {
- state.set(`${submodulePath}/${filePath}`, hash);
+ files.set(`${submodulePath}/${filePath}`, hash);
}
}
}
- return state;
+ return files;
}
/**
@@ -332,8 +423,7 @@ export function getRepoChanges(
const result: child_process.SpawnSyncReturns = Executable.spawnSync(
gitPath || 'git',
- [
- '--no-optional-locks',
+ STANDARD_GIT_OPTIONS.concat([
'diff-index',
'--color=never',
'--no-renames',
@@ -342,7 +432,7 @@ export function getRepoChanges(
'-z',
revision,
'--'
- ],
+ ]),
{
currentWorkingDirectory: rootDirectory
}
@@ -382,7 +472,10 @@ export function ensureGitMinimumVersion(gitPath?: string): void {
}
function getGitVersion(gitPath?: string): IGitVersion {
- const result: child_process.SpawnSyncReturns = Executable.spawnSync(gitPath || 'git', ['version']);
+ const result: child_process.SpawnSyncReturns = Executable.spawnSync(
+ gitPath || 'git',
+ STANDARD_GIT_OPTIONS.concat(['version'])
+ );
if (result.status !== 0) {
throw new Error(
diff --git a/libraries/package-deps-hash/src/index.ts b/libraries/package-deps-hash/src/index.ts
index 855573b8589..2135572b5b7 100644
--- a/libraries/package-deps-hash/src/index.ts
+++ b/libraries/package-deps-hash/src/index.ts
@@ -18,6 +18,6 @@ export {
IFileDiffStatus,
getRepoChanges,
getRepoRoot,
- getRepoState,
+ getRepoStateAsync,
ensureGitMinimumVersion
} from './getRepoState';
diff --git a/libraries/package-deps-hash/src/test/__snapshots__/getRepoDeps.test.ts.snap b/libraries/package-deps-hash/src/test/__snapshots__/getRepoDeps.test.ts.snap
new file mode 100644
index 00000000000..add7d8be46f
--- /dev/null
+++ b/libraries/package-deps-hash/src/test/__snapshots__/getRepoDeps.test.ts.snap
@@ -0,0 +1,104 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`getRepoStateAsync can handle adding one file 1`] = `
+Object {
+ "nestedTestProject/package.json": "18a1e415e56220fa5122428a4ef8eb8874756576",
+ "nestedTestProject/src/file 1.txt": "c7b2f707ac99ca522f965210a7b6b0b109863f34",
+ "testProject/a.txt": "2e65efe2a145dda7ee51d1741299f848e5bf752e",
+ "testProject/file 2.txt": "a385f754ec4fede884a4864d090064d9aeef8ccb",
+ "testProject/file1.txt": "c7b2f707ac99ca522f965210a7b6b0b109863f34",
+ "testProject/file蝴蝶.txt": "ae814af81e16cb2ae8c57503c77e2cab6b5462ba",
+ "testProject/package.json": "18a1e415e56220fa5122428a4ef8eb8874756576",
+}
+`;
+
+exports[`getRepoStateAsync can handle adding two files 1`] = `
+Object {
+ "nestedTestProject/package.json": "18a1e415e56220fa5122428a4ef8eb8874756576",
+ "nestedTestProject/src/file 1.txt": "c7b2f707ac99ca522f965210a7b6b0b109863f34",
+ "testProject/a.txt": "2e65efe2a145dda7ee51d1741299f848e5bf752e",
+ "testProject/b.txt": "2e65efe2a145dda7ee51d1741299f848e5bf752e",
+ "testProject/file 2.txt": "a385f754ec4fede884a4864d090064d9aeef8ccb",
+ "testProject/file1.txt": "c7b2f707ac99ca522f965210a7b6b0b109863f34",
+ "testProject/file蝴蝶.txt": "ae814af81e16cb2ae8c57503c77e2cab6b5462ba",
+ "testProject/package.json": "18a1e415e56220fa5122428a4ef8eb8874756576",
+}
+`;
+
+exports[`getRepoStateAsync can handle changing one file 1`] = `
+Object {
+ "nestedTestProject/package.json": "18a1e415e56220fa5122428a4ef8eb8874756576",
+ "nestedTestProject/src/file 1.txt": "c7b2f707ac99ca522f965210a7b6b0b109863f34",
+ "testProject/file 2.txt": "a385f754ec4fede884a4864d090064d9aeef8ccb",
+ "testProject/file1.txt": "f2ba8f84ab5c1bce84a7b441cb1959cfc7093b7f",
+ "testProject/file蝴蝶.txt": "ae814af81e16cb2ae8c57503c77e2cab6b5462ba",
+ "testProject/package.json": "18a1e415e56220fa5122428a4ef8eb8874756576",
+}
+`;
+
+exports[`getRepoStateAsync can handle removing one file 1`] = `
+Object {
+ "nestedTestProject/package.json": "18a1e415e56220fa5122428a4ef8eb8874756576",
+ "nestedTestProject/src/file 1.txt": "c7b2f707ac99ca522f965210a7b6b0b109863f34",
+ "testProject/file 2.txt": "a385f754ec4fede884a4864d090064d9aeef8ccb",
+ "testProject/file蝴蝶.txt": "ae814af81e16cb2ae8c57503c77e2cab6b5462ba",
+ "testProject/package.json": "18a1e415e56220fa5122428a4ef8eb8874756576",
+}
+`;
+
+exports[`getRepoStateAsync can handle uncommitted filenames with spaces and non-ASCII characters 1`] = `
+Object {
+ "nestedTestProject/package.json": "18a1e415e56220fa5122428a4ef8eb8874756576",
+ "nestedTestProject/src/file 1.txt": "c7b2f707ac99ca522f965210a7b6b0b109863f34",
+ "testProject/a file name.txt": "2e65efe2a145dda7ee51d1741299f848e5bf752e",
+ "testProject/a file.txt": "2e65efe2a145dda7ee51d1741299f848e5bf752e",
+ "testProject/file 2.txt": "a385f754ec4fede884a4864d090064d9aeef8ccb",
+ "testProject/file1.txt": "c7b2f707ac99ca522f965210a7b6b0b109863f34",
+ "testProject/file蝴蝶.txt": "ae814af81e16cb2ae8c57503c77e2cab6b5462ba",
+ "testProject/newFile批把.txt": "2e65efe2a145dda7ee51d1741299f848e5bf752e",
+ "testProject/package.json": "18a1e415e56220fa5122428a4ef8eb8874756576",
+}
+`;
+
+exports[`getRepoStateAsync can parse committed files 1`] = `
+Object {
+ "nestedTestProject/package.json": "18a1e415e56220fa5122428a4ef8eb8874756576",
+ "nestedTestProject/src/file 1.txt": "c7b2f707ac99ca522f965210a7b6b0b109863f34",
+ "testProject/file 2.txt": "a385f754ec4fede884a4864d090064d9aeef8ccb",
+ "testProject/file1.txt": "c7b2f707ac99ca522f965210a7b6b0b109863f34",
+ "testProject/file蝴蝶.txt": "ae814af81e16cb2ae8c57503c77e2cab6b5462ba",
+ "testProject/package.json": "18a1e415e56220fa5122428a4ef8eb8874756576",
+}
+`;
+
+exports[`getRepoStateAsync handles requests for additional files 1`] = `
+Object {
+ "nestedTestProject/package.json": "18a1e415e56220fa5122428a4ef8eb8874756576",
+ "nestedTestProject/src/file 1.txt": "c7b2f707ac99ca522f965210a7b6b0b109863f34",
+ "testProject/file 2.txt": "a385f754ec4fede884a4864d090064d9aeef8ccb",
+ "testProject/file1.txt": "c7b2f707ac99ca522f965210a7b6b0b109863f34",
+ "testProject/file蝴蝶.txt": "ae814af81e16cb2ae8c57503c77e2cab6b5462ba",
+ "testProject/log.log": "2e65efe2a145dda7ee51d1741299f848e5bf752e",
+ "testProject/package.json": "18a1e415e56220fa5122428a4ef8eb8874756576",
+}
+`;
+
+exports[`parseGitHashObject can parse multiple entries 1`] = `
+Map {
+ "a" => "11",
+ "b" => "22",
+ "c" => "33",
+}
+`;
+
+exports[`parseGitHashObject can parse multiple entries with trailing whitespace 1`] = `
+Map {
+ "a" => "11",
+ "b" => "22",
+ "c" => "33",
+}
+`;
+
+exports[`parseGitHashObject throws if too few hashes are provided 1`] = `"Expected 3 hashes from \\"git hash-object\\" but received 2"`;
+
+exports[`parseGitHashObject throws if too many hashes are provided 1`] = `"Expected 2 hashes from \\"git hash-object\\" but received 3"`;
diff --git a/libraries/package-deps-hash/src/test/getRepoDeps.test.ts b/libraries/package-deps-hash/src/test/getRepoDeps.test.ts
index ffcf20f6141..b031efa33b6 100644
--- a/libraries/package-deps-hash/src/test/getRepoDeps.test.ts
+++ b/libraries/package-deps-hash/src/test/getRepoDeps.test.ts
@@ -4,9 +4,9 @@
import * as path from 'path';
import { execSync } from 'child_process';
-import { getRepoState, parseGitLsTree, getRepoRoot } from '../getRepoState';
+import { getRepoStateAsync, parseGitLsTree, getRepoRoot, parseGitHashObject } from '../getRepoState';
-import { FileSystem, FileConstants } from '@rushstack/node-core-library';
+import { FileSystem } from '@rushstack/node-core-library';
const SOURCE_PATH: string = path.join(__dirname).replace(path.join('lib', 'test'), path.join('src', 'test'));
@@ -15,19 +15,20 @@ const TEST_PROJECT_PATH: string = path.join(SOURCE_PATH, 'testProject');
const FILTERS: string[] = [`testProject/`, `nestedTestProject/`];
-function getRelevantEntries(results: Map): Map {
- const relevantResults: Map = new Map();
+function checkSnapshot(results: Map): void {
+ const relevantResults: Record = {};
for (const [key, hash] of results) {
if (key.startsWith(TEST_PREFIX)) {
const partialKey: string = key.slice(TEST_PREFIX.length);
for (const filter of FILTERS) {
if (partialKey.startsWith(filter)) {
- relevantResults.set(partialKey, hash);
+ relevantResults[partialKey] = hash;
}
}
}
}
- return relevantResults;
+
+ expect(relevantResults).toMatchSnapshot();
}
describe(getRepoRoot.name, () => {
@@ -83,114 +84,78 @@ describe(parseGitLsTree.name, () => {
});
});
-describe(getRepoState.name, () => {
- it('can parse committed files', () => {
- const results: Map = getRepoState(__dirname);
- const filteredResults: Map = getRelevantEntries(results);
- const expectedFiles: Map = new Map(
- Object.entries({
- 'nestedTestProject/src/file 1.txt': 'c7b2f707ac99ca522f965210a7b6b0b109863f34',
- [`nestedTestProject/${FileConstants.PackageJson}`]: '18a1e415e56220fa5122428a4ef8eb8874756576',
- 'testProject/file1.txt': 'c7b2f707ac99ca522f965210a7b6b0b109863f34',
- 'testProject/file 2.txt': 'a385f754ec4fede884a4864d090064d9aeef8ccb',
- 'testProject/file蝴蝶.txt': 'ae814af81e16cb2ae8c57503c77e2cab6b5462ba',
- [`testProject/${FileConstants.PackageJson}`]: '18a1e415e56220fa5122428a4ef8eb8874756576'
- })
- );
-
- for (const [filePath, hash] of expectedFiles) {
- expect(filteredResults.get(filePath)).toEqual(hash);
- }
- expect(filteredResults.size).toEqual(expectedFiles.size);
+describe(parseGitHashObject.name, () => {
+ it('can handle requesting zero entries', () => {
+ const results: Map = new Map(parseGitHashObject('', []));
+ expect(results.size).toEqual(0);
+ });
+
+ it('can parse multiple entries', () => {
+ const results: Map = new Map(parseGitHashObject('11\n22\n33', ['a', 'b', 'c']));
+ expect(results).toMatchSnapshot();
+ });
+
+ it('can parse multiple entries with trailing whitespace', () => {
+ const results: Map = new Map(parseGitHashObject('11\n22\n33\n\n', ['a', 'b', 'c']));
+ expect(results).toMatchSnapshot();
+ });
+
+ it('throws if too few hashes are provided', () => {
+ expect(() => {
+ new Map(parseGitHashObject('11\n22', ['a', 'b', 'c']));
+ }).toThrowErrorMatchingSnapshot();
});
- it('can handle adding one file', () => {
+ it('throws if too many hashes are provided', () => {
+ expect(() => {
+ new Map(parseGitHashObject('11\n22\n33', ['a', 'b']));
+ }).toThrowErrorMatchingSnapshot();
+ });
+});
+
+describe(getRepoStateAsync.name, () => {
+ it('can parse committed files', async () => {
+ const results: Map = await getRepoStateAsync(__dirname);
+ checkSnapshot(results);
+ });
+
+ it('can handle adding one file', async () => {
const tempFilePath: string = path.join(TEST_PROJECT_PATH, 'a.txt');
FileSystem.writeFile(tempFilePath, 'a');
- const results: Map = getRepoState(__dirname);
- const filteredResults: Map = getRelevantEntries(results);
-
try {
- const expectedFiles: Map = new Map(
- Object.entries({
- 'nestedTestProject/src/file 1.txt': 'c7b2f707ac99ca522f965210a7b6b0b109863f34',
- [`nestedTestProject/${FileConstants.PackageJson}`]: '18a1e415e56220fa5122428a4ef8eb8874756576',
- 'testProject/a.txt': '2e65efe2a145dda7ee51d1741299f848e5bf752e',
- 'testProject/file1.txt': 'c7b2f707ac99ca522f965210a7b6b0b109863f34',
- 'testProject/file 2.txt': 'a385f754ec4fede884a4864d090064d9aeef8ccb',
- 'testProject/file蝴蝶.txt': 'ae814af81e16cb2ae8c57503c77e2cab6b5462ba',
- [`testProject/${FileConstants.PackageJson}`]: '18a1e415e56220fa5122428a4ef8eb8874756576'
- })
- );
-
- for (const [filePath, hash] of expectedFiles) {
- expect(filteredResults.get(filePath)).toEqual(hash);
- }
- expect(filteredResults.size).toEqual(expectedFiles.size);
+ const results: Map = await getRepoStateAsync(__dirname);
+ checkSnapshot(results);
} finally {
FileSystem.deleteFile(tempFilePath);
}
});
- it('can handle adding two files', () => {
+ it('can handle adding two files', async () => {
const tempFilePath1: string = path.join(TEST_PROJECT_PATH, 'a.txt');
const tempFilePath2: string = path.join(TEST_PROJECT_PATH, 'b.txt');
FileSystem.writeFile(tempFilePath1, 'a');
FileSystem.writeFile(tempFilePath2, 'a');
- const results: Map = getRepoState(__dirname);
- const filteredResults: Map = getRelevantEntries(results);
-
try {
- const expectedFiles: Map = new Map(
- Object.entries({
- 'nestedTestProject/src/file 1.txt': 'c7b2f707ac99ca522f965210a7b6b0b109863f34',
- [`nestedTestProject/${FileConstants.PackageJson}`]: '18a1e415e56220fa5122428a4ef8eb8874756576',
- 'testProject/a.txt': '2e65efe2a145dda7ee51d1741299f848e5bf752e',
- 'testProject/b.txt': '2e65efe2a145dda7ee51d1741299f848e5bf752e',
- 'testProject/file1.txt': 'c7b2f707ac99ca522f965210a7b6b0b109863f34',
- 'testProject/file 2.txt': 'a385f754ec4fede884a4864d090064d9aeef8ccb',
- 'testProject/file蝴蝶.txt': 'ae814af81e16cb2ae8c57503c77e2cab6b5462ba',
- [`testProject/${FileConstants.PackageJson}`]: '18a1e415e56220fa5122428a4ef8eb8874756576'
- })
- );
-
- for (const [filePath, hash] of expectedFiles) {
- expect(filteredResults.get(filePath)).toEqual(hash);
- }
- expect(filteredResults.size).toEqual(expectedFiles.size);
+ const results: Map = await getRepoStateAsync(__dirname);
+ checkSnapshot(results);
} finally {
FileSystem.deleteFile(tempFilePath1);
FileSystem.deleteFile(tempFilePath2);
}
});
- it('can handle removing one file', () => {
+ it('can handle removing one file', async () => {
const testFilePath: string = path.join(TEST_PROJECT_PATH, 'file1.txt');
FileSystem.deleteFile(testFilePath);
- const results: Map = getRepoState(__dirname);
- const filteredResults: Map = getRelevantEntries(results);
-
try {
- const expectedFiles: Map = new Map(
- Object.entries({
- 'nestedTestProject/src/file 1.txt': 'c7b2f707ac99ca522f965210a7b6b0b109863f34',
- [`nestedTestProject/${FileConstants.PackageJson}`]: '18a1e415e56220fa5122428a4ef8eb8874756576',
- 'testProject/file 2.txt': 'a385f754ec4fede884a4864d090064d9aeef8ccb',
- 'testProject/file蝴蝶.txt': 'ae814af81e16cb2ae8c57503c77e2cab6b5462ba',
- [`testProject/${FileConstants.PackageJson}`]: '18a1e415e56220fa5122428a4ef8eb8874756576'
- })
- );
-
- for (const [filePath, hash] of expectedFiles) {
- expect(filteredResults.get(filePath)).toEqual(hash);
- }
- expect(filteredResults.size).toEqual(expectedFiles.size);
+ const results: Map = await getRepoStateAsync(__dirname);
+ checkSnapshot(results);
} finally {
execSync(`git checkout --force HEAD -- ${TEST_PREFIX}testProject/file1.txt`, {
stdio: 'ignore',
@@ -199,30 +164,14 @@ describe(getRepoState.name, () => {
}
});
- it('can handle changing one file', () => {
+ it('can handle changing one file', async () => {
const testFilePath: string = path.join(TEST_PROJECT_PATH, 'file1.txt');
FileSystem.writeFile(testFilePath, 'abc');
- const results: Map = getRepoState(__dirname);
- const filteredResults: Map = getRelevantEntries(results);
-
try {
- const expectedFiles: Map = new Map(
- Object.entries({
- 'nestedTestProject/src/file 1.txt': 'c7b2f707ac99ca522f965210a7b6b0b109863f34',
- [`nestedTestProject/${FileConstants.PackageJson}`]: '18a1e415e56220fa5122428a4ef8eb8874756576',
- 'testProject/file1.txt': 'f2ba8f84ab5c1bce84a7b441cb1959cfc7093b7f',
- 'testProject/file 2.txt': 'a385f754ec4fede884a4864d090064d9aeef8ccb',
- 'testProject/file蝴蝶.txt': 'ae814af81e16cb2ae8c57503c77e2cab6b5462ba',
- [`testProject/${FileConstants.PackageJson}`]: '18a1e415e56220fa5122428a4ef8eb8874756576'
- })
- );
-
- for (const [filePath, hash] of expectedFiles) {
- expect(filteredResults.get(filePath)).toEqual(hash);
- }
- expect(filteredResults.size).toEqual(expectedFiles.size);
+ const results: Map = await getRepoStateAsync(__dirname);
+ checkSnapshot(results);
} finally {
execSync(`git checkout --force HEAD -- ${TEST_PREFIX}testProject/file1.txt`, {
stdio: 'ignore',
@@ -231,7 +180,7 @@ describe(getRepoState.name, () => {
}
});
- it('can handle uncommitted filenames with spaces and non-ASCII characters', () => {
+ it('can handle uncommitted filenames with spaces and non-ASCII characters', async () => {
const tempFilePath1: string = path.join(TEST_PROJECT_PATH, 'a file.txt');
const tempFilePath2: string = path.join(TEST_PROJECT_PATH, 'a file name.txt');
const tempFilePath3: string = path.join(TEST_PROJECT_PATH, 'newFile批把.txt');
@@ -240,32 +189,28 @@ describe(getRepoState.name, () => {
FileSystem.writeFile(tempFilePath2, 'a');
FileSystem.writeFile(tempFilePath3, 'a');
- const results: Map = getRepoState(__dirname);
- const filteredResults: Map = getRelevantEntries(results);
-
try {
- const expectedFiles: Map = new Map(
- Object.entries({
- 'nestedTestProject/src/file 1.txt': 'c7b2f707ac99ca522f965210a7b6b0b109863f34',
- [`nestedTestProject/${FileConstants.PackageJson}`]: '18a1e415e56220fa5122428a4ef8eb8874756576',
- 'testProject/a file.txt': '2e65efe2a145dda7ee51d1741299f848e5bf752e',
- 'testProject/a file name.txt': '2e65efe2a145dda7ee51d1741299f848e5bf752e',
- 'testProject/file1.txt': 'c7b2f707ac99ca522f965210a7b6b0b109863f34',
- 'testProject/file 2.txt': 'a385f754ec4fede884a4864d090064d9aeef8ccb',
- 'testProject/file蝴蝶.txt': 'ae814af81e16cb2ae8c57503c77e2cab6b5462ba',
- 'testProject/newFile批把.txt': '2e65efe2a145dda7ee51d1741299f848e5bf752e',
- [`testProject/${FileConstants.PackageJson}`]: '18a1e415e56220fa5122428a4ef8eb8874756576'
- })
- );
-
- for (const [filePath, hash] of expectedFiles) {
- expect(filteredResults.get(filePath)).toEqual(hash);
- }
- expect(filteredResults.size).toEqual(expectedFiles.size);
+ const results: Map = await getRepoStateAsync(__dirname);
+ checkSnapshot(results);
} finally {
FileSystem.deleteFile(tempFilePath1);
FileSystem.deleteFile(tempFilePath2);
FileSystem.deleteFile(tempFilePath3);
}
});
+
+ it('handles requests for additional files', async () => {
+ const tempFilePath1: string = path.join(TEST_PROJECT_PATH, 'log.log');
+
+ FileSystem.writeFile(tempFilePath1, 'a');
+
+ try {
+ const results: Map = await getRepoStateAsync(__dirname, [
+ `${TEST_PREFIX}testProject/log.log`
+ ]);
+ checkSnapshot(results);
+ } finally {
+ FileSystem.deleteFile(tempFilePath1);
+ }
+ });
});
diff --git a/libraries/rig-package/CHANGELOG.json b/libraries/rig-package/CHANGELOG.json
index cd960e1367c..b3223652403 100644
--- a/libraries/rig-package/CHANGELOG.json
+++ b/libraries/rig-package/CHANGELOG.json
@@ -1,6 +1,18 @@
{
"name": "@rushstack/rig-package",
"entries": [
+ {
+ "version": "0.3.18",
+ "tag": "@rushstack/rig-package_v0.3.18",
+ "date": "Fri, 10 Feb 2023 01:18:50 GMT",
+ "comments": {
+ "dependency": [
+ {
+ "comment": "Updating dependency \"@rushstack/eslint-config\" to `3.2.0`"
+ }
+ ]
+ }
+ },
{
"version": "0.3.17",
"tag": "@rushstack/rig-package_v0.3.17",
diff --git a/libraries/rig-package/CHANGELOG.md b/libraries/rig-package/CHANGELOG.md
index cf6410dd0d7..1750a9f34d2 100644
--- a/libraries/rig-package/CHANGELOG.md
+++ b/libraries/rig-package/CHANGELOG.md
@@ -1,6 +1,11 @@
# Change Log - @rushstack/rig-package
-This log was last generated on Mon, 10 Oct 2022 15:23:44 GMT and should not be manually modified.
+This log was last generated on Fri, 10 Feb 2023 01:18:50 GMT and should not be manually modified.
+
+## 0.3.18
+Fri, 10 Feb 2023 01:18:50 GMT
+
+_Version update only_
## 0.3.17
Mon, 10 Oct 2022 15:23:44 GMT
diff --git a/libraries/rig-package/package.json b/libraries/rig-package/package.json
index 73720b1dc2e..b413fef8b79 100644
--- a/libraries/rig-package/package.json
+++ b/libraries/rig-package/package.json
@@ -1,6 +1,6 @@
{
"name": "@rushstack/rig-package",
- "version": "0.3.17",
+ "version": "0.3.18",
"description": "A system for sharing tool configurations between projects without duplicating config files.",
"main": "lib/index.js",
"typings": "dist/rig-package.d.ts",
@@ -21,10 +21,10 @@
},
"devDependencies": {
"@rushstack/eslint-config": "workspace:*",
- "@rushstack/heft-node-rig": "1.11.0",
- "@rushstack/heft": "0.48.0",
+ "@rushstack/heft-node-rig": "1.11.14",
+ "@rushstack/heft": "0.49.3",
"@types/heft-jest": "1.0.1",
- "@types/node": "12.20.24",
+ "@types/node": "14.18.36",
"@types/resolve": "1.20.2",
"ajv": "~6.12.5",
"resolve": "~1.22.1"
diff --git a/libraries/rush-lib/assets/rush-init/common/config/rush/command-line.json b/libraries/rush-lib/assets/rush-init/common/config/rush/command-line.json
index 534365ae4d0..8b972ba7734 100644
--- a/libraries/rush-lib/assets/rush-init/common/config/rush/command-line.json
+++ b/libraries/rush-lib/assets/rush-init/common/config/rush/command-line.json
@@ -15,17 +15,16 @@
{
/**
* (Required) Determines the type of custom command.
- * Rush's "bulk" commands are invoked separately for each project. Rush will look in
- * each project's package.json file for a "scripts" entry whose name matches the
- * command name. By default, the command will run for every project in the repo,
- * according to the dependency graph (similar to how "rush build" works).
+ * Rush's "bulk" commands are invoked separately for each project. By default, the command will run for
+ * every project in the repo, according to the dependency graph (similar to how "rush build" works).
* The set of projects can be restricted e.g. using the "--to" or "--from" parameters.
*/
"commandKind": "bulk",
/**
* (Required) The name that will be typed as part of the command line. This is also the name
- * of the "scripts" hook in the project's package.json file.
+ * of the "scripts" hook in the project's package.json file (if "shellCommand" is not specified).
+ *
* The name should be comprised of lower case words separated by hyphens or colons. The name should include an
* English verb (e.g. "deploy"). Use a hyphen to separate words (e.g. "upload-docs"). A group of related commands
* can be prefixed with a colon (e.g. "docs:generate", "docs:deploy", "docs:serve", etc).
@@ -61,6 +60,16 @@
*/
"safeForSimultaneousRushProcesses": false,
+ /**
+ * (Optional) If the `shellCommand` field is set for a bulk command, Rush will invoke it for each
+ * selected project; otherwise, Rush will invoke the package.json `"scripts"` entry matching Rush command name.
+ *
+ * The string is the path to a script that will be invoked using the OS shell. The working directory will be
+ * the folder that contains rush.json. If custom parameters are associated with this command, their
+ * values will be appended to the end of this string.
+ */
+ // "shellCommand": "node common/scripts/my-bulk-command.js",
+
/**
* (Required) If true, then this command is safe to be run in parallel, i.e. executed
* simultaneously for multiple projects. Similar to "rush build", regardless of parallelism
diff --git a/libraries/rush-lib/assets/rush-init/common/config/rush/experiments.json b/libraries/rush-lib/assets/rush-init/common/config/rush/experiments.json
index 29539c4876b..151718a75fd 100644
--- a/libraries/rush-lib/assets/rush-init/common/config/rush/experiments.json
+++ b/libraries/rush-lib/assets/rush-init/common/config/rush/experiments.json
@@ -46,5 +46,10 @@
* If true, perform a clean install after when running `rush install` or `rush update` if the
* `.npmrc` file has changed since the last install.
*/
- /*[LINE "HYPOTHETICAL"]*/ "cleanInstallAfterNpmrcChanges": true
+ /*[LINE "HYPOTHETICAL"]*/ "cleanInstallAfterNpmrcChanges": true,
+
+ /**
+ * If true, print the outputs of shell commands defined in event hooks to the console.
+ */
+ /*[LINE "HYPOTHETICAL"]*/ "printEventHooksOutputToConsole": true
}
diff --git a/libraries/rush-lib/assets/rush-init/rush.json b/libraries/rush-lib/assets/rush-init/rush.json
index 9842c4bd120..12012e5c9f5 100644
--- a/libraries/rush-lib/assets/rush-init/rush.json
+++ b/libraries/rush-lib/assets/rush-init/rush.json
@@ -42,7 +42,7 @@
* LTS schedule: https://nodejs.org/en/about/releases/
* LTS versions: https://nodejs.org/en/download/releases/
*/
- "nodeSupportedVersionRange": ">=12.13.0 <13.0.0 || >=14.15.0 <15.0.0 || >=16.13.0 <17.0.0",
+ "nodeSupportedVersionRange": ">=14.15.0 <15.0.0 || >=16.13.0 <17.0.0 || >=18.15.0 <19.0.0",
/**
* If the version check above fails, Rush will display a message showing the current
diff --git a/libraries/rush-lib/package.json b/libraries/rush-lib/package.json
index c27e1f3309f..69bf3615371 100644
--- a/libraries/rush-lib/package.json
+++ b/libraries/rush-lib/package.json
@@ -1,6 +1,6 @@
{
"name": "@microsoft/rush-lib",
- "version": "5.88.0",
+ "version": "5.95.0",
"description": "A library for writing scripts that interact with the Rush tool",
"repository": {
"type": "git",
@@ -30,11 +30,12 @@
"@rushstack/stream-collator": "workspace:*",
"@rushstack/terminal": "workspace:*",
"@rushstack/ts-command-line": "workspace:*",
- "@types/node-fetch": "1.6.9",
+ "@types/node-fetch": "2.6.2",
"@yarnpkg/lockfile": "~1.0.2",
"builtin-modules": "~3.1.0",
"cli-table": "~0.3.1",
"colors": "~1.2.1",
+ "dependency-path": "~9.2.8",
"figures": "3.0.0",
"git-repo-info": "~2.1.0",
"glob-escape": "~0.0.2",
@@ -72,7 +73,7 @@
"@types/inquirer": "7.3.1",
"@types/js-yaml": "3.12.1",
"@types/lodash": "4.14.116",
- "@types/node": "12.20.24",
+ "@types/node": "14.18.36",
"@types/npm-package-arg": "6.1.0",
"@types/npm-packlist": "~1.1.1",
"@types/read-package-tree": "5.1.0",
@@ -81,11 +82,17 @@
"@types/ssri": "~7.1.0",
"@types/strict-uri-encode": "2.0.0",
"@types/tar": "6.1.1",
- "@types/webpack-env": "1.13.0",
- "webpack": "~5.68.0"
+ "@types/webpack-env": "1.18.0",
+ "webpack": "~5.75.0"
},
"publishOnlyDependencies": {
"@rushstack/rush-amazon-s3-build-cache-plugin": "workspace:*",
"@rushstack/rush-azure-storage-build-cache-plugin": "workspace:*"
- }
+ },
+ "sideEffects": [
+ "lib-esnext/start-pnpm.js",
+ "lib-esnext/start.js",
+ "lib-esnext/startx.js",
+ "lib-esnext/utilities/SetRushLibPath.js"
+ ]
}
diff --git a/libraries/rush-lib/src/api/CommandLineConfiguration.ts b/libraries/rush-lib/src/api/CommandLineConfiguration.ts
index e05587797cd..b8366ba0da6 100644
--- a/libraries/rush-lib/src/api/CommandLineConfiguration.ts
+++ b/libraries/rush-lib/src/api/CommandLineConfiguration.ts
@@ -36,7 +36,7 @@ export interface IPhase {
name: string;
/**
- * If set to "true," this this phase was generated from a bulk command, and
+ * If set to `true,` this this phase was generated from a bulk command, and
* was not explicitly defined in the command-line.json file.
*/
isSynthetic: boolean;
@@ -44,7 +44,7 @@ export interface IPhase {
/**
* This property is used in the name of the filename for the logs generated by this
* phase. This is a filesystem-safe version of the phase name. For example,
- * a phase with name "_phase:compile" has a `logFilenameIdentifier` of "_phase_compile".
+ * a phase with name `_phase:compile` has a `logFilenameIdentifier` of `_phase_compile`.
*/
logFilenameIdentifier: string;
@@ -62,14 +62,26 @@ export interface IPhase {
};
/**
- * Normally Rush requires that each project's package.json has a \"scripts\" entry matching the phase name. To disable this check, set \"ignoreMissingScript\" to true.
+ * Normally Rush requires that each project's package.json has a `"scripts"` entry matching the phase name.
+ * To disable this check, set `ignoreMissingScript` to true.
*/
ignoreMissingScript: boolean;
/**
- * By default, Rush returns a nonzero exit code if errors or warnings occur during a command. If this option is set to \"true\", Rush will return a zero exit code if warnings occur during the execution of this phase.
+ * By default, Rush returns a nonzero exit code if errors or warnings occur during a command. If this option is
+ * set to `true`, Rush will return a zero exit code if warnings occur during the execution of this phase.
*/
allowWarningsOnSuccess: boolean;
+
+ /**
+ * (Optional) If the `shellCommand` field is set for a bulk command, Rush will invoke it for each
+ * selected project; otherwise, Rush will invoke the package.json `"scripts"` entry matching Rush command/phase name.
+ *
+ * This string is the path to a script that will be invoked using the OS shell. The working directory will be
+ * the folder that contains rush.json. If custom parameters are associated with this command, their
+ * values will be appended to the end of this string.
+ */
+ shellCommand?: string;
}
export interface ICommandWithParameters {
@@ -84,6 +96,10 @@ export interface IPhasedCommandConfig extends IPhasedCommandWithoutPhasesJson, I
isSynthetic: boolean;
disableBuildCache?: boolean;
+ originalPhases: Set;
+ /**
+ * Include upstream and self phases.
+ */
phases: Set;
/**
@@ -285,6 +301,7 @@ export class CommandLineConfiguration {
const commandsJson: ICommandLineJson['commands'] = commandLineJson?.commands;
let buildCommandPhases: IPhasedCommandConfig['phases'] | undefined;
+ let buildCommandOriginalPhases: IPhasedCommandConfig['phases'] | undefined;
if (commandsJson) {
for (const command of commandsJson) {
if (this.commands.has(command.name)) {
@@ -297,6 +314,7 @@ export class CommandLineConfiguration {
let normalizedCommand: Command;
switch (command.commandKind) {
case RushConstants.phasedCommandKind: {
+ const originalPhases: Set = new Set();
const commandPhases: Set = new Set();
const watchPhases: Set = new Set();
@@ -304,6 +322,7 @@ export class CommandLineConfiguration {
...command,
isSynthetic: false,
associatedParameters: new Set(),
+ originalPhases,
phases: commandPhases,
watchPhases,
alwaysWatch: false,
@@ -319,6 +338,7 @@ export class CommandLineConfiguration {
);
}
+ originalPhases.add(phase);
commandPhases.add(phase);
}
@@ -395,6 +415,7 @@ export class CommandLineConfiguration {
} else if (normalizedCommand.name === RushConstants.buildCommandName) {
// Record the build command phases in case we need to construct a synthetic "rebuild" command
buildCommandPhases = normalizedCommand.phases;
+ buildCommandOriginalPhases = normalizedCommand.originalPhases;
}
}
@@ -409,12 +430,13 @@ export class CommandLineConfiguration {
buildCommand = this._translateBulkCommandToPhasedCommand(DEFAULT_BUILD_COMMAND_JSON);
buildCommand.disableBuildCache = DEFAULT_BUILD_COMMAND_JSON.disableBuildCache;
buildCommandPhases = buildCommand.phases;
+ buildCommandOriginalPhases = buildCommand.originalPhases;
this.commands.set(buildCommand.name, buildCommand);
}
if (!this.commands.has(RushConstants.rebuildCommandName)) {
// If a rebuild command was not specified in the config file, add the default rebuild command
- if (!buildCommandPhases) {
+ if (!buildCommandPhases || !buildCommandOriginalPhases) {
throw new Error(`Phases for the "${RushConstants.buildCommandName}" were not found.`);
}
@@ -425,6 +447,7 @@ export class CommandLineConfiguration {
phases: buildCommandPhases,
disableBuildCache: DEFAULT_REBUILD_COMMAND_JSON.disableBuildCache,
associatedParameters: buildCommand.associatedParameters, // rebuild should share build's parameters in this case,
+ originalPhases: buildCommandOriginalPhases,
watchPhases: new Set(),
alwaysWatch: false,
alwaysInstall: undefined
@@ -658,7 +681,8 @@ export class CommandLineConfiguration {
upstream: new Set()
},
ignoreMissingScript: !!command.ignoreMissingScript,
- allowWarningsOnSuccess: !!command.allowWarningsInSuccessfulBuild
+ allowWarningsOnSuccess: !!command.allowWarningsInSuccessfulBuild,
+ shellCommand: command.shellCommand
};
if (!command.ignoreDependencyOrder) {
@@ -676,6 +700,7 @@ export class CommandLineConfiguration {
isSynthetic: true,
associatedParameters: new Set(),
phases,
+ originalPhases: phases,
// Bulk commands used the same phases for watch as for regular execution. Preserve behavior.
watchPhases: command.watchForChanges ? phases : new Set(),
alwaysWatch: !!command.watchForChanges,
diff --git a/libraries/rush-lib/src/api/CommandLineJson.ts b/libraries/rush-lib/src/api/CommandLineJson.ts
index 3d140c9473f..c9abe5468b2 100644
--- a/libraries/rush-lib/src/api/CommandLineJson.ts
+++ b/libraries/rush-lib/src/api/CommandLineJson.ts
@@ -14,6 +14,7 @@ export interface IBaseCommandJson {
description?: string;
safeForSimultaneousRushProcesses: boolean;
autoinstallerName?: string;
+ shellCommand?: string;
}
/**
diff --git a/libraries/rush-lib/src/api/EnvironmentConfiguration.ts b/libraries/rush-lib/src/api/EnvironmentConfiguration.ts
index 3bd511504b7..99b34ff369b 100644
--- a/libraries/rush-lib/src/api/EnvironmentConfiguration.ts
+++ b/libraries/rush-lib/src/api/EnvironmentConfiguration.ts
@@ -153,6 +153,12 @@ export enum EnvironmentVariableNames {
*/
RUSH_TAR_BINARY_PATH = 'RUSH_TAR_BINARY_PATH',
+ /**
+ * Internal variable that explicitly specifies the path for the version of `@microsoft/rush-lib` being executed.
+ * Will be set upon loading Rush.
+ */
+ RUSH_LIB_PATH = '_RUSH_LIB_PATH',
+
/**
* When Rush executes shell scripts, it sometimes changes the working directory to be a project folder or
* the repository root folder. The original working directory (where the Rush command was invoked) is assigned
@@ -441,6 +447,7 @@ export class EnvironmentConfiguration {
break;
case EnvironmentVariableNames.RUSH_INVOKED_FOLDER:
+ case EnvironmentVariableNames.RUSH_LIB_PATH:
// Assigned by Rush itself
break;
diff --git a/libraries/rush-lib/src/api/ExperimentsConfiguration.ts b/libraries/rush-lib/src/api/ExperimentsConfiguration.ts
index 17fddb8d731..b428d50d1f3 100644
--- a/libraries/rush-lib/src/api/ExperimentsConfiguration.ts
+++ b/libraries/rush-lib/src/api/ExperimentsConfiguration.ts
@@ -53,6 +53,11 @@ export interface IExperimentsJson {
* `.npmrc` file has changed since the last install.
*/
cleanInstallAfterNpmrcChanges?: boolean;
+
+ /**
+ * If true, print the outputs of shell commands defined in event hooks to the console.
+ */
+ printEventHooksOutputToConsole?: boolean;
}
/**
diff --git a/libraries/rush-lib/src/api/PackageJsonEditor.ts b/libraries/rush-lib/src/api/PackageJsonEditor.ts
index a417d09b1ab..7a153ce6299 100644
--- a/libraries/rush-lib/src/api/PackageJsonEditor.ts
+++ b/libraries/rush-lib/src/api/PackageJsonEditor.ts
@@ -66,7 +66,10 @@ export class PackageJsonEditor {
public readonly filePath: string;
- private constructor(filepath: string, data: IPackageJson) {
+ /**
+ * @internal
+ */
+ protected constructor(filepath: string, data: IPackageJson) {
this.filePath = filepath;
this._sourceData = data;
this._modified = false;
diff --git a/libraries/rush-lib/src/api/Rush.ts b/libraries/rush-lib/src/api/Rush.ts
index 9f1b6ef6b5c..3fcdc1cd221 100644
--- a/libraries/rush-lib/src/api/Rush.ts
+++ b/libraries/rush-lib/src/api/Rush.ts
@@ -1,7 +1,16 @@
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
// See LICENSE in the project root for license information.
-import { IPackageJson, ITerminalProvider, PackageJsonLookup } from '@rushstack/node-core-library';
+import * as path from 'path';
+
+import {
+ InternalError,
+ IPackageJson,
+ ITerminalProvider,
+ PackageJsonLookup
+} from '@rushstack/node-core-library';
+
+import '../utilities/SetRushLibPath';
import { RushCommandLineParser } from '../cli/RushCommandLineParser';
import { RushStartupBanner } from '../cli/RushStartupBanner';
@@ -50,6 +59,7 @@ export interface ILaunchOptions {
*/
export class Rush {
private static __rushLibPackageJson: IPackageJson | undefined = undefined;
+ private static __rushLibPackageFolder: string | undefined = undefined;
/**
* This API is used by the `@microsoft/rush` front end to launch the "rush" command-line.
@@ -117,11 +127,25 @@ export class Rush {
* @internal
*/
public static get _rushLibPackageJson(): IPackageJson {
+ Rush._ensureOwnPackageJsonIsLoaded();
+ return Rush.__rushLibPackageJson!;
+ }
+
+ public static get _rushLibPackageFolder(): string {
+ Rush._ensureOwnPackageJsonIsLoaded();
+ return Rush.__rushLibPackageFolder!;
+ }
+
+ private static _ensureOwnPackageJsonIsLoaded(): void {
if (!Rush.__rushLibPackageJson) {
- Rush.__rushLibPackageJson = PackageJsonLookup.loadOwnPackageJson(__dirname);
+ const packageJsonFilePath: string | undefined =
+ PackageJsonLookup.instance.tryGetPackageJsonFilePathFor(__dirname);
+ if (!packageJsonFilePath) {
+ throw new InternalError('Unable to locate the package.json file for this module');
+ }
+ Rush.__rushLibPackageFolder = path.dirname(packageJsonFilePath);
+ Rush.__rushLibPackageJson = PackageJsonLookup.instance.loadPackageJson(packageJsonFilePath);
}
-
- return Rush.__rushLibPackageJson;
}
/**
diff --git a/libraries/rush-lib/src/api/RushConfigurationProject.ts b/libraries/rush-lib/src/api/RushConfigurationProject.ts
index b29f600178a..7af194badd2 100644
--- a/libraries/rush-lib/src/api/RushConfigurationProject.ts
+++ b/libraries/rush-lib/src/api/RushConfigurationProject.ts
@@ -7,10 +7,11 @@ import { JsonFile, IPackageJson, FileSystem, FileConstants, JsonSyntax } from '@
import { RushConfiguration } from '../api/RushConfiguration';
import { VersionPolicy, LockStepVersionPolicy } from './VersionPolicy';
-import { PackageJsonEditor } from './PackageJsonEditor';
+import type { PackageJsonEditor } from './PackageJsonEditor';
import { RushConstants } from '../logic/RushConstants';
import { PackageNameParsers } from './PackageNameParsers';
import { DependencySpecifier, DependencySpecifierType } from '../logic/DependencySpecifier';
+import { SaveCallbackPackageJsonEditor } from './SaveCallbackPackageJsonEditor';
/**
* This represents the JSON data object for a project entry in the rush.json configuration file.
@@ -61,6 +62,7 @@ export class RushConfigurationProject {
private _versionPolicy: VersionPolicy | undefined = undefined;
private _dependencyProjects: Set | undefined = undefined;
private _consumingProjects: Set | undefined = undefined;
+ private _packageJson: IPackageJson;
/**
* The name of the NPM package. An error is reported if this name is not
@@ -121,7 +123,9 @@ export class RushConfigurationProject {
/**
* The parsed NPM "package.json" file from projectFolder.
*/
- public readonly packageJson: IPackageJson;
+ public get packageJson(): IPackageJson {
+ return this._packageJson;
+ }
/**
* A useful wrapper around the package.json file for making modifications
@@ -208,7 +212,7 @@ export class RushConfigurationProject {
const packageJsonFilename: string = path.join(this.projectFolder, FileConstants.PackageJson);
try {
- this.packageJson = JsonFile.load(packageJsonFilename, { jsonSyntax: JsonSyntax.Strict });
+ this._packageJson = JsonFile.load(packageJsonFilename, { jsonSyntax: JsonSyntax.Strict });
} catch (error) {
if (FileSystem.isNotExistError(error as Error)) {
throw new Error(
@@ -258,7 +262,15 @@ export class RushConfigurationProject {
);
}
- this.packageJsonEditor = PackageJsonEditor.fromObject(this.packageJson, packageJsonFilename);
+ this.packageJsonEditor = SaveCallbackPackageJsonEditor.fromObjectWithCallback({
+ object: this.packageJson,
+ filename: packageJsonFilename,
+ onSaved: (newObject) => {
+ // Just update the in-memory copy, don't bother doing the validation again
+ this._packageJson = newObject;
+ this._dependencyProjects = undefined; // Reset the cached dependency projects
+ }
+ });
this.tempProjectName = tempProjectName;
diff --git a/libraries/rush-lib/src/api/RushInternals.ts b/libraries/rush-lib/src/api/RushInternals.ts
new file mode 100644
index 00000000000..6abf2e7122e
--- /dev/null
+++ b/libraries/rush-lib/src/api/RushInternals.ts
@@ -0,0 +1,28 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+import { Rush } from './Rush';
+
+/**
+ * Used by rush-sdk to access internals of rush-lib.
+ * @internal
+ */
+export class RushInternals {
+ /**
+ * Used by rush-sdk to load an internal API specified by its module path.
+ *
+ * @param srcImportPath - The module path to load. For example, to refer to `src/api/ChangeFile.ts`,
+ * the `srcImportPath` would be `"api/ChangeFile"`.
+ * @returns the module object as would be returned by `require()`
+ */
+ public static loadModule(srcImportPath: string): unknown {
+ const libPath: string = `${Rush._rushLibPackageFolder}/lib/${srcImportPath}`;
+ try {
+ return require(libPath);
+ } catch (e) {
+ throw new Error(
+ `The specified internal API "src/${srcImportPath}" is not implemented by Rush ${Rush.version}`
+ );
+ }
+ }
+}
diff --git a/libraries/rush-lib/src/api/RushProjectConfiguration.ts b/libraries/rush-lib/src/api/RushProjectConfiguration.ts
index bb5aa5b432f..0245b8c53a9 100644
--- a/libraries/rush-lib/src/api/RushProjectConfiguration.ts
+++ b/libraries/rush-lib/src/api/RushProjectConfiguration.ts
@@ -76,6 +76,17 @@ export interface IOperationSettings {
* you list them here.
*/
dependsOnEnvVars?: string[];
+
+ /**
+ * An optional list of glob (minimatch) patterns pointing to files that can affect this operation.
+ * The hash values of the contents of these files will become part of the final hash when reading
+ * and writing the build cache.
+ *
+ * Note: if a particular file will be matched by patterns provided by both `incrementalBuildIgnoredGlobs` and
+ * `dependsOnAdditionalFiles` options - `dependsOnAdditionalFiles` will win and the file will be included
+ * calculating final hash value when reading and writing the build cache
+ */
+ dependsOnAdditionalFiles?: string[];
}
interface IOldRushProjectJson {
diff --git a/libraries/rush-lib/src/api/SaveCallbackPackageJsonEditor.ts b/libraries/rush-lib/src/api/SaveCallbackPackageJsonEditor.ts
new file mode 100644
index 00000000000..3543310304d
--- /dev/null
+++ b/libraries/rush-lib/src/api/SaveCallbackPackageJsonEditor.ts
@@ -0,0 +1,34 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+import { IPackageJson } from '@rushstack/node-core-library';
+import { PackageJsonEditor } from './PackageJsonEditor';
+
+export interface IFromObjectOptions {
+ object: IPackageJson;
+ filename: string;
+ onSaved?: (newObject: IPackageJson) => void;
+}
+
+export class SaveCallbackPackageJsonEditor extends PackageJsonEditor {
+ private readonly _onSaved: ((newObject: IPackageJson) => void) | undefined;
+
+ private constructor(options: IFromObjectOptions) {
+ super(options.filename, options.object);
+
+ this._onSaved = options.onSaved;
+ }
+
+ public static fromObjectWithCallback(options: IFromObjectOptions): SaveCallbackPackageJsonEditor {
+ return new SaveCallbackPackageJsonEditor(options);
+ }
+
+ public saveIfModified(): boolean {
+ const modified: boolean = super.saveIfModified();
+ if (this._onSaved) {
+ this._onSaved(this.saveToObject());
+ }
+
+ return modified;
+ }
+}
diff --git a/libraries/rush-lib/src/api/test/CommandLineConfiguration.test.ts b/libraries/rush-lib/src/api/test/CommandLineConfiguration.test.ts
index ea069525820..7bb8fe2d795 100644
--- a/libraries/rush-lib/src/api/test/CommandLineConfiguration.test.ts
+++ b/libraries/rush-lib/src/api/test/CommandLineConfiguration.test.ts
@@ -2,7 +2,13 @@
// See LICENSE in the project root for license information.
import { RushConstants } from '../../logic/RushConstants';
-import { Command, CommandLineConfiguration, IParameterJson, IPhase } from '../CommandLineConfiguration';
+import {
+ IPhasedCommandConfig,
+ CommandLineConfiguration,
+ IParameterJson,
+ IPhase,
+ Command
+} from '../CommandLineConfiguration';
describe(CommandLineConfiguration.name, () => {
it('Forbids a misnamed phase', () => {
@@ -262,4 +268,30 @@ describe(CommandLineConfiguration.name, () => {
expect(phaseParametersArray).toHaveLength(0);
});
});
+
+ describe('shellCommand in bulk command', () => {
+ it('get "custom-shell-command-echo" command', () => {
+ const commandLineConfiguration: CommandLineConfiguration = new CommandLineConfiguration({
+ commands: [
+ {
+ commandKind: 'bulk',
+ name: 'custom-shell-command-echo',
+ summary: 'custom define bulk shellCommand echo',
+ enableParallelism: true,
+ safeForSimultaneousRushProcesses: false,
+ shellCommand: 'echo'
+ }
+ ]
+ });
+
+ const command: IPhasedCommandConfig | undefined = commandLineConfiguration.commands.get(
+ 'custom-shell-command-echo'
+ ) as IPhasedCommandConfig;
+ expect(command).toBeDefined();
+ expect(command?.phases).toBeDefined();
+ const phase = [...command?.phases][0];
+ expect(phase.name).toEqual('custom-shell-command-echo');
+ expect(phase.shellCommand).toEqual('echo');
+ });
+ });
});
diff --git a/libraries/rush-lib/src/api/test/RushConfiguration.test.ts b/libraries/rush-lib/src/api/test/RushConfiguration.test.ts
index 47117397031..893b0c30508 100644
--- a/libraries/rush-lib/src/api/test/RushConfiguration.test.ts
+++ b/libraries/rush-lib/src/api/test/RushConfiguration.test.ts
@@ -3,12 +3,13 @@
import * as path from 'path';
-import { Path, Text } from '@rushstack/node-core-library';
+import { JsonFile, Path, Text } from '@rushstack/node-core-library';
import { RushConfiguration } from '../RushConfiguration';
import { ApprovedPackagesPolicy } from '../ApprovedPackagesPolicy';
import { RushConfigurationProject } from '../RushConfigurationProject';
import { Utilities } from '../../utilities/Utilities';
import { EnvironmentConfiguration } from '../EnvironmentConfiguration';
+import { DependencyType } from '../PackageJsonEditor';
function normalizePathForComparison(pathToNormalize: string): string {
return Text.replaceAll(pathToNormalize, '\\', '/').toUpperCase();
@@ -32,6 +33,7 @@ describe(RushConfiguration.name, () => {
afterEach(() => {
process.env = _oldEnv;
+ jest.resetAllMocks();
});
it("can't load too new rush", () => {
@@ -315,4 +317,29 @@ describe(RushConfiguration.name, () => {
'Because the new config file "common/config/rush/pnpm-config.json" is being used, you must remove the old setting "pnpmOptions" from rush.json'
);
});
+
+ describe(RushConfigurationProject.name, () => {
+ it('correctly updates the packageJson property after the packageJson is edited by packageJsonEditor', async () => {
+ const rushConfiguration: RushConfiguration = RushConfiguration.loadFromConfigurationFile(
+ `${__dirname}/repo/rush-pnpm.json`
+ );
+ jest.spyOn(JsonFile, 'save').mockImplementation(() => {
+ /* no-op*/
+ return true;
+ });
+
+ const project: RushConfigurationProject = rushConfiguration.getProjectByName('project1')!;
+
+ expect(project.packageJson.devDependencies).toMatchSnapshot('devDependencies before');
+ expect(Array.from(project.dependencyProjects.values()).map((x) => x.packageName)).toMatchSnapshot(
+ 'dependencyProjects before'
+ );
+ project.packageJsonEditor.addOrUpdateDependency('project2', '1.0.0', DependencyType.Dev);
+ project.packageJsonEditor.saveIfModified();
+ expect(project.packageJson.devDependencies).toMatchSnapshot('devDependencies after');
+ expect(Array.from(project.dependencyProjects.values()).map((x) => x.packageName)).toMatchSnapshot(
+ 'dependencyProjects after'
+ );
+ });
+ });
});
diff --git a/libraries/rush-lib/src/api/test/__snapshots__/RushConfiguration.test.ts.snap b/libraries/rush-lib/src/api/test/__snapshots__/RushConfiguration.test.ts.snap
index 716b1019de1..79352d781bb 100644
--- a/libraries/rush-lib/src/api/test/__snapshots__/RushConfiguration.test.ts.snap
+++ b/libraries/rush-lib/src/api/test/__snapshots__/RushConfiguration.test.ts.snap
@@ -1,3 +1,19 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP
+exports[`RushConfiguration RushConfigurationProject correctly updates the packageJson property after the packageJson is edited by packageJsonEditor: dependencyProjects after 1`] = `
+Array [
+ "project2",
+]
+`;
+
+exports[`RushConfiguration RushConfigurationProject correctly updates the packageJson property after the packageJson is edited by packageJsonEditor: dependencyProjects before 1`] = `Array []`;
+
+exports[`RushConfiguration RushConfigurationProject correctly updates the packageJson property after the packageJson is edited by packageJsonEditor: devDependencies after 1`] = `
+Object {
+ "project2": "1.0.0",
+}
+`;
+
+exports[`RushConfiguration RushConfigurationProject correctly updates the packageJson property after the packageJson is edited by packageJsonEditor: devDependencies before 1`] = `undefined`;
+
exports[`RushConfiguration fails to load repo/rush-repository-url-urls.json 1`] = `"The 'repository.url' field cannot be used when 'repository.urls' is present"`;
diff --git a/libraries/rush-lib/src/cli/RushCommandLineParser.ts b/libraries/rush-lib/src/cli/RushCommandLineParser.ts
index 2f027d1f09e..3f483e054f1 100644
--- a/libraries/rush-lib/src/cli/RushCommandLineParser.ts
+++ b/libraries/rush-lib/src/cli/RushCommandLineParser.ts
@@ -66,7 +66,7 @@ export interface IRushCommandLineParserOptions {
export class RushCommandLineParser extends CommandLineParser {
public telemetry: Telemetry | undefined;
- public rushGlobalFolder!: RushGlobalFolder;
+ public rushGlobalFolder: RushGlobalFolder;
public readonly rushConfiguration!: RushConfiguration;
public readonly rushSession: RushSession;
public readonly pluginManager: PluginManager;
@@ -127,6 +127,8 @@ export class RushCommandLineParser extends CommandLineParser {
rushConfiguration: this.rushConfiguration
});
+ this.rushGlobalFolder = new RushGlobalFolder();
+
this.rushSession = new RushSession({
getIsDebugMode: () => this.isDebug,
terminalProvider: this._terminalProvider
@@ -136,7 +138,8 @@ export class RushCommandLineParser extends CommandLineParser {
rushConfiguration: this.rushConfiguration,
terminal: this._terminal,
builtInPluginConfigurations: this._rushOptions.builtInPluginConfigurations,
- restrictConsoleOutput: this._restrictConsoleOutput
+ restrictConsoleOutput: this._restrictConsoleOutput,
+ rushGlobalFolder: this.rushGlobalFolder
});
this._populateActions();
@@ -238,8 +241,6 @@ export class RushCommandLineParser extends CommandLineParser {
private _populateActions(): void {
try {
- this.rushGlobalFolder = new RushGlobalFolder();
-
// Alphabetical order
this.addAction(new AddAction(this));
this.addAction(new ChangeAction(this));
@@ -394,6 +395,7 @@ export class RushCommandLineParser extends CommandLineParser {
disableBuildCache: command.disableBuildCache || false,
initialPhases: command.phases,
+ originalPhases: command.originalPhases,
watchPhases: command.watchPhases,
watchDebounceMs: command.watchDebounceMs ?? RushConstants.defaultWatchDebounceMs,
phases: commandLineConfiguration.phases,
diff --git a/libraries/rush-lib/src/cli/actions/InitAutoinstallerAction.ts b/libraries/rush-lib/src/cli/actions/InitAutoinstallerAction.ts
index 76e2ee4edc2..83a30f7996d 100644
--- a/libraries/rush-lib/src/cli/actions/InitAutoinstallerAction.ts
+++ b/libraries/rush-lib/src/cli/actions/InitAutoinstallerAction.ts
@@ -38,7 +38,8 @@ export class InitAutoinstallerAction extends BaseRushAction {
const autoinstaller: Autoinstaller = new Autoinstaller({
autoinstallerName,
- rushConfiguration: this.rushConfiguration
+ rushConfiguration: this.rushConfiguration,
+ rushGlobalFolder: this.rushGlobalFolder
});
if (FileSystem.exists(autoinstaller.folderFullPath)) {
diff --git a/libraries/rush-lib/src/cli/actions/UpdateAutoinstallerAction.ts b/libraries/rush-lib/src/cli/actions/UpdateAutoinstallerAction.ts
index d6d836898f4..54aa48dab80 100644
--- a/libraries/rush-lib/src/cli/actions/UpdateAutoinstallerAction.ts
+++ b/libraries/rush-lib/src/cli/actions/UpdateAutoinstallerAction.ts
@@ -32,9 +32,15 @@ export class UpdateAutoinstallerAction extends BaseRushAction {
const autoinstaller: Autoinstaller = new Autoinstaller({
autoinstallerName,
- rushConfiguration: this.rushConfiguration
+ rushConfiguration: this.rushConfiguration,
+ rushGlobalFolder: this.rushGlobalFolder
});
- autoinstaller.update();
+
+ // Do not run `autoinstaller.prepareAsync` here. It tries to install the autoinstaller with
+ // --frozen-lockfile or equivalent, which will fail if the autoinstaller's dependencies
+ // have been changed.
+
+ await autoinstaller.updateAsync();
console.log('\nSuccess.');
}
diff --git a/libraries/rush-lib/src/cli/scriptActions/GlobalScriptAction.ts b/libraries/rush-lib/src/cli/scriptActions/GlobalScriptAction.ts
index f5b033601e0..e2d0f393851 100644
--- a/libraries/rush-lib/src/cli/scriptActions/GlobalScriptAction.ts
+++ b/libraries/rush-lib/src/cli/scriptActions/GlobalScriptAction.ts
@@ -88,7 +88,8 @@ export class GlobalScriptAction extends BaseScriptAction {
private async _prepareAutoinstallerName(): Promise {
const autoInstaller: Autoinstaller = new Autoinstaller({
autoinstallerName: this._autoinstallerName,
- rushConfiguration: this.rushConfiguration
+ rushConfiguration: this.rushConfiguration,
+ rushGlobalFolder: this.rushGlobalFolder
});
await autoInstaller.prepareAsync();
diff --git a/libraries/rush-lib/src/cli/scriptActions/PhasedScriptAction.ts b/libraries/rush-lib/src/cli/scriptActions/PhasedScriptAction.ts
index 7e56d27454d..7b29b4f8326 100644
--- a/libraries/rush-lib/src/cli/scriptActions/PhasedScriptAction.ts
+++ b/libraries/rush-lib/src/cli/scriptActions/PhasedScriptAction.ts
@@ -28,6 +28,7 @@ import { BuildCacheConfiguration } from '../../api/BuildCacheConfiguration';
import { SelectionParameterSet } from '../parsing/SelectionParameterSet';
import type { IPhase, IPhasedCommandConfig } from '../../api/CommandLineConfiguration';
import { Operation } from '../../logic/operations/Operation';
+import { OperationExecutionRecord } from '../../logic/operations/OperationExecutionRecord';
import { PhasedOperationPlugin } from '../../logic/operations/PhasedOperationPlugin';
import { ShellOperationRunnerPlugin } from '../../logic/operations/ShellOperationRunnerPlugin';
import { Event } from '../../api/EventHooks';
@@ -46,6 +47,7 @@ export interface IPhasedScriptActionOptions extends IBaseScriptActionOptions;
initialPhases: Set;
watchPhases: Set;
phases: Map;
@@ -102,6 +104,7 @@ export class PhasedScriptAction extends BaseScriptAction {
private readonly _enableParallelism: boolean;
private readonly _isIncrementalBuildAllowed: boolean;
private readonly _disableBuildCache: boolean;
+ private readonly _originalPhases: ReadonlySet;
private readonly _initialPhases: ReadonlySet;
private readonly _watchPhases: ReadonlySet;
private readonly _watchDebounceMs: number;
@@ -124,6 +127,7 @@ export class PhasedScriptAction extends BaseScriptAction {
this._enableParallelism = options.enableParallelism;
this._isIncrementalBuildAllowed = options.incremental;
this._disableBuildCache = options.disableBuildCache;
+ this._originalPhases = options.originalPhases;
this._initialPhases = options.initialPhases;
this._watchPhases = options.watchPhases;
this._watchDebounceMs = options.watchDebounceMs ?? RushConstants.defaultWatchDebounceMs;
@@ -330,6 +334,7 @@ export class PhasedScriptAction extends BaseScriptAction {
isInitial: true,
isWatch,
rushConfiguration: this.rushConfiguration,
+ phaseOriginal: new Set(this._originalPhases),
phaseSelection: new Set(this._initialPhases),
projectChangeAnalyzer,
projectSelection,
@@ -340,7 +345,13 @@ export class PhasedScriptAction extends BaseScriptAction {
quietMode: isQuietMode,
debugMode: this.parser.isDebug,
parallelism,
- changedProjectsOnly
+ changedProjectsOnly,
+ beforeExecuteOperations: async (records: Map) => {
+ await this.hooks.beforeExecuteOperations.promise(records);
+ },
+ onOperationStatusChanged: (record: OperationExecutionRecord) => {
+ this.hooks.onOperationStatusChanged.call(record);
+ }
};
const internalOptions: IRunPhasesOptions = {
@@ -353,7 +364,7 @@ export class PhasedScriptAction extends BaseScriptAction {
terminal.write('Analyzing repo state... ');
const repoStateStopwatch: Stopwatch = new Stopwatch();
repoStateStopwatch.start();
- projectChangeAnalyzer._ensureInitialized(terminal);
+ await projectChangeAnalyzer._ensureInitializedAsync(terminal);
repoStateStopwatch.stop();
terminal.writeLine(`DONE (${repoStateStopwatch.toString()})`);
terminal.writeLine();
@@ -400,6 +411,7 @@ export class PhasedScriptAction extends BaseScriptAction {
private async _runWatchPhases(options: IRunPhasesOptions): Promise {
const { initialCreateOperationsContext, executionManagerOptions, stopwatch, terminal } = options;
+ const phaseOriginal: Set = new Set(this._watchPhases);
const phaseSelection: Set = new Set(this._watchPhases);
const { projectChangeAnalyzer: initialState, projectSelection: projectsToWatch } =
@@ -457,6 +469,7 @@ export class PhasedScriptAction extends BaseScriptAction {
isInitial: false,
projectChangeAnalyzer: state,
projectsInUnknownState: changedProjects,
+ phaseOriginal,
phaseSelection
};
diff --git a/libraries/rush-lib/src/cli/test/RushCommandLineParser.test.ts b/libraries/rush-lib/src/cli/test/RushCommandLineParser.test.ts
index a458406ef6e..2ca62a05d0a 100644
--- a/libraries/rush-lib/src/cli/test/RushCommandLineParser.test.ts
+++ b/libraries/rush-lib/src/cli/test/RushCommandLineParser.test.ts
@@ -1,11 +1,25 @@
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
// See LICENSE in the project root for license information.
+jest.mock(`@rushstack/package-deps-hash`, () => {
+ return {
+ getRepoRoot(dir: string): string {
+ return dir;
+ },
+ getRepoStateAsync(): ReadonlyMap {
+ return new Map();
+ },
+ getRepoChangesAsync(): ReadonlyMap {
+ return new Map();
+ }
+ };
+});
+
import './mockRushCommandLineParser';
import * as path from 'path';
import { FileSystem, JsonFile, Path, PackageJsonLookup } from '@rushstack/node-core-library';
-import { RushCommandLineParser } from '../RushCommandLineParser';
+import type { RushCommandLineParser as RushCommandLineParserType } from '../RushCommandLineParser';
import { LastLinkFlagFactory } from '../../api/LastLinkFlag';
import { Autoinstaller } from '../../logic/Autoinstaller';
import { ITelemetryData } from '../../logic/Telemetry';
@@ -31,7 +45,7 @@ interface IChildProcessModuleMock {
* Interface definition for a test instance for the RushCommandLineParser.
*/
interface IParserTestInstance {
- parser: RushCommandLineParser;
+ parser: RushCommandLineParserType;
spawnMock: jest.Mock;
}
@@ -66,7 +80,10 @@ const __dirnameInLib: string = getDirnameInLib();
/**
* Helper to set up a test instance for RushCommandLineParser.
*/
-function getCommandLineParserInstance(repoName: string, taskName: string): IParserTestInstance {
+async function getCommandLineParserInstanceAsync(
+ repoName: string,
+ taskName: string
+): Promise {
// Run these tests in the /lib folder because some of them require compiled output
// Point to the test repo folder
const startPath: string = `${__dirnameInLib}/${repoName}`;
@@ -76,11 +93,13 @@ function getCommandLineParserInstance(repoName: string, taskName: string): IPars
FileSystem.deleteFolder(`${startPath}/a/.rush/temp`);
FileSystem.deleteFolder(`${startPath}/b/.rush/temp`);
+ const { RushCommandLineParser } = await import('../RushCommandLineParser');
+
// Create a Rush CLI instance. This instance is heavy-weight and relies on setting process.exit
// to exit and clear the Rush file lock. So running multiple `it` or `describe` test blocks over the same test
// repo will fail due to contention over the same lock which is kept until the test runner process
// ends.
- const parser: RushCommandLineParser = new RushCommandLineParser({ cwd: startPath });
+ const parser: RushCommandLineParserType = new RushCommandLineParser({ cwd: startPath });
// Bulk tasks are hard-coded to expect install to have been completed. So, ensure the last-link.flag
// file exists and is valid
@@ -104,8 +123,8 @@ function pathEquals(actual: string, expected: string): void {
const SPAWN_ARG_ARGS: number = 1;
const SPAWN_ARG_OPTIONS: number = 2;
-describe(RushCommandLineParser.name, () => {
- describe(RushCommandLineParser.prototype.execute.name, () => {
+describe('RushCommandLineParser', () => {
+ describe('execute', () => {
afterEach(() => {
jest.clearAllMocks();
});
@@ -114,7 +133,7 @@ describe(RushCommandLineParser.name, () => {
describe("'build' action", () => {
it(`executes the package's 'build' script`, async () => {
const repoName: string = 'basicAndRunBuildActionRepo';
- const instance: IParserTestInstance = getCommandLineParserInstance(repoName, 'build');
+ const instance: IParserTestInstance = await getCommandLineParserInstanceAsync(repoName, 'build');
await expect(instance.parser.execute()).resolves.toEqual(true);
@@ -146,7 +165,7 @@ describe(RushCommandLineParser.name, () => {
describe("'rebuild' action", () => {
it(`executes the package's 'build' script`, async () => {
const repoName: string = 'basicAndRunRebuildActionRepo';
- const instance: IParserTestInstance = getCommandLineParserInstance(repoName, 'rebuild');
+ const instance: IParserTestInstance = await getCommandLineParserInstanceAsync(repoName, 'rebuild');
await expect(instance.parser.execute()).resolves.toEqual(true);
@@ -180,7 +199,7 @@ describe(RushCommandLineParser.name, () => {
describe("'build' action", () => {
it(`executes the package's 'build' script`, async () => {
const repoName: string = 'overrideRebuildAndRunBuildActionRepo';
- const instance: IParserTestInstance = getCommandLineParserInstance(repoName, 'build');
+ const instance: IParserTestInstance = await getCommandLineParserInstanceAsync(repoName, 'build');
await expect(instance.parser.execute()).resolves.toEqual(true);
@@ -212,7 +231,7 @@ describe(RushCommandLineParser.name, () => {
describe("'rebuild' action", () => {
it(`executes the package's 'rebuild' script`, async () => {
const repoName: string = 'overrideRebuildAndRunRebuildActionRepo';
- const instance: IParserTestInstance = getCommandLineParserInstance(repoName, 'rebuild');
+ const instance: IParserTestInstance = await getCommandLineParserInstanceAsync(repoName, 'rebuild');
await expect(instance.parser.execute()).resolves.toEqual(true);
@@ -246,7 +265,7 @@ describe(RushCommandLineParser.name, () => {
describe("'build' action", () => {
it(`executes the package's 'build' script`, async () => {
const repoName: string = 'overrideAndDefaultBuildActionRepo';
- const instance: IParserTestInstance = getCommandLineParserInstance(repoName, 'build');
+ const instance: IParserTestInstance = await getCommandLineParserInstanceAsync(repoName, 'build');
await expect(instance.parser.execute()).resolves.toEqual(true);
// There should be 1 build per package
@@ -278,7 +297,7 @@ describe(RushCommandLineParser.name, () => {
it(`executes the package's 'build' script`, async () => {
// broken
const repoName: string = 'overrideAndDefaultRebuildActionRepo';
- const instance: IParserTestInstance = getCommandLineParserInstance(repoName, 'rebuild');
+ const instance: IParserTestInstance = await getCommandLineParserInstanceAsync(repoName, 'rebuild');
await expect(instance.parser.execute()).resolves.toEqual(true);
// There should be 1 build per package
@@ -311,9 +330,9 @@ describe(RushCommandLineParser.name, () => {
it(`throws an error when starting Rush`, async () => {
const repoName: string = 'overrideBuildAsGlobalCommandRepo';
- await expect(() => {
- getCommandLineParserInstance(repoName, 'doesnt-matter');
- }).toThrowErrorMatchingInlineSnapshot(
+ await expect(async () => {
+ await getCommandLineParserInstanceAsync(repoName, 'doesnt-matter');
+ }).rejects.toThrowErrorMatchingInlineSnapshot(
`"command-line.json defines a command \\"build\\" using the command kind \\"global\\". This command can only be designated as a command kind \\"bulk\\" or \\"phased\\"."`
);
});
@@ -323,9 +342,9 @@ describe(RushCommandLineParser.name, () => {
it(`throws an error when starting Rush`, async () => {
const repoName: string = 'overrideRebuildAsGlobalCommandRepo';
- await expect(() => {
- getCommandLineParserInstance(repoName, 'doesnt-matter');
- }).toThrowErrorMatchingInlineSnapshot(
+ await expect(async () => {
+ await getCommandLineParserInstanceAsync(repoName, 'doesnt-matter');
+ }).rejects.toThrowErrorMatchingInlineSnapshot(
`"command-line.json defines a command \\"rebuild\\" using the command kind \\"global\\". This command can only be designated as a command kind \\"bulk\\" or \\"phased\\"."`
);
});
@@ -335,9 +354,9 @@ describe(RushCommandLineParser.name, () => {
it(`throws an error when starting Rush`, async () => {
const repoName: string = 'overrideBuildWithSimultaneousProcessesRepo';
- await expect(() => {
- getCommandLineParserInstance(repoName, 'doesnt-matter');
- }).toThrowErrorMatchingInlineSnapshot(
+ await expect(async () => {
+ await getCommandLineParserInstanceAsync(repoName, 'doesnt-matter');
+ }).rejects.toThrowErrorMatchingInlineSnapshot(
`"command-line.json defines a command \\"build\\" using \\"safeForSimultaneousRushProcesses=true\\". This configuration is not supported for \\"build\\"."`
);
});
@@ -347,9 +366,9 @@ describe(RushCommandLineParser.name, () => {
it(`throws an error when starting Rush`, async () => {
const repoName: string = 'overrideRebuildWithSimultaneousProcessesRepo';
- await expect(() => {
- getCommandLineParserInstance(repoName, 'doesnt-matter');
- }).toThrowErrorMatchingInlineSnapshot(
+ await expect(async () => {
+ await getCommandLineParserInstanceAsync(repoName, 'doesnt-matter');
+ }).rejects.toThrowErrorMatchingInlineSnapshot(
`"command-line.json defines a command \\"rebuild\\" using \\"safeForSimultaneousRushProcesses=true\\". This configuration is not supported for \\"rebuild\\"."`
);
});
@@ -358,7 +377,7 @@ describe(RushCommandLineParser.name, () => {
describe('in repo plugin custom flushTelemetry', () => {
it('creates a custom telemetry file', async () => {
const repoName: string = 'tapFlushTelemetryAndRunBuildActionRepo';
- const instance: IParserTestInstance = getCommandLineParserInstance(repoName, 'build');
+ const instance: IParserTestInstance = await getCommandLineParserInstanceAsync(repoName, 'build');
const telemetryFilePath: string = `${instance.parser.rushConfiguration.commonTempFolder}/test-telemetry.json`;
FileSystem.deleteFile(telemetryFilePath);
diff --git a/libraries/rush-lib/src/index.ts b/libraries/rush-lib/src/index.ts
index f969c51adb4..d1860e96034 100644
--- a/libraries/rush-lib/src/index.ts
+++ b/libraries/rush-lib/src/index.ts
@@ -63,7 +63,7 @@ export { PackageJsonEditor, PackageJsonDependency, DependencyType } from './api/
export { RepoStateFile } from './logic/RepoStateFile';
-export { LookupByPath } from './logic/LookupByPath';
+export { LookupByPath, IPrefixMatch } from './logic/LookupByPath';
export { EventHooks, Event } from './api/EventHooks';
export { ChangeManager } from './api/ChangeManager';
@@ -84,6 +84,7 @@ export {
export { VersionPolicyConfiguration } from './api/VersionPolicyConfiguration';
export { ILaunchOptions, Rush } from './api/Rush';
+export { RushInternals as _RushInternals } from './api/RushInternals';
export { ExperimentsConfiguration, IExperimentsJson } from './api/ExperimentsConfiguration';
@@ -126,3 +127,8 @@ export {
IOperationStateFileOptions as _IOperationStateFileOptions,
IOperationStateJson as _IOperationStateJson
} from './logic/operations/OperationStateFile';
+export {
+ OperationMetadataManager as _OperationMetadataManager,
+ IOperationMetadataManagerOptions as _IOperationMetadataManagerOptions,
+ IOperationMetaData as _IOperationMetadata
+} from './logic/operations/OperationMetadataManager';
diff --git a/libraries/rush-lib/src/logic/Autoinstaller.ts b/libraries/rush-lib/src/logic/Autoinstaller.ts
index ec3d869bc5d..879bee9fcf8 100644
--- a/libraries/rush-lib/src/logic/Autoinstaller.ts
+++ b/libraries/rush-lib/src/logic/Autoinstaller.ts
@@ -11,7 +11,7 @@ import { PackageName, IParsedPackageNameOrError } from '@rushstack/node-core-lib
import { RushConfiguration } from '../api/RushConfiguration';
import { PackageJsonEditor } from '../api/PackageJsonEditor';
import { InstallHelpers } from './installManager/InstallHelpers';
-import { RushGlobalFolder } from '../api/RushGlobalFolder';
+import type { RushGlobalFolder } from '../api/RushGlobalFolder';
import { RushConstants } from './RushConstants';
import { LastInstallFlag } from '../api/LastInstallFlag';
import { RushCommandLineParser } from '../cli/RushCommandLineParser';
@@ -19,6 +19,7 @@ import { RushCommandLineParser } from '../cli/RushCommandLineParser';
interface IAutoinstallerOptions {
autoinstallerName: string;
rushConfiguration: RushConfiguration;
+ rushGlobalFolder: RushGlobalFolder;
restrictConsoleOutput?: boolean;
}
@@ -26,11 +27,13 @@ export class Autoinstaller {
public readonly name: string;
private readonly _rushConfiguration: RushConfiguration;
+ private readonly _rushGlobalFolder: RushGlobalFolder;
private readonly _restrictConsoleOutput: boolean;
public constructor(options: IAutoinstallerOptions) {
this.name = options.autoinstallerName;
this._rushConfiguration = options.rushConfiguration;
+ this._rushGlobalFolder = options.rushGlobalFolder;
this._restrictConsoleOutput =
options.restrictConsoleOutput ?? RushCommandLineParser.shouldRestrictConsoleOutput();
@@ -75,10 +78,9 @@ export class Autoinstaller {
);
}
- const rushGlobalFolder: RushGlobalFolder = new RushGlobalFolder();
await InstallHelpers.ensureLocalPackageManager(
this._rushConfiguration,
- rushGlobalFolder,
+ this._rushGlobalFolder,
RushConstants.defaultMaxInstallAttempts,
this._restrictConsoleOutput
);
@@ -155,7 +157,14 @@ export class Autoinstaller {
}
}
- public update(): void {
+ public async updateAsync(): Promise {
+ await InstallHelpers.ensureLocalPackageManager(
+ this._rushConfiguration,
+ this._rushGlobalFolder,
+ RushConstants.defaultMaxInstallAttempts,
+ this._restrictConsoleOutput
+ );
+
const autoinstallerPackageJsonPath: string = path.join(this.folderFullPath, 'package.json');
if (!FileSystem.exists(autoinstallerPackageJsonPath)) {
diff --git a/libraries/rush-lib/src/logic/EventHooksManager.ts b/libraries/rush-lib/src/logic/EventHooksManager.ts
index d950c7ffd9b..7156466e403 100644
--- a/libraries/rush-lib/src/logic/EventHooksManager.ts
+++ b/libraries/rush-lib/src/logic/EventHooksManager.ts
@@ -34,13 +34,17 @@ export class EventHooksManager {
const stopwatch: Stopwatch = Stopwatch.start();
console.log('\n' + colors.green(`Executing event hooks for ${Event[event]}`));
+
+ const printEventHooksOutputToConsole: boolean | undefined =
+ isDebug ||
+ this._rushConfiguration.experimentsConfiguration.configuration.printEventHooksOutputToConsole;
scripts.forEach((script) => {
try {
Utilities.executeLifecycleCommand(script, {
rushConfiguration: this._rushConfiguration,
workingDirectory: this._rushConfiguration.rushJsonFolder,
initCwd: this._commonTempFolder,
- handleOutput: !isDebug,
+ handleOutput: !printEventHooksOutputToConsole,
environmentPathOptions: {
includeRepoBin: true
}
diff --git a/libraries/rush-lib/src/logic/InteractiveUpgrader.ts b/libraries/rush-lib/src/logic/InteractiveUpgrader.ts
index fbcf46fdb88..3b2e1d0b8cf 100644
--- a/libraries/rush-lib/src/logic/InteractiveUpgrader.ts
+++ b/libraries/rush-lib/src/logic/InteractiveUpgrader.ts
@@ -72,7 +72,10 @@ export class InteractiveUpgrader {
): Promise {
const { projectFolder } = rushProject;
- const currentState: NpmCheck.INpmCheckCurrentState = await npmCheck({ cwd: projectFolder });
+ const currentState: NpmCheck.INpmCheckCurrentState = await npmCheck({
+ cwd: projectFolder,
+ skipUnused: true
+ });
return currentState.get('packages');
}
diff --git a/libraries/rush-lib/src/logic/LookupByPath.ts b/libraries/rush-lib/src/logic/LookupByPath.ts
index 0fbaf994108..a848949f216 100644
--- a/libraries/rush-lib/src/logic/LookupByPath.ts
+++ b/libraries/rush-lib/src/logic/LookupByPath.ts
@@ -15,6 +15,21 @@ interface IPathTreeNode {
children: Map> | undefined;
}
+interface IPrefixEntry {
+ prefix: string;
+ index: number;
+}
+
+/**
+ * Object containing both the matched item and the start index of the remainder of the query.
+ *
+ * @beta
+ */
+export interface IPrefixMatch {
+ value: TItem;
+ index: number;
+}
+
/**
* This class is used to associate POSIX relative paths, such as those returned by `git` commands,
* with entities that correspond with ancestor folders, such as Rush Projects.
@@ -24,11 +39,11 @@ interface IPathTreeNode {
* @example
* ```ts
* const tree = new LookupByPath([['foo', 1], ['bar', 2], ['foo/bar', 3]]);
- * tree.getNearestAncestor('foo'); // returns 1
- * tree.getNearestAncestor('foo/baz'); // returns 1
- * tree.getNearestAncestor('baz'); // returns undefined
- * tree.getNearestAncestor('foo/bar/baz'); returns 3
- * tree.getNearestAncestor('bar/foo/bar'); returns 2
+ * tree.findChildPath('foo'); // returns 1
+ * tree.findChildPath('foo/baz'); // returns 1
+ * tree.findChildPath('baz'); // returns undefined
+ * tree.findChildPath('foo/bar/baz'); returns 3
+ * tree.findChildPath('bar/foo/bar'); returns 2
* ```
* @beta
*/
@@ -72,21 +87,35 @@ export class LookupByPath {
* `LookupByPath.iteratePathSegments('foo\\bar\\baz', '\\')` yields 'foo', 'bar', 'baz'
*/
public static *iteratePathSegments(serializedPath: string, delimiter: string = '/'): Iterable {
- if (!serializedPath) {
+ for (const prefixMatch of this._iteratePrefixes(serializedPath, delimiter)) {
+ yield prefixMatch.prefix;
+ }
+ }
+
+ private static *_iteratePrefixes(input: string, delimiter: string = '/'): Iterable {
+ if (!input) {
return;
}
- let nextIndex: number = serializedPath.indexOf(delimiter);
let previousIndex: number = 0;
- while (nextIndex >= 0) {
- yield serializedPath.slice(previousIndex, nextIndex);
+ let nextIndex: number = input.indexOf(delimiter);
+ // Leading segments
+ while (nextIndex >= 0) {
+ yield {
+ prefix: input.slice(previousIndex, nextIndex),
+ index: nextIndex
+ };
previousIndex = nextIndex + 1;
- nextIndex = serializedPath.indexOf(delimiter, previousIndex);
+ nextIndex = input.indexOf(delimiter, previousIndex);
}
- if (previousIndex + 1 < serializedPath.length) {
- yield serializedPath.slice(previousIndex);
+ // Last segment
+ if (previousIndex + 1 < input.length) {
+ yield {
+ prefix: input.slice(previousIndex, input.length),
+ index: input.length
+ };
}
}
@@ -146,6 +175,24 @@ export class LookupByPath {
return this.findChildPathFromSegments(LookupByPath.iteratePathSegments(childPath, this.delimiter));
}
+ /**
+ * Searches for the item for which the recorded prefix is the longest matching prefix of `query`.
+ * Obtains both the item and the length of the matched prefix, so that the remainder of the path can be
+ * extracted.
+ *
+ * @returns the found item and the length of the matched prefix, or `undefined` if no item was found
+ *
+ * @example
+ * ```ts
+ * const tree = new LookupByPath([['foo', 1], ['foo/bar', 2]]);
+ * tree.findLongestPrefixMatch('foo/baz'); // returns { item: 1, index: 3 }
+ * tree.findLongestPrefixMatch('foo/bar/baz'); // returns { item: 2, index: 7 }
+ * ```
+ */
+ public findLongestPrefixMatch(query: string): IPrefixMatch | undefined {
+ return this._findLongestPrefixMatch(LookupByPath._iteratePrefixes(query, this.delimiter));
+ }
+
/**
* Searches for the item associated with `childPathSegments`, or the nearest ancestor of that path that
* has an associated item.
@@ -179,4 +226,43 @@ export class LookupByPath {
return best;
}
+
+ /**
+ * Iterates through progressively longer prefixes of a given string and returns as soon
+ * as the number of candidate items that match the prefix are 1 or 0.
+ *
+ * If a match is present, returns the matched itme and the length of the matched prefix.
+ *
+ * @returns the found item, or `undefined` if no item was found
+ */
+ private _findLongestPrefixMatch(prefixes: Iterable): IPrefixMatch | undefined {
+ let node: IPathTreeNode = this._root;
+ let best: IPrefixMatch | undefined = node.value
+ ? {
+ value: node.value,
+ index: 0
+ }
+ : undefined;
+ // Trivial cases
+ if (node.children) {
+ for (const { prefix: hash, index } of prefixes) {
+ const child: IPathTreeNode | undefined = node.children.get(hash);
+ if (!child) {
+ break;
+ }
+ node = child;
+ if (node.value !== undefined) {
+ best = {
+ value: node.value,
+ index
+ };
+ }
+ if (!node.children) {
+ break;
+ }
+ }
+ }
+
+ return best;
+ }
}
diff --git a/libraries/rush-lib/src/logic/ProjectChangeAnalyzer.ts b/libraries/rush-lib/src/logic/ProjectChangeAnalyzer.ts
index da0f2cd2413..8b775ebfe97 100644
--- a/libraries/rush-lib/src/logic/ProjectChangeAnalyzer.ts
+++ b/libraries/rush-lib/src/logic/ProjectChangeAnalyzer.ts
@@ -8,11 +8,10 @@ import ignore, { Ignore } from 'ignore';
import {
getRepoChanges,
getRepoRoot,
- getRepoState,
- getGitHashForFiles,
+ getRepoStateAsync,
IFileDiffStatus
} from '@rushstack/package-deps-hash';
-import { Path, InternalError, FileSystem, ITerminal, Async } from '@rushstack/node-core-library';
+import { Path, FileSystem, ITerminal, Async } from '@rushstack/node-core-library';
import { RushConfiguration } from '../api/RushConfiguration';
import { RushProjectConfiguration } from '../api/RushProjectConfiguration';
@@ -51,9 +50,13 @@ interface IGitState {
rootDir: string;
}
-interface IRawRepoState {
+/**
+ * @internal
+ */
+export interface IRawRepoState {
projectState: Map> | undefined;
rootDir: string;
+ rawHashes: Map;
}
/**
@@ -93,7 +96,7 @@ export class ProjectChangeAnalyzer {
return filteredProjectData;
}
- const data: IRawRepoState | undefined = this._ensureInitialized(terminal);
+ const data: IRawRepoState | undefined = await this._ensureInitializedAsync(terminal);
if (!data) {
return undefined;
@@ -124,9 +127,9 @@ export class ProjectChangeAnalyzer {
/**
* @internal
*/
- public _ensureInitialized(terminal: ITerminal): IRawRepoState | undefined {
+ public async _ensureInitializedAsync(terminal: ITerminal): Promise {
if (this._data === UNINITIALIZED) {
- this._data = this._getData(terminal);
+ this._data = await this._getDataAsync(terminal);
}
return this._data;
@@ -325,13 +328,14 @@ export class ProjectChangeAnalyzer {
return changedProjects;
}
- private _getData(terminal: ITerminal): IRawRepoState {
- const repoState: IGitState | undefined = this._getRepoDeps(terminal);
+ private async _getDataAsync(terminal: ITerminal): Promise {
+ const repoState: IGitState | undefined = await this._getRepoDepsAsync(terminal);
if (!repoState) {
// Mark as resolved, but no data
return {
projectState: undefined,
- rootDir: this._rushConfiguration.rushJsonFolder
+ rootDir: this._rushConfiguration.rushJsonFolder,
+ rawHashes: new Map()
};
}
@@ -347,44 +351,7 @@ export class ProjectChangeAnalyzer {
const { hashes: repoDeps, rootDir } = repoState;
// Currently, only pnpm handles project shrinkwraps
- if (this._rushConfiguration.packageManager === 'pnpm') {
- const projectDependencyManifestPaths: string[] = [];
-
- for (const project of projectHashDeps.keys()) {
- const projectShrinkwrapFilePath: string = BaseProjectShrinkwrapFile.getFilePathForProject(project);
- const relativeProjectShrinkwrapFilePath: string = Path.convertToSlashes(
- path.relative(rootDir, projectShrinkwrapFilePath)
- );
-
- if (!FileSystem.exists(projectShrinkwrapFilePath)) {
- throw new Error(
- `A project dependency file (${relativeProjectShrinkwrapFilePath}) is missing. You may need to run ` +
- '"rush install" or "rush update".'
- );
- }
-
- projectDependencyManifestPaths.push(relativeProjectShrinkwrapFilePath);
- }
-
- const gitPath: string = this._git.getGitPathOrThrow();
- const hashes: Map = getGitHashForFiles(
- projectDependencyManifestPaths,
- rootDir,
- gitPath
- );
-
- let i: number = 0;
- for (const projectDeps of projectHashDeps.values()) {
- const projectDependencyManifestPath: string = projectDependencyManifestPaths[i];
- const hash: string | undefined = hashes.get(projectDependencyManifestPath);
- if (hash === undefined) {
- throw new InternalError(`Expected to get a hash for ${projectDependencyManifestPath}`);
- }
-
- projectDeps.set(projectDependencyManifestPath, hash);
- i++;
- }
- } else {
+ if (this._rushConfiguration.packageManager !== 'pnpm') {
// Determine the current variant from the link JSON.
const variant: string | undefined = this._rushConfiguration.currentInstalledVariant;
@@ -416,7 +383,8 @@ export class ProjectChangeAnalyzer {
return {
projectState: projectHashDeps,
- rootDir
+ rootDir,
+ rawHashes: repoState.hashes
};
}
@@ -434,13 +402,42 @@ export class ProjectChangeAnalyzer {
}
}
- private _getRepoDeps(terminal: ITerminal): IGitState | undefined {
+ private async _getRepoDepsAsync(terminal: ITerminal): Promise {
try {
+ const gitPath: string = this._git.getGitPathOrThrow();
+
if (this._git.isPathUnderGitWorkingTree()) {
- // Load the package deps hash for the whole repository
- const gitPath: string = this._git.getGitPathOrThrow();
+ // Do not use getGitInfo().root; it is the root of the *primary* worktree, not the *current* one.
const rootDir: string = getRepoRoot(this._rushConfiguration.rushJsonFolder, gitPath);
- const hashes: Map = getRepoState(rootDir, gitPath);
+ // Load the package deps hash for the whole repository
+ // Include project shrinkwrap files as part of the computation
+ const additionalFilesToHash: string[] = [];
+
+ if (this._rushConfiguration.packageManager === 'pnpm') {
+ const absoluteFilePathsToCheck: string[] = [];
+
+ for (const project of this._rushConfiguration.projects) {
+ const projectShrinkwrapFilePath: string =
+ BaseProjectShrinkwrapFile.getFilePathForProject(project);
+ absoluteFilePathsToCheck.push(projectShrinkwrapFilePath);
+ const relativeProjectShrinkwrapFilePath: string = Path.convertToSlashes(
+ path.relative(rootDir, projectShrinkwrapFilePath)
+ );
+
+ additionalFilesToHash.push(relativeProjectShrinkwrapFilePath);
+ }
+
+ await Async.forEachAsync(absoluteFilePathsToCheck, async (filePath: string) => {
+ if (!(await FileSystem.existsAsync(filePath))) {
+ throw new Error(
+ `A project dependency file (${filePath}) is missing. You may need to run ` +
+ '"rush install" or "rush update".'
+ );
+ }
+ });
+ }
+
+ const hashes: Map = await getRepoStateAsync(rootDir, additionalFilesToHash, gitPath);
return {
gitPath,
hashes,
diff --git a/libraries/rush-lib/src/logic/buildCache/getHashesForGlobsAsync.ts b/libraries/rush-lib/src/logic/buildCache/getHashesForGlobsAsync.ts
new file mode 100644
index 00000000000..4e3f136602a
--- /dev/null
+++ b/libraries/rush-lib/src/logic/buildCache/getHashesForGlobsAsync.ts
@@ -0,0 +1,120 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { Async, Import, LegacyAdapters } from '@rushstack/node-core-library';
+import { getGitHashForFiles } from '@rushstack/package-deps-hash';
+import * as path from 'path';
+import type { IOptions } from 'glob';
+import type { IRawRepoState } from '../ProjectChangeAnalyzer';
+
+const glob: typeof import('glob') = Import.lazy('glob', require);
+
+const globAsync = (pattern: string, options: IOptions = {}): Promise => {
+ return LegacyAdapters.convertCallbackToPromise(glob, pattern, options);
+};
+
+async function expandGlobPatternsAsync(
+ globPatterns: Iterable,
+ packagePath: string
+): Promise {
+ const allMatches: Set = new Set();
+
+ await Async.forEachAsync(
+ globPatterns,
+ async (pattern) => {
+ const matches: string[] = await globAsync(pattern, {
+ cwd: packagePath,
+ nodir: true,
+ // We want to keep path's type unchanged,
+ // i.e. if the pattern was a relative path, then matched paths should also be relative paths
+ // if the pattern was an absolute path, then matched paths should also be absolute paths
+ //
+ // We are doing this because these paths are going to be used to calculate a hash for the build cache and some users
+ // might choose to depend on global files (e.g. `/etc/os-release`) and some might choose to depend on local files
+ // (e.g. `../path/to/workspace/file`)
+ //
+ // In both cases we want that path to the resource would be the same on all machines,
+ // regardless of what is the current working directory.
+ //
+ // That being said, we want to keep `realpath` and `absolute` options here as false:
+ realpath: false,
+ absolute: false
+ });
+ matches.forEach((match) => allMatches.add(match));
+ },
+ { concurrency: 10 }
+ );
+
+ if (allMatches.size === 0) {
+ throw new Error(
+ `Couldn't find any files matching provided glob patterns: ["${Array.from(globPatterns).join('", "')}"].`
+ );
+ }
+
+ return Array.from(allMatches);
+}
+
+interface IKnownHashesResult {
+ foundPaths: Map;
+ missingPaths: string[];
+}
+
+function getKnownHashes(
+ filePaths: string[],
+ packagePath: string,
+ repoState: IRawRepoState
+): IKnownHashesResult {
+ const missingPaths: string[] = [];
+ const foundPaths: Map = new Map();
+
+ for (const filePath of filePaths) {
+ const absolutePath: string = path.isAbsolute(filePath) ? filePath : path.join(packagePath, filePath);
+
+ /**
+ * We are using RegExp here to prevent false positives in the following string.replace function
+ * - `^` anchor makes sure that we are replacing only the beginning of the string
+ * - extra `/` makes sure that we are remove extra slash from the relative path
+ */
+ const gitFilePath: string = absolutePath.replace(new RegExp('^' + repoState.rootDir + '/'), '');
+ const foundHash: string | undefined = repoState.rawHashes.get(gitFilePath);
+
+ if (foundHash) {
+ foundPaths.set(filePath, foundHash);
+ } else {
+ missingPaths.push(filePath);
+ }
+ }
+
+ return { foundPaths, missingPaths };
+}
+
+export async function getHashesForGlobsAsync(
+ globPatterns: Iterable,
+ packagePath: string,
+ repoState: IRawRepoState | undefined
+): Promise> {
+ const filePaths: string[] = await expandGlobPatternsAsync(globPatterns, packagePath);
+
+ if (!repoState) {
+ return getGitHashForFiles(filePaths, packagePath);
+ }
+
+ const { foundPaths, missingPaths } = getKnownHashes(filePaths, packagePath, repoState);
+ const calculatedHashes: Map = getGitHashForFiles(missingPaths, packagePath);
+
+ /**
+ * We want to keep the order of the output the same regardless whether the file was already
+ * hashed by git or not (as this can change, e.g. due to .gitignore).
+ * Therefore we will populate our final hashes map in the same order as `filePaths`.
+ */
+ const result: Map = new Map();
+ for (const filePath of filePaths) {
+ const hash: string | undefined = foundPaths.get(filePath) || calculatedHashes.get(filePath);
+ if (!hash) {
+ // Sanity check -- this should never happen
+ throw new Error(`Failed to calculate hash of file: "${filePath}"`);
+ }
+ result.set(filePath, hash);
+ }
+
+ return result;
+}
diff --git a/libraries/rush-lib/src/logic/deploy/DeployManager.ts b/libraries/rush-lib/src/logic/deploy/DeployManager.ts
index 78175e3f9a8..ce4d392bcef 100644
--- a/libraries/rush-lib/src/logic/deploy/DeployManager.ts
+++ b/libraries/rush-lib/src/logic/deploy/DeployManager.ts
@@ -31,7 +31,7 @@ import { RushConfigurationProject } from '../../api/RushConfigurationProject';
import { DeployScenarioConfiguration, IDeployScenarioProjectJson } from './DeployScenarioConfiguration';
import { PnpmfileConfiguration } from '../pnpm/PnpmfileConfiguration';
import { matchesWithStar } from './Utils';
-import { scriptsFolderName } from '../../utilities/PathConstants';
+import { createLinksScriptFilename, scriptsFolderPath } from '../../utilities/PathConstants';
// (@types/npm-packlist is missing this API)
declare module 'npm-packlist' {
@@ -665,7 +665,7 @@ export class DeployManager {
if (deployState.scenarioConfiguration.json.linkCreation === 'script') {
console.log('Copying create-links.js');
FileSystem.copyFile({
- sourcePath: `${scriptsFolderName}/create-links.js`,
+ sourcePath: `${scriptsFolderPath}/${createLinksScriptFilename}`,
destinationPath: path.join(deployState.targetRootFolder, 'create-links.js'),
alreadyExistsBehavior: AlreadyExistsBehavior.Error
});
diff --git a/libraries/rush-lib/src/logic/installManager/RushInstallManager.ts b/libraries/rush-lib/src/logic/installManager/RushInstallManager.ts
index 9889de84da1..14847602cab 100644
--- a/libraries/rush-lib/src/logic/installManager/RushInstallManager.ts
+++ b/libraries/rush-lib/src/logic/installManager/RushInstallManager.ts
@@ -575,45 +575,28 @@ export class RushInstallManager extends BaseInstallManager {
);
}
- try {
- Utilities.executeCommandWithRetry(
- {
- command: packageManagerFilename,
- args: installArgs,
- workingDirectory: this.rushConfiguration.commonTempFolder,
- environment: packageManagerEnv,
- suppressOutput: false
- },
- this.options.maxInstallAttempts,
- () => {
- if (this.rushConfiguration.packageManager === 'pnpm') {
- console.log(colors.yellow(`Deleting the "node_modules" folder`));
- this.installRecycler.moveFolder(commonNodeModulesFolder);
-
- // Leave the pnpm-store as is for the retry. This ensures that packages that have already
- // been downloaded need not be downloaded again, thereby potentially increasing the chances
- // of a subsequent successful install.
-
- Utilities.createFolderWithRetry(commonNodeModulesFolder);
- }
+ Utilities.executeCommandWithRetry(
+ {
+ command: packageManagerFilename,
+ args: installArgs,
+ workingDirectory: this.rushConfiguration.commonTempFolder,
+ environment: packageManagerEnv,
+ suppressOutput: false
+ },
+ this.options.maxInstallAttempts,
+ () => {
+ if (this.rushConfiguration.packageManager === 'pnpm') {
+ console.log(colors.yellow(`Deleting the "node_modules" folder`));
+ this.installRecycler.moveFolder(commonNodeModulesFolder);
+
+ // Leave the pnpm-store as is for the retry. This ensures that packages that have already
+ // been downloaded need not be downloaded again, thereby potentially increasing the chances
+ // of a subsequent successful install.
+
+ Utilities.createFolderWithRetry(commonNodeModulesFolder);
}
- );
- } catch (error) {
- // All the install attempts failed.
-
- if (
- this.rushConfiguration.packageManager === 'pnpm' &&
- this.rushConfiguration.pnpmOptions.pnpmStore === 'local'
- ) {
- // If the installation has failed even after the retries, then pnpm store may
- // have got into a corrupted, irrecoverable state. Delete the store so that a
- // future install can create the store afresh.
- console.log(colors.yellow(`Deleting the "pnpm-store" folder`));
- this.installRecycler.moveFolder(this.rushConfiguration.pnpmOptions.pnpmStorePath);
}
-
- throw error;
- }
+ );
if (this.rushConfiguration.packageManager === 'npm') {
console.log('\n' + colors.bold('Running "npm shrinkwrap"...'));
diff --git a/libraries/rush-lib/src/logic/operations/IOperationRunner.ts b/libraries/rush-lib/src/logic/operations/IOperationRunner.ts
index 82bcae1ef00..22062e82b71 100644
--- a/libraries/rush-lib/src/logic/operations/IOperationRunner.ts
+++ b/libraries/rush-lib/src/logic/operations/IOperationRunner.ts
@@ -5,7 +5,7 @@ import type { StdioSummarizer } from '@rushstack/terminal';
import type { CollatedWriter } from '@rushstack/stream-collator';
import type { OperationStatus } from './OperationStatus';
-import type { OperationStateFile } from './OperationStateFile';
+import type { OperationMetadataManager } from './OperationMetadataManager';
import type { IStopwatchResult } from '../../utilities/Stopwatch';
/**
@@ -31,11 +31,11 @@ export interface IOperationRunnerContext {
*/
stdioSummarizer: StdioSummarizer;
/**
- * Object used to record state of the operation.
+ * Object used to manage metadata of the operation.
*
* @internal
*/
- _operationStateFile?: OperationStateFile;
+ _operationMetadataManager?: OperationMetadataManager;
/**
* Object used to track elapsed time.
*/
diff --git a/libraries/rush-lib/src/logic/operations/OperationExecutionManager.ts b/libraries/rush-lib/src/logic/operations/OperationExecutionManager.ts
index a84a0cb67d6..4cc9847e9f9 100644
--- a/libraries/rush-lib/src/logic/operations/OperationExecutionManager.ts
+++ b/libraries/rush-lib/src/logic/operations/OperationExecutionManager.ts
@@ -18,6 +18,9 @@ export interface IOperationExecutionManagerOptions {
parallelism: number;
changedProjectsOnly: boolean;
destination?: TerminalWritable;
+
+ onOperationStatusChanged?: (record: OperationExecutionRecord) => void;
+ beforeExecuteOperations?: (records: Map) => Promise;
}
/**
@@ -44,13 +47,25 @@ export class OperationExecutionManager {
private readonly _terminal: CollatedTerminal;
+ private readonly _onOperationStatusChanged?: (record: OperationExecutionRecord) => void;
+ private readonly _beforeExecuteOperations?: (
+ records: Map
+ ) => Promise;
+
// Variables for current status
private _hasAnyFailures: boolean;
private _hasAnyNonAllowedWarnings: boolean;
private _completedOperations: number;
public constructor(operations: Set, options: IOperationExecutionManagerOptions) {
- const { quietMode, debugMode, parallelism, changedProjectsOnly } = options;
+ const {
+ quietMode,
+ debugMode,
+ parallelism,
+ changedProjectsOnly,
+ onOperationStatusChanged,
+ beforeExecuteOperations
+ } = options;
this._completedOperations = 0;
this._quietMode = quietMode;
this._hasAnyFailures = false;
@@ -58,6 +73,9 @@ export class OperationExecutionManager {
this._changedProjectsOnly = changedProjectsOnly;
this._parallelism = parallelism;
+ this._beforeExecuteOperations = beforeExecuteOperations;
+ this._onOperationStatusChanged = onOperationStatusChanged;
+
// TERMINAL PIPELINE:
//
// streamCollator --> colorsNewlinesTransform --> StdioWritable
@@ -77,6 +95,7 @@ export class OperationExecutionManager {
// Convert the developer graph to the mutable execution graph
const executionRecordContext: IOperationExecutionRecordContext = {
streamCollator: this._streamCollator,
+ onOperationStatusChanged,
debugMode,
quietMode
};
@@ -183,6 +202,8 @@ export class OperationExecutionManager {
prioritySort
);
+ await this._beforeExecuteOperations?.(this._executionRecords);
+
// This function is a callback because it may write to the collatedWriter before
// operation.executeAsync returns (and cleans up the writer)
const onOperationComplete: (record: OperationExecutionRecord) => void = (
@@ -250,6 +271,7 @@ export class OperationExecutionManager {
terminal.writeStdoutLine(`"${blockedRecord.name}" is blocked by "${name}".`);
}
blockedRecord.status = OperationStatus.Blocked;
+ this._onOperationStatusChanged?.(blockedRecord);
for (const dependent of blockedRecord.consumers) {
blockedQueue.add(dependent);
diff --git a/libraries/rush-lib/src/logic/operations/OperationExecutionRecord.ts b/libraries/rush-lib/src/logic/operations/OperationExecutionRecord.ts
index c285d9b6371..3c97bbc574a 100644
--- a/libraries/rush-lib/src/logic/operations/OperationExecutionRecord.ts
+++ b/libraries/rush-lib/src/logic/operations/OperationExecutionRecord.ts
@@ -9,10 +9,11 @@ import { OperationStatus } from './OperationStatus';
import { IOperationRunner, IOperationRunnerContext } from './IOperationRunner';
import { Operation } from './Operation';
import { Stopwatch } from '../../utilities/Stopwatch';
-import { OperationStateFile } from './OperationStateFile';
+import { OperationMetadataManager } from './OperationMetadataManager';
export interface IOperationExecutionRecordContext {
streamCollator: StreamCollator;
+ onOperationStatusChanged?: (record: OperationExecutionRecord) => void;
debugMode: boolean;
quietMode: boolean;
@@ -81,7 +82,7 @@ export class OperationExecutionRecord implements IOperationRunnerContext {
public readonly runner: IOperationRunner;
public readonly weight: number;
- public readonly _operationStateFile: OperationStateFile | undefined;
+ public readonly _operationMetadataManager: OperationMetadataManager | undefined;
private readonly _context: IOperationExecutionRecordContext;
@@ -99,7 +100,7 @@ export class OperationExecutionRecord implements IOperationRunnerContext {
this.runner = runner;
this.weight = operation.weight;
if (operation.associatedPhase && operation.associatedProject) {
- this._operationStateFile = new OperationStateFile({
+ this._operationMetadataManager = new OperationMetadataManager({
phase: operation.associatedPhase,
rushProject: operation.associatedProject
});
@@ -129,12 +130,13 @@ export class OperationExecutionRecord implements IOperationRunnerContext {
public get nonCachedDurationMs(): number | undefined {
// Lazy calculated because the state file is created/restored later on
- return this._operationStateFile?.state?.nonCachedDurationMs;
+ return this._operationMetadataManager?.stateFile.state?.nonCachedDurationMs;
}
public async executeAsync(onResult: (record: OperationExecutionRecord) => void): Promise {
this.status = OperationStatus.Executing;
this.stopwatch.start();
+ this._context.onOperationStatusChanged?.(this);
try {
this.status = await this.runner.executeAsync(this);
@@ -149,6 +151,7 @@ export class OperationExecutionRecord implements IOperationRunnerContext {
this._collatedWriter?.close();
this.stdioSummarizer.close();
this.stopwatch.stop();
+ this._context.onOperationStatusChanged?.(this);
}
}
}
diff --git a/libraries/rush-lib/src/logic/operations/OperationMetadataManager.ts b/libraries/rush-lib/src/logic/operations/OperationMetadataManager.ts
new file mode 100644
index 00000000000..3ee563a9142
--- /dev/null
+++ b/libraries/rush-lib/src/logic/operations/OperationMetadataManager.ts
@@ -0,0 +1,141 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+import * as fs from 'fs';
+import { Async, FileSystem, IFileSystemCopyFileOptions, ITerminal } from '@rushstack/node-core-library';
+
+import { OperationStateFile } from './OperationStateFile';
+import { RushConstants } from '../RushConstants';
+
+import type { IPhase } from '../../api/CommandLineConfiguration';
+import type { RushConfigurationProject } from '../../api/RushConfigurationProject';
+import type { IOperationStateJson } from './OperationStateFile';
+
+/**
+ * @internal
+ */
+export interface IOperationMetadataManagerOptions {
+ rushProject: RushConfigurationProject;
+ phase: IPhase;
+}
+
+/**
+ * @internal
+ */
+export interface IOperationMetaData {
+ durationInSeconds: number;
+ logPath: string;
+ errorLogPath: string;
+}
+
+/**
+ * A helper class for managing the meta files of a operation.
+ *
+ * @internal
+ */
+export class OperationMetadataManager {
+ public readonly stateFile: OperationStateFile;
+ private _metadataFolder: string;
+ private _logPath: string;
+ private _errorLogPath: string;
+ private _relativeLogPath: string;
+ private _relativeErrorLogPath: string;
+
+ public constructor(options: IOperationMetadataManagerOptions) {
+ const { rushProject, phase } = options;
+ const { projectFolder } = rushProject;
+
+ const identifier: string = phase.logFilenameIdentifier;
+ this._metadataFolder = `${RushConstants.projectRushFolderName}/${RushConstants.rushTempFolderName}/operation/${identifier}`;
+
+ this.stateFile = new OperationStateFile({
+ projectFolder: projectFolder,
+ metadataFolder: this._metadataFolder
+ });
+
+ this._relativeLogPath = `${this._metadataFolder}/all.log`;
+ this._relativeErrorLogPath = `${this._metadataFolder}/error.log`;
+ this._logPath = `${projectFolder}/${this._relativeLogPath}`;
+ this._errorLogPath = `${projectFolder}/${this._relativeErrorLogPath}`;
+ }
+
+ /**
+ * Returns the relative paths of the metadata files to project folder.
+ *
+ * Example: `.rush/temp/operation/_phase_build/state.json`
+ * Example: `.rush/temp/operation/_phase_build/all.log`
+ * Example: `.rush/temp/operation/_phase_build/error.log`
+ */
+ public get relativeFilepaths(): string[] {
+ return [this.stateFile.relativeFilepath, this._relativeLogPath, this._relativeErrorLogPath];
+ }
+
+ public async saveAsync({ durationInSeconds, logPath, errorLogPath }: IOperationMetaData): Promise {
+ const state: IOperationStateJson = {
+ nonCachedDurationMs: durationInSeconds * 1000
+ };
+ await this.stateFile.writeAsync(state);
+
+ const copyFileOptions: IFileSystemCopyFileOptions[] = [
+ {
+ sourcePath: logPath,
+ destinationPath: this._logPath
+ },
+ {
+ sourcePath: errorLogPath,
+ destinationPath: this._errorLogPath
+ }
+ ];
+
+ // Try to copy log files
+ await Async.forEachAsync(copyFileOptions, async (options) => {
+ try {
+ await FileSystem.copyFileAsync(options);
+ } catch (e) {
+ if (!FileSystem.isNotExistError(e)) {
+ throw e;
+ }
+ }
+ });
+ }
+
+ public async tryRestoreAsync({
+ terminal,
+ logPath,
+ errorLogPath
+ }: {
+ terminal: ITerminal;
+ logPath: string;
+ errorLogPath: string;
+ }): Promise {
+ await this.stateFile.tryRestoreAsync();
+
+ // Append cached log into current log file
+ terminal.writeLine('');
+ terminal.writeLine(`Restoring cached log file at ${this._logPath}`);
+ try {
+ const logReadStream: fs.ReadStream = fs.createReadStream(this._logPath, {
+ encoding: 'utf-8'
+ });
+ for await (const data of logReadStream) {
+ terminal.write(data);
+ }
+ } catch (e) {
+ if (!FileSystem.isNotExistError(e)) {
+ throw e;
+ }
+ }
+
+ // Try to restore cached error log as error log file
+ try {
+ await FileSystem.copyFileAsync({
+ sourcePath: this._errorLogPath,
+ destinationPath: errorLogPath
+ });
+ } catch (e) {
+ if (!FileSystem.isNotExistError(e)) {
+ throw e;
+ }
+ }
+ }
+}
diff --git a/libraries/rush-lib/src/logic/operations/OperationStateFile.ts b/libraries/rush-lib/src/logic/operations/OperationStateFile.ts
index cb6c9f82335..de8b6ed7321 100644
--- a/libraries/rush-lib/src/logic/operations/OperationStateFile.ts
+++ b/libraries/rush-lib/src/logic/operations/OperationStateFile.ts
@@ -2,17 +2,13 @@
// See LICENSE in the project root for license information.
import { FileSystem, InternalError, JsonFile } from '@rushstack/node-core-library';
-import { RushConstants } from '../RushConstants';
-
-import type { IPhase } from '../../api/CommandLineConfiguration';
-import type { RushConfigurationProject } from '../../api/RushConfigurationProject';
/**
* @internal
*/
export interface IOperationStateFileOptions {
- rushProject: RushConfigurationProject;
- phase: IPhase;
+ projectFolder: string;
+ metadataFolder: string;
}
/**
@@ -31,28 +27,25 @@ export class OperationStateFile {
private _state: IOperationStateJson | undefined;
/**
- * Returns the filename of the metadata file.
+ * The path of the state json file.
+ *
+ * Example: `/code/repo/my-project/.rush/temp/operation/_phase_build/state.json`
*/
- public readonly filename: string;
-
- public constructor(options: IOperationStateFileOptions) {
- const { rushProject, phase } = options;
- this.filename = OperationStateFile._getFilename(phase, rushProject);
- }
-
- private static _getFilename(phase: IPhase, project: RushConfigurationProject): string {
- const relativeFilename: string = OperationStateFile.getFilenameRelativeToProjectRoot(phase);
- return `${project.projectFolder}/${relativeFilename}`;
- }
+ public readonly filepath: string;
/**
- * ProjectBuildCache expects the relative path for better logging
+ * The relative path of the state json file to project folder
*
- * @internal
+ * Example: `.rush/temp/operation/_phase_build/state.json`
*/
- public static getFilenameRelativeToProjectRoot(phase: IPhase): string {
- const identifier: string = phase.logFilenameIdentifier;
- return `${RushConstants.projectRushFolderName}/${RushConstants.rushTempFolderName}/operation/${identifier}/state.json`;
+ public readonly relativeFilepath: string;
+
+ public static filename: string = 'state.json';
+
+ public constructor(options: IOperationStateFileOptions) {
+ const { projectFolder, metadataFolder } = options;
+ this.relativeFilepath = `${metadataFolder}/${OperationStateFile.filename}`;
+ this.filepath = `${projectFolder}/${this.relativeFilepath}`;
}
public get state(): IOperationStateJson | undefined {
@@ -60,13 +53,13 @@ export class OperationStateFile {
}
public async writeAsync(json: IOperationStateJson): Promise {
- await JsonFile.saveAsync(json, this.filename, { ensureFolderExists: true, updateExistingFile: true });
+ await JsonFile.saveAsync(json, this.filepath, { ensureFolderExists: true, updateExistingFile: true });
this._state = json;
}
public async tryRestoreAsync(): Promise {
try {
- this._state = await JsonFile.loadAsync(this.filename);
+ this._state = await JsonFile.loadAsync(this.filepath);
} catch (error) {
if (FileSystem.isNotExistError(error as Error)) {
this._state = undefined;
diff --git a/libraries/rush-lib/src/logic/operations/PhasedOperationPlugin.ts b/libraries/rush-lib/src/logic/operations/PhasedOperationPlugin.ts
index f07984f2a6e..17de0854eaf 100644
--- a/libraries/rush-lib/src/logic/operations/PhasedOperationPlugin.ts
+++ b/libraries/rush-lib/src/logic/operations/PhasedOperationPlugin.ts
@@ -29,13 +29,18 @@ function createOperations(
existingOperations: Set,
context: ICreateOperationsContext
): Set {
- const { projectsInUnknownState: changedProjects, phaseSelection, projectSelection } = context;
+ const {
+ projectsInUnknownState: changedProjects,
+ phaseOriginal,
+ phaseSelection,
+ projectSelection
+ } = context;
const operationsWithWork: Set = new Set();
const operations: Map = new Map();
// Create tasks for selected phases and projects
- for (const phase of phaseSelection) {
+ for (const phase of phaseOriginal) {
for (const project of projectSelection) {
getOrCreateOperation(phase, project);
}
diff --git a/libraries/rush-lib/src/logic/operations/ProjectLogWritable.ts b/libraries/rush-lib/src/logic/operations/ProjectLogWritable.ts
index 0310f0c6269..838811c41e4 100644
--- a/libraries/rush-lib/src/logic/operations/ProjectLogWritable.ts
+++ b/libraries/rush-lib/src/logic/operations/ProjectLogWritable.ts
@@ -13,8 +13,10 @@ export class ProjectLogWritable extends TerminalWritable {
private readonly _project: RushConfigurationProject;
private readonly _terminal: CollatedTerminal;
- private _logPath: string;
- private _errorLogPath: string;
+ public readonly logPath: string;
+ public readonly errorLogPath: string;
+ public readonly relativeLogPath: string;
+ public readonly relativeErrorLogPath: string;
private _logWriter: FileWriter | undefined = undefined;
private _errorLogWriter: FileWriter | undefined = undefined;
@@ -29,22 +31,35 @@ export class ProjectLogWritable extends TerminalWritable {
this._terminal = terminal;
function getLogFilePaths(
- basePath: string,
- logFilenameIdentifier: string
- ): { logPath: string; errorLogPath: string } {
+ projectFolder: string,
+ logFilenameIdentifier: string,
+ logFolder?: string
+ ): { logPath: string; errorLogPath: string; relativeLogPath: string; relativeErrorLogPath: string } {
const unscopedProjectName: string = PackageNameParsers.permissive.getUnscopedName(project.packageName);
+ const logFilename: string = `${unscopedProjectName}.${logFilenameIdentifier}.log`;
+ const errorLogFilename: string = `${unscopedProjectName}.${logFilenameIdentifier}.error.log`;
+
+ const relativeLogPath: string = logFolder ? `${logFolder}/${logFilename}` : logFilename;
+ const relativeErrorLogPath: string = logFolder ? `${logFolder}/${errorLogFilename}` : errorLogFilename;
+
+ const logPath: string = `${projectFolder}/${relativeLogPath}`;
+ const errorLogPath: string = `${projectFolder}/${relativeErrorLogPath}`;
return {
- logPath: `${basePath}/${unscopedProjectName}.${logFilenameIdentifier}.log`,
- errorLogPath: `${basePath}/${unscopedProjectName}.${logFilenameIdentifier}.error.log`
+ logPath,
+ errorLogPath,
+ relativeLogPath,
+ relativeErrorLogPath
};
}
const projectFolder: string = this._project.projectFolder;
- const { logPath: legacyLogPath, errorLogPath: legacyErrorLogPath } = getLogFilePaths(
- projectFolder,
- 'build'
- );
+ const {
+ logPath: legacyLogPath,
+ errorLogPath: legacyErrorLogPath,
+ relativeLogPath: legacyRelativeLogPath,
+ relativeErrorLogPath: legacyRelativeErrorLogPath
+ } = getLogFilePaths(projectFolder, 'build');
// If the phased commands experiment is enabled, put logs under `rush-logs`
if (project.rushConfiguration.experimentsConfiguration.configuration.phasedCommands) {
// Delete the legacy logs
@@ -54,18 +69,26 @@ export class ProjectLogWritable extends TerminalWritable {
const logPathPrefix: string = `${projectFolder}/${RushConstants.rushLogsFolderName}`;
FileSystem.ensureFolder(logPathPrefix);
- const { logPath, errorLogPath } = getLogFilePaths(logPathPrefix, logFilenameIdentifier);
- this._logPath = logPath;
- this._errorLogPath = errorLogPath;
+ const { logPath, errorLogPath, relativeLogPath, relativeErrorLogPath } = getLogFilePaths(
+ projectFolder,
+ logFilenameIdentifier,
+ RushConstants.rushLogsFolderName
+ );
+ this.logPath = logPath;
+ this.errorLogPath = errorLogPath;
+ this.relativeLogPath = relativeLogPath;
+ this.relativeErrorLogPath = relativeErrorLogPath;
} else {
- this._logPath = legacyLogPath;
- this._errorLogPath = legacyErrorLogPath;
+ this.logPath = legacyLogPath;
+ this.errorLogPath = legacyErrorLogPath;
+ this.relativeLogPath = legacyRelativeLogPath;
+ this.relativeErrorLogPath = legacyRelativeErrorLogPath;
}
- FileSystem.deleteFile(this._logPath);
- FileSystem.deleteFile(this._errorLogPath);
+ FileSystem.deleteFile(this.logPath);
+ FileSystem.deleteFile(this.errorLogPath);
- this._logWriter = FileWriter.open(this._logPath);
+ this._logWriter = FileWriter.open(this.logPath);
}
protected onWriteChunk(chunk: ITerminalChunk): void {
@@ -78,7 +101,7 @@ export class ProjectLogWritable extends TerminalWritable {
if (chunk.kind === TerminalChunkKind.Stderr) {
// Only stderr gets written to *..error.log
if (!this._errorLogWriter) {
- this._errorLogWriter = FileWriter.open(this._errorLogPath);
+ this._errorLogWriter = FileWriter.open(this.errorLogPath);
}
this._errorLogWriter.write(chunk.text);
}
diff --git a/libraries/rush-lib/src/logic/operations/ShellOperationRunner.ts b/libraries/rush-lib/src/logic/operations/ShellOperationRunner.ts
index 147b5609d5d..2dca3e01b37 100644
--- a/libraries/rush-lib/src/logic/operations/ShellOperationRunner.ts
+++ b/libraries/rush-lib/src/logic/operations/ShellOperationRunner.ts
@@ -29,15 +29,16 @@ import { OperationError } from './OperationError';
import { IOperationRunner, IOperationRunnerContext } from './IOperationRunner';
import { ProjectLogWritable } from './ProjectLogWritable';
import { ProjectBuildCache } from '../buildCache/ProjectBuildCache';
+import { getHashesForGlobsAsync } from '../buildCache/getHashesForGlobsAsync';
import { IOperationSettings, RushProjectConfiguration } from '../../api/RushProjectConfiguration';
import { CollatedTerminalProvider } from '../../utilities/CollatedTerminalProvider';
import { RushConstants } from '../RushConstants';
import { EnvironmentConfiguration } from '../../api/EnvironmentConfiguration';
-import { OperationStateFile } from './OperationStateFile';
+import { OperationMetadataManager } from './OperationMetadataManager';
import type { RushConfiguration } from '../../api/RushConfiguration';
import type { RushConfigurationProject } from '../../api/RushConfigurationProject';
-import type { ProjectChangeAnalyzer } from '../ProjectChangeAnalyzer';
+import type { ProjectChangeAnalyzer, IRawRepoState } from '../ProjectChangeAnalyzer';
import type { BuildCacheConfiguration } from '../../api/BuildCacheConfiguration';
import type { IPhase } from '../../api/CommandLineConfiguration';
@@ -208,17 +209,17 @@ export class ShellOperationRunner implements IOperationRunner {
}
let projectDeps: IProjectDeps | undefined;
- let trackedFiles: string[] | undefined;
+ let trackedProjectFiles: string[] | undefined;
try {
const fileHashes: Map | undefined =
await this._projectChangeAnalyzer._tryGetProjectDependenciesAsync(this._rushProject, terminal);
if (fileHashes) {
const files: { [filePath: string]: string } = {};
- trackedFiles = [];
+ trackedProjectFiles = [];
for (const [filePath, fileHash] of fileHashes) {
files[filePath] = fileHash;
- trackedFiles.push(filePath);
+ trackedProjectFiles.push(filePath);
}
projectDeps = {
@@ -264,10 +265,11 @@ export class ShellOperationRunner implements IOperationRunner {
//
let buildCacheReadAttempted: boolean = false;
if (this._isCacheReadAllowed) {
- const projectBuildCache: ProjectBuildCache | undefined = await this._tryGetProjectBuildCacheAsync(
+ const projectBuildCache: ProjectBuildCache | undefined = await this._tryGetProjectBuildCacheAsync({
terminal,
- trackedFiles
- );
+ trackedProjectFiles,
+ operationMetadataManager: context._operationMetadataManager
+ });
buildCacheReadAttempted = !!projectBuildCache;
const restoreFromCacheSuccess: boolean | undefined =
@@ -275,7 +277,11 @@ export class ShellOperationRunner implements IOperationRunner {
if (restoreFromCacheSuccess) {
// Restore the original state of the operation without cache
- await context._operationStateFile?.tryRestoreAsync();
+ await context._operationMetadataManager?.tryRestoreAsync({
+ terminal,
+ logPath: projectLogWritable.logPath,
+ errorLogPath: projectLogWritable.errorLogPath
+ });
return OperationStatus.FromCache;
}
}
@@ -373,18 +379,24 @@ export class ShellOperationRunner implements IOperationRunner {
ensureFolderExists: true
});
- // If the operation without cache was successful, we can save the state to disk
+ // If the operation without cache was successful, we can save the metadata to disk
const { duration: durationInSeconds } = context.stopwatch;
- await context._operationStateFile?.writeAsync({
- nonCachedDurationMs: durationInSeconds * 1000
+ await context._operationMetadataManager?.saveAsync({
+ durationInSeconds,
+ logPath: projectLogWritable.logPath,
+ errorLogPath: projectLogWritable.errorLogPath
});
// If the command is successful, we can calculate project hash, and no dependencies were skipped,
// write a new cache entry.
const setCacheEntryPromise: Promise | undefined = this.isCacheWriteAllowed
- ? (await this._tryGetProjectBuildCacheAsync(terminal, trackedFiles))?.trySetCacheEntryAsync(
- terminal
- )
+ ? (
+ await this._tryGetProjectBuildCacheAsync({
+ terminal,
+ trackedProjectFiles,
+ operationMetadataManager: context._operationMetadataManager
+ })
+ )?.trySetCacheEntryAsync(terminal)
: undefined;
const [, cacheWriteSuccess] = await Promise.all([writeProjectStatePromise, setCacheEntryPromise]);
@@ -410,10 +422,15 @@ export class ShellOperationRunner implements IOperationRunner {
}
}
- private async _tryGetProjectBuildCacheAsync(
- terminal: ITerminal,
- trackedProjectFiles: string[] | undefined
- ): Promise {
+ private async _tryGetProjectBuildCacheAsync({
+ terminal,
+ trackedProjectFiles,
+ operationMetadataManager
+ }: {
+ terminal: ITerminal;
+ trackedProjectFiles: string[] | undefined;
+ operationMetadataManager: OperationMetadataManager | undefined;
+ }): Promise {
if (this._projectBuildCache === UNINITIALIZED) {
this._projectBuildCache = undefined;
@@ -442,7 +459,7 @@ export class ShellOperationRunner implements IOperationRunner {
const projectOutputFolderNames: ReadonlyArray =
operationSettings.outputFolderNames || [];
const additionalProjectOutputFilePaths: ReadonlyArray = [
- OperationStateFile.getFilenameRelativeToProjectRoot(this._phase)
+ ...(operationMetadataManager?.relativeFilepaths || [])
];
const additionalContext: Record = {};
if (operationSettings.dependsOnEnvVars) {
@@ -450,6 +467,27 @@ export class ShellOperationRunner implements IOperationRunner {
additionalContext['$' + varName] = process.env[varName] || '';
}
}
+
+ if (operationSettings.dependsOnAdditionalFiles) {
+ const repoState: IRawRepoState | undefined =
+ await this._projectChangeAnalyzer._ensureInitializedAsync(terminal);
+
+ const additionalFiles: Map = await getHashesForGlobsAsync(
+ operationSettings.dependsOnAdditionalFiles,
+ this._rushProject.projectFolder,
+ repoState
+ );
+
+ terminal.writeDebugLine(
+ `Including additional files to calculate build cache hash:\n ${Array.from(
+ additionalFiles.keys()
+ ).join('\n ')} `
+ );
+
+ for (const [filePath, fileHash] of additionalFiles) {
+ additionalContext['file://' + filePath] = fileHash;
+ }
+ }
this._projectBuildCache = await ProjectBuildCache.tryGetProjectBuildCache({
projectConfiguration,
projectOutputFolderNames,
diff --git a/libraries/rush-lib/src/logic/operations/ShellOperationRunnerPlugin.ts b/libraries/rush-lib/src/logic/operations/ShellOperationRunnerPlugin.ts
index 31129619a28..d070fc1588b 100644
--- a/libraries/rush-lib/src/logic/operations/ShellOperationRunnerPlugin.ts
+++ b/libraries/rush-lib/src/logic/operations/ShellOperationRunnerPlugin.ts
@@ -61,7 +61,12 @@ function createShellOperations(
// to specify a runner type requested in rush-project.json
const customParameterValues: ReadonlyArray = getCustomParameterValuesForPhase(phase);
- const commandToRun: string | undefined = getScriptToRun(project, phase.name, customParameterValues);
+ const commandToRun: string | undefined = getScriptToRun(
+ project,
+ phase.name,
+ customParameterValues,
+ phase.shellCommand
+ );
if (commandToRun === undefined && !phase.ignoreMissingScript) {
throw new Error(
@@ -100,11 +105,12 @@ function createShellOperations(
function getScriptToRun(
rushProject: RushConfigurationProject,
commandToRun: string,
- customParameterValues: ReadonlyArray
+ customParameterValues: ReadonlyArray,
+ shellCommand: string | undefined
): string | undefined {
const { scripts } = rushProject.packageJson;
- const rawCommand: string | undefined | null = scripts?.[commandToRun];
+ const rawCommand: string | undefined | null = shellCommand ?? scripts?.[commandToRun];
if (rawCommand === undefined || rawCommand === null) {
return undefined;
diff --git a/libraries/rush-lib/src/logic/operations/test/PhasedOperationPlugin.test.ts b/libraries/rush-lib/src/logic/operations/test/PhasedOperationPlugin.test.ts
index 62b2a308a18..2d5b46c79ec 100644
--- a/libraries/rush-lib/src/logic/operations/test/PhasedOperationPlugin.test.ts
+++ b/libraries/rush-lib/src/logic/operations/test/PhasedOperationPlugin.test.ts
@@ -68,8 +68,9 @@ describe(PhasedOperationPlugin.name, () => {
const context: Pick<
ICreateOperationsContext,
- 'phaseSelection' | 'projectSelection' | 'projectsInUnknownState'
+ 'phaseOriginal' | 'phaseSelection' | 'projectSelection' | 'projectsInUnknownState'
> = {
+ phaseOriginal: phaseSelection,
phaseSelection,
projectSelection,
projectsInUnknownState: changedProjects
diff --git a/libraries/rush-lib/src/logic/operations/test/ShellOperationRunnerPlugin.test.ts b/libraries/rush-lib/src/logic/operations/test/ShellOperationRunnerPlugin.test.ts
new file mode 100644
index 00000000000..96fe059ee21
--- /dev/null
+++ b/libraries/rush-lib/src/logic/operations/test/ShellOperationRunnerPlugin.test.ts
@@ -0,0 +1,112 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+import path from 'path';
+import { JsonFile } from '@rushstack/node-core-library';
+
+import { RushConfiguration } from '../../../api/RushConfiguration';
+import { CommandLineConfiguration, IPhasedCommandConfig } from '../../../api/CommandLineConfiguration';
+import { Operation } from '../Operation';
+import { ICommandLineJson } from '../../../api/CommandLineJson';
+import { PhasedOperationPlugin } from '../PhasedOperationPlugin';
+import { ShellOperationRunnerPlugin } from '../ShellOperationRunnerPlugin';
+import { ICreateOperationsContext, PhasedCommandHooks } from '../../../pluginFramework/PhasedCommandHooks';
+import { ShellOperationRunner } from '../ShellOperationRunner';
+
+interface ISerializedOperation {
+ name: string;
+ commandToRun: string;
+}
+
+function serializeOperation(operation: Operation): ISerializedOperation {
+ return {
+ name: operation.name!,
+ commandToRun: (operation.runner as ShellOperationRunner)['_commandToRun']
+ };
+}
+
+describe(ShellOperationRunnerPlugin.name, () => {
+ it('shellCommand "echo custom shellCommand" should be set to commandToRun', async () => {
+ const rushJsonFile: string = path.resolve(__dirname, `../../test/customShellCommandinBulkRepo/rush.json`);
+ const commandLineJsonFile: string = path.resolve(
+ __dirname,
+ `../../test/customShellCommandinBulkRepo/common/config/rush/command-line.json`
+ );
+
+ const rushConfiguration = RushConfiguration.loadFromConfigurationFile(rushJsonFile);
+ const commandLineJson: ICommandLineJson = JsonFile.load(commandLineJsonFile);
+
+ const commandLineConfiguration = new CommandLineConfiguration(commandLineJson);
+
+ const echoCommand: IPhasedCommandConfig = commandLineConfiguration.commands.get(
+ 'echo'
+ )! as IPhasedCommandConfig;
+
+ const fakeCreateOperationsContext: Pick<
+ ICreateOperationsContext,
+ 'phaseOriginal' | 'phaseSelection' | 'projectSelection' | 'projectsInUnknownState'
+ > = {
+ phaseOriginal: echoCommand.phases,
+ phaseSelection: echoCommand.phases,
+ projectSelection: new Set(rushConfiguration.projects),
+ projectsInUnknownState: new Set(rushConfiguration.projects)
+ };
+
+ const hooks: PhasedCommandHooks = new PhasedCommandHooks();
+
+ // Generates the default operation graph
+ new PhasedOperationPlugin().apply(hooks);
+ // Applies the Shell Operation Runner to selected operations
+ new ShellOperationRunnerPlugin().apply(hooks);
+
+ const operations: Set = await hooks.createOperations.promise(
+ new Set(),
+ fakeCreateOperationsContext as ICreateOperationsContext
+ );
+ // All projects
+ expect(Array.from(operations, serializeOperation)).toMatchSnapshot();
+ });
+
+ it('shellCommand priority should be higher than script name', async () => {
+ const rushJsonFile: string = path.resolve(
+ __dirname,
+ `../../test/customShellCommandinBulkOverrideScriptsRepo/rush.json`
+ );
+ const commandLineJsonFile: string = path.resolve(
+ __dirname,
+ `../../test/customShellCommandinBulkOverrideScriptsRepo/common/config/rush/command-line.json`
+ );
+
+ const rushConfiguration = RushConfiguration.loadFromConfigurationFile(rushJsonFile);
+ const commandLineJson: ICommandLineJson = JsonFile.load(commandLineJsonFile);
+
+ const commandLineConfiguration = new CommandLineConfiguration(commandLineJson);
+ const echoCommand: IPhasedCommandConfig = commandLineConfiguration.commands.get(
+ 'echo'
+ )! as IPhasedCommandConfig;
+
+ const fakeCreateOperationsContext: Pick<
+ ICreateOperationsContext,
+ 'phaseOriginal' | 'phaseSelection' | 'projectSelection' | 'projectsInUnknownState'
+ > = {
+ phaseOriginal: echoCommand.phases,
+ phaseSelection: echoCommand.phases,
+ projectSelection: new Set(rushConfiguration.projects),
+ projectsInUnknownState: new Set(rushConfiguration.projects)
+ };
+
+ const hooks: PhasedCommandHooks = new PhasedCommandHooks();
+
+ // Generates the default operation graph
+ new PhasedOperationPlugin().apply(hooks);
+ // Applies the Shell Operation Runner to selected operations
+ new ShellOperationRunnerPlugin().apply(hooks);
+
+ const operations: Set = await hooks.createOperations.promise(
+ new Set(),
+ fakeCreateOperationsContext as ICreateOperationsContext
+ );
+ // All projects
+ expect(Array.from(operations, serializeOperation)).toMatchSnapshot();
+ });
+});
diff --git a/libraries/rush-lib/src/logic/operations/test/__snapshots__/ShellOperationRunnerPlugin.test.ts.snap b/libraries/rush-lib/src/logic/operations/test/__snapshots__/ShellOperationRunnerPlugin.test.ts.snap
new file mode 100644
index 00000000000..f5990af4d43
--- /dev/null
+++ b/libraries/rush-lib/src/logic/operations/test/__snapshots__/ShellOperationRunnerPlugin.test.ts.snap
@@ -0,0 +1,27 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`ShellOperationRunnerPlugin shellCommand "echo custom shellCommand" should be set to commandToRun 1`] = `
+Array [
+ Object {
+ "commandToRun": "echo custom shellCommand ",
+ "name": "a",
+ },
+ Object {
+ "commandToRun": "echo custom shellCommand ",
+ "name": "b",
+ },
+]
+`;
+
+exports[`ShellOperationRunnerPlugin shellCommand priority should be higher than script name 1`] = `
+Array [
+ Object {
+ "commandToRun": "echo custom shellCommand ",
+ "name": "a",
+ },
+ Object {
+ "commandToRun": "echo custom shellCommand ",
+ "name": "b",
+ },
+]
+`;
diff --git a/libraries/rush-lib/src/logic/pnpm/PnpmLinkManager.ts b/libraries/rush-lib/src/logic/pnpm/PnpmLinkManager.ts
index 273221771be..43599b6c748 100644
--- a/libraries/rush-lib/src/logic/pnpm/PnpmLinkManager.ts
+++ b/libraries/rush-lib/src/logic/pnpm/PnpmLinkManager.ts
@@ -6,6 +6,7 @@ import * as crypto from 'crypto';
import uriEncode from 'strict-uri-encode';
import pnpmLinkBins from '@pnpm/link-bins';
import * as semver from 'semver';
+import { depPathToFilename } from 'dependency-path';
import colors from 'colors/safe';
import {
@@ -217,6 +218,7 @@ export class PnpmLinkManager extends BaseLinkManager {
// e.g.: C:\wbt\common\temp\node_modules\.local\C%3A%2Fwbt%2Fcommon%2Ftemp%2Fprojects%2Fapi-documenter.tgz\node_modules
const pathToLocalInstallation: string = this._getPathToLocalInstallation(
+ tarballEntry,
absolutePathToTgzFile,
folderNameSuffix
);
@@ -272,8 +274,12 @@ export class PnpmLinkManager extends BaseLinkManager {
});
}
- private _getPathToLocalInstallation(absolutePathToTgzFile: string, folderSuffix: string): string {
- if (this._pnpmVersion.major >= 6) {
+ private _getPathToLocalInstallation(
+ tarballEntry: string,
+ absolutePathToTgzFile: string,
+ folderSuffix: string
+ ): string {
+ if (this._pnpmVersion.major === 6) {
// PNPM 6 changed formatting to replace all ':' and '/' chars with '+'. Additionally, folder names > 120
// are trimmed and hashed. NOTE: PNPM internally uses fs.realpath.native, which will cause additional
// issues in environments that do not support long paths.
@@ -294,6 +300,20 @@ export class PnpmLinkManager extends BaseLinkManager {
.digest('hex')}`;
}
+ return path.join(
+ this._rushConfiguration.commonTempFolder,
+ RushConstants.nodeModulesFolderName,
+ '.pnpm',
+ folderName,
+ RushConstants.nodeModulesFolderName
+ );
+ } else if (this._pnpmVersion.major >= 7) {
+ // PNPM 7 changed the local path format again and the hashing algorithm
+ // See https://github.com/pnpm/pnpm/releases/tag/v7.0.0
+ // e.g.:
+ // file+projects+presentation-integration-tests.tgz_jsdom@11.12.0
+ const escapedLocalPath: string = depPathToFilename(tarballEntry);
+ const folderName: string = `${escapedLocalPath}${folderSuffix}`;
return path.join(
this._rushConfiguration.commonTempFolder,
RushConstants.nodeModulesFolderName,
diff --git a/libraries/rush-lib/src/logic/test/LookupByPath.test.ts b/libraries/rush-lib/src/logic/test/LookupByPath.test.ts
index 0329ac2315c..5b4cbeed881 100644
--- a/libraries/rush-lib/src/logic/test/LookupByPath.test.ts
+++ b/libraries/rush-lib/src/logic/test/LookupByPath.test.ts
@@ -101,3 +101,37 @@ describe(LookupByPath.prototype.findChildPath.name, () => {
expect(tree.findChildPathFromSegments(['foo', 'bar', 'baz'])).toEqual(1);
});
});
+
+describe(LookupByPath.prototype.findLongestPrefixMatch.name, () => {
+ it('returns empty for an empty tree', () => {
+ expect(new LookupByPath().findLongestPrefixMatch('foo')).toEqual(undefined);
+ });
+ it('returns the matching node for a trivial tree', () => {
+ expect(new LookupByPath([['foo', 1]]).findLongestPrefixMatch('foo')).toEqual({ value: 1, index: 3 });
+ });
+ it('returns the matching node for a single-layer tree', () => {
+ const tree: LookupByPath = new LookupByPath([
+ ['foo', 1],
+ ['barbar', 2],
+ ['baz', 3]
+ ]);
+
+ expect(tree.findLongestPrefixMatch('foo')).toEqual({ value: 1, index: 3 });
+ expect(tree.findLongestPrefixMatch('barbar')).toEqual({ value: 2, index: 6 });
+ expect(tree.findLongestPrefixMatch('baz')).toEqual({ value: 3, index: 3 });
+ expect(tree.findLongestPrefixMatch('buzz')).toEqual(undefined);
+ });
+ it('returns the matching parent for multi-layer queries', () => {
+ const tree: LookupByPath = new LookupByPath([
+ ['foo', 1],
+ ['barbar', 2],
+ ['baz', 3],
+ ['foo/bar', 4]
+ ]);
+
+ expect(tree.findLongestPrefixMatch('foo/bar')).toEqual({ value: 4, index: 7 });
+ expect(tree.findLongestPrefixMatch('barbar/baz')).toEqual({ value: 2, index: 6 });
+ expect(tree.findLongestPrefixMatch('baz/foo')).toEqual({ value: 3, index: 3 });
+ expect(tree.findLongestPrefixMatch('foo/foo')).toEqual({ value: 1, index: 3 });
+ });
+});
diff --git a/libraries/rush-lib/src/logic/test/ProjectChangeAnalyzer.test.ts b/libraries/rush-lib/src/logic/test/ProjectChangeAnalyzer.test.ts
index 47a5818cd52..326e1d09006 100644
--- a/libraries/rush-lib/src/logic/test/ProjectChangeAnalyzer.test.ts
+++ b/libraries/rush-lib/src/logic/test/ProjectChangeAnalyzer.test.ts
@@ -46,12 +46,12 @@ describe(ProjectChangeAnalyzer.name, () => {
const subject: ProjectChangeAnalyzer = new ProjectChangeAnalyzer(rushConfiguration);
- subject['_getRepoDeps'] = jest.fn(() => {
- return {
+ subject['_getRepoDepsAsync'] = jest.fn(() => {
+ return Promise.resolve({
gitPath: 'git',
hashes: files,
rootDir: ''
- };
+ });
});
return subject;
@@ -255,7 +255,7 @@ describe(ProjectChangeAnalyzer.name, () => {
expect(await subject._tryGetProjectDependenciesAsync(projects[0], terminal)).toEqual(
new Map([['apps/apple/core.js', 'a101']])
);
- expect(subject['_getRepoDeps']).toHaveBeenCalledTimes(1);
+ expect(subject['_getRepoDepsAsync']).toHaveBeenCalledTimes(1);
});
});
diff --git a/libraries/rush-lib/src/logic/test/customShellCommandinBulkOverrideScriptsRepo/a/package.json b/libraries/rush-lib/src/logic/test/customShellCommandinBulkOverrideScriptsRepo/a/package.json
new file mode 100644
index 00000000000..f00575e3099
--- /dev/null
+++ b/libraries/rush-lib/src/logic/test/customShellCommandinBulkOverrideScriptsRepo/a/package.json
@@ -0,0 +1,9 @@
+{
+ "name": "a",
+ "version": "1.0.0",
+ "description": "Test package a",
+ "scripts": {
+ "build": "fake_build_task_but_works_with_mock",
+ "rebuild": "fake_REbuild_task_but_works_with_mock"
+ }
+}
diff --git a/libraries/rush-lib/src/logic/test/customShellCommandinBulkOverrideScriptsRepo/b/package.json b/libraries/rush-lib/src/logic/test/customShellCommandinBulkOverrideScriptsRepo/b/package.json
new file mode 100644
index 00000000000..8b915354e7c
--- /dev/null
+++ b/libraries/rush-lib/src/logic/test/customShellCommandinBulkOverrideScriptsRepo/b/package.json
@@ -0,0 +1,10 @@
+{
+ "name": "b",
+ "version": "1.0.0",
+ "description": "Test package b",
+ "scripts": {
+ "build": "fake_build_task_but_works_with_mock",
+ "rebuild": "fake_REbuild_task_but_works_with_mock",
+ "echo": "fake_echo_task_but_works_with_mock"
+ }
+}
diff --git a/libraries/rush-lib/src/logic/test/customShellCommandinBulkOverrideScriptsRepo/common/config/rush/command-line.json b/libraries/rush-lib/src/logic/test/customShellCommandinBulkOverrideScriptsRepo/common/config/rush/command-line.json
new file mode 100644
index 00000000000..4070ff96146
--- /dev/null
+++ b/libraries/rush-lib/src/logic/test/customShellCommandinBulkOverrideScriptsRepo/common/config/rush/command-line.json
@@ -0,0 +1,21 @@
+{
+ "$schema": "https://developer.microsoft.com/json-schemas/rush/v5/command-line.schema.json",
+ "commands": [
+ {
+ "commandKind": "bulk",
+ "name": "echo",
+ "summary": "execute 'echo' command",
+ "description": "execute 'echo' command for selected project",
+ "enableParallelism": true,
+ "shellCommand": "echo custom shellCommand"
+ }
+ ],
+ "parameters": [
+ {
+ "longName": "--flag-for-echo",
+ "description": "This flag should be usable for build and rebuild commands.",
+ "parameterKind": "flag",
+ "associatedCommands": ["echo"]
+ }
+ ]
+}
diff --git a/libraries/rush-lib/src/logic/test/customShellCommandinBulkOverrideScriptsRepo/rush.json b/libraries/rush-lib/src/logic/test/customShellCommandinBulkOverrideScriptsRepo/rush.json
new file mode 100644
index 00000000000..f39da1606c4
--- /dev/null
+++ b/libraries/rush-lib/src/logic/test/customShellCommandinBulkOverrideScriptsRepo/rush.json
@@ -0,0 +1,17 @@
+{
+ "npmVersion": "6.4.1",
+ "rushVersion": "5.5.2",
+ "projectFolderMinDepth": 1,
+ "projectFolderMaxDepth": 99,
+
+ "projects": [
+ {
+ "packageName": "a",
+ "projectFolder": "a"
+ },
+ {
+ "packageName": "b",
+ "projectFolder": "b"
+ }
+ ]
+}
diff --git a/libraries/rush-lib/src/logic/test/customShellCommandinBulkRepo/a/package.json b/libraries/rush-lib/src/logic/test/customShellCommandinBulkRepo/a/package.json
new file mode 100644
index 00000000000..f00575e3099
--- /dev/null
+++ b/libraries/rush-lib/src/logic/test/customShellCommandinBulkRepo/a/package.json
@@ -0,0 +1,9 @@
+{
+ "name": "a",
+ "version": "1.0.0",
+ "description": "Test package a",
+ "scripts": {
+ "build": "fake_build_task_but_works_with_mock",
+ "rebuild": "fake_REbuild_task_but_works_with_mock"
+ }
+}
diff --git a/libraries/rush-lib/src/logic/test/customShellCommandinBulkRepo/b/package.json b/libraries/rush-lib/src/logic/test/customShellCommandinBulkRepo/b/package.json
new file mode 100644
index 00000000000..8f203bb691d
--- /dev/null
+++ b/libraries/rush-lib/src/logic/test/customShellCommandinBulkRepo/b/package.json
@@ -0,0 +1,9 @@
+{
+ "name": "b",
+ "version": "1.0.0",
+ "description": "Test package b",
+ "scripts": {
+ "build": "fake_build_task_but_works_with_mock",
+ "rebuild": "fake_REbuild_task_but_works_with_mock"
+ }
+}
diff --git a/libraries/rush-lib/src/logic/test/customShellCommandinBulkRepo/common/config/rush/command-line.json b/libraries/rush-lib/src/logic/test/customShellCommandinBulkRepo/common/config/rush/command-line.json
new file mode 100644
index 00000000000..4070ff96146
--- /dev/null
+++ b/libraries/rush-lib/src/logic/test/customShellCommandinBulkRepo/common/config/rush/command-line.json
@@ -0,0 +1,21 @@
+{
+ "$schema": "https://developer.microsoft.com/json-schemas/rush/v5/command-line.schema.json",
+ "commands": [
+ {
+ "commandKind": "bulk",
+ "name": "echo",
+ "summary": "execute 'echo' command",
+ "description": "execute 'echo' command for selected project",
+ "enableParallelism": true,
+ "shellCommand": "echo custom shellCommand"
+ }
+ ],
+ "parameters": [
+ {
+ "longName": "--flag-for-echo",
+ "description": "This flag should be usable for build and rebuild commands.",
+ "parameterKind": "flag",
+ "associatedCommands": ["echo"]
+ }
+ ]
+}
diff --git a/libraries/rush-lib/src/logic/test/customShellCommandinBulkRepo/rush.json b/libraries/rush-lib/src/logic/test/customShellCommandinBulkRepo/rush.json
new file mode 100644
index 00000000000..f39da1606c4
--- /dev/null
+++ b/libraries/rush-lib/src/logic/test/customShellCommandinBulkRepo/rush.json
@@ -0,0 +1,17 @@
+{
+ "npmVersion": "6.4.1",
+ "rushVersion": "5.5.2",
+ "projectFolderMinDepth": 1,
+ "projectFolderMaxDepth": 99,
+
+ "projects": [
+ {
+ "packageName": "a",
+ "projectFolder": "a"
+ },
+ {
+ "packageName": "b",
+ "projectFolder": "b"
+ }
+ ]
+}
diff --git a/libraries/rush-lib/src/pluginFramework/PhasedCommandHooks.ts b/libraries/rush-lib/src/pluginFramework/PhasedCommandHooks.ts
index 1c2e893b67d..a38b9870135 100644
--- a/libraries/rush-lib/src/pluginFramework/PhasedCommandHooks.ts
+++ b/libraries/rush-lib/src/pluginFramework/PhasedCommandHooks.ts
@@ -11,7 +11,7 @@ import type { RushConfigurationProject } from '../api/RushConfigurationProject';
import type { Operation } from '../logic/operations/Operation';
import type { ProjectChangeAnalyzer } from '../logic/ProjectChangeAnalyzer';
-import { IExecutionResult } from '../logic/operations/IOperationExecutionResult';
+import { IExecutionResult, IOperationExecutionResult } from '../logic/operations/IOperationExecutionResult';
/**
* A plugin that interacts with a phased commands.
@@ -52,6 +52,10 @@ export interface ICreateOperationsContext {
* If true, the command is running in watch mode.
*/
readonly isWatch: boolean;
+ /**
+ * The set of phases original for the current command execution.
+ */
+ readonly phaseOriginal: ReadonlySet;
/**
* The set of phases selected for the current command execution.
*/
@@ -87,6 +91,19 @@ export class PhasedCommandHooks {
public readonly createOperations: AsyncSeriesWaterfallHook<[Set, ICreateOperationsContext]> =
new AsyncSeriesWaterfallHook(['operations', 'context'], 'createOperations');
+ /**
+ * Hook invoked before operation start
+ * Hook is series for stable output.
+ */
+ public readonly beforeExecuteOperations: AsyncSeriesHook<[Map]> =
+ new AsyncSeriesHook(['records']);
+
+ /**
+ * Hook invoked when operation status changed
+ * Hook is series for stable output.
+ */
+ public readonly onOperationStatusChanged: SyncHook<[IOperationExecutionResult]> = new SyncHook(['record']);
+
/**
* Hook invoked after executing a set of operations.
* Use the context to distinguish between the initial run and phased runs.
diff --git a/libraries/rush-lib/src/pluginFramework/PluginLoader/AutoinstallerPluginLoader.ts b/libraries/rush-lib/src/pluginFramework/PluginLoader/AutoinstallerPluginLoader.ts
index adcfac85586..07a8d165247 100644
--- a/libraries/rush-lib/src/pluginFramework/PluginLoader/AutoinstallerPluginLoader.ts
+++ b/libraries/rush-lib/src/pluginFramework/PluginLoader/AutoinstallerPluginLoader.ts
@@ -13,9 +13,11 @@ import {
IRushPluginManifestJson,
PluginLoaderBase
} from './PluginLoaderBase';
+import type { RushGlobalFolder } from '../../api/RushGlobalFolder';
interface IAutoinstallerPluginLoaderOptions extends IPluginLoaderOptions {
restrictConsoleOutput: boolean;
+ rushGlobalFolder: RushGlobalFolder;
}
/**
@@ -31,7 +33,8 @@ export class AutoinstallerPluginLoader extends PluginLoaderBase;
private readonly _loadedPluginNames: Set = new Set();
+ private readonly _rushGlobalFolder: RushGlobalFolder;
private _error: Error | undefined;
@@ -42,6 +45,7 @@ export class PluginManager {
this._rushConfiguration = options.rushConfiguration;
this._rushSession = options.rushSession;
this._restrictConsoleOutput = options.restrictConsoleOutput;
+ this._rushGlobalFolder = options.rushGlobalFolder;
this._installedAutoinstallerNames = new Set();
@@ -98,7 +102,8 @@ export class PluginManager {
pluginConfiguration,
rushConfiguration: this._rushConfiguration,
terminal: this._terminal,
- restrictConsoleOutput: this._restrictConsoleOutput
+ restrictConsoleOutput: this._restrictConsoleOutput,
+ rushGlobalFolder: this._rushGlobalFolder
});
});
}
diff --git a/libraries/rush-lib/src/schemas/command-line.schema.json b/libraries/rush-lib/src/schemas/command-line.schema.json
index a1a27511adb..3499274d003 100644
--- a/libraries/rush-lib/src/schemas/command-line.schema.json
+++ b/libraries/rush-lib/src/schemas/command-line.schema.json
@@ -56,6 +56,11 @@
"commandKind": {
"enum": ["bulk"]
},
+ "shellCommand": {
+ "title": "Shell Command",
+ "description": "(Optional) If the \"shellCommand\" field is set for a bulk command, Rush will invoke it for each selected project; otherwise, Rush will invoke the package.json \"scripts\" entry matching Rush command name.\n\nThe string is the path to a script that will be invoked using the OS shell. The working directory will be the folder that contains rush.json. If custom parameters are associated with this command, their values will be appended to the end of this string.",
+ "type": "string"
+ },
"enableParallelism": {
"title": "enableParallelism",
"description": "If true then this command can be run in parallel, i.e. executed simultaneously for multiple projects.",
@@ -102,6 +107,7 @@
"summary": { "$ref": "#/definitions/anything" },
"description": { "$ref": "#/definitions/anything" },
"safeForSimultaneousRushProcesses": { "$ref": "#/definitions/anything" },
+ "shellCommand": { "$ref": "#/definitions/anything" },
"enableParallelism": { "$ref": "#/definitions/anything" },
"ignoreDependencyOrder": { "$ref": "#/definitions/anything" },
diff --git a/libraries/rush-lib/src/schemas/experiments.schema.json b/libraries/rush-lib/src/schemas/experiments.schema.json
index caff117b104..bb1e8e92602 100644
--- a/libraries/rush-lib/src/schemas/experiments.schema.json
+++ b/libraries/rush-lib/src/schemas/experiments.schema.json
@@ -37,6 +37,10 @@
"cleanInstallAfterNpmrcChanges": {
"description": "If true, perform a clean install after when running `rush install` or `rush update` if the `.npmrc` file has changed since the last install.",
"type": "boolean"
+ },
+ "printEventHooksOutputToConsole": {
+ "description": "If true, print the outputs of shell commands defined in event hooks to the console.",
+ "type": "boolean"
}
},
"additionalProperties": false
diff --git a/libraries/rush-lib/src/schemas/rush-project.schema.json b/libraries/rush-lib/src/schemas/rush-project.schema.json
index 6b163cfd04f..d309a568e45 100644
--- a/libraries/rush-lib/src/schemas/rush-project.schema.json
+++ b/libraries/rush-lib/src/schemas/rush-project.schema.json
@@ -60,6 +60,15 @@
"uniqueItems": true
},
+ "dependsOnAdditionalFiles": {
+ "type": "array",
+ "description": "Specify a list of glob (minimatch) paths (absolute or relative) pointing to files (within or outside the .git repository) that affect the output of this operation. If provided, the hash values of these files will become part of the final hash when reading and writing from cache.",
+ "items": {
+ "type": "string"
+ },
+ "uniqueItems": true
+ },
+
"disableBuildCacheForOperation": {
"description": "Disable caching for this operation. The operation will never be restored from cache. This may be useful if this operation affects state outside of its folder.",
"type": "boolean"
diff --git a/libraries/rush-lib/src/utilities/AsyncRecycler.ts b/libraries/rush-lib/src/utilities/AsyncRecycler.ts
index 6c7cea8f09f..af7f136a4ce 100644
--- a/libraries/rush-lib/src/utilities/AsyncRecycler.ts
+++ b/libraries/rush-lib/src/utilities/AsyncRecycler.ts
@@ -2,10 +2,11 @@
// See LICENSE in the project root for license information.
import * as child_process from 'child_process';
+import * as fs from 'fs';
import * as os from 'os';
import * as path from 'path';
-import { Text, Path, FileSystem, FileSystemStats } from '@rushstack/node-core-library';
+import { Text, Path, FileSystem } from '@rushstack/node-core-library';
import { Utilities } from './Utilities';
@@ -17,6 +18,7 @@ import { Utilities } from './Utilities';
export class AsyncRecycler {
private _movedFolderCount: number;
private _deleting: boolean;
+ private _prefix: string;
/**
* The full path of the recycler folder.
@@ -28,6 +30,7 @@ export class AsyncRecycler {
this.recyclerFolder = path.resolve(recyclerFolder);
this._movedFolderCount = 0;
this._deleting = false;
+ this._prefix = `${Date.now()}`;
}
/**
@@ -50,22 +53,17 @@ export class AsyncRecycler {
++this._movedFolderCount;
- // We need to do a simple "FileSystem.move" here, however if the folder we're trying to rename
+ // We need to do a simple "fs.renameSync" here, however if the folder we're trying to rename
// has a lock, or if its destination container doesn't exist yet,
// then there seems to be some OS process (virus scanner?) that holds
// a lock on the folder for a split second, which causes renameSync to
// fail. To workaround that, retry for up to 7 seconds before giving up.
const maxWaitTimeMs: number = 7 * 1000;
- const oldFolderName: string = path.basename(folderPath);
- const newFolderPath: string = path.join(this.recyclerFolder, `${oldFolderName}_${new Date().getTime()}`);
-
- if (!FileSystem.exists(this.recyclerFolder)) {
- Utilities.createFolderWithRetry(this.recyclerFolder);
- }
+ Utilities.createFolderWithRetry(this.recyclerFolder);
Utilities.retryUntilTimeout(
- () => FileSystem.move({ sourcePath: folderPath, destinationPath: newFolderPath }),
+ () => this._renameOrRecurseInFolder(folderPath),
maxWaitTimeMs,
(e) =>
new Error(`Error: ${e}\nOften this is caused by a file lock from a process like the virus scanner.`),
@@ -83,20 +81,14 @@ export class AsyncRecycler {
const excludeSet: Set = new Set((membersToExclude || []).map((x) => x.toUpperCase()));
- for (const memberPath of FileSystem.readFolderItemNames(resolvedFolderPath, { absolutePaths: true })) {
- const normalizedMemberName: string = path.basename(memberPath).toUpperCase();
+ for (const dirent of FileSystem.readFolderItems(resolvedFolderPath)) {
+ const normalizedMemberName: string = dirent.name.toUpperCase();
if (!excludeSet.has(normalizedMemberName)) {
- let shouldMove: boolean = false;
- try {
- const stats: FileSystemStats = FileSystem.getLinkStatistics(memberPath);
- shouldMove = stats.isDirectory();
- } catch (error) {
- // If we fail to access the item, assume it's not a folder
- }
- if (shouldMove) {
- this.moveFolder(memberPath);
+ const absolutePath: string = path.resolve(folderPath, dirent.name);
+ if (dirent.isDirectory()) {
+ this._renameOrRecurseInFolder(absolutePath);
} else {
- FileSystem.deleteFolder(memberPath);
+ FileSystem.deleteFile(absolutePath);
}
}
}
@@ -179,4 +171,34 @@ export class AsyncRecycler {
// The child won't stay alive unless we unlink it from the parent process
process.unref();
}
+
+ private _renameOrRecurseInFolder(folderPath: string): void {
+ const ordinal: number = this._movedFolderCount++;
+ const targetDir: string = `${this.recyclerFolder}/${this._prefix}_${ordinal}`;
+ try {
+ fs.renameSync(folderPath, targetDir);
+ return;
+ } catch (err) {
+ if (FileSystem.isNotExistError(err)) {
+ return;
+ }
+
+ if (err.code !== 'EPERM') {
+ throw err;
+ }
+ }
+
+ const children: fs.Dirent[] = FileSystem.readFolderItems(folderPath);
+ for (const child of children) {
+ const absoluteChild: string = `${folderPath}/${child.name}`;
+ if (child.isDirectory()) {
+ this._renameOrRecurseInFolder(absoluteChild);
+ } else {
+ FileSystem.deleteFile(absoluteChild);
+ }
+ }
+
+ // Yes, this is a folder. The API deletes empty folders, too.
+ FileSystem.deleteFile(folderPath);
+ }
}
diff --git a/libraries/rush-lib/src/utilities/PathConstants.ts b/libraries/rush-lib/src/utilities/PathConstants.ts
index 167bdb8af24..c55551b5549 100644
--- a/libraries/rush-lib/src/utilities/PathConstants.ts
+++ b/libraries/rush-lib/src/utilities/PathConstants.ts
@@ -23,6 +23,7 @@ export const installRunScriptFilename: string = 'install-run.js';
export const installRunRushScriptFilename: string = 'install-run-rush.js';
export const installRunRushxScriptFilename: string = 'install-run-rushx.js';
export const installRunRushPnpmScriptFilename: string = 'install-run-rush-pnpm.js';
+export const createLinksScriptFilename: string = 'create-links.js';
/**
* The path to the scripts folder in rush-lib/dist.
diff --git a/libraries/rush-lib/src/utilities/SetRushLibPath.ts b/libraries/rush-lib/src/utilities/SetRushLibPath.ts
new file mode 100644
index 00000000000..ec18843e67b
--- /dev/null
+++ b/libraries/rush-lib/src/utilities/SetRushLibPath.ts
@@ -0,0 +1,12 @@
+import { PackageJsonLookup } from '@rushstack/node-core-library';
+
+import { EnvironmentVariableNames } from '../api/EnvironmentConfiguration';
+
+if (!process.env[EnvironmentVariableNames.RUSH_LIB_PATH]) {
+ const rootDir: string | undefined = PackageJsonLookup.instance.tryGetPackageFolderFor(__dirname);
+ if (rootDir) {
+ // Route to the 'main' field of package.json
+ const rushLibIndex: string = require.resolve(rootDir, { paths: [] });
+ process.env[EnvironmentVariableNames.RUSH_LIB_PATH] = rushLibIndex;
+ }
+}
diff --git a/libraries/rush-lib/src/utilities/Utilities.ts b/libraries/rush-lib/src/utilities/Utilities.ts
index ed8266e7331..9bbc1a3a0c0 100644
--- a/libraries/rush-lib/src/utilities/Utilities.ts
+++ b/libraries/rush-lib/src/utilities/Utilities.ts
@@ -338,7 +338,7 @@ export class Utilities {
environment?: IEnvironment,
keepEnvironment: boolean = false
): string {
- const result: child_process.SpawnSyncReturns = Utilities._executeCommandInternal(
+ const result: child_process.SpawnSyncReturns = Utilities._executeCommandInternal(
command,
args,
workingDirectory,
@@ -396,11 +396,8 @@ export class Utilities {
* @param options - options for how the command should be run
*/
public static executeLifecycleCommand(command: string, options: ILifecycleCommandOptions): number {
- const result: child_process.SpawnSyncReturns = Utilities._executeLifecycleCommandInternal(
- command,
- child_process.spawnSync,
- options
- );
+ const result: child_process.SpawnSyncReturns =
+ Utilities._executeLifecycleCommandInternal(command, child_process.spawnSync, options);
if (options.handleOutput) {
Utilities._processResult(result);
@@ -675,7 +672,7 @@ export class Utilities {
| undefined,
environment?: IEnvironment,
keepEnvironment: boolean = false
- ): child_process.SpawnSyncReturns {
+ ): child_process.SpawnSyncReturns {
const options: child_process.SpawnSyncOptions = {
cwd: workingDirectory,
shell: true,
@@ -704,7 +701,7 @@ export class Utilities {
const escapedArgs: string[] = args.map((x) => Utilities.escapeShellParameter(x));
- let result: child_process.SpawnSyncReturns = child_process.spawnSync(
+ let result: child_process.SpawnSyncReturns = child_process.spawnSync(
escapedCommand,
escapedArgs,
options
@@ -724,7 +721,7 @@ export class Utilities {
return result;
}
- private static _processResult(result: child_process.SpawnSyncReturns): void {
+ private static _processResult(result: child_process.SpawnSyncReturns): void {
if (result.error) {
result.error.message += '\n' + (result.stderr ? result.stderr.toString() + '\n' : '');
throw result.error;
diff --git a/libraries/rush-lib/webpack.config.js b/libraries/rush-lib/webpack.config.js
index 9857e2de4ea..8b47dcf2478 100644
--- a/libraries/rush-lib/webpack.config.js
+++ b/libraries/rush-lib/webpack.config.js
@@ -121,6 +121,10 @@ module.exports = () => {
[PathConstants.installRunRushPnpmScriptFilename]: {
import: `${__dirname}/lib-esnext/scripts/install-run-rush-pnpm.js`,
...SCRIPT_ENTRY_OPTIONS
+ },
+ [PathConstants.createLinksScriptFilename]: {
+ import: `${__dirname}/lib-esnext/scripts/create-links.js`,
+ ...SCRIPT_ENTRY_OPTIONS
}
})
];
diff --git a/libraries/rush-sdk/README.md b/libraries/rush-sdk/README.md
index c0322a3a390..73ec410e3c7 100644
--- a/libraries/rush-sdk/README.md
+++ b/libraries/rush-sdk/README.md
@@ -1,29 +1,66 @@
## @rushstack/rush-sdk
-This is a companion package for the Rush tool. See the [@microsoft/rush](https://www.npmjs.com/package/@microsoft/rush) package for details.
+This is a companion package for the Rush tool. See the [@microsoft/rush](https://www.npmjs.com/package/@microsoft/rush) package for details.
-⚠ ***THIS PACKAGE IS EXPERIMENTAL*** ⚠
+⚠ **_THIS PACKAGE IS EXPERIMENTAL_** ⚠
-The **@rushstack/rush-sdk** package acts as a lightweight proxy for accessing the APIs of the **@microsoft/rush-lib** engine. It is intended to support three different use cases:
+The **@rushstack/rush-sdk** package acts as a lightweight proxy for accessing the APIs of the **@microsoft/rush-lib** engine. It is intended to support three different use cases:
-1. Rush plugins should import from **@rushstack/rush-sdk** instead of **@microsoft/rush-lib**. This gives plugins full access to Rush APIs while avoiding a redundant installation of those packages. At runtime, the APIs will be bound to the correct `rushVersion` from **rush.json**, and guaranteed to be the same **@microsoft/rush-lib** module instance as the plugin host.
+1. Rush plugins should import from **@rushstack/rush-sdk** instead of **@microsoft/rush-lib**. This gives plugins full access to Rush APIs while avoiding a redundant installation of those packages. At runtime, the APIs will be bound to the correct `rushVersion` from **rush.json**, and guaranteed to be the same **@microsoft/rush-lib** module instance as the plugin host.
-2. When authoring unit tests for a Rush plugin, developers should add **@microsoft/rush-lib** to their **package.json** `devDependencies`. In this context, **@rushstack/rush-sdk** will resolve to that instance for testing purposes.
+2. When authoring unit tests for a Rush plugin, developers should add **@microsoft/rush-lib** to their **package.json** `devDependencies`. In this context, **@rushstack/rush-sdk** will resolve to that instance for testing purposes.
-3. For scripts and tools that are designed to be used in a Rush monorepo, in the future **@rushstack/rush-sdk** will automatically invoke **install-run-rush.js** and load the local installation. This ensures that tools load a compatible version of the Rush engine for the given branch. Once this is implemented, **@rushstack/rush-sdk** can replace **@microsoft/rush-lib** entirely as the official API interface, with the latter serving as the underlying implementation.
+3. For projects within a monorepo that use **@rushstack/rush-sdk** during their build process, child processes will inherit the installation of Rush that invoked them. This is communicated using the `_RUSH_LIB_PATH` environment variable.
+4. For scripts and tools that are designed to be used in a Rush monorepo, in the future **@rushstack/rush-sdk** will automatically invoke **install-run-rush.js** and load the local installation. This ensures that tools load a compatible version of the Rush engine for the given branch. Once this is implemented, **@rushstack/rush-sdk** can replace **@microsoft/rush-lib** entirely as the official API interface, with the latter serving as the underlying implementation.
The **@rushstack/rush-sdk** API declarations are identical to the corresponding version of **@microsoft/rush-lib**.
-## Debugging
+## Importing internal APIs
+
+Backwards compatibility is only guaranteed for the APIs marked as `@public` in the official `rush-lib.d.ts` entry point.
+However, sometimes it is expedient for a script to import internal modules from `@microsoft/rush-lib` to access
+unofficial APIs. This practice faces a technical challenge that `@microsoft/rush-lib` is bundled using Webpack.
+The `@rushstack/rush-sdk` package provides stub files that import the corresponding internal module from the
+Webpack bundle, via the `@rushstack/webpack-deep-imports-plugin` mechanism.
+
+> **WARNING:** If the loaded `rush-lib` package has a different version from `rush-sdk`, there is
+> no guarantee that the corresponding path will exist or have the same type signature.
+> Access internal APIs at your own risk. If you find an internal API to be useful, we recommend
+> that you create a GitHub issue proposing to make it public.
+
+Example 1: Conventional import of a public API:
+
+```ts
+// THIS IS THE RECOMMENDED PRACTICE:
+import { RushConfiguration } from '@rushstack/rush-sdk';
+const config = RushConfiguration.loadFromDefaultLocation();
+console.log(config.commonFolder);
+```
-Verbose logging can be turn on by set environment variable `RUSH_SDK_DEBUG` to `1`
+Example 2: How to import an internal API:
+
+```ts
+// WARNING: INTERNAL APIS MAY CHANGE AT ANY TIME -- USE THIS AT YOUR OWN RISK:
+
+// Important: Since we're calling an internal API, we need to use the unbundled .d.ts files
+// instead of the normal .d.ts rollup, otherwise TypeScript will complain about a type mismatch.
+import { RushConfiguration } from '@rushstack/rush-sdk/lib/index';
+const config = RushConfiguration.loadFromDefaultLocation();
+console.log(config.commonFolder);
+
+// Load an internal module from the Webpack bundle using a path-based import of a stub file:
+import { GitEmailPolicy } from '@rushstack/rush-sdk/lib/logic/policy/GitEmailPolicy';
+console.log(GitEmailPolicy.getEmailExampleLines(config));
+```
+
+## Debugging
+Verbose logging can be enabled by setting environment variable `RUSH_SDK_DEBUG=1`.
## Links
-- [CHANGELOG.md](
- https://github.com/microsoft/rushstack/blob/main/apps/rush/CHANGELOG.md) - Find
+- [CHANGELOG.md](https://github.com/microsoft/rushstack/blob/main/apps/rush/CHANGELOG.md) - Find
out what's new in the latest version
- [API Reference](https://api.rushstack.io/pages/rush-lib/)
diff --git a/libraries/rush-sdk/config/heft.json b/libraries/rush-sdk/config/heft.json
index 821b6785023..e1389cd7acc 100644
--- a/libraries/rush-sdk/config/heft.json
+++ b/libraries/rush-sdk/config/heft.json
@@ -11,7 +11,7 @@
"build": {
"cleanFiles": [
{
- "sourcePath": "./dist/rush-lib.d.ts"
+ "sourcePath": "lib-shim"
}
],
@@ -33,6 +33,16 @@
"typescript": {
"taskDependencies": ["copy-rush-lib-types"]
+ },
+
+ "generate-stubs": {
+ "taskDependencies": ["typescript"],
+ "taskEvent": {
+ "eventKind": "runScript",
+ "options": {
+ "scriptPath": "./lib-shim/generate-stubs.js"
+ }
+ }
}
}
}
diff --git a/libraries/rush-sdk/config/typescript.json b/libraries/rush-sdk/config/typescript.json
new file mode 100644
index 00000000000..3362be93d3f
--- /dev/null
+++ b/libraries/rush-sdk/config/typescript.json
@@ -0,0 +1,5 @@
+{
+ "$schema": "https://developer.microsoft.com/json-schemas/heft/typescript.schema.json",
+
+ "emitFolderNameForTests": "lib-shim"
+}
diff --git a/libraries/rush-sdk/package.json b/libraries/rush-sdk/package.json
index 4f31165d20a..8fb1f3ab8ec 100644
--- a/libraries/rush-sdk/package.json
+++ b/libraries/rush-sdk/package.json
@@ -1,6 +1,6 @@
{
"name": "@rushstack/rush-sdk",
- "version": "5.88.0",
+ "version": "5.95.0",
"description": "An API for interacting with the Rush engine",
"repository": {
"type": "git",
@@ -8,7 +8,7 @@
"directory": "apps/rush-sdk"
},
"homepage": "https://rushjs.io",
- "main": "lib/index.js",
+ "main": "lib-shim/index.js",
"typings": "dist/rush-lib.d.ts",
"scripts": {
"build": "heft build --clean",
@@ -18,7 +18,7 @@
"license": "MIT",
"dependencies": {
"@rushstack/node-core-library": "workspace:*",
- "@types/node-fetch": "1.6.9",
+ "@types/node-fetch": "2.6.2",
"tapable": "2.2.1"
},
"devDependencies": {
@@ -30,6 +30,6 @@
"@rushstack/ts-command-line": "workspace:*",
"@rushstack/terminal": "workspace:*",
"@types/semver": "7.3.5",
- "@types/webpack-env": "1.13.0"
+ "@types/webpack-env": "1.18.0"
}
}
diff --git a/libraries/rush-sdk/src/generate-stubs.ts b/libraries/rush-sdk/src/generate-stubs.ts
new file mode 100644
index 00000000000..ba6bcb1d799
--- /dev/null
+++ b/libraries/rush-sdk/src/generate-stubs.ts
@@ -0,0 +1,66 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+import * as path from 'path';
+
+import { FileSystem, Import, Path } from '@rushstack/node-core-library';
+
+function generateLibFilesRecursively(options: {
+ parentSourcePath: string;
+ parentTargetPath: string;
+ parentSrcImportPathWithSlash: string;
+ libShimIndexPath: string;
+}): void {
+ for (const folderItem of FileSystem.readFolderItems(options.parentSourcePath)) {
+ const sourcePath: string = path.join(options.parentSourcePath, folderItem.name);
+ const targetPath: string = path.join(options.parentTargetPath, folderItem.name);
+
+ if (folderItem.isDirectory()) {
+ // create destination folder
+ FileSystem.ensureEmptyFolder(targetPath);
+ generateLibFilesRecursively({
+ parentSourcePath: sourcePath,
+ parentTargetPath: targetPath,
+ parentSrcImportPathWithSlash: options.parentSrcImportPathWithSlash + folderItem.name + '/',
+ libShimIndexPath: options.libShimIndexPath
+ });
+ } else {
+ if (folderItem.name.endsWith('.d.ts')) {
+ FileSystem.copyFile({
+ sourcePath: sourcePath,
+ destinationPath: targetPath
+ });
+ } else if (folderItem.name.endsWith('.js')) {
+ const srcImportPath: string = options.parentSrcImportPathWithSlash + path.parse(folderItem.name).name;
+ const shimPath: string = path.relative(options.parentTargetPath, options.libShimIndexPath);
+ const shimPathLiteral: string = JSON.stringify(Path.convertToSlashes(shimPath));
+ const srcImportPathLiteral: string = JSON.stringify(srcImportPath);
+
+ FileSystem.writeFile(
+ targetPath,
+ // Example:
+ // module.exports = require("../../../lib-shim/index")._rushSdk_loadInternalModule("logic/policy/GitEmailPolicy");
+ `module.exports = require(${shimPathLiteral})._rushSdk_loadInternalModule(${srcImportPathLiteral});`
+ );
+ }
+ }
+ }
+}
+
+// Entry point invoked by "runScript" action from config/heft.json
+export function run(): void {
+ const rushLibFolder: string = Import.resolvePackage({
+ baseFolderPath: __dirname,
+ packageName: '@microsoft/rush-lib'
+ });
+
+ const stubsTargetPath: string = path.resolve(__dirname, '../lib');
+ console.log('generate-stubs: Generating stub files under: ' + stubsTargetPath);
+ generateLibFilesRecursively({
+ parentSourcePath: path.join(rushLibFolder, 'lib'),
+ parentTargetPath: stubsTargetPath,
+ parentSrcImportPathWithSlash: '',
+ libShimIndexPath: path.join(__dirname, '../lib-shim/index')
+ });
+ console.log('generate-stubs: Completed successfully.');
+}
diff --git a/libraries/rush-sdk/src/index.ts b/libraries/rush-sdk/src/index.ts
index e619eca098d..2677e9bef8d 100644
--- a/libraries/rush-sdk/src/index.ts
+++ b/libraries/rush-sdk/src/index.ts
@@ -15,7 +15,7 @@ import {
} from '@rushstack/node-core-library';
import type { SpawnSyncReturns } from 'child_process';
-const RUSH_LIB_NAME: string = '@microsoft/rush-lib';
+const RUSH_LIB_NAME: '@microsoft/rush-lib' = '@microsoft/rush-lib';
const verboseEnabled: boolean = typeof process !== 'undefined' && process.env.RUSH_SDK_DEBUG === '1';
const terminal: Terminal = new Terminal(
@@ -28,6 +28,7 @@ type RushLibModuleType = Record;
declare const global: NodeJS.Global &
typeof globalThis & {
___rush___rushLibModule?: RushLibModuleType;
+ ___rush___rushLibModuleFromEnvironment?: RushLibModuleType;
___rush___rushLibModuleFromInstallAndRunRush?: RushLibModuleType;
};
@@ -46,7 +47,9 @@ function _require(moduleName: string): TResult {
// SCENARIO 1: Rush's PluginManager has initialized "rush-sdk" with Rush's own instance of rush-lib.
// The Rush host process will assign "global.___rush___rushLibModule" before loading the plugin.
let rushLibModule: RushLibModuleType | undefined =
- global.___rush___rushLibModule || global.___rush___rushLibModuleFromInstallAndRunRush;
+ global.___rush___rushLibModule ||
+ global.___rush___rushLibModuleFromEnvironment ||
+ global.___rush___rushLibModuleFromInstallAndRunRush;
let errorMessage: string = '';
// SCENARIO 2: The project importing "rush-sdk" has installed its own instance of "rush-lib"
@@ -89,7 +92,31 @@ if (rushLibModule === undefined) {
}
}
-// SCENARIO 3: A tool or script depends on "rush-sdk", and is meant to be used inside a monorepo folder.
+// SCENARIO 3: A tool or script has been invoked as a child process by an instance of "rush-lib" and can use the
+// version that invoked it. In this case, use process.env._RUSH_LIB_PATH to find "rush-lib".
+if (rushLibModule === undefined) {
+ const rushLibVariable: '_RUSH_LIB_PATH' = '_RUSH_LIB_PATH';
+ const rushLibPath: string | undefined = process.env[rushLibVariable];
+ if (rushLibPath) {
+ terminal.writeVerboseLine(
+ `Try to load ${RUSH_LIB_NAME} from process.env.${rushLibVariable} from caller package`
+ );
+ try {
+ rushLibModule = _require(rushLibPath);
+ } catch (error) {
+ // Log this as a warning, since it is unexpected to define an incorrect value of the variable.
+ terminal.writeWarningLine(`Failed to load ${RUSH_LIB_NAME} via process.env.${rushLibVariable}`);
+ }
+
+ if (rushLibModule !== undefined) {
+ // to track which scenario is active and how it got initialized.
+ global.___rush___rushLibModuleFromEnvironment = rushLibModule;
+ terminal.writeVerboseLine(`Loaded ${RUSH_LIB_NAME} from process.env.${rushLibVariable}`);
+ }
+ }
+}
+
+// SCENARIO 4: A standalone tool or script depends on "rush-sdk", and is meant to be used inside a monorepo folder.
// In this case, we can use install-run-rush.js to obtain the appropriate rush-lib version for the monorepo.
if (rushLibModule === undefined) {
try {
@@ -181,6 +208,18 @@ for (const property in rushLibModule) {
}
}
+/**
+ * Used by the .js stubs for path-based imports of `@microsoft/rush-lib` internal APIs.
+ */
+export function _rushSdk_loadInternalModule(srcImportPath: string): unknown {
+ if (!exports._RushInternals) {
+ throw new Error(
+ `Rush version ${exports.Rush.version} does not support internal API imports via rush-sdk`
+ );
+ }
+ return exports._RushInternals.loadModule(srcImportPath);
+}
+
/**
* Require `@microsoft/rush-lib` under the specified folder path.
*/
diff --git a/libraries/rush-sdk/src/test/__snapshots__/script.test.ts.snap b/libraries/rush-sdk/src/test/__snapshots__/script.test.ts.snap
new file mode 100644
index 00000000000..36bce37042e
--- /dev/null
+++ b/libraries/rush-sdk/src/test/__snapshots__/script.test.ts.snap
@@ -0,0 +1,76 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`@rushstack/rush-sdk Should load via env when Rush has loaded (for child processes): stderr 1`] = `""`;
+
+exports[`@rushstack/rush-sdk Should load via env when Rush has loaded (for child processes): stdout 1`] = `
+"Try to load @microsoft/rush-lib from process.env._RUSH_LIB_PATH from caller package
+Loaded @microsoft/rush-lib from process.env._RUSH_LIB_PATH
+[
+ '_rushSdk_loadInternalModule',
+ 'ApprovedPackagesConfiguration',
+ 'ApprovedPackagesItem',
+ 'ApprovedPackagesPolicy',
+ 'BuildCacheConfiguration',
+ 'BumpType',
+ 'ChangeManager',
+ 'CommonVersionsConfiguration',
+ 'CredentialCache',
+ 'DependencyType',
+ 'EnvironmentConfiguration',
+ 'EnvironmentVariableNames',
+ 'Event',
+ 'EventHooks',
+ 'ExperimentsConfiguration',
+ 'FileSystemBuildCacheProvider',
+ 'IndividualVersionPolicy',
+ 'LockStepVersionPolicy',
+ 'LookupByPath',
+ 'NpmOptionsConfiguration',
+ 'Operation',
+ 'OperationStatus',
+ 'PackageJsonDependency',
+ 'PackageJsonEditor',
+ 'PackageManager',
+ 'PackageManagerOptionsConfigurationBase',
+ 'PhasedCommandHooks',
+ 'PnpmOptionsConfiguration',
+ 'ProjectChangeAnalyzer',
+ 'RepoStateFile',
+ 'Rush',
+ 'RushConfiguration',
+ 'RushConfigurationProject',
+ 'RushConstants',
+ 'RushLifecycleHooks',
+ 'RushSession',
+ 'RushUserConfiguration',
+ 'VersionPolicy',
+ 'VersionPolicyConfiguration',
+ 'VersionPolicyDefinitionName',
+ 'YarnOptionsConfiguration',
+ '_LastInstallFlag',
+ '_OperationMetadataManager',
+ '_OperationStateFile',
+ '_RushGlobalFolder',
+ '_RushInternals'
+]"
+`;
+
+exports[`@rushstack/rush-sdk Should load via global (for plugins): stderr 1`] = `""`;
+
+exports[`@rushstack/rush-sdk Should load via global (for plugins): stdout 1`] = `"[ '_rushSdk_loadInternalModule', 'foo' ]"`;
+
+exports[`@rushstack/rush-sdk Should load via install-run (for standalone tools): stderr 1`] = `""`;
+
+exports[`@rushstack/rush-sdk Should load via install-run (for standalone tools): stdout 1`] = `
+"Trying to load @microsoft/rush-lib installed by install-run-rush
+Loaded @microsoft/rush-lib installed by install-run-rush
+[ '_rushSdk_loadInternalModule', 'foo' ]"
+`;
+
+exports[`@rushstack/rush-sdk Should load via process.env._RUSH_LIB_PATH (for child processes): stderr 1`] = `""`;
+
+exports[`@rushstack/rush-sdk Should load via process.env._RUSH_LIB_PATH (for child processes): stdout 1`] = `
+"Try to load @microsoft/rush-lib from process.env._RUSH_LIB_PATH from caller package
+Loaded @microsoft/rush-lib from process.env._RUSH_LIB_PATH
+[ '_rushSdk_loadInternalModule', 'foo' ]"
+`;
diff --git a/libraries/rush-sdk/src/test/script.test.ts b/libraries/rush-sdk/src/test/script.test.ts
index 2554c494e12..e1919b55694 100644
--- a/libraries/rush-sdk/src/test/script.test.ts
+++ b/libraries/rush-sdk/src/test/script.test.ts
@@ -1,15 +1,79 @@
import * as path from 'path';
import { Executable } from '@rushstack/node-core-library';
-const rushSdkPath: string = path.join(__dirname, '../../lib/index.js');
+const rushSdkPath: string = path.join(__dirname, '../../lib-shim/index.js');
const sandboxRepoPath: string = `${__dirname}/sandbox`;
const mockPackageFolder: string = `${sandboxRepoPath}/mock-package`;
const mockRushLibPath: string = `${__dirname}/fixture/mock-rush-lib.js`;
const coreLibPath: string = require.resolve('@rushstack/node-core-library');
-describe('used in script', () => {
- it('should work when used in script', () => {
+describe('@rushstack/rush-sdk', () => {
+ it('Should load via global (for plugins)', () => {
+ const result = Executable.spawnSync(
+ 'node',
+ [
+ '-e',
+ `
+global.___rush___rushLibModule = { foo: 1 };
+console.log(Object.keys(require(${JSON.stringify(rushSdkPath)})));`
+ ],
+ {
+ currentWorkingDirectory: mockPackageFolder,
+ environment: {
+ ...process.env,
+ RUSH_SDK_DEBUG: '1',
+ _RUSH_LIB_PATH: '' // Need to clear if invoked via Rush
+ }
+ }
+ );
+ expect(result.stderr.trim()).toMatchSnapshot('stderr');
+ expect(result.stdout.trim()).toMatchSnapshot('stdout');
+ expect(result.status).toBe(0);
+ });
+
+ it('Should load via env when Rush has loaded (for child processes)', () => {
+ const result = Executable.spawnSync(
+ 'node',
+ [
+ '-e',
+ `
+require('@microsoft/rush-lib');
+console.log(Object.keys(require(${JSON.stringify(rushSdkPath)})));`
+ ],
+ {
+ currentWorkingDirectory: mockPackageFolder,
+ environment: {
+ ...process.env,
+ RUSH_SDK_DEBUG: '1',
+ _RUSH_LIB_PATH: '' // Need to clear if invoked via Rush
+ }
+ }
+ );
+ expect(result.stderr.trim()).toMatchSnapshot('stderr');
+ expect(result.stdout.trim()).toMatchSnapshot('stdout');
+ expect(result.status).toBe(0);
+ });
+
+ it('Should load via process.env._RUSH_LIB_PATH (for child processes)', () => {
+ const result = Executable.spawnSync(
+ 'node',
+ ['-e', `console.log(Object.keys(require(${JSON.stringify(rushSdkPath)})));`],
+ {
+ currentWorkingDirectory: mockPackageFolder,
+ environment: {
+ ...process.env,
+ RUSH_SDK_DEBUG: '1',
+ _RUSH_LIB_PATH: mockRushLibPath
+ }
+ }
+ );
+ expect(result.stderr.trim()).toMatchSnapshot('stderr');
+ expect(result.stdout.trim()).toMatchSnapshot('stdout');
+ expect(result.status).toBe(0);
+ });
+
+ it('Should load via install-run (for standalone tools)', () => {
const result = Executable.spawnSync(
'node',
[
@@ -24,15 +88,20 @@ const mockResolveModule = (options) => {
return originalResolveModule(options);
}
Import.resolveModule = mockResolveModule;
-console.log(require(${JSON.stringify(rushSdkPath)}));
+console.log(Object.keys(require(${JSON.stringify(rushSdkPath)})));
`
],
{
- currentWorkingDirectory: mockPackageFolder
+ currentWorkingDirectory: mockPackageFolder,
+ environment: {
+ ...process.env,
+ RUSH_SDK_DEBUG: '1',
+ _RUSH_LIB_PATH: '' // Need to clear if invoked via Rush
+ }
}
);
- expect(result.stderr.trim()).toMatchInlineSnapshot(`""`);
- expect(result.stdout.trim()).toMatchInlineSnapshot(`"{ foo: [Getter] }"`);
+ expect(result.stderr.trim()).toMatchSnapshot('stderr');
+ expect(result.stdout.trim()).toMatchSnapshot('stdout');
expect(result.status).toBe(0);
});
});
diff --git a/libraries/rush-sdk/tsconfig.json b/libraries/rush-sdk/tsconfig.json
index ab74a420295..5448a10b510 100644
--- a/libraries/rush-sdk/tsconfig.json
+++ b/libraries/rush-sdk/tsconfig.json
@@ -1,6 +1,7 @@
{
"extends": "./node_modules/@rushstack/heft-node-rig/profiles/default/tsconfig-base.json",
"compilerOptions": {
+ "outDir": "lib-shim",
"types": [
"heft-jest",
"webpack-env" // Use webpack-env here instead of node so we have __non_webpack_require__
diff --git a/libraries/rush-themed-ui/.eslintrc.js b/libraries/rush-themed-ui/.eslintrc.js
new file mode 100644
index 00000000000..288eaa16364
--- /dev/null
+++ b/libraries/rush-themed-ui/.eslintrc.js
@@ -0,0 +1,7 @@
+// 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/web-app', '@rushstack/eslint-config/mixins/react'],
+ parserOptions: { tsconfigRootDir: __dirname }
+};
diff --git a/libraries/rush-themed-ui/.npmignore b/libraries/rush-themed-ui/.npmignore
new file mode 100644
index 00000000000..302dbc5b019
--- /dev/null
+++ b/libraries/rush-themed-ui/.npmignore
@@ -0,0 +1,30 @@
+# 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)
\ No newline at end of file
diff --git a/libraries/rush-themed-ui/LICENSE b/libraries/rush-themed-ui/LICENSE
new file mode 100644
index 00000000000..e08fddbd337
--- /dev/null
+++ b/libraries/rush-themed-ui/LICENSE
@@ -0,0 +1,24 @@
+@rushstack/rush-themed-ui
+
+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.
diff --git a/libraries/rush-themed-ui/README.md b/libraries/rush-themed-ui/README.md
new file mode 100644
index 00000000000..9681cf99c86
--- /dev/null
+++ b/libraries/rush-themed-ui/README.md
@@ -0,0 +1,5 @@
+# @rushstack/rush-themed-ui
+
+**Rush Components** provides a suite of styled components that can be used in rush applications to ensure a consistent look and feel among all rushstack helper applications.
+
+Rush Components is part of the [Rush Stack](https://rushstack.io/) family of projects.
diff --git a/libraries/rush-themed-ui/config/api-extractor.json b/libraries/rush-themed-ui/config/api-extractor.json
new file mode 100644
index 00000000000..cafe285cb0d
--- /dev/null
+++ b/libraries/rush-themed-ui/config/api-extractor.json
@@ -0,0 +1,427 @@
+/**
+ * Config file for API Extractor. For more info, please visit: https://api-extractor.com
+ */
+{
+ "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+
+ /**
+ * Optionally specifies another JSON config file that this file extends from. This provides a way for
+ * standard settings to be shared across multiple projects.
+ *
+ * If the path starts with "./" or "../", the path is resolved relative to the folder of the file that contains
+ * the "extends" field. Otherwise, the first path segment is interpreted as an NPM package name, and will be
+ * resolved using NodeJS require().
+ *
+ * SUPPORTED TOKENS: none
+ * DEFAULT VALUE: ""
+ */
+ // "extends": "./shared/api-extractor-base.json"
+ // "extends": "my-package/include/api-extractor-base.json"
+
+ /**
+ * Determines the "" token that can be used with other config file settings. The project folder
+ * typically contains the tsconfig.json and package.json config files, but the path is user-defined.
+ *
+ * The path is resolved relative to the folder of the config file that contains the setting.
+ *
+ * The default value for "projectFolder" is the token "", which means the folder is determined by traversing
+ * parent folders, starting from the folder containing api-extractor.json, and stopping at the first folder
+ * that contains a tsconfig.json file. If a tsconfig.json file cannot be found in this way, then an error
+ * will be reported.
+ *
+ * SUPPORTED TOKENS:
-
);
};
diff --git a/apps/lockfile-explorer-web/src/containers/SelectedEntryPreview/styles.scss b/apps/lockfile-explorer-web/src/containers/SelectedEntryPreview/styles.scss
index b816c5a6770..591fc4c2274 100644
--- a/apps/lockfile-explorer-web/src/containers/SelectedEntryPreview/styles.scss
+++ b/apps/lockfile-explorer-web/src/containers/SelectedEntryPreview/styles.scss
@@ -1,15 +1,9 @@
-@import 'office-ui-fabric-core/dist/sass/References';
+@use '../../styles/base';
.SelectedEntryCard {
margin-top: 12px;
- box-shadow: $ms-depth-shadow-8;
- background-color: $ms-color-gray10;
- padding: 12px 24px;
- height: 8%;
- overflow: scroll;
- p {
- font-size: 12px;
- }
+ @include base.card;
+ padding: 12px;
& > * + * {
margin-top: 8px;
}
diff --git a/apps/lockfile-explorer-web/src/helpers/displaySpecChanges.ts b/apps/lockfile-explorer-web/src/helpers/displaySpecChanges.ts
index 9005d1563fc..fb05326943b 100644
--- a/apps/lockfile-explorer-web/src/helpers/displaySpecChanges.ts
+++ b/apps/lockfile-explorer-web/src/helpers/displaySpecChanges.ts
@@ -5,7 +5,7 @@ export const displaySpecChanges = (specChanges: Map
-
+
- Selected entry:
- {selectedEntry.displayText} +
+
- {renderButtonRow()}
-
+
+ Selected entry:
+
+ {selectedEntry.displayText}
+
+ {renderButtonRow()}
-
+ Package Entry: {selectedEntry.rawEntryId}
-Package JSON path: {selectedEntry.packageJsonFolderPath}
-
+ Package Entry: {selectedEntry.rawEntryId}
+ Package JSON path: {selectedEntry.packageJsonFolderPath}
+
+
+ 
-*Lockfile Explorer main window* - +_Lockfile Explorer main window_ ## How it works -The web app will expect to find a Rush workspace in the current working directory where the `lockfile-explorer` -command was invoked. It will read files such as: +The web app will expect to find a Rush/PNPM workspace in the current working directory where +the `lockfile-explorer` command was invoked. It will read files such as: - **common/config/rush/pnpm-lock.yaml** - the PNPM lockfile for your monorepo - **common/config/rush/.pnpmfile.cjs** - which transforms **package.json** files during installation -- The **package.json** files for your Rush projects -- The **package.json** files for packages installed under - +- The **package.json** files for your local workspace projects +- The **package.json** files for external packages installed in the `node_modules` folders. ## Links -- [Documentation](https://lfx.rushstack.io/) on the Lockfile Explorer project website -- [CHANGELOG.md]( - https://github.com/microsoft/rushstack/blob/main/apps/lockfile-explorer/CHANGELOG.md) - Find +- [Documentation and tutorials](https://lfx.rushstack.io/) on the Lockfile Explorer project website +- [CHANGELOG.md](https://github.com/microsoft/rushstack/blob/main/apps/lockfile-explorer/CHANGELOG.md) - Find out what's new in the latest version - [@rushstack/trace-import](https://www.npmjs.com/package/@rushstack/trace-import) - a command-line tool for troubleshooting how modules are resolved by `import` and `require()` diff --git a/apps/lockfile-explorer/package.json b/apps/lockfile-explorer/package.json index 02ea46678a7..99a1a27f662 100644 --- a/apps/lockfile-explorer/package.json +++ b/apps/lockfile-explorer/package.json @@ -1,6 +1,6 @@ { "name": "@rushstack/lockfile-explorer", - "version": "0.1.7", + "version": "1.0.9", "description": "Rush Lockfile Explorer: The UI for solving version conflicts quickly in a large monorepo", "keywords": [ "conflict", @@ -25,7 +25,8 @@ "homepage": "https://lfx.rushstack.io/", "license": "MIT", "bin": { - "lockfile-explorer": "./bin/lockfile-explorer" + "lockfile-explorer": "./bin/lockfile-explorer", + "lfx": "./bin/lockfile-explorer" }, "scripts": { "build": "heft build --clean", @@ -45,7 +46,7 @@ "@types/express": "4.17.13", "@types/heft-jest": "1.0.1", "@types/js-yaml": "3.12.1", - "@types/node": "12.20.24", + "@types/node": "14.18.36", "@types/update-notifier": "~6.0.1" }, "dependencies": { diff --git a/apps/lockfile-explorer/src/init.ts b/apps/lockfile-explorer/src/init.ts index 2870e68c61c..1baf98ea0fd 100644 --- a/apps/lockfile-explorer/src/init.ts +++ b/apps/lockfile-explorer/src/init.ts @@ -4,15 +4,18 @@ // This function will read the current directory and try to figure out if it's a rush project or regular pnpm workspace // Currently it will throw error if neither can be determined -import { FileSystem, JsonFile, PackageJsonLookup, Path } from '@rushstack/node-core-library'; +import { FileSystem, JsonFile, Path } from '@rushstack/node-core-library'; import type { IRushConfigurationJson } from '@microsoft/rush-lib/lib/api/RushConfiguration'; import { type IAppState, IRushProjectDetails, ProjectType } from './state'; -export const init = (): IAppState => { +export const init = (options: { + lockfileExplorerProjectRoot: string; + appVersion: string; + debugMode: boolean; +}): IAppState => { + const { lockfileExplorerProjectRoot, appVersion, debugMode } = options; const currDir = process.cwd(); - const lockfileExplorerProjectRoot: string = PackageJsonLookup.instance.tryGetPackageFolderFor(__dirname)!; - const appVersion: string = JsonFile.load(`${lockfileExplorerProjectRoot}/package.json`).version; let appState: IAppState | undefined; let currExploredDir = Path.convertToSlashes(currDir); @@ -21,7 +24,7 @@ export const init = (): IAppState => { const rushJsonPath: string = `${currExploredDir}/rush.json`; const pnpmLockPath: string = `${currExploredDir}/pnpm-lock.yaml`; if (FileSystem.exists(rushJsonPath)) { - console.log('found rush project: ', rushJsonPath); + console.log('Found a Rush workspace: ', rushJsonPath); // Load the rush projects const rushJson: IRushConfigurationJson = JsonFile.load(rushJsonPath); const projectsByProjectFolder: Map
protected
abstract
abstract | Some abstract method. |
+
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.abstractclass.method.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.abstractclass.method.md
new file mode 100644
index 00000000000..ed23bf4d3eb
--- /dev/null
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.abstractclass.method.md
@@ -0,0 +1,17 @@
+
+
+[Home](./index.md) > [api-documenter-test](./api-documenter-test.md) > [AbstractClass](./api-documenter-test.abstractclass.md) > [method](./api-documenter-test.abstractclass.method.md)
+
+## AbstractClass.method() method
+
+Some abstract method.
+
+**Signature:**
+
+```typescript
+abstract method(): void;
+```
+**Returns:**
+
+void
+
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.abstractclass.property.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.abstractclass.property.md
new file mode 100644
index 00000000000..14d9a35f906
--- /dev/null
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.abstractclass.property.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [api-documenter-test](./api-documenter-test.md) > [AbstractClass](./api-documenter-test.abstractclass.md) > [property](./api-documenter-test.abstractclass.property.md)
+
+## AbstractClass.property property
+
+Some abstract property.
+
+**Signature:**
+
+```typescript
+protected abstract property: number;
+```
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.constraint.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.constraint.md
index baad3fa0c92..23e1eba6aa2 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.constraint.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.constraint.md
@@ -6,7 +6,7 @@
Type parameter constraint used by test case below.
-Signature:
+**Signature:**
```typescript
export interface Constraint
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.constvariable.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.constvariable.md
index 3eb2979a44b..f1983273097 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.constvariable.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.constvariable.md
@@ -6,7 +6,7 @@
An exported variable declaration.
-Signature:
+**Signature:**
```typescript
constVariable: number
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.decoratorexample.creationdate.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.decoratorexample.creationdate.md
index 0edf2faff44..10d7cac8d65 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.decoratorexample.creationdate.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.decoratorexample.creationdate.md
@@ -6,12 +6,12 @@
The date when the record was created.
-Signature:
+**Signature:**
```typescript
creationDate: Date;
```
-Decorators:
+**Decorators:**
`@jsonSerialized`
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.decoratorexample.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.decoratorexample.md
index 0b1737db6a8..1ad743d98dc 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.decoratorexample.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.decoratorexample.md
@@ -5,7 +5,7 @@
## DecoratorExample class
-Signature:
+**Signature:**
```typescript
export declare class DecoratorExample
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.defaulttype.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.defaulttype.md
index 06b19e759fd..63b11b92846 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.defaulttype.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.defaulttype.md
@@ -6,7 +6,7 @@
Type parameter default type used by test case below.
-Signature:
+**Signature:**
```typescript
export interface DefaultType
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docbaseclass._constructor_.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docbaseclass._constructor_.md
index 9fb39e46aa2..2bf60957465 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docbaseclass._constructor_.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docbaseclass._constructor_.md
@@ -6,7 +6,7 @@
The simple constructor for `DocBaseClass`
-Signature:
+**Signature:**
```typescript
constructor();
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docbaseclass._constructor__1.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docbaseclass._constructor__1.md
index 152500bd6ed..6e1fb0514dd 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docbaseclass._constructor__1.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docbaseclass._constructor__1.md
@@ -6,7 +6,7 @@
The overloaded constructor for `DocBaseClass`
-Signature:
+**Signature:**
```typescript
constructor(x: number);
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docbaseclass.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docbaseclass.md
index 792bd688c23..9956be3c3e8 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docbaseclass.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docbaseclass.md
@@ -7,7 +7,7 @@
Example base class
-Signature:
+**Signature:**
```typescript
export declare class DocBaseClass
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.deprecatedexample.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.deprecatedexample.md
index 3572fc89d0e..7bc105104ec 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.deprecatedexample.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.deprecatedexample.md
@@ -9,12 +9,12 @@
> Use `otherThing()` instead.
>
-Signature:
+**Signature:**
```typescript
deprecatedExample(): void;
```
-Returns:
+**Returns:**
void
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.examplefunction.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.examplefunction.md
index c081fa0be54..25b2e9e4eee 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.examplefunction.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.examplefunction.md
@@ -6,7 +6,7 @@
This is an overloaded function.
-Signature:
+**Signature:**
```typescript
exampleFunction(a: string, b: string): string;
@@ -19,7 +19,7 @@ exampleFunction(a: string, b: string): string;
| a | string | the first string |
| b | string | the second string |
-Returns:
+**Returns:**
string
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.examplefunction_1.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.examplefunction_1.md
index 498b44a3568..63c9b7d4075 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.examplefunction_1.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.examplefunction_1.md
@@ -6,7 +6,7 @@
This is also an overloaded function.
-Signature:
+**Signature:**
```typescript
exampleFunction(x: number): number;
@@ -18,7 +18,7 @@ exampleFunction(x: number): number;
| --- | --- | --- |
| x | number | the number |
-Returns:
+**Returns:**
number
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.genericwithconstraintanddefault.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.genericwithconstraintanddefault.md
index 4379e46d416..d13ef6c720f 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.genericwithconstraintanddefault.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.genericwithconstraintanddefault.md
@@ -6,7 +6,7 @@
This is a method with a complex type parameter.
-Signature:
+**Signature:**
```typescript
genericWithConstraintAndDefaultprotected
readonly
static
protected
static
readonly
protected | string | Some protected property. |
| [readonlyProperty](./api-documenter-test.docclass1.readonlyproperty.md) | readonly | string | |
| [regularProperty](./api-documenter-test.docclass1.regularproperty.md) | | [SystemEvent](./api-documenter-test.systemevent.md) | This is a regular property that happens to use the SystemEvent type. |
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.modifiedevent.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.modifiedevent.md
index 5d20b88e0a2..6efebd1c5ef 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.modifiedevent.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.modifiedevent.md
@@ -6,7 +6,7 @@
This event is fired whenever the object is modified.
-Signature:
+**Signature:**
```typescript
readonly modifiedEvent: SystemEvent;
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.multiplemodifiersproperty.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.multiplemodifiersproperty.md
index 852ce939e10..255329bedc9 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.multiplemodifiersproperty.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.multiplemodifiersproperty.md
@@ -6,7 +6,7 @@
Some property with multiple modifiers.
-Signature:
+**Signature:**
```typescript
protected static readonly multipleModifiersProperty: boolean;
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.optionalparamfunction.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.optionalparamfunction.md
index 136ea5f01d1..77c1a7b9978 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.optionalparamfunction.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.optionalparamfunction.md
@@ -6,7 +6,7 @@
This is a function with an optional parameter.
-Signature:
+**Signature:**
```typescript
optionalParamFunction(x?: number): void;
@@ -16,9 +16,9 @@ optionalParamFunction(x?: number): void;
| Parameter | Type | Description |
| --- | --- | --- |
-| x | number | (Optional) the number |
+| x | number | _(Optional)_ the number |
-Returns:
+**Returns:**
void
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.protectedproperty.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.protectedproperty.md
index 1520c48dc75..80faac05579 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.protectedproperty.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.protectedproperty.md
@@ -6,7 +6,7 @@
Some protected property.
-Signature:
+**Signature:**
```typescript
protected protectedProperty: string;
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.readonlyproperty.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.readonlyproperty.md
index 44cb15a1324..df221991d88 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.readonlyproperty.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.readonlyproperty.md
@@ -4,7 +4,7 @@
## DocClass1.readonlyProperty property
-Signature:
+**Signature:**
```typescript
get readonlyProperty(): string;
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.regularproperty.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.regularproperty.md
index 3cf536db280..b08e0233e35 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.regularproperty.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.regularproperty.md
@@ -6,7 +6,7 @@
This is a regular property that happens to use the SystemEvent type.
-Signature:
+**Signature:**
```typescript
regularProperty: SystemEvent;
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.sumwithexample.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.sumwithexample.md
index eccbbb642ec..5e8dd1a7d57 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.sumwithexample.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.sumwithexample.md
@@ -6,7 +6,7 @@
Returns the sum of two numbers.
-Signature:
+**Signature:**
```typescript
static sumWithExample(x: number, y: number): number;
@@ -19,7 +19,7 @@ static sumWithExample(x: number, y: number): number;
| x | number | the first number to add |
| y | number | the second number to add |
-Returns:
+**Returns:**
number
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.tableexample.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.tableexample.md
index 994c0c00f8e..30e593b2370 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.tableexample.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.tableexample.md
@@ -6,12 +6,12 @@
An example with tables:
-Signature:
+**Signature:**
```typescript
tableExample(): void;
```
-Returns:
+**Returns:**
void
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.writeableproperty.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.writeableproperty.md
index a5284923d0d..2a98f0b99af 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.writeableproperty.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.writeableproperty.md
@@ -4,7 +4,7 @@
## DocClass1.writeableProperty property
-Signature:
+**Signature:**
```typescript
get writeableProperty(): string;
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.writeonlyproperty.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.writeonlyproperty.md
index c67cc8b01dd..a8a3e2f3c1e 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.writeonlyproperty.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.writeonlyproperty.md
@@ -6,7 +6,7 @@
API Extractor will surface an `ae-missing-getter` finding for this property.
-Signature:
+**Signature:**
```typescript
set writeonlyProperty(value: string);
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclassinterfacemerge.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclassinterfacemerge.md
index 50644c01913..09e8b18f838 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclassinterfacemerge.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclassinterfacemerge.md
@@ -6,7 +6,7 @@
Interface that merges with class
-Signature:
+**Signature:**
```typescript
export interface DocClassInterfaceMerge
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docenum.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docenum.md
index 876add8c2a7..2cf74f71557 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docenum.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docenum.md
@@ -7,7 +7,7 @@
Docs for DocEnum
-Signature:
+**Signature:**
```typescript
export declare enum DocEnum
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docenumnamespacemerge.examplefunction.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docenumnamespacemerge.examplefunction.md
index 96a3f8f8dbb..d3450d285d5 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docenumnamespacemerge.examplefunction.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docenumnamespacemerge.examplefunction.md
@@ -6,12 +6,12 @@
This is a function inside of a namespace that merges with an enum.
-Signature:
+**Signature:**
```typescript
function exampleFunction(): void;
```
-Returns:
+**Returns:**
void
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docenumnamespacemerge.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docenumnamespacemerge.md
index d67ae839e12..3d6ea812daf 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docenumnamespacemerge.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docenumnamespacemerge.md
@@ -6,7 +6,7 @@
Namespace that merges with enum
-Signature:
+**Signature:**
```typescript
export declare namespace DocEnumNamespaceMerge
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.ecmasmbols.example.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.ecmasmbols.example.md
index bc53b742377..03bffc31e62 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.ecmasmbols.example.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.ecmasmbols.example.md
@@ -6,7 +6,7 @@
An ECMAScript symbol
-Signature:
+**Signature:**
```typescript
example: unique symbol
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.ecmasmbols.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.ecmasmbols.md
index 6dc78e8f8eb..223267ecb6a 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.ecmasmbols.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.ecmasmbols.md
@@ -6,7 +6,7 @@
A namespace containing an ECMAScript symbol
-Signature:
+**Signature:**
```typescript
export declare namespace EcmaSmbols
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.exampleduplicatetypealias.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.exampleduplicatetypealias.md
index a9f6beec2a6..f20d492a8e4 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.exampleduplicatetypealias.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.exampleduplicatetypealias.md
@@ -6,10 +6,10 @@
A type alias that has duplicate references.
-Signature:
+**Signature:**
```typescript
export declare type ExampleDuplicateTypeAlias = SystemEvent | typeof SystemEvent;
```
-References: [SystemEvent](./api-documenter-test.systemevent.md)
+**References:** [SystemEvent](./api-documenter-test.systemevent.md)
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.examplefunction.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.examplefunction.md
index f86960f8be8..4c1163ab3ee 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.examplefunction.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.examplefunction.md
@@ -6,7 +6,7 @@
An exported function with hyperlinked parameters and return value.
-Signature:
+**Signature:**
```typescript
export declare function exampleFunction(x: ExampleTypeAlias, y: number): IDocInterface1;
@@ -19,7 +19,7 @@ export declare function exampleFunction(x: ExampleTypeAlias, y: number): IDocInt
| x | [ExampleTypeAlias](./api-documenter-test.exampletypealias.md) | an API item that should get hyperlinked |
| y | number | a system type that should NOT get hyperlinked |
-Returns:
+**Returns:**
[IDocInterface1](./api-documenter-test.idocinterface1.md)
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.exampletypealias.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.exampletypealias.md
index 04ab2642d0d..11d67ba93c2 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.exampletypealias.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.exampletypealias.md
@@ -6,7 +6,7 @@
A type alias
-Signature:
+**Signature:**
```typescript
export declare type ExampleTypeAlias = Promisereadonly | boolean | (Optional) Description of optionalReadonlyField |
-| [optionalUndocumentedField?](./api-documenter-test.idocinterface7.optionalundocumentedfield.md) | | boolean | (Optional) |
+| [optionalField?](./api-documenter-test.idocinterface7.optionalfield.md) | | boolean | _(Optional)_ Description of optionalField |
+| [optionalReadonlyField?](./api-documenter-test.idocinterface7.optionalreadonlyfield.md) | readonly | boolean | _(Optional)_ Description of optionalReadonlyField |
+| [optionalUndocumentedField?](./api-documenter-test.idocinterface7.optionalundocumentedfield.md) | | boolean | _(Optional)_ |
## Methods
| Method | Description |
| --- | --- |
-| [optionalMember()?](./api-documenter-test.idocinterface7.optionalmember.md) | (Optional) Description of optionalMember |
+| [optionalMember()?](./api-documenter-test.idocinterface7.optionalmember.md) | _(Optional)_ Description of optionalMember |
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface7.optionalfield.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface7.optionalfield.md
index 1e58ea4e884..d2644fbc653 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface7.optionalfield.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface7.optionalfield.md
@@ -6,7 +6,7 @@
Description of optionalField
-Signature:
+**Signature:**
```typescript
optionalField?: boolean;
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface7.optionalmember.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface7.optionalmember.md
index 8bc7031978d..90b672df149 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface7.optionalmember.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface7.optionalmember.md
@@ -6,12 +6,12 @@
Description of optionalMember
-Signature:
+**Signature:**
```typescript
optionalMember?(): any;
```
-Returns:
+**Returns:**
any
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface7.optionalreadonlyfield.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface7.optionalreadonlyfield.md
index 8e5c77def61..5969b1df869 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface7.optionalreadonlyfield.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface7.optionalreadonlyfield.md
@@ -6,7 +6,7 @@
Description of optionalReadonlyField
-Signature:
+**Signature:**
```typescript
readonly optionalReadonlyField?: boolean;
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface7.optionalundocumentedfield.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface7.optionalundocumentedfield.md
index c56d73710ca..163348c2f72 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface7.optionalundocumentedfield.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface7.optionalundocumentedfield.md
@@ -4,7 +4,7 @@
## IDocInterface7.optionalUndocumentedField property
-Signature:
+**Signature:**
```typescript
optionalUndocumentedField?: boolean;
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.md
index 8ac3f68444c..ff7da3c5e33 100644
--- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.md
+++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.md
@@ -19,6 +19,12 @@ This project tests various documentation generation scenarios and doc comment sy
| [Generic](./api-documenter-test.generic.md) | Generic class. |
| [SystemEvent](./api-documenter-test.systemevent.md) | A class used to exposed events.
| +## Abstract Classes + +| Abstract Class | Description | +| --- | --- | +| [AbstractClass](./api-documenter-test.abstractclass.md) | Some abstract class with abstract members. | + ## Enumerations | Enumeration | Description | diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.outernamespace.innernamespace.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.outernamespace.innernamespace.md index f0898e29ce6..f4494372d73 100644 --- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.outernamespace.innernamespace.md +++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.outernamespace.innernamespace.md @@ -6,7 +6,7 @@ A nested namespace -Signature: +**Signature:** ```typescript namespace InnerNamespace diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.outernamespace.innernamespace.nestedfunction.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.outernamespace.innernamespace.nestedfunction.md index 3ba952009e5..11eec09bc35 100644 --- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.outernamespace.innernamespace.nestedfunction.md +++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.outernamespace.innernamespace.nestedfunction.md @@ -6,7 +6,7 @@ A function inside a namespace -Signature: +**Signature:** ```typescript function nestedFunction(x: number): number; @@ -18,7 +18,7 @@ function nestedFunction(x: number): number; | --- | --- | --- | | x | number | | -Returns: +**Returns:** number diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.outernamespace.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.outernamespace.md index baa5e873882..70a81789486 100644 --- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.outernamespace.md +++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.outernamespace.md @@ -6,7 +6,7 @@ A top-level namespace -Signature: +**Signature:** ```typescript export declare namespace OuterNamespace diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.outernamespace.nestedvariable.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.outernamespace.nestedvariable.md index b0b93787cd4..b898150a9f5 100644 --- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.outernamespace.nestedvariable.md +++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.outernamespace.nestedvariable.md @@ -6,7 +6,7 @@ A variable exported from within a namespace. -Signature: +**Signature:** ```typescript nestedVariable: boolean diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.systemevent.addhandler.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.systemevent.addhandler.md index cafc021ee8e..ec269a54f4f 100644 --- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.systemevent.addhandler.md +++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.systemevent.addhandler.md @@ -6,7 +6,7 @@ Adds an handler for the event. -Signature: +**Signature:** ```typescript addHandler(handler: () => void): void; @@ -18,7 +18,7 @@ addHandler(handler: () => void): void; | --- | --- | --- | | handler | () => void | | -Returns: +**Returns:** void diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.systemevent.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.systemevent.md index 47baad77696..844fef6c164 100644 --- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.systemevent.md +++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.systemevent.md @@ -7,7 +7,7 @@ A class used to exposed events. -Signature: +**Signature:** ```typescript export declare class SystemEvent diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.typealias.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.typealias.md index 5d36ebd5e69..8709cd788d4 100644 --- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.typealias.md +++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.typealias.md @@ -5,7 +5,7 @@ ## TypeAlias type -Signature: +**Signature:** ```typescript export declare type TypeAlias = number; diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.yamlreferenceuniquenesstest.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.yamlreferenceuniquenesstest.md index 1cf863cf3ff..8cd0c20f399 100644 --- a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.yamlreferenceuniquenesstest.md +++ b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.yamlreferenceuniquenesstest.md @@ -5,12 +5,12 @@ ## yamlReferenceUniquenessTest() function -Signature: +**Signature:** ```typescript export declare function yamlReferenceUniquenessTest(): IDocInterface1; ``` -Returns: +**Returns:** [IDocInterface1](./api-documenter-test.idocinterface1.md) diff --git a/build-tests/api-documenter-test/etc/yaml/api-documenter-test.yml b/build-tests/api-documenter-test/etc/yaml/api-documenter-test.yml index 7576e5ade75..241ca97a87d 100644 --- a/build-tests/api-documenter-test/etc/yaml/api-documenter-test.yml +++ b/build-tests/api-documenter-test/etc/yaml/api-documenter-test.yml @@ -1,69 +1,70 @@ -### YamlMime:TSPackage -uid: api-documenter-test! -name: api-documenter-test -type: package -summary: |- - api-extractor-test-05 - - This project tests various documentation generation scenarios and doc comment syntaxes. -interfaces: - - 'api-documenter-test!Constraint:interface' - - 'api-documenter-test!DefaultType:interface' - - 'api-documenter-test!DocClassInterfaceMerge:interface' - - 'api-documenter-test!IDocInterface1:interface' - - 'api-documenter-test!IDocInterface2:interface' - - 'api-documenter-test!IDocInterface3:interface' - - 'api-documenter-test!IDocInterface4:interface' - - 'api-documenter-test!IDocInterface5:interface' - - 'api-documenter-test!IDocInterface6:interface' - - 'api-documenter-test!IDocInterface7:interface' -classes: - - 'api-documenter-test!DecoratorExample:class' - - 'api-documenter-test!DocBaseClass:class' - - 'api-documenter-test!DocClass1:class' - - 'api-documenter-test!DocClassInterfaceMerge:class' - - 'api-documenter-test!Generic:class' - - 'api-documenter-test!SystemEvent:class' -enums: - - 'api-documenter-test!DocEnum:enum' - - 'api-documenter-test!DocEnumNamespaceMerge:enum' -typeAliases: - - 'api-documenter-test!ExampleDuplicateTypeAlias:type' - - 'api-documenter-test!ExampleTypeAlias:type' - - 'api-documenter-test!ExampleUnionTypeAlias:type' - - 'api-documenter-test!GenericTypeAlias:type' - - 'api-documenter-test!TypeAlias:type' -functions: - - name: 'exampleFunction(x, y)' - uid: 'api-documenter-test!exampleFunction:function(1)' - package: api-documenter-test! - summary: An exported function with hyperlinked parameters and return value. - remarks: '' - example: [] - isPreview: false - isDeprecated: false - syntax: - content: 'export declare function exampleFunction(x: ExampleTypeAlias, y: number): IDocInterface1;' - parameters: - - id: x - description: an API item that should get hyperlinked - type: '