squawk-cli 2.22.0__tar.gz → 2.24.0__tar.gz

{squawk_cli-2.22.0 → squawk_cli-2.24.0}/Cargo.lock

@@ -2596,7 +2596,7 @@ checksum = "6e63cff320ae2c57904679ba7cb63280a3dc4613885beafb148ee7bf9aa9042d"
 
 [[package]]
 name = "squawk"
-version = "2.22.0"
+version = "2.24.0"
 dependencies = [
  "annotate-snippets",
  "anyhow",
@@ -2673,6 +2673,7 @@ name = "squawk_server"
 version = "0.0.0"
 dependencies = [
  "anyhow",
+ "insta",
  "line-index",
  "log",
  "lsp-server",

{squawk_cli-2.22.0 → squawk_cli-2.24.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: squawk-cli
-Version: 2.22.0
+Version: 2.24.0
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: MacOS

{squawk_cli-2.22.0 → squawk_cli-2.24.0}/crates/squawk/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "squawk"
-version = "2.22.0"
+version = "2.24.0"
 default-run = "squawk"
 
 authors.workspace = true

{squawk_cli-2.22.0 → squawk_cli-2.24.0}/crates/squawk/README.md

@@ -179,7 +179,7 @@ You can also ignore multiple rules by making a comma seperated list:
 alter table t drop column c cascade;
 ```
 
-To ignore a rule for the entire rule, use `squawk-ignore-file`:
+To ignore a rule for the entire file, use `squawk-ignore-file`:
 
 ```sql
 -- squawk-ignore-file ban-drop-column

{squawk_cli-2.22.0 → squawk_cli-2.24.0}/crates/squawk/src/github.rs

@@ -33,6 +33,7 @@ fn get_github_private_key(
 }
 
 fn create_gh_app(
+    github_api_url: Option<String>,
     github_install_id: Option<i64>,
     github_app_id: Option<i64>,
     github_token: Option<String>,
@@ -51,7 +52,11 @@ fn create_gh_app(
 
     if let Some(github_token) = github_token {
         info!("using github actions client");
-        return Ok(Box::new(actions::GitHub::new(&github_token)));
+        let client = match github_api_url {
+            Some(github_api_url) => actions::GitHub::new_with_url(&github_api_url, &github_token),
+            None => actions::GitHub::new(&github_token),
+        };
+        return Ok(Box::new(client));
     };
     bail!(
         "Missing GitHub credentials:
@@ -84,6 +89,7 @@ pub fn check_and_comment_on_pr(
         paths,
         fail_on_violations,
         github_private_key,
+        github_api_url,
         github_token,
         github_app_id,
         github_install_id,
@@ -101,6 +107,7 @@ pub fn check_and_comment_on_pr(
         };
 
     let github_app = create_gh_app(
+        github_api_url,
         github_install_id,
         github_app_id,
         github_token,

{squawk_cli-2.22.0 → squawk_cli-2.24.0}/crates/squawk/src/main.rs

@@ -32,6 +32,9 @@ pub struct UploadToGithubArgs {
     github_private_key: Option<String>,
     #[structopt(long, env = "SQUAWK_GITHUB_PRIVATE_KEY_BASE64")]
     github_private_key_base64: Option<String>,
+    /// GitHub API url.
+    #[structopt(long, env = "SQUAWK_GITHUB_API_URL")]
+    github_api_url: Option<String>,
     #[structopt(long, env = "SQUAWK_GITHUB_TOKEN")]
     github_token: Option<String>,
     /// GitHub App Id.

{squawk_cli-2.22.0 → squawk_cli-2.24.0}/crates/squawk/src/reporter.rs

@@ -34,7 +34,7 @@ fn check_sql(
     linter.settings.assume_in_transaction = assume_in_transaction;
     let parse = SourceFile::parse(sql);
     let parse_errors = parse.errors();
-    let errors = linter.lint(parse, sql);
+    let errors = linter.lint(&parse, sql);
     let line_index = LineIndex::new(sql);
 
     let mut violations = Vec::with_capacity(parse_errors.len() + errors.len());

{squawk_cli-2.22.0 → squawk_cli-2.24.0}/crates/squawk_github/src/actions.rs

@@ -1,13 +1,20 @@
 use crate::app;
-use crate::{Comment, GitHubApi, GithubError};
+use crate::{Comment, DEFAULT_GITHUB_API_URL, GitHubApi, GithubError};
 
 pub struct GitHub {
+    github_api_url: String,
     github_token: String,
 }
 impl GitHub {
     #[must_use]
     pub fn new(github_token: &str) -> Self {
+        Self::new_with_url(DEFAULT_GITHUB_API_URL, github_token)
+    }
+
+    #[must_use]
+    pub fn new_with_url(github_api_url: &str, github_token: &str) -> Self {
         GitHub {
+            github_api_url: github_api_url.to_string(),
             github_token: github_token.to_string(),
         }
     }
@@ -24,6 +31,7 @@ impl GitHubApi for GitHub {
         body: &str,
     ) -> Result<(), GithubError> {
         app::create_comment(
+            &self.github_api_url,
             app::CommentArgs {
                 owner: owner.to_string(),
                 repo: repo.to_string(),
@@ -40,6 +48,7 @@ impl GitHubApi for GitHub {
         issue_id: i64,
     ) -> Result<Vec<Comment>, GithubError> {
         app::list_comments(
+            &self.github_api_url,
             &app::PullRequest {
                 issue: issue_id,
                 owner: owner.to_string(),
@@ -56,6 +65,7 @@ impl GitHubApi for GitHub {
         body: &str,
     ) -> Result<(), GithubError> {
         app::update_comment(
+            &self.github_api_url,
             owner,
             repo,
             comment_id,

{squawk_cli-2.22.0 → squawk_cli-2.24.0}/crates/squawk_github/src/app.rs

@@ -1,7 +1,7 @@
 #![allow(clippy::doc_markdown)]
 #![allow(clippy::missing_errors_doc)]
 #![allow(clippy::single_match_else)]
-use crate::{Comment, GitHubApi, GithubError};
+use crate::{Comment, DEFAULT_GITHUB_API_URL, GitHubApi, GithubError};
 use jsonwebtoken::{Algorithm, EncodingKey, Header};
 
 use log::info;
@@ -32,10 +32,14 @@ pub struct GithubAccessToken {
     pub token: String,
 }
 /// https://developer.github.com/v3/apps/#create-an-installation-access-token-for-an-app
-fn create_access_token(jwt: &str, install_id: i64) -> Result<GithubAccessToken, GithubError> {
+fn create_access_token(
+    github_api_url: &str,
+    jwt: &str,
+    install_id: i64,
+) -> Result<GithubAccessToken, GithubError> {
     Ok(reqwest::Client::new()
         .post(&format!(
-            "https://api.github.com/app/installations/{install_id}/access_tokens",
+            "{github_api_url}/app/installations/{install_id}/access_tokens",
         ))
         .header(AUTHORIZATION, format!("Bearer {jwt}"))
         .header(ACCEPT, "application/vnd.github.machine-man-preview+json")
@@ -45,11 +49,15 @@ fn create_access_token(jwt: &str, install_id: i64) -> Result<GithubAccessToken,
 }
 
 /// https://developer.github.com/v3/issues/comments/#create-an-issue-comment
-pub(crate) fn create_comment(comment: CommentArgs, secret: &str) -> Result<(), GithubError> {
+pub(crate) fn create_comment(
+    github_api_url: &str,
+    comment: CommentArgs,
+    secret: &str,
+) -> Result<(), GithubError> {
     let comment_body = CommentBody { body: comment.body };
     reqwest::Client::new()
         .post(&format!(
-            "https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/comments",
+            "{github_api_url}/repos/{owner}/{repo}/issues/{issue_number}/comments",
             owner = comment.owner,
             repo = comment.repo,
             issue_number = comment.issue
@@ -68,9 +76,9 @@ pub struct GitHubAppInfo {
 }
 
 /// Get the bot name for finding existing comments on a PR
-pub fn get_app_info(jwt: &str) -> Result<GitHubAppInfo, GithubError> {
+pub fn get_app_info(github_api_url: &str, jwt: &str) -> Result<GitHubAppInfo, GithubError> {
     Ok(reqwest::Client::new()
-        .get("https://api.github.com/app")
+        .get(&format!("{github_api_url}/app"))
         .header(AUTHORIZATION, format!("Bearer {jwt}"))
         .send()?
         .error_for_status()?
@@ -142,12 +150,16 @@ pub struct PullRequest {
 }
 
 /// https://developer.github.com/v3/issues/comments/#list-issue-comments
-pub(crate) fn list_comments(pr: &PullRequest, secret: &str) -> Result<Vec<Comment>, GithubError> {
+pub(crate) fn list_comments(
+    github_api_url: &str,
+    pr: &PullRequest,
+    secret: &str,
+) -> Result<Vec<Comment>, GithubError> {
     // TODO(sbdchd): use the next links to get _all_ the comments
     // see: https://developer.github.com/v3/guides/traversing-with-pagination/
     Ok(reqwest::Client::new()
         .get(&format!(
-            "https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/comments",
+            "{github_api_url}/repos/{owner}/{repo}/issues/{issue_number}/comments",
             owner = pr.owner,
             repo = pr.repo,
             issue_number = pr.issue
@@ -161,6 +173,7 @@ pub(crate) fn list_comments(pr: &PullRequest, secret: &str) -> Result<Vec<Commen
 
 /// https://developer.github.com/v3/issues/comments/#update-an-issue-comment
 pub(crate) fn update_comment(
+    github_api_url: &str,
     owner: &str,
     repo: &str,
     comment_id: i64,
@@ -169,7 +182,7 @@ pub(crate) fn update_comment(
 ) -> Result<(), GithubError> {
     reqwest::Client::new()
         .patch(&format!(
-            "https://api.github.com/repos/{owner}/{repo}/issues/comments/{comment_id}",
+            "{github_api_url}/repos/{owner}/{repo}/issues/comments/{comment_id}",
         ))
         .header(AUTHORIZATION, format!("Bearer {secret}"))
         .json(&CommentBody { body })
@@ -179,19 +192,30 @@ pub(crate) fn update_comment(
 }
 
 pub struct GitHub {
+    github_api_url: String,
     slug_name: String,
     installation_access_token: String,
 }
 
 impl GitHub {
     pub fn new(private_key: &str, app_id: i64, installation_id: i64) -> Result<Self, GithubError> {
+        Self::new_with_url(DEFAULT_GITHUB_API_URL, private_key, app_id, installation_id)
+    }
+
+    pub fn new_with_url(
+        github_api_url: &str,
+        private_key: &str,
+        app_id: i64,
+        installation_id: i64,
+    ) -> Result<Self, GithubError> {
         info!("generating jwt");
         let jwt = generate_jwt(private_key, app_id)?;
         info!("getting app info");
-        let app_info = get_app_info(&jwt)?;
-        let access_token = create_access_token(&jwt, installation_id)?;
+        let app_info = get_app_info(github_api_url, &jwt)?;
+        let access_token = create_access_token(github_api_url, &jwt, installation_id)?;
 
         Ok(GitHub {
+            github_api_url: github_api_url.to_string(),
             slug_name: format!("{}[bot]", app_info.slug),
             installation_access_token: access_token.token,
         })
@@ -210,6 +234,7 @@ impl GitHubApi for GitHub {
         body: &str,
     ) -> Result<(), GithubError> {
         create_comment(
+            &self.github_api_url,
             CommentArgs {
                 owner: owner.to_string(),
                 repo: repo.to_string(),
@@ -226,6 +251,7 @@ impl GitHubApi for GitHub {
         issue_id: i64,
     ) -> Result<Vec<Comment>, GithubError> {
         list_comments(
+            &self.github_api_url,
             &PullRequest {
                 owner: owner.to_string(),
                 repo: repo.to_string(),
@@ -242,6 +268,7 @@ impl GitHubApi for GitHub {
         body: &str,
     ) -> Result<(), GithubError> {
         update_comment(
+            &self.github_api_url,
             owner,
             repo,
             comment_id,

{squawk_cli-2.22.0 → squawk_cli-2.24.0}/crates/squawk_github/src/lib.rs

@@ -8,6 +8,8 @@ use std::error::Error;
 use log::info;
 use serde::{Deserialize, Serialize};
 
+pub(crate) const DEFAULT_GITHUB_API_URL: &'static str = "https://api.github.com";
+
 #[derive(Debug)]
 pub enum GithubError {
     JsonWebTokenCreation(jsonwebtoken::errors::Error),

{squawk_cli-2.22.0 → squawk_cli-2.24.0}/crates/squawk_linter/src/ignore.rs

@@ -42,10 +42,10 @@ fn comment_body(token: &SyntaxToken) -> Option<(&str, TextRange)> {
 }
 
 // TODO: maybe in a future version we can rename this to squawk-ignore-line
-const IGNORE_LINE_TEXT: &str = "squawk-ignore";
-const IGNORE_FILE_TEXT: &str = "squawk-ignore-file";
+pub const IGNORE_LINE_TEXT: &str = "squawk-ignore";
+pub const IGNORE_FILE_TEXT: &str = "squawk-ignore-file";
 
-fn ignore_rule_names(token: &SyntaxToken) -> Option<(&str, TextRange, IgnoreKind)> {
+pub fn ignore_rule_info(token: &SyntaxToken) -> Option<(&str, TextRange, IgnoreKind)> {
     if let Some((comment_body, range)) = comment_body(token) {
         let without_start = comment_body.trim_start();
         let trim_start_size = comment_body.len() - without_start.len();
@@ -74,7 +74,7 @@ pub(crate) fn find_ignores(ctx: &mut Linter, file: &SyntaxNode) {
             rowan::WalkEvent::Enter(NodeOrToken::Token(token))
                 if token.kind() == SyntaxKind::COMMENT =>
             {
-                if let Some((rule_names, range, kind)) = ignore_rule_names(&token) {
+                if let Some((rule_names, range, kind)) = ignore_rule_info(&token) {
                     let mut set = HashSet::new();
                     let mut offset = 0usize;
 
@@ -98,11 +98,10 @@ pub(crate) fn find_ignores(ctx: &mut Linter, file: &SyntaxNode) {
                             let end = start + TextSize::new(trimmed.len() as u32);
                             let range = TextRange::new(start, end);
 
-                            ctx.report(Violation::new(
+                            ctx.report(Violation::for_range(
                                 Rule::UnusedIgnore,
                                 format!("unknown name {trimmed}"),
                                 range,
-                                None,
                             ));
                         }
 
@@ -144,6 +143,37 @@ alter table t drop column c cascade;
         assert!(ignore.violation_names.contains(&Rule::BanDropColumn));
     }
 
+    #[test]
+    fn multiple_sql_comments_with_ignore_is_ok() {
+        let sql = "
+-- fooo bar
+-- buzz
+-- squawk-ignore prefer-robust-stmts
+create table x();
+
+select 1;
+";
+
+        let parse = squawk_syntax::SourceFile::parse(sql);
+        let mut linter = Linter::with_all_rules();
+        find_ignores(&mut linter, &parse.syntax_node());
+
+        assert_eq!(linter.ignores.len(), 1);
+        let ignore = &linter.ignores[0];
+        assert!(
+            ignore.violation_names.contains(&Rule::PreferRobustStmts),
+            "Make sure we picked up the ignore"
+        );
+
+        let errors = linter.lint(&parse, sql);
+
+        assert_eq!(
+            errors,
+            vec![],
+            "We shouldn't have any errors because we have the ignore setup"
+        );
+    }
+
     #[test]
     fn single_ignore_c_style_comment() {
         let sql = r#"
@@ -217,7 +247,7 @@ create table users (
 "#;
 
         let parse = squawk_syntax::SourceFile::parse(sql);
-        let errors = linter.lint(parse, sql);
+        let errors = linter.lint(&parse, sql);
         assert_eq!(errors.len(), 0);
     }
 
@@ -227,7 +257,7 @@ create table users (
         let sql = r#"alter table t add column c char;"#;
 
         let parse = squawk_syntax::SourceFile::parse(sql);
-        let errors = linter.lint(parse, sql);
+        let errors = linter.lint(&parse, sql);
         assert_eq!(errors.len(), 1);
     }
 
@@ -244,7 +274,7 @@ create table test_table (
         "#;
 
         let parse = squawk_syntax::SourceFile::parse(sql);
-        let errors = linter.lint(parse, sql);
+        let errors = linter.lint(&parse, sql);
         assert_eq!(errors.len(), 0);
     }
 
@@ -282,7 +312,7 @@ alter table t drop column c cascade;
         assert!(ignore.violation_names.is_empty());
 
         let errors: Vec<_> = linter
-            .lint(parse, sql)
+            .lint(&parse, sql)
             .into_iter()
             .map(|x| x.code)
             .collect();
@@ -353,7 +383,7 @@ alter table t2 drop column c2 cascade;
 
         let parse = squawk_syntax::SourceFile::parse(sql);
         let errors: Vec<_> = linter
-            .lint(parse, sql)
+            .lint(&parse, sql)
             .into_iter()
             .map(|x| x.code)
             .collect();
@@ -377,7 +407,7 @@ alter table t2 drop column c2 cascade;
 
         let parse = squawk_syntax::SourceFile::parse(sql);
         let errors: Vec<_> = linter
-            .lint(parse, sql)
+            .lint(&parse, sql)
             .into_iter()
             .map(|x| x.code)
             .collect();

{squawk_cli-2.22.0 → squawk_cli-2.24.0}/crates/squawk_linter/src/lib.rs

@@ -10,11 +10,12 @@ use rowan::TextRange;
 use rowan::TextSize;
 use serde::{Deserialize, Serialize};
 
+use squawk_syntax::SyntaxNode;
 use squawk_syntax::{Parse, SourceFile};
 
 pub use version::Version;
 
-mod ignore;
+pub mod ignore;
 mod ignore_index;
 mod version;
 mod visitors;
@@ -218,16 +219,6 @@ impl fmt::Display for Rule {
     }
 }
 
-#[derive(Debug, Clone, PartialEq, Eq)]
-pub struct Violation {
-    // TODO: should this be String instead?
-    pub code: Rule,
-    pub message: String,
-    pub text_range: TextRange,
-    pub help: Option<String>,
-    pub fix: Option<Fix>,
-}
-
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub struct Fix {
     pub title: String,
@@ -249,35 +240,71 @@ pub struct Edit {
     pub text: Option<String>,
 }
 impl Edit {
-    fn insert<T: Into<String>>(text: T, at: TextSize) -> Self {
+    pub fn insert<T: Into<String>>(text: T, at: TextSize) -> Self {
         Self {
             text_range: TextRange::new(at, at),
             text: Some(text.into()),
         }
     }
+    pub fn replace<T: Into<String>>(text_range: TextRange, text: T) -> Self {
+        Self {
+            text_range,
+            text: Some(text.into()),
+        }
+    }
+}
+
+#[derive(Debug, Clone, PartialEq, Eq)]
+pub struct Violation {
+    // TODO: should this be String instead?
+    pub code: Rule,
+    pub message: String,
+    pub text_range: TextRange,
+    pub help: Option<String>,
+    pub fix: Option<Fix>,
 }
 
 impl Violation {
     #[must_use]
-    pub fn new(
-        code: Rule,
-        message: String,
-        text_range: TextRange,
-        help: impl Into<Option<String>>,
-    ) -> Self {
+    pub fn for_node(code: Rule, message: String, node: &SyntaxNode) -> Self {
+        let range = node.text_range();
+
+        let start = node
+            .children_with_tokens()
+            .filter(|x| !x.kind().is_trivia())
+            .next()
+            .map(|x| x.text_range().start())
+            // Not sure we actually hit this, but just being safe
+            .unwrap_or_else(|| range.start());
+
+        Self {
+            code,
+            text_range: TextRange::new(start, range.end()),
+            message,
+            help: None,
+            fix: None,
+        }
+    }
+
+    #[must_use]
+    pub fn for_range(code: Rule, message: String, text_range: TextRange) -> Self {
         Self {
             code,
             text_range,
             message,
-            help: help.into(),
+            help: None,
             fix: None,
         }
     }
 
-    fn with_fix(mut self, fix: Option<Fix>) -> Violation {
+    fn fix(mut self, fix: Option<Fix>) -> Violation {
         self.fix = fix;
         self
     }
+    fn help(mut self, help: impl Into<String>) -> Violation {
+        self.help = Some(help.into());
+        self
+    }
 }
 
 #[derive(Default)]
@@ -303,7 +330,7 @@ impl Linter {
     }
 
     #[must_use]
-    pub fn lint(&mut self, file: Parse<SourceFile>, text: &str) -> Vec<Violation> {
+    pub fn lint(&mut self, file: &Parse<SourceFile>, text: &str) -> Vec<Violation> {
         if self.rules.contains(&Rule::AddingFieldWithDefault) {
             adding_field_with_default(self, &file);
         }

{squawk_cli-2.22.0 → squawk_cli-2.24.0}/crates/squawk_linter/src/rules/adding_field_with_default.rs

@@ -73,20 +73,24 @@ pub(crate) fn adding_field_with_default(ctx: &mut Linter, parse: &Parse<SourceFi
                                 if is_const_expr(&expr) || is_non_volatile(&expr) {
                                     continue;
                                 }
-                                ctx.report(Violation::new(
-                                    Rule::AddingFieldWithDefault,
-                                    message.into(),
-                                    expr.syntax().text_range(),
-                                    help.to_string(),
-                                ))
+                                ctx.report(
+                                    Violation::for_node(
+                                        Rule::AddingFieldWithDefault,
+                                        message.into(),
+                                        expr.syntax(),
+                                    )
+                                    .help(help),
+                                )
                             }
                             ast::Constraint::GeneratedConstraint(generated) => {
-                                ctx.report(Violation::new(
-                                    Rule::AddingFieldWithDefault,
-                                    message.into(),
-                                    generated.syntax().text_range(),
-                                    help.to_string(),
-                                ));
+                                ctx.report(
+                                    Violation::for_node(
+                                        Rule::AddingFieldWithDefault,
+                                        message.into(),
+                                        generated.syntax(),
+                                    )
+                                    .help(help),
+                                );
                             }
                             _ => (),
                         }

{squawk_cli-2.22.0 → squawk_cli-2.24.0}/crates/squawk_linter/src/rules/adding_foreign_key_constraint.rs

@@ -25,12 +25,14 @@ pub(crate) fn adding_foreign_key_constraint(ctx: &mut Linter, parse: &Parse<Sour
                                 ast::Constraint::ForeignKeyConstraint(_)
                                     | ast::Constraint::ReferencesConstraint(_)
                             ) {
-                                ctx.report(Violation::new(
-                                    Rule::AddingForeignKeyConstraint,
-                                    message.into(),
-                                    constraint.syntax().text_range(),
-                                    help.to_string(),
-                                ))
+                                ctx.report(
+                                    Violation::for_node(
+                                        Rule::AddingForeignKeyConstraint,
+                                        message.into(),
+                                        constraint.syntax(),
+                                    )
+                                    .help(help),
+                                )
                             }
                         }
                     }
@@ -41,12 +43,14 @@ pub(crate) fn adding_foreign_key_constraint(ctx: &mut Linter, parse: &Parse<Sour
                                 ast::Constraint::ForeignKeyConstraint(_)
                                     | ast::Constraint::ReferencesConstraint(_)
                             ) {
-                                ctx.report(Violation::new(
-                                    Rule::AddingForeignKeyConstraint,
-                                    message.into(),
-                                    constraint.syntax().text_range(),
-                                    help.to_string(),
-                                ))
+                                ctx.report(
+                                    Violation::for_node(
+                                        Rule::AddingForeignKeyConstraint,
+                                        message.into(),
+                                        constraint.syntax(),
+                                    )
+                                    .help(help),
+                                )
                             }
                         }
                     }

{squawk_cli-2.22.0 → squawk_cli-2.24.0}/crates/squawk_linter/src/rules/adding_not_null_field.rs

@@ -16,14 +16,12 @@ pub(crate) fn adding_not_null_field(ctx: &mut Linter, parse: &Parse<SourceFile>)
                     };
 
                     if matches!(option, ast::AlterColumnOption::SetNotNull(_)) {
-                        ctx.report(Violation::new(
+                        ctx.report(Violation::for_node(
                             Rule::AddingNotNullableField,
                             "Setting a column `NOT NULL` blocks reads while the table is scanned."
                                 .into(),
-                            option.syntax().text_range(),
-                            "Make the field nullable and use a `CHECK` constraint instead."
-                                .to_string(),
-                        ));
+                            option.syntax(),
+                        ).help("Make the field nullable and use a `CHECK` constraint instead."));
                     }
                 }
             }