From f265be660528f10c9166dc78f536e688518e0844 Mon Sep 17 00:00:00 2001 From: danadajian Date: Sat, 16 Jul 2022 23:00:08 -0500 Subject: [PATCH] docs: improve README.md and fix typos --- README.md | 6 +++++- src/common.ts | 13 +++++++++++++ 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e7e9ffa6..1624aa6b 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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: diff --git a/src/common.ts b/src/common.ts index 10e79b09..e938459e 100644 --- a/src/common.ts +++ b/src/common.ts @@ -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');