Merge pull request #288 from MH4GF/detect-cruise-script

feat: detect cruise script

README.md

@@ -53,7 +53,7 @@ For more information on config file, please see [the official documentation](htt
 
 ### Customizing cruise script
 
-This action automatically adds necessary flags to your cruise script. The default script is:
+This action automatically adds necessary flags to your cruise script based on package manager. For example, if you are using yarn, the default script is:
 
 ```bash
 yarn run -s depcruise

action.yml

@@ -10,9 +10,8 @@ inputs:
     required: false
     description: 'read rules and options from file (e.g. .dependency-cruiser.js)'
   cruise-script:
-    required: true
+    required: false
     description: 'specify depcruise script (e.g. yarn depcruise)'
-    default: yarn run -s depcruise
   working-directory:
     required: false
     description: 'running actions in another directory'

src/options.ts

@@ -17,7 +17,7 @@ export const getOptions = (): Promise<Options> => {
   const changedFiles = core.getInput('target_files', { required: false }).split(' ')
   const targetFiles = filterSupportedFiles(changedFiles)
   const focus = formatFocusOption(targetFiles)
-  const cruiseScript = core.getInput('cruise_script', { required: true })
+  const cruiseScript = core.getInput('cruise_script', { required: false })
   const packageManager = core.getInput('package_manager', { required: false })
   const depcruiseConfigFilePath = getConfigFilePath()
   const pr = context.payload.pull_request

src/options/validateOptions.test.ts

@@ -15,7 +15,7 @@ const baseOptions: Options = {
   targetFiles: `test/runDepcruise/sample/__mocks__/test`,
   focus: `"^test/runDepcruise/sample/__mocks__/test/fixtures/cjs/root_one.js|^test/runDepcruise/sample/__mocks__/test/fixtures/cjs/root_two.js"`,
   depcruiseConfigFilePath: `test/runDepcruise/.dependency-cruiser.js`,
-  cruiseScript: 'yarn run -s depcruise',
+  cruiseScript: '',
   workingDirectory: 'test/runDepcruise',
   packageManager: 'yarn',
 }
@@ -50,4 +50,34 @@ describe('validateOptions', () => {
       new ValidationError('inputs.package_manager must be one of: yarn, npm, pnpm, bun'),
     )
   })
+
+  const cruiseScripts: Record<'packageManager' | 'result', string>[] = [
+    { packageManager: 'yarn', result: 'yarn run -s depcruise' },
+    { packageManager: 'npm', result: 'npx --no-install depcruise' },
+    { packageManager: 'pnpm', result: 'pnpm exec depcruise' },
+    { packageManager: 'bun', result: 'bun x depcruise' },
+  ]
+  describe.each(cruiseScripts)(
+    'detect default cruise script when cruiseScript is empty',
+    ({ packageManager, result }) => {
+      it(`return ${result} when packageManager is ${packageManager}`, async () => {
+        const options = {
+          ...baseOptions,
+          packageManager,
+          cruiseScript: '',
+        }
+        const resultOptions = await validateOptions(options)
+        expect(resultOptions.cruiseScript).toBe(result)
+      })
+    },
+  )
+  it("return cruiseScript when cruiseScript isn't empty", async () => {
+    const options = {
+      ...baseOptions,
+      packageManager: 'npm',
+      cruiseScript: 'npm run depcruise',
+    }
+    const resultOptions = await validateOptions(options)
+    expect(resultOptions.cruiseScript).toBe('npm run depcruise')
+  })
 })

src/options/validateOptions.ts

@@ -12,6 +12,24 @@ const MESSAGE_INVALID_PACKAGE_MANAGER = `inputs.package_manager must be one of:
 )}`
 const WARNING_MESSAGES = [MESSAGE_REQUIRED_TARGET_FILES]
 
+const packageManagerSchema = string()
+  .required()
+  .oneOf(SUPPORTED_PACKAGE_MANAGERS, MESSAGE_INVALID_PACKAGE_MANAGER)
+
+const detectedCruiseScript = (_packageManager: string): string => {
+  const packageManager = packageManagerSchema.validateSync(_packageManager)
+  switch (packageManager) {
+    case 'yarn':
+      return 'yarn run -s depcruise'
+    case 'npm':
+      return 'npx --no-install depcruise'
+    case 'pnpm':
+      return 'pnpm exec depcruise'
+    case 'bun':
+      return 'bun x depcruise'
+  }
+}
+
 const optionsSchema = object({
   token: string().required(),
   owner: string().required(),
@@ -21,11 +39,17 @@ const optionsSchema = object({
   targetFiles: string().required(MESSAGE_REQUIRED_TARGET_FILES),
   focus: string().required(),
   depcruiseConfigFilePath: string().required(),
-  cruiseScript: string().required(),
   workingDirectory: string().required(),
-  packageManager: string()
-    .required()
-    .oneOf(SUPPORTED_PACKAGE_MANAGERS, MESSAGE_INVALID_PACKAGE_MANAGER),
+  packageManager: packageManagerSchema,
+  cruiseScript: string()
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+    .transform((value) => (value === '' ? undefined : value))
+    .when('packageManager', ([packageManager], schema) => {
+      return typeof packageManager === 'string'
+        ? schema.default(detectedCruiseScript(packageManager))
+        : schema
+    })
+    .required(),
 })
 
 export type Options = InferType<typeof optionsSchema>