Make example folder self-contained

README.md

@@ -30,6 +30,7 @@ $ npx schemalint
 Here is an example configuration file:
 
 ```javascript
+/** @type {import("schemalint").Config } */
 module.exports = {
   // Connection configuration. See: https://node-postgres.com/apis/client
   connection: {
@@ -40,12 +41,12 @@ module.exports = {
     charset: "utf8",
   },
 
-  // Schemas to lint.
+  // Schemas to be linted.
   schemas: [{ name: "public" }],
 
   // Rules to be checked. The key is the rule name and the value is an array
-  // whose first value is the severity (only "error" is supported) and the
-  // rest are rule-specific parameters.
+  // whose first value is the severity ("error" to enable the rule, "off" to
+  // disable it) and the rest are rule-specific parameters.
   rules: {
     "name-casing": ["error", "snake"],
     "name-inflection": ["error", "singular"],

example/.schemalintrc.js

@@ -1,3 +1,4 @@
+/** @type {import('schemalint').Config } */
 module.exports = {
   connection: {
     host: 'localhost',
@@ -8,7 +9,7 @@ module.exports = {
     port: 54321,
   },
 
-  plugins: ['./example/custom-rules'],
+  plugins: ['./custom-rules'],
 
   rules: {
     'identifier-naming': ['error'],

example/README.md

@@ -12,16 +12,16 @@ I've created a Docker image that hosts it so if you have Docker installed, you c
 npm run start-example-db
 ```
 
-First, run the build script in this folder with:
+First, run the install command in this folder with:
 
 ```
-npm run build
+npm install
 ```
 
-Then, run the config file in this folder with:
+Then, run the schemalint using the config file `schemalintrc.js` in this folder with:
 
 ```
-npm run run-example
+npm run lint:schema  # or just `npx schemalint`
 ```
 
 You should see output like this:

example/custom-rules/identifierNaming.js

@@ -1,5 +1,6 @@
 // This example rule will enforce primary key columns be named like this: tablename_id
 
+/** @type {import('schemalint').Rule} */
 const identifierNaming = {
   name: 'identifier-naming',
   docs: {