Skip to content

Commit

Permalink
docs: improve README.md and fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
danadajian committed Jul 17, 2022
1 parent 57d7232 commit f265be6
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# cypress-codegen

[![GitHub Actions CI](https://github.com/ExpediaGroup/cypress-codegen/workflows/Release/badge.svg)](https://github.com/ExpediaGroup/cypress-codegen/actions?query=workflow%3ARelease)
[![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)!

## Table of Contents
Expand All @@ -24,7 +28,7 @@ npm i --save-dev cypress-codegen

## Usage

Model your Cypress project exactly like [the one in this repository](cypress.config.ts)!
Model your Cypress project exactly like [the one in this repository](https://github.com/ExpediaGroup/cypress-codegen/blob/main/cypress.config.ts)!

1. Add the required plugin code to `cypress.config.ts` like so:

Expand Down
13 changes: 13 additions & 0 deletions src/common.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
/*
Copyright 2022 Expedia, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

export const COMMANDS_DIRECTORY = 'cypress/commands';

export const isScopedMethod = (methodName: string) => methodName.endsWith('Scoped');

0 comments on commit f265be6

Please sign in to comment.