feat: add cli command (#51)

* feat: add cli command

* add cli test

* fix

* put back plugin

* prettier

* update workflow

* update docs

.github/workflows/test.yaml

@@ -26,6 +26,31 @@ jobs:
 
       - name: Unit Tests
         run: npm run test
+  cli:
+    name: CLI
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: .nvmrc
+
+      - name: Install
+        run: npm ci
+
+      - name: Run cypress-codegen
+        run: npm run cli
+
+      - name: Check generated types match git
+        run: |
+          if [[ $(git status --porcelain) ]]; then
+            echo "Detected changes in generated types"
+            git status
+            exit 1
+          fi
   component:
     name: ${{ matrix.name }}
     strategy:

README.md

@@ -4,7 +4,7 @@
 [![npm version](https://badge.fury.io/js/cypress-codegen.svg)](https://www.npmjs.com/package/cypress-codegen)
 [![Downloads](https://img.shields.io/npm/dm/cypress-codegen.svg)](https://www.npmjs.com/package/cypress-codegen)
 
-A [Cypress](https://www.cypress.io/) plugin which automatically adds and enables IntelliSense for your [custom commands](https://docs.cypress.io/api/cypress-api/custom-commands)!
+A [Cypress](https://www.cypress.io/) plugin and CLI tool which automatically adds and enables IntelliSense for your [custom commands](https://docs.cypress.io/api/cypress-api/custom-commands)!
 
 ## Table of Contents
 
@@ -26,7 +26,7 @@ The `cypress-codegen` plugin will dynamically import all of your project's custo
 npm i --save-dev cypress-codegen
 ```
 
-## Usage
+## Plugin Usage
 
 Model your Cypress project exactly like [the one in this repository](https://github.com/ExpediaGroup/cypress-codegen/blob/main/cypress.config.ts)!
 
@@ -92,6 +92,12 @@ setupNodeEvents(on, config) {
 }
 ```
 
+## Command Line Usage
+
+You can also run `cypress-codegen` in your terminal to generate types for your Cypress project!
+
+Optionally pass the `--prettier-config` flag to pass in a stringified prettier config object.
+
 ## Configuration
 
 ### Project Flag