squawk-cli 0.24.0 → 0.24.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +11 -1
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # squawk [![npm](https://img.shields.io/npm/v/squawk-cli)](https://www.npmjs.com/package/squawk-cli) ![Rust CI](https://github.com/sbdchd/squawk/workflows/Rust%20CI/badge.svg)
1
+ # squawk [![npm](https://img.shields.io/npm/v/squawk-cli)](https://www.npmjs.com/package/squawk-cli)
2
2
 
3
3
  > linter for Postgres migrations
4
4
 
@@ -188,6 +188,8 @@ Note the `files` parameter as it specifies the location of the files to be linte
188
188
  - <https://github.com/tbicr/django-pg-zero-downtime-migrations>
189
189
  - <https://github.com/3YOURMIND/django-migration-linter>
190
190
  - <https://github.com/ankane/strong_migrations>
191
+ - <https://github.com/AdmTal/PostgreSQL-Query-Lock-Explainer>
192
+ - <https://github.com/stripe/pg-schema-diff>
191
193
 
192
194
  ## related blog posts / SE Posts / PG Docs
193
195
 
@@ -222,6 +224,14 @@ $ nix develop
222
224
  [nix-shell]$ ./s/fmt
223
225
  ```
224
226
 
227
+ ### adding a new rule
228
+
229
+ When adding a new rule, the `s/new-rule` script will create stubs for your rule in Rust and in Documentation site.
230
+
231
+ ```bash
232
+ s/new-rule 'prefer big serial'
233
+ ```
234
+
225
235
  ### releasing a new version
226
236
 
227
237
  1. update the CHANGELOG.md and bump version in the cli `Cargo.toml`, ensure the
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "squawk-cli",
3
- "version": "0.24.0",
3
+ "version": "0.24.1",
4
4
  "description": "linter for PostgreSQL, focused on migrations",
5
5
  "repository": "git@github.com:sbdchd/squawk.git",
6
6
  "author": "Steve Dignam <steve@dignam.xyz>",