web-namespaces - npm Package Compare versions

Comparing version 2.0.0 to 2.0.1

index.d.ts

@@ -1,8 +0,6 @@
-export namespace webNamespaces {
-  const html: string
-  const mathml: string
-  const svg: string
-  const xlink: string
-  const xml: string
-  const xmlns: string
-}
+/**
+ * Map of web namespaces.
+ *
+ * @type {Record<string, string>}
+ */
+export const webNamespaces: Record<string, string>

index.js

@@ -1,2 +0,7 @@
-export var webNamespaces = {
+/**
+ * Map of web namespaces.
+ *
+ * @type {Record<string, string>}
+ */
+export const webNamespaces = {
   html: 'http://www.w3.org/1999/xhtml',
@@ -3,0 +8,0 @@ mathml: 'http://www.w3.org/1998/Math/MathML',

package.json

 {
   "name": "web-namespaces",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Map of web namespaces",
@@ -34,25 +34,25 @@ "license": "MIT",
     "@types/tape": "^4.0.0",
-    "bail": "^1.0.0",
+    "bail": "^2.0.0",
     "c8": "^7.0.0",
     "concat-stream": "^2.0.0",
-    "hast-util-select": "^4.0.0",
-    "hast-util-to-string": "^1.0.0",
+    "hast-util-select": "^5.0.0",
+    "hast-util-to-string": "^2.0.0",
     "prettier": "^2.0.0",
-    "rehype-parse": "^7.0.0",
-    "remark-cli": "^9.0.0",
-    "remark-preset-wooorm": "^8.0.0",
+    "rehype-parse": "^8.0.0",
+    "remark-cli": "^10.0.0",
+    "remark-preset-wooorm": "^9.0.0",
     "rimraf": "^3.0.0",
     "tape": "^5.0.0",
+    "type-coverage": "^2.0.0",
     "typescript": "^4.0.0",
-    "unified": "^9.0.0",
-    "xo": "^0.38.0"
+    "unified": "^10.0.0",
+    "xo": "^0.46.0"
   },
   "scripts": {
+    "generate": "node build",
     "prepublishOnly": "npm run build && npm run format",
-    "prebuild": "rimraf \"*.d.ts\"",
-    "build": "tsc",
-    "generate": "node build",
+    "build": "rimraf \"*.d.ts\" && tsc && type-coverage",
     "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
-    "test-api": "node test.js",
-    "test-coverage": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov node test.js",
+    "test-api": "node --conditions development test.js",
+    "test-coverage": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov npm run test-api",
     "test": "npm run generate && npm run build && npm run format && npm run test-coverage"
@@ -69,8 +69,3 @@ },
   "xo": {
-    "prettier": true,
-    "rules": {
-      "import/no-mutable-exports": "off",
-      "no-var": "off",
-      "prefer-arrow-callback": "off"
-    }
+    "prettier": true
   },
@@ -81,3 +76,9 @@ "remarkConfig": {
     ]
+  },
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "strict": true,
+    "ignoreCatch": true
   }
 }

readme.md

@@ -10,9 +10,31 @@ # web-namespaces
 
+## Contents
+
+*   [What is this?](#what-is-this)
+*   [When should I use this?](#when-should-i-use-this)
+*   [Install](#install)
+*   [Use](#use)
+*   [API](#api)
+    *   [`webNamespaces`](#webnamespaces)
+*   [Types](#types)
+*   [Compatibility](#compatibility)
+*   [Security](#security)
+*   [Related](#related)
+*   [Contribute](#contribute)
+*   [License](#license)
+
+## What is this?
+
+This is a map of names to namespaces found on the web platforms.
+
+## When should I use this?
+
+You can use this package if you want to access the XML, HTML, SVG, etc.
+namespace urls.
+
 ## Install
 
-This package is ESM only: Node 12+ is needed to use it and it must be `import`ed
-instead of `require`d.
+This package is [ESM only][esm].
+In Node.js (version 12.20+, 14.14+, or 16.0+), install with [npm][]:
 
-[npm][]:
-
 ```sh
@@ -22,2 +44,16 @@ npm install web-namespaces
 
+In Deno with [Skypack][]:
+
+```js
+import {webNamespaces} from 'https://cdn.skypack.dev/web-namespaces@2?dts'
+```
+
+In browsers with [Skypack][]:
+
+```html
+<script type="module">
+  import {webNamespaces} from 'https://cdn.skypack.dev/web-namespaces@2?min'
+</script>
+```
+
 ## Use
@@ -51,19 +87,39 @@
 
-`Record.<string, string>` — Map of name to namespaces.
+Map of names to namespaces (`Record<string, string>`).
 
+## Types
+
+This package is fully typed with [TypeScript][].
+There are no extra exported types.
+
+## Compatibility
+
+This package is at least compatible with all maintained versions of Node.js.
+As of now, that is Node.js 12.20+, 14.14+, and 16.0+.
+It also works in Deno and modern browsers.
+
+## Security
+
+This package is safe.
+
 ## Related
 
-*   [`html-tag-names`](https://github.com/wooorm/html-tag-names)
-    — List of HTML tags
-*   [`mathml-tag-names`](https://github.com/wooorm/mathml-tag-names)
-    — List of MathML tags
-*   [`svg-tag-names`](https://github.com/wooorm/svg-tag-names)
-    — List of SVG tags
-*   [`svg-element-attributes`](https://github.com/wooorm/svg-element-attributes)
-    — Map of SVG elements to allowed attributes
-*   [`html-element-attributes`](https://github.com/wooorm/html-element-attributes)
-    — Map of HTML elements to allowed attributes
-*   [`aria-attributes`](https://github.com/wooorm/aria-attributes)
-    — List of ARIA attributes
+*   [`wooorm/html-tag-names`](https://github.com/wooorm/html-tag-names)
+    — list of HTML tag names
+*   [`wooorm/mathml-tag-names`](https://github.com/wooorm/mathml-tag-names)
+    — list of MathML tag names
+*   [`wooorm/svg-tag-names`](https://github.com/wooorm/svg-tag-names)
+    — list of SVG tag names
+*   [`wooorm/svg-element-attributes`](https://github.com/wooorm/svg-element-attributes)
+    — map of SVG elements to allowed attributes
+*   [`wooorm/html-element-attributes`](https://github.com/wooorm/html-element-attributes)
+    — map of HTML elements to allowed attributes
+*   [`wooorm/aria-attributes`](https://github.com/wooorm/aria-attributes)
+    — list of ARIA attributes
 
+## Contribute
+
+Yes please!
+See [How to Contribute to Open Source][contribute].
+
 ## License
@@ -93,4 +149,12 @@
 
+[skypack]: https://www.skypack.dev
+
 [license]: license
 
 [author]: https://wooorm.com
+
+[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
+
+[typescript]: https://www.typescriptlang.org
+
+[contribute]: https://opensource.guide/how-to-contribute/

No alert changes

Improved metrics

Total package byte prevSize

7443

increased by26.86%

Lines of code

19

increased by18.75%

Number of lines in readme file

157

increased by68.82%

Worsened metrics

Dev dependency count

16

increased by6.67%

No dependency changes