Skip to content

feat(@deepnote/cli): support linting integrations env yaml file directly #337

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
jamesbhobbs merged 15 commits into from
Jun 25, 2026
Merged

feat(@deepnote/cli): support linting integrations env yaml file directly #337

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
82b0acc
feat(@deepnote/cli): support linting integrations env yaml file directly
tkislan Feb 23, 2026
3c63078
fix(@deepnote/cli): correct JSON success and explicit integrations-fi…
tkislan Jun 4, 2026
c4a9f02
fix(@deepnote/cli): match SQL env var name for digit-prefixed integra…
tkislan Jun 4, 2026
fdf4d7a
test(@deepnote/cli): snapshot/whole-object lint assertions; reuse get…
tkislan Jun 4, 2026
5a32ba1
Remove duplicate sql var name function
tkislan Jun 5, 2026
0925d5d
Merge origin/main into tk/lint-integrations-env-file
tkislan Jun 5, 2026
b93bb54
fix(@deepnote/cli): surface integration env-var generation errors and…
tkislan Jun 5, 2026
2e05dc3
docs(@deepnote/cli): sync deepnote skill for new lint CLI contract
tkislan Jun 5, 2026
4beffa5
Fix spell check
tkislan Jun 5, 2026
fd3de37
fix(@deepnote/runtime-core): replace console.error with injected onWa…
tkislan Jun 5, 2026
8f2ad0d
Run prettier
tkislan Jun 5, 2026
e1b3c1c
chore(repo): merge main into tk/lint-integrations-env-file
jamesbhobbs Jun 25, 2026
8552e71
fix(@deepnote/cli): import ValidationIssue from @deepnote/database-in…
jamesbhobbs Jun 25, 2026
90465b6
test(@deepnote/cli): add cloud-sql to integration type snapshots
jamesbhobbs Jun 25, 2026
b9176a1
fix(@deepnote/cli): tidy lint integrations-yaml edge cases
jamesbhobbs Jun 25, 2026
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
25 changes: 22 additions & 3 deletions packages/cli/src/cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -599,11 +599,15 @@ ${c.bold('Examples:')}
// Lint command - check for issues
program
.command('lint')
.description('Check a .deepnote file for issues')
.argument('<path>', 'Path to a .deepnote file')
.description('Check a .deepnote file or integrations yaml file for issues')
.argument('[path]', `Path to a .deepnote file or ${DEFAULT_INTEGRATIONS_FILE} (defaults to current directory)`)
.option('-o, --output <format>', 'Output format: json, llm', createFormatValidator(['json'], JSON_LLM_RESOLUTION))
.option('--notebook <name>', 'Lint only a specific notebook')
.option('--python <path>', 'Path to Python interpreter')
.option(
'--integrations-file <path>',
`Path to integrations env file (default: ${DEFAULT_INTEGRATIONS_FILE} next to .deepnote file)`
)
.addHelpText('after', () => {
const c = getChalk()
return `
Expand All @@ -617,25 +621,40 @@ ${c.bold('Checks:')}

${c.underline('Integrations')}
- missing-integration: SQL blocks using integrations that are not configured
- configuration errors in ${DEFAULT_INTEGRATIONS_FILE} (YAML syntax, schema, missing env vars)

${c.underline('Inputs')}
- missing-input: Input blocks without default values

${c.bold('Integrations File:')}
Integrations are automatically loaded from ${DEFAULT_INTEGRATIONS_FILE} in the same directory as the
.deepnote file (or from --integrations-file if specified). This allows the lint command to detect
which SQL integrations are properly configured and report configuration errors explicitly.

You can also lint an integrations yaml file directly by passing it as the path argument.
This validates the file structure, integration schemas, and environment variable references.

${c.bold('Exit Codes:')}
0 No errors found (warnings may be present)
1 One or more errors found
1 One or more errors found (including configuration errors)
2 Invalid usage (bad arguments, file not found)

${c.bold('Examples:')}
${c.dim('# Lint a .deepnote file')}
$ deepnote lint my-project.deepnote

${c.dim('# Lint an integrations yaml file directly')}
$ deepnote lint ${DEFAULT_INTEGRATIONS_FILE}

${c.dim('# Output as JSON for CI/CD')}
$ deepnote lint my-project.deepnote -o json

${c.dim('# Lint only a specific notebook')}
$ deepnote lint my-project.deepnote --notebook "Analysis"

${c.dim('# Use a custom integrations file')}
$ deepnote lint my-project.deepnote --integrations-file prod-integrations.yaml

${c.dim('# Use in CI pipeline')}
$ deepnote lint my-project.deepnote || exit 1
`
Expand Down
Loading