Function createLintAction

packages/cli/src/commands/lint.ts:131–167

(_program: Command)

 * Creates the lint action - checks for issues in a .deepnote file or integrations yaml file.
 */
export function createLintAction(_program: Command): (path: string | undefined, options: LintOptions) => Promise<void> {
  return async (path, options) => {
    try {
      debug(`Linting: ${path}`)
      let result: LintFileResult
      if (path != null && isYamlPath(path)) {
        // The YAML file itself is the integrations file, so --integrations-file has no meaning here.
        if (options.integrationsFile) {
          warn('Warning: --integrations-file is ignored when linting an integrations YAML file directly')
        }
        result = await lintIntegrationsFile(path)
      } else {
        result = await lintFile(path, options)
      }
      outputLintResult(result, options)

      // Exit with error code if there are notebook errors or configuration errors
      const hasErrors = result.issueCount.errors > 0 || result.integrationsFile.issues.length > 0
      if (hasErrors) {
        process.exit(ExitCode.Error)
      }
    } catch (error) {
      const message = error instanceof Error ? error.message : String(error)
      const exitCode =
        error instanceof FileResolutionError || error instanceof InitNotebookResolutionError
          ? ExitCode.InvalidUsage
          : ExitCode.Error

      if (options.output === 'json') {
        outputJson({ success: false, error: message })
      } else {
        logError(message)
      }
      process.exit(exitCode)
    }
  }
}

async function lintFile(path: string | undefined, options: LintOptions): Promise<LintFileResult> {
  // Loading `.env` and injecting integration env vars mutates `process.env`; restore it afterwards