GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-06 15:31:16 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'tom/23347-story-globals' of https://github.com/storybookjs/storybook into tom/23347-story-globals

Browse Source
This commit is contained in:
Norbert de Langen 2024-07-25 17:18:33 +02:00
commit b7df7472ac
10 changed files with 73 additions and 87 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
code/core/src/common/js-package-manager/JsPackageManager.ts
View File

@ -64,22 +64,6 @@ export abstract class JsPackageManager {
return packageJSON ? packageJSON.version ?? null : null;
}
// NOTE: for some reason yarn prefers the npm registry in
// local development, so always use npm
async setRegistryURL(url: string) {
if (url) {
await this.executeCommand({ command: 'npm', args: ['config', 'set', 'registry', url] });
} else {
await this.executeCommand({ command: 'npm', args: ['config', 'delete', 'registry'] });
}
}
async getRegistryURL() {
const res = await this.executeCommand({ command: 'npm', args: ['config', 'get', 'registry'] });
const url = res.trim();
return url === 'undefined' ? undefined : url;
}
constructor(options?: JsPackageManagerOptions) {
this.cwd = options?.cwd || process.cwd();
}
@ -487,6 +471,8 @@ export abstract class JsPackageManager {
): // Use generic and conditional type to force `string[]` if fetchAllVersions is true and `string` if false
Promise<T extends true ? string[] : string>;
public abstract getRegistryURL(): Promise<string | undefined>;
public abstract runPackageCommand(
command: string,
args: string[],

15
code/core/src/common/js-package-manager/NPMProxy.test.ts
View File

@ -34,21 +34,6 @@ describe('NPM Proxy', () => {
});
});
describe('setRegistryUrl', () => {
it('should run `npm config set registry https://foo.bar`', async () => {
const executeCommandSpy = vi.spyOn(npmProxy, 'executeCommand').mockResolvedValueOnce('');
await npmProxy.setRegistryURL('https://foo.bar');
expect(executeCommandSpy).toHaveBeenCalledWith(
expect.objectContaining({
command: 'npm',
args: ['config', 'set', 'registry', 'https://foo.bar'],
})
);
});
});
describe('installDependencies', () => {
describe('npm6', () => {
it('should run `npm install`', async () => {

11
code/core/src/common/js-package-manager/NPMProxy.ts
View File

@ -181,6 +181,17 @@ export class NPMProxy extends JsPackageManager {
});
}
public async getRegistryURL() {
const res = await this.executeCommand({
command: 'npm',
// "npm config" commands are not allowed in workspaces per default
// https://github.com/npm/cli/issues/6099#issuecomment-1847584792
args: ['config', 'get', 'registry', '-ws=false', '-iwr'],
});
const url = res.trim();
return url === 'undefined' ? undefined : url;
}
protected async runAddDeps(dependencies: string[], installAsDevDependencies: boolean) {
const { logStream, readLogFile, moveLogFile, removeLogFile } = await createLogStream();
let args = [...dependencies];

15
code/core/src/common/js-package-manager/PNPMProxy.test.ts
View File

@ -24,21 +24,6 @@ describe('PNPM Proxy', () => {
});
});
describe('setRegistryUrl', () => {
it('should run `npm config set registry https://foo.bar`', async () => {
const executeCommandSpy = vi.spyOn(pnpmProxy, 'executeCommand').mockResolvedValueOnce('');
await pnpmProxy.setRegistryURL('https://foo.bar');
expect(executeCommandSpy).toHaveBeenCalledWith(
expect.objectContaining({
command: 'npm',
args: ['config', 'set', 'registry', 'https://foo.bar'],
})
);
});
});
describe('installDependencies', () => {
it('should run `pnpm install`', async () => {
const executeCommandSpy = vi

9
code/core/src/common/js-package-manager/PNPMProxy.ts
View File

@ -90,6 +90,15 @@ export class PNPMProxy extends JsPackageManager {
});
}
public async getRegistryURL() {
const res = await this.executeCommand({
command: 'pnpm',
args: ['config', 'get', 'registry'],
});
const url = res.trim();
return url === 'undefined' ? undefined : url;
}
async runPackageCommand(command: string, args: string[], cwd?: string): Promise<string> {
return this.executeCommand({
command: 'pnpm',

15
code/core/src/common/js-package-manager/Yarn1Proxy.test.ts
View File

@ -25,21 +25,6 @@ describe('Yarn 1 Proxy', () => {
});
});
describe('setRegistryUrl', () => {
it('should run `yarn config set npmRegistryServer https://foo.bar`', async () => {
const executeCommandSpy = vi.spyOn(yarn1Proxy, 'executeCommand').mockResolvedValueOnce('');
await yarn1Proxy.setRegistryURL('https://foo.bar');
expect(executeCommandSpy).toHaveBeenCalledWith(
expect.objectContaining({
command: 'npm',
args: ['config', 'set', 'registry', 'https://foo.bar'],
})
);
});
});
describe('installDependencies', () => {
it('should run `yarn`', async () => {
const executeCommandSpy = vi.spyOn(yarn1Proxy, 'executeCommand').mockResolvedValueOnce('');

9
code/core/src/common/js-package-manager/Yarn1Proxy.ts
View File

@ -83,6 +83,15 @@ export class Yarn1Proxy extends JsPackageManager {
return JSON.parse(readFileSync(packageJsonPath, 'utf-8')) as Record<string, any>;
}
public async getRegistryURL() {
const res = await this.executeCommand({
command: 'yarn',
args: ['config', 'get', 'registry'],
});
const url = res.trim();
return url === 'undefined' ? undefined : url;
}
public async findInstallations(pattern: string[], { depth = 99 }: { depth?: number } = {}) {
const yarnArgs = ['list', '--pattern', pattern.map((p) => `"${p}"`).join(' '), '--json'];

15
code/core/src/common/js-package-manager/Yarn2Proxy.test.ts
View File

@ -53,21 +53,6 @@ describe('Yarn 2 Proxy', () => {
});
});
describe('setRegistryUrl', () => {
it('should run `yarn config set npmRegistryServer https://foo.bar`', async () => {
const executeCommandSpy = vi.spyOn(yarn2Proxy, 'executeCommand').mockResolvedValueOnce('');
await yarn2Proxy.setRegistryURL('https://foo.bar');
expect(executeCommandSpy).toHaveBeenCalledWith(
expect.objectContaining({
command: 'npm',
args: ['config', 'set', 'registry', 'https://foo.bar'],
})
);
});
});
describe('addDependencies', () => {
it('with devDep it should run `yarn install -D @storybook/core`', async () => {
const executeCommandSpy = vi.spyOn(yarn2Proxy, 'executeCommand').mockResolvedValueOnce('');

9
code/core/src/common/js-package-manager/Yarn2Proxy.ts
View File

@ -239,6 +239,15 @@ export class Yarn2Proxy extends JsPackageManager {
await removeLogFile();
}
public async getRegistryURL() {
const res = await this.executeCommand({
command: 'yarn',
args: ['config', 'get', 'npmRegistryServer'],
});
const url = res.trim();
return url === 'undefined' ? undefined : url;
}
protected async runRemoveDeps(dependencies: string[]) {
const args = [...dependencies];

44
scripts/sandbox/generate.ts
View File

@ -45,18 +45,34 @@ const sbInit = async (
await runCommand(`${sbCliBinaryPath} init ${fullFlags.join(' ')}`, { cwd, env }, debug);
};
const withLocalRegistry = async (packageManager: JsPackageManager, action: () => Promise<void>) => {
type LocalRegistryProps = {
packageManager: JsPackageManager;
action: () => Promise<void>;
cwd: string;
env: Record<string, any>;
debug: boolean;
};
const withLocalRegistry = async ({
packageManager,
action,
cwd,
env,
debug,
}: LocalRegistryProps) => {
const prevUrl = await packageManager.getRegistryURL();
let error;
try {
console.log(`📦 Configuring local registry: ${LOCAL_REGISTRY_URL}`);
packageManager.setRegistryURL(LOCAL_REGISTRY_URL);
// NOTE: for some reason yarn prefers the npm registry in
// local development, so always use npm
await runCommand(`npm config set registry ${LOCAL_REGISTRY_URL}`, { cwd, env }, debug);
await action();
} catch (e) {
error = e;
} finally {
console.log(`📦 Restoring registry: ${prevUrl}`);
await packageManager.setRegistryURL(prevUrl);
await runCommand(`npm config set registry ${prevUrl}`, { cwd, env }, debug);
if (error) {
throw error;
@ -88,14 +104,20 @@ const addStorybook = async ({
const packageManager = JsPackageManagerFactory.getPackageManager({ force: 'yarn1' }, tmpDir);
if (localRegistry) {
await withLocalRegistry(packageManager, async () => {
await packageManager.addPackageResolutions({
...storybookVersions,
// Yarn1 Issue: https://github.com/storybookjs/storybook/issues/22431
jackspeak: '2.1.1',
});
await withLocalRegistry({
packageManager,
action: async () => {
await packageManager.addPackageResolutions({
...storybookVersions,
// Yarn1 Issue: https://github.com/storybookjs/storybook/issues/22431
jackspeak: '2.1.1',
});
await sbInit(tmpDir, env, [...flags, '--package-manager=yarn1'], debug);
await sbInit(tmpDir, env, [...flags, '--package-manager=yarn1'], debug);
},
cwd: tmpDir,
env,
debug,
});
} else {
await sbInit(tmpDir, env, [...flags, '--package-manager=yarn1'], debug);
@ -159,7 +181,7 @@ const runGenerators = async (
const baseDir = join(REPROS_DIRECTORY, dirName);
const beforeDir = join(baseDir, BEFORE_DIR_NAME);
try {
let flags: string[] = [];
let flags: string[] = ['--no-dev'];
if (expected.renderer === '@storybook/html') flags = ['--type html'];
else if (expected.renderer === '@storybook/server') flags = ['--type server'];