-
Notifications
You must be signed in to change notification settings - Fork 73
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add new Init command for Project Setup
- Loading branch information
Showing
6 changed files
with
196 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| import boxen from "boxen"; | ||
| import {writeFile} from 'jsonfile'; | ||
| import prompts from 'prompts'; | ||
| import readPkgUp from 'read-pkg-up'; | ||
|
|
||
| import type { Configuration } from "../node-src/types"; | ||
| import noPackageJson from '../node-src/ui/messages/errors/noPackageJson'; | ||
|
|
||
|
|
||
| const TestFrameworkType = { | ||
| STORYBOOK: 'storybook', | ||
| PLAYWRIGHT: 'playwright', | ||
| CYPRESS: 'cypress' | ||
| }; | ||
|
|
||
| const addChromaticScriptToPackageJson = async (packageJson, packagePath) => { | ||
| try { | ||
| const scriptName = 'chromaticTest'; | ||
| const json = { ...packageJson }; | ||
| if (!json.scripts) json.scripts = {}; | ||
| json.scripts[scriptName] = `npx chromatic`; | ||
| await writeFile(packagePath, json, { spaces: 2 }); | ||
| } catch (e) { | ||
| console.warn(e) | ||
| } | ||
| } | ||
|
|
||
| const createChromaticConfigFile = async (configFile: string, configuration: Configuration) => { | ||
| await writeFile(configFile, configuration); | ||
| } | ||
|
|
||
| export async function main() { | ||
| console.log( | ||
| boxen('Welcome to Chromatic Initialization tool! This CLI will help get Chromatic setup within your project.', { | ||
| title: 'Chromatic Init', | ||
| titleAlignment: 'center', | ||
| textAlignment: 'center', | ||
| padding: 1, | ||
| borderStyle: 'double', | ||
| borderColor: '#FF4400', | ||
| }) | ||
| ) | ||
|
|
||
| const pkgInfo = await readPkgUp({ cwd: process.cwd() }); | ||
| if (!pkgInfo) { | ||
| console.error(noPackageJson()); | ||
| process.exit(253); | ||
| } | ||
|
|
||
| const { path: packagePath, packageJson } = pkgInfo; | ||
|
|
||
| const { buildScriptName} = await prompts([ | ||
| { | ||
| type: 'select', | ||
| name: 'testFramework', | ||
| message: 'What testing framework are you using?', | ||
| choices: [ | ||
| {title: 'Storybook', value: TestFrameworkType.STORYBOOK}, | ||
| {title: 'Playwright', value: TestFrameworkType.PLAYWRIGHT}, | ||
| {title: 'Cypress', value: TestFrameworkType.CYPRESS}, | ||
| ], | ||
| initial: 0 | ||
| }, | ||
| { | ||
| type: (prev) => prev === TestFrameworkType.STORYBOOK ? "text" : null, | ||
| name: 'buildScriptName', | ||
| message: "What is the name of the NPM script that builds your Storybook? (default: build-storybook)", | ||
| } | ||
| ]) | ||
| const {readme, _id, ...rest} = packageJson | ||
| await addChromaticScriptToPackageJson(rest, packagePath); | ||
| await createChromaticConfigFile('chromatic.config.json', { | ||
| autoAcceptChanges: "main", | ||
| ...(buildScriptName && { | ||
| buildScriptName | ||
| }), | ||
| // exitOnceUploaded: true, TODO: Only enable this option by default if project is linked. | ||
| externals: ["public/**"], | ||
| onlyChanged: true, | ||
| skip: "dependabot/**" | ||
| }) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters