diff --git a/CHANGELOG.md b/CHANGELOG.md index 509113e..fd2b586 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # **Change Log** 📜📝 -All notable changes to "**@bumble/jest-chrome**" library will be +All notable changes to "**jest-chrome**" library will be documented in this file. The format is based on diff --git a/README.md b/README.md index c81757e..8f85b76 100755 --- a/README.md +++ b/README.md @@ -1,21 +1,17 @@ -# `@bumble/jest-chrome` +# `jest-chrome` A complete mock of the Chrome API for Chrome extensions, for use with Jest. -The `chrome` object is based on schemas from the Chromium -project, with thanks to -[`sinon-chrome`](https://github.com/acvetkov/sinon-chrome) for -compiling the schemas. - TypeScript support is built in. Each function and event is based -on -[`@types/chrome`](https://www.npmjs.com/package/@types/chrome). +on the +[`@types/chrome`](https://www.npmjs.com/package/@types/chrome) +package. ## Installation ```sh -npm i @bumble/jest-chrome -D +npm i jest-chrome -D ``` Set `chrome` in the global scope during setup so that it is @@ -36,14 +32,14 @@ Use the setup file to assign the mocked `chrome` object to the ```javascript // jest.setup.js -Object.assign(global, require('@bumble/jest-chrome')) +Object.assign(global, require('jest-chrome')) ``` -Import `chrome` from `@bumble/jest-chrome` for Intellisense and -linting. This is the same object as `chrome` in the global scope. +Import `chrome` from `jest-chrome` for Intellisense and linting. +This is the same object as `chrome` in the global scope. ```javascript -import { chrome } from '@bumble/jest-chrome' +import { chrome } from 'jest-chrome' ``` ## Usage @@ -201,3 +197,13 @@ test('chrome api functions with lastError', () => { expect(chrome.runtime.lastError).toBeUndefined() }) ``` + +### Contributions + +The `chrome` object is based on schemas from the Chromium +project, with thanks to +[`sinon-chrome`](https://github.com/acvetkov/sinon-chrome) for +compiling the schemas. + +Special thanks to [@shellscape](https://github.com/shellscape) +for transferring the NPM package name `jest-chrome` to us! diff --git a/package.json b/package.json index 9fe1327..8353358 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "@bumble/jest-chrome", + "name": "jest-chrome", "version": "0.5.3", "description": "Test Chrome extensions with Jest. A complete mock of the Chrome API.", "keywords": [ @@ -12,7 +12,8 @@ "test", "typescript" ], - "repository": "bumble-org/jest-chrome", + "repository": "github:extend-chrome/jest-chrome", + "bugs": "https://github.com/extend-chrome/jest-chrome/issues", "license": "MIT", "author": "Jack Steam ", "main": "lib/index.cjs.js",