generate manually

Author: juleswritescode

docs/rule_sources.md

@@ -3,6 +3,7 @@
 ### Squawk
 | Squawk Rule Name | Rule Name |
 | ---- | ---- |
+| [adding-required-field](https://squawkhq.com/docs/adding-required-field) |[addingRequiredField](./rules/adding-required-field) |
 | [ban-drop-column](https://squawkhq.com/docs/ban-drop-column) |[banDropColumn](./rules/ban-drop-column) |
 | [ban-drop-not-null](https://squawkhq.com/docs/ban-drop-not-null) |[banDropNotNull](./rules/ban-drop-not-null) |
 | [ban-drop-table](https://squawkhq.com/docs/ban-drop-table) |[banDropTable](./rules/ban-drop-table) |

docs/rules.md

@@ -11,6 +11,7 @@ Below the list of rules supported by Postgres Language Tools, divided by group.
 Rules that detect potential safety issues in your code.
 | Rule name | Description | Properties |
 | --- | --- | --- |
+| [addingRequiredField](./rules/adding-required-field) | Adding a new column that is NOT NULL and has no default value to an existing table effectively makes it required. |  |
 | [banDropColumn](./rules/ban-drop-column) | Dropping a column may break existing clients. | <span class='inline-icon' title="This rule is recommended" ><Icon name="approve-check-circle" size="1.2rem" label="This rule is recommended" /></span> |
 | [banDropNotNull](./rules/ban-drop-not-null) | Dropping a NOT NULL constraint may break existing clients. | <span class='inline-icon' title="This rule is recommended" ><Icon name="approve-check-circle" size="1.2rem" label="This rule is recommended" /></span> |
 | [banDropTable](./rules/ban-drop-table) | Dropping a table may break existing clients. | <span class='inline-icon' title="This rule is recommended" ><Icon name="approve-check-circle" size="1.2rem" label="This rule is recommended" /></span> |

docs/rules/adding-required-field.md

@@ -0,0 +1,31 @@
+# addingRequiredField
+**Diagnostic Category: `lint/safety/addingRequiredField`**
+
+**Since**: `vnext`
+
+
+**Sources**: 
+- Inspired from: <a href="https://squawkhq.com/docs/adding-required-field" target="_blank"><code>squawk/adding-required-field</code></a>
+
+## Description
+Adding a new column that is NOT NULL and has no default value to an existing table effectively makes it required.
+
+This will fail immediately upon running for any populated table. Furthermore, old application code that is unaware of this column will fail to INSERT to this table.
+
+Make new columns optional initially by omitting the NOT NULL constraint until all existing data and application code has been updated. Once no NULL values are written to or persisted in the database, set it to NOT NULL.
+Alternatively, if using Postgres version 11 or later, add a DEFAULT value that is not volatile. This allows the column to keep its NOT NULL constraint.
+
+## Invalid
+
+alter table test add column count int not null;
+
+## Valid in Postgres >= 11
+
+alter table test add column count int not null default 0;
+
+## How to configure
+```toml title="pglt.toml"
+[linter.rules.safety]
+addingRequiredField = "error"
+
+```

docs/schemas/0.0.0/schema.json

@@ -292,6 +292,17 @@
       "description": "A list of rules that belong to this group",
       "type": "object",
       "properties": {
+        "addingRequiredField": {
+          "description": "Adding a new column that is NOT NULL and has no default value to an existing table effectively makes it required.",
+          "anyOf": [
+            {
+              "$ref": "#/definitions/RuleConfiguration"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
         "all": {
           "description": "It enables ALL rules for this group.",
           "type": [

docs/schemas/latest/schema.json

@@ -292,6 +292,17 @@
       "description": "A list of rules that belong to this group",
       "type": "object",
       "properties": {
+        "addingRequiredField": {
+          "description": "Adding a new column that is NOT NULL and has no default value to an existing table effectively makes it required.",
+          "anyOf": [
+            {
+              "$ref": "#/definitions/RuleConfiguration"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
         "all": {
           "description": "It enables ALL rules for this group.",
           "type": [