global-jsdom 8.7.0 → 8.8.0

package/commonjs/register.cjs

@@ -0,0 +1,4 @@
+/* eslint-disable */
+const jsdom = require('./index.cjs')
+
+jsdom()

package/package.json

@@ -1,28 +1,30 @@
 {
   "name": "global-jsdom",
   "description": "Enable DOM in Node.js",
-  "version": "8.7.0",
+  "version": "8.8.0",
   "author": {
     "name": "jonathan schatz",
     "email": "jon@divisionbyzero.com",
     "url": "https://github.com/modosc"
   },
-  "type": "commonjs",
-  "main": "./commonjs/index.js",
+  "type": "module",
   "exports": {
     ".": {
-      "require": "./commonjs/index.js",
+      "require": "./commonjs/index.cjs",
       "default": "./esm/index.mjs"
     },
     "./register": {
-      "require": "./commonjs/register.js",
+      "require": "./commonjs/register.cjs",
       "default": "./esm/register.mjs"
     }
   },
   "module": "./esm/index.mjs",
+  "main": "./commonjs/index.cjs",
+  "types": "types/index.d.ts",
   "files": [
     "commonjs/*",
-    "esm/*"
+    "esm/*",
+    "types/*"
   ],
   "bugs": {
     "url": "https://github.com/modosc/global-jsdom/issues"
@@ -31,13 +33,13 @@
     "Rico Sta. Cruz <rico@ricostacruz.com>"
   ],
   "devDependencies": {
-    "chai": "^4.1.2",
-    "eslint": "^8.2.2",
+    "chai": "^4.3.7",
+    "eslint": "^8.36.0",
     "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-plugin-import": "^2.7.0",
+    "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-mocha": "^10.1.0",
-    "jsdom": "^21.0.0",
-    "mocha": "^10.0.0"
+    "jsdom": "^21.1.1",
+    "mocha": "^10.2.0"
   },
   "homepage": "https://github.com/modosc/global-jsdom#readme",
   "keywords": [
@@ -57,12 +59,10 @@
     "url": "git+https://github.com/modosc/global-jsdom.git"
   },
   "scripts": {
-    "test": "yarn test:jsdom && yarn test:examples",
-    "test:jsdom": "yarn test:jsdom:esm && yarn test:jsdom:commonjs",
-    "test:jsdom:esm": "yarn mocha --require test/setup.mjs test/*.test.mjs",
-    "test:jsdom:commonjs": "yarn mocha --require test/setup.js test/*.test.js",
-    "test:examples": "cd examples && yarn install && yarn upgrade global-jsdom && yarn test; cd ..",
-    "lint": "yarn eslint --ext=js,mjs --cache .eslintrc.js examples/ commonjs/ esm/ test/ ",
-    "lint:fix": "yarn eslint --ext=js,mjs --cache --fix .eslintrc.js examples/ commonjs/ esm/ test/"
+    "test": "yarn test:esm && yarn test:commonjs",
+    "test:esm": "yarn mocha --require test/setup.mjs test/*.test.mjs",
+    "test:commonjs": "yarn mocha --require test/setup.cjs test/*.test.cjs",
+    "lint": "yarn eslint --ext=cjs,mjs --cache .eslintrc.cjs commonjs/ esm/ test/",
+    "lint:fix": "yarn eslint --ext=cjs,mjs --cache --fix .eslintrc.cjs commonjs/ esm/ test/"
   }
-}
+}

package/types/index.d.ts

@@ -0,0 +1,7 @@
+declare module "global-jsdom" {
+	import { ConstructorOptions } from "jsdom";
+
+	function globalJsdom(html?: string, options?: ConstructorOptions): () => void;
+
+	export = globalJsdom;
+}

package/HISTORY.md

