Commitc6fd31d

committed

feat: generate start and test NPM scripts (#303)

1 parent6773f73 commitc6fd31dCopy full SHA for c6fd31d

File tree

+53

-0

lines changed

+53

-0

lines changed

Lines changed: 15 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@ import getCommand from './utils/getCommand'`
`18`	`18`	`importgetLanguagefrom'./utils/getLanguage'`
`19`	`19`	`importrenderEslintfrom'./utils/renderEslint'`
`20`	`20`	`import{FILES_TO_FILTER}from'./utils/filterList'`
	`21`	`+importaddNpmScriptfrom'./utils/addNpmScript'`
`21`	`22`
`22`	`23`	`functionisValidPackageName(projectName){`
`23`	`24`	`return/^(?:@[a-z0-9-~][a-z0-9-._~]\/)?[a-z0-9-~][a-z0-9-._~]$/.test(projectName)`
`@@ -491,6 +492,20 @@ async function init() {`
`491`	`492`	`constuserAgent=process.env.npm_config_user_agent??''`
`492`	`493`	`constpackageManager=/pnpm/.test(userAgent) ?'pnpm' :/yarn/.test(userAgent) ?'yarn' :'npm'`
`493`	`494`
	`495`	`+// Extend the package.json with the test script`
	`496`	`+constpackageJsonPath=path.resolve(root,'package.json')`
	`497`	`+addNpmScript('start',packageManager,'dev',packageJsonPath)`
	`498`	`+if(`
	`499`	`+(needsCypress\|\|needsNightwatch\|\|needsPlaywright)&&`
	`500`	`+!needsVitest&&`
	`501`	`+!needsCypressCT&&`
	`502`	`+!needsNightwatchCT`
	`503`	`+){`
	`504`	`+addNpmScript('test',packageManager,'test:e2e',packageJsonPath)`
	`505`	`+}elseif(needsVitest\|\|needsCypressCT\|\|needsNightwatchCT){`
	`506`	`+addNpmScript('test',packageManager,'test:unit',packageJsonPath)`
	`507`	`+}`
	`508`	`+`
`494`	`509`	`// README generation`
`495`	`510`	`fs.writeFileSync(`
`496`	`511`	`path.resolve(root,'README.md'),`

Lines changed: 5 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -37,4 +37,9 @@ for (const projectName of projects) {`
`37`	`37`	console.log(`Running unit tests in${projectName}`)
`38`	`38`	await$`pnpm test:unit`
`39`	`39`	`}`
	`40`	`+`
	`41`	`+if('test:unit'inpackageJSON.scripts\|\|'test:e2e'inpackageJSON.scripts){`
	`42`	+console.log(`Running the test script in${projectName}`)
	`43`	+await$`pnpm test`
	`44`	`+}`
`40`	`45`	`}`

Lines changed: 33 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,33 @@`
	`1`	`+import*asfsfrom'node:fs'`
	`2`	`+`
	`3`	`+/**`
	`4`	`+ * Adds a new NPM script to the generated package.json file.`
	`5`	`+ * The new script invokes another existing script with the package manager used by the developer,`
	`6`	`+ * and is placed directly after the referenced NPM script.`
	`7`	`+ *@param {string} scriptName the name of the new NPM script`
	`8`	`+ *@param {string} packageManager the name of the used package manager, e.g. npm, pnpm or yarn`
	`9`	`+ *@param {string} invokedScriptName the name of the invoked NPM script`
	`10`	`+ *@param {string} packageJsonPath the path of the destination package.json file`
	`11`	`+ */`
	`12`	`+functionaddNpmScript(`
	`13`	`+scriptName:string,`
	`14`	`+packageManager:string,`
	`15`	`+invokedScriptName:string,`
	`16`	`+packageJsonPath:string`
	`17`	`+){`
	`18`	`+constpackageJson=JSON.parse(fs.readFileSync(packageJsonPath,'utf-8'))`
	`19`	`+constcommand=`
	`20`	`+packageManager==='npm'`
	`21`	+ ?`npm run${invokedScriptName}`
	`22`	+ :`${packageManager}${invokedScriptName}`
	`23`	`+packageJson.scripts=Object.entries(packageJson.scripts).reduce((result,entry)=>{`
	`24`	`+result[entry[0]]=entry[1]`
	`25`	`+if(entry[0]===invokedScriptName){`
	`26`	`+result[scriptName]=command`
	`27`	`+}`
	`28`	`+returnresult`
	`29`	`+},{})`
	`30`	`+fs.writeFileSync(packageJsonPath,JSON.stringify(packageJson,null,2)+'\n')`
	`31`	`+}`
	`32`	`+`
	`33`	`+exportdefaultaddNpmScript`

Comments

(0)