mathml-tag-names - npm Package Compare versions

Comparing version 3.0.1 to 3.0.2

index.d.ts

@@ -1,1 +0,6 @@
-export var mathmlTagNames: string[]
+/**
+ * List of known MathML tag names.
+ *
+ * @type {Array<string>}
+ */
+export const mathmlTagNames: Array<string>

index.js

@@ -1,2 +0,7 @@
-export var mathmlTagNames = [
+/**
+ * List of known MathML tag names.
+ *
+ * @type {Array<string>}
+ */
+export const mathmlTagNames = [
   'abs',
@@ -3,0 +8,0 @@ 'and',

package.json

 {
   "name": "mathml-tag-names",
-  "version": "3.0.1",
-  "description": "List of known MathML tag-names",
+  "version": "3.0.2",
+  "description": "List of known MathML tag names",
   "license": "MIT",
   "keywords": [
-    "MathML",
+    "mathml",
     "math",
@@ -35,25 +35,25 @@ "tag",
     "@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",
-    "generate": "node build",
-    "prebuild": "rimraf \"*.d.ts\"",
-    "build": "tsc",
+    "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"
@@ -70,8 +70,3 @@ },
   "xo": {
-    "prettier": true,
-    "rules": {
-      "import/no-mutable-exports": "off",
-      "no-var": "off",
-      "prefer-arrow-callback": "off"
-    }
+    "prettier": true
   },
@@ -82,3 +77,9 @@ "remarkConfig": {
     ]
+  },
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "strict": true,
+    "ignoreCatch": true
   }
 }

readme.md

@@ -9,14 +9,35 @@ # mathml-tag-names
 List of known MathML tag names.
-Includes the elements from [MathML 1][mathml1], [MathML 2][mathml2], and
+
+## Contents
+
+*   [What is this?](#what-is-this)
+*   [When should I use this?](#when-should-i-use-this)
+*   [Install](#install)
+*   [Use](#use)
+*   [API](#api)
+    *   [`mathmlTagNames`](#mathmltagnames)
+*   [Types](#types)
+*   [Compatibility](#compatibility)
+*   [Security](#security)
+*   [Related](#related)
+*   [Contribute](#contribute)
+*   [License](#license)
+
+## What is this?
+
+This is a list of MathML tag names.
+It includes all tag names from [MathML 1][mathml1], [MathML 2][mathml2], and
 [MathML 3][mathml3].
+The repo is includes scripts to regenerate the data from the specs.
 
-The repo contains a script to crawl specs to include newly introduced tag names.
+## When should I use this?
 
+You can use this package when you need to know what tag names are allowed in
+any version of MathML.
+
 ## 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
@@ -26,2 +47,16 @@ npm install mathml-tag-names
 
+In Deno with [Skypack][]:
+
+```js
+import {mathmlTagNames} from 'https://cdn.skypack.dev/mathml-tag-names@3?dts'
+```
+
+In browsers with [Skypack][]:
+
+```html
+<script type="module">
+  import {mathmlTagNames} from 'https://cdn.skypack.dev/mathml-tag-names@3?min'
+</script>
+```
+
 ## Use
@@ -61,17 +96,36 @@
 
-`string[]` — List of lowercase tag names.
+List of known (lowercase) MathML tag names (`Array<string>`).
 
+## Types
+
+This package is fully typed with [TypeScript][].
+
+## 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
-*   [`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/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 attributes
+*   [`wooorm/html-element-attributes`](https://github.com/wooorm/html-element-attributes)
+    — map of HTML elements to 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
@@ -101,2 +155,4 @@
 
+[skypack]: https://www.skypack.dev
+
 [license]: license
@@ -106,2 +162,8 @@
 
+[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
+
+[typescript]: https://www.typescriptlang.org
+
+[contribute]: https://opensource.guide/how-to-contribute/
+
 [mathml1]: https://www.w3.org/TR/1998/REC-MathML-19980407/appendixF.html
@@ -108,0 +170,0 @@

No alert changes

Improved metrics

Total package byte prevSize

9659

increased by20.35%

Lines of code

202

increased by5.21%

Number of lines in readme file

169

increased by57.94%

Worsened metrics

Dev dependency count

16

increased by6.67%

No dependency changes