@@ -1,188 +0,0 @@
-## [v8.7.0]
-- Relax jsdom peer dependency for jsdom 21
-- update deps
-
-## [v8.6.0]
-- (really) fix jsdom peerDep
-- fix(perf): consolidate window key filtering https://github.com/modosc/global-jsdom/pull/256
-- update semver for jsdom in peerDeps (fixes #245) https://github.com/modosc/global-jsdom/pull/259
-- update actions/checkout@v3, actions/setup-node@v3, node-version: 16 https://github.com/modosc/global-jsdom/pull/258
-- remove babel deps
-
-## [v8.5.0]
-- Relax jsdom peer dependency for jsdom 20
-- Update deps
-
-## [v8.4.0]
-- Relax jsdom peer dependency for jsdom 19
-- Update deps
-
-## [v8.3.0]
-- Relax jsdom peer dependency for jsdom 18
-- Update deps
-
-## [v8.2.0]
-- Relax jsdom peer dependency for jsdom 17
-
-## [v8.1.0]
-- Fix jsdom peer dependency version specifier https://github.com/modosc/global-jsdom/pull/126
-- Update deps
-
-## [v8.0.0]
-> Feb 10, 2021
-
-- **BREAKING CHANGE** `babel` usage removed, Node v12 or greater is required
-- **BREAKING CHANGE** `pretendToBeVisual` is enabled by default, see https://github.com/modosc/global-jsdom/issues/97
-- **BREAKING CHANGE** ES2015 modules are now `.mjs` files, you may need to
-  [enable a node flag](https://nodejs.org/api/esm.html#esm_conditional_exports)
-
-## [v5.0.0]
-> Jul 14, 2019
-
-- Handle jsdom 15
-[v5.0.0]: https://github.com/modosc/global-jsdom/compare/v4.3.0...v5.0.0
-
-
-## [v4.3.0]
-> Jul 14, 2019
-
-- Update deps
-[v4.3.0]: https://github.com/modosc/global-jsdom/compare/v4.2.0...v4.3.0
-
-## [v4.2.0]
-> Oct 19, 2017
-
-- Just kidding, use `global.$jsdom` instead.
-[v4.2.0]: https://github.com/modosc/global-jsdom/compare/v4.1.0...v4.2.0
-
-## [v4.1.0]
-> Oct 18, 2017
-
-- Don't clobber `global.jsdom`, use `global._jsdom` instead
-[v4.1.0]: https://github.com/modosc/global-jsdom/compare/v4.0.0...v4.1.0
-
-## [v8.3.0]
-- Relax jsdom peer dependency for jsdom 18
-- Update deps## [v4.0.0]
-> Oct 18, 2017
-
-- Update peerDeps for jsdom 11
-- Add es module export
-- Drop browserify support
-- Add access to global.jsdom instance
-[v4.0.0]: https://github.com/modosc/global-jsdom/compare/v3.0.2...v4.0.0
-
-## [v3.0.2]
-> May  8, 2017
-
-- [#17] - Fix issue with `Image`. ([@jtag05])
-- [#16] - Mark jsdom as a peer dependency. ([@Cinematique])
-
-[v3.0.2]: https://github.com/modosc/global-jsdom/compare/v3.0.0...v3.0.2
-
-## [v3.0.0]
-> May  8, 2017
-
-- [#23] - jsdom-global now requires jsdom v10. ([@GinjiBan])
-
-[v3.0.0]: https://github.com/modosc/global-jsdom/compare/v2.1.1...v3.0.0
-
-## [v2.1.1]
-> Dec 24, 2016
-
-- [#11] - Fix issues with XMLHttpRequest.
-
-[v2.1.1]: https://github.com/modosc/global-jsdom/compare/v2.1.0...v2.1.1
-
-## [v2.1.0]
-> Aug 22, 2016
-
-- [#6], [#7] - Fix support for jsdom 9.4.0.
-
-[v2.1.0]: https://github.com/modosc/global-jsdom/compare/v2.0.0...v2.1.0
-
-## [v2.0.0]
-> May 13, 2016
-
-- [#3] - Allow overriding `html` and `options` being passed to jsdom. ([#5], [@kenjiru])
-- Deprecate the undocumented (and never-used) feature of calling `jsdom(function)`.
-
-[v2.0.0]: https://github.com/modosc/global-jsdom/compare/v1.7.0...v2.0.0
-
-## [v1.7.0]
-> Mar 21, 2016
-
-- Implement `jsdom-global/register` for use in simpler cases.
-
-[v1.7.0]: https://github.com/modosc/global-jsdom/compare/v1.6.2...v1.7.0
-
-## [v1.6.2]
-> Feb 22, 2016
-
-- Fix typo in browser.js.
-
-[v1.6.2]: https://github.com/modosc/global-jsdom/compare/v1.6.1...v1.6.2
-
-## [v1.6.1]
-> Jan 15, 2016
-
-- Make `jsdomGlobal()` idempotent - that is, you may call it twice and expect
-the same result without any side effects.
-
-[v1.6.1]: https://github.com/modosc/global-jsdom/compare/v1.5.0...v1.6.1
-
-## [v1.5.0]
-> Jan 12, 2016
-
-- Remove tape integration... we don't need it.
-
-[v1.5.0]: https://github.com/modosc/global-jsdom/compare/v1.4.0...v1.5.0
-
-## [v1.4.0]
-> Jan 12, 2016
-
-- `tape`: Shows navigator userAgent in tape output.
-
-[v1.4.0]: https://github.com/modosc/global-jsdom/compare/v1.3.0...v1.4.0
-
-## [v1.3.0]
-> Jan 11, 2016
-
-- Add browserify support.
-
-[v1.3.0]: https://github.com/modosc/global-jsdom/compare/v1.2.0...v1.3.0
-
-## [v1.2.0]
-> Jan 11, 2016
-
-- Fix compatibility with legacy Node.js versions.
-
-[v1.2.0]: https://github.com/modosc/global-jsdom/compare/v1.1.0...v1.2.0
-
-## [v1.1.0]
-> Jan 11, 2016
-
-- Add `cleanup()`.
-
-[v1.1.0]: https://github.com/modosc/global-jsdom/compare/v1.0.0...v1.1.0
-
-## [v1.0.0]
-> Jan 11, 2016
-
-- Initial release.
-
-[v1.0.0]: https://github.com/modosc/global-jsdom/tree/v1.0.0
-[#3]: https://github.com/modosc/global-jsdom/issues/3
-[#5]: https://github.com/modosc/global-jsdom/issues/5
-[#6]: https://github.com/modosc/global-jsdom/issues/6
-[#7]: https://github.com/modosc/global-jsdom/issues/7
-[#2]: https://github.com/modosc/global-jsdom/issues/2
-[#11]: https://github.com/modosc/global-jsdom/issues/11
-[#16]: https://github.com/modosc/global-jsdom/issues/16
-[#17]: https://github.com/modosc/global-jsdom/issues/17
-[#23]: https://github.com/modosc/global-jsdom/issues/23
-[@Cinematique]: https://github.com/Cinematique
-[@GinjiBan]: https://github.com/GinjiBan
-[@jtag05]: https://github.com/jtag05
-[@kenjiru]: https://github.com/kenjiru
-[@ngryman]: https://github.com/ngryman

package/LICENSE

@@ -1,22 +0,0 @@
-MIT License
-
-Copyright for portions of global-jsdom are held by Rico Sta. Cruz, 2016 as part of
-jsdom-global. All other copyright for global-jsdom are held by jonathan schatz, 2017.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/README.md

@@ -1,131 +0,0 @@
-# global-jsdom
-[![npm version](http://img.shields.io/npm/v/global-jsdom.svg?style=flat-square)](https://www.npmjs.com/package/global-jsdom)
-![Node.js CI](https://github.com/modosc/global-jsdom/workflows/Node.js%20CI/badge.svg?branch=master)
-
-> Enables DOM in Node.js
-`global-jsdom` will inject `document`, `window` and other DOM API into your Node.js environment. This allows you to run browser tests in Node.js. The specific attributes set on `global` come directly from the `jsdom` version you have installed.
-## Install
-
-Requires [node][] >= 12 and [jsdom][] >= 10 or above
-
-```
-npm install --save-dev --save-exact jsdom global-jsdom
-```
-[node]: https://github.com/nodejs/node
-[jsdom]: https://github.com/tmpvar/jsdom
-
-## Usage
-
-Just invoke it to turn your Node.js environment into a DOM environment.
-
-```js
-// commonjs
-require('global-jsdom/register')
-
-// or es2015
-import 'global-jsdom/register'
-
-// you can now use the DOM
-document.body.innerHTML = 'hello'
-
-// you can also access the current jsdom instance through $jsdom
-global.$jsdom.reconfigure({})
-```
-
-## Configuration
-You may pass configuration parameters to `jsdom` like so:
-```js
-// commonjs
-const globalJsdom = require('global-jsdom')
-
-// or es2015
-import globalJsdom from 'global-jsdom'
-
-// then
-globalJsdom(html, options)
-```
-Check the [jsdom.jsdom()][] documentation for valid values for the `options`
-parameter.
-
-### Default Options
-The following set of default options are passed to `jsdom`
-```js
-{
-  // if url isn't set then localStorage breaks with a cryptic error, see
-  // https://github.com/jsdom/jsdom/issues/2304#issuecomment-408320484
-  url: 'http://localhost:3000',
-  // pretendToBeVisual is enabled so that react works, see
-  // https://github.com/jsdom/jsdom#pretending-to-be-a-visual-browser
-  pretendToBeVisual: true,
-}
-```
-### Cleanup
-To clean up the global namespace just invoke the returned function:
-```js
-// commonjs
-const cleanup = require('global-jsdom')()
-
-// es2015
-import globalJsdom from 'global-jsdom'
-const cleanup = globalJsdom()
-
-// do things, then
-cleanup()
-```
-
-## Tape
-
-In [tape][], run it before your other tests.
-
-```js
-require('global-jsdom/register')
-
-test('your tests', (t) => {
-  /* and so on... */
-})
-```
-
-## Mocha
-
-__Simple:__ Use Mocha's `--require` option. Add this to the `test/mocha.opts` file (create it if it doesn't exist)
-
-```
--r global-jsdom/register
-```
-
-__Advanced:__ For finer control, you can instead add it via [mocha]'s `before` and `after` hooks.
-
-```js
-before(function () {
-  this.jsdom = require('global-jsdom')()
-})
-
-after(function () {
-  this.jsdom()
-})
-```
-
-[tape]: https://github.com/substack/tape
-[mocha]: https://mochajs.org/
-[jsdom.jsdom()]: https://github.com/tmpvar/jsdom/#for-the-hardcore-jsdomjsdom
-
-## ES2015
-
-If you're using a [recent version of
-node](https://nodejs.org/api/esm.html#esm_conditional_exports) then `import` should
-just work:
-
-
-```js
-import 'global-jsdom/register'
-import React from 'react'
-import jQuery from 'jquery'
-// ...
-```
-
-## Migration from `jsdom-global`
-1. `browserify` support is dropped - I have no way to test this and `webpack` started giving higher priority to the `browser` field in `package.json` than `module`
-
-## Thanks
-
-original code forked from [jsdom-global](https://github.com/rstacruz/jsdom-global)

package/commonjs/register.js

@@ -1,4 +0,0 @@
-/* eslint-disable */
-const jsdom = require('./index.js')
-
-jsdom()