Skip to content

CLI: Add line ignoring storybook's .log files upon init #26099

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ndelangen merged 5 commits into from
Feb 20, 2024
Merged

CLI: Add line ignoring storybook's .log files upon init #26099

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7ca1efa
add a line ignoring the storybook generated log files to git ignore
ndelangen Feb 19, 2024
3029661
order imports a bit
ndelangen Feb 19, 2024
738c825
Merge branch 'next' into norbert/add-line-to-gitignore-file
ndelangen Feb 19, 2024
096d56d
Update code/lib/cli/src/initiate.ts
ndelangen Feb 20, 2024
998bcaf
Merge branch 'next' into norbert/add-line-to-gitignore-file
ndelangen Feb 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions code/lib/cli/src/initiate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import { appendFile, readFile } from 'fs/promises';
import type { PackageJson } from 'read-pkg-up';
import findUp from 'find-up';
import chalk from 'chalk';
import prompts from 'prompts';
import { telemetry } from '@storybook/telemetry';
Expand All @@ -10,6 +12,7 @@ import {
JsPackageManagerFactory,
commandLog,
paddedLog,
getProjectRoot,
} from '@storybook/core-common';
import type { JsPackageManager } from '@storybook/core-common';

Expand Down Expand Up @@ -369,6 +372,15 @@ export async function doInitiate(
return { shouldRunDev: false };
}

const foundGitIgnoreFile = await findUp('.gitignore', { cwd: process.cwd() });
const rootDirectory = getProjectRoot();
if (foundGitIgnoreFile && foundGitIgnoreFile.includes(rootDirectory)) {
const contents = await readFile(foundGitIgnoreFile, 'utf-8');
if (!contents.includes('*storybook.log')) {
await appendFile(foundGitIgnoreFile, '\n*storybook.log');
}
}

const storybookCommand =
projectType === ProjectType.ANGULAR
? `ng run ${installResult.projectName}:storybook`
Expand Down