html-url-attributes - npm Package Compare versions

Comparing version 2.0.0 to 3.0.0

index.d.ts

@@ -1,25 +0,1 @@
-/**
- * @fileoverview
- *   Map of URL attributes in HTML
- * @longdescription
- *   ## Use
- *
- *   ```js
- *   import {urlAttributes} from 'html-url-attributes'
- *
- *   urlAttributes.formAction
- *   //=> ['button', 'input']
- *   urlAttributes.href
- *   //=> ['a', 'area', 'base', 'link']
- *   ```
- *
- *   ## API
- *
- *   ### `urlAttributes`
- *
- *   Map of URL attributes in HTML (`Record<string, string[]>`).
- */
-/**
- * @type {Record<string, string[]|null>}
- */
-export const urlAttributes: Record<string, string[] | null>
+export { urlAttributes } from "./lib/index.js";

index.js

 /**
- * @fileoverview
- *   Map of URL attributes in HTML
- * @longdescription
- *   ## Use
+ * Utility with info on URL attributes.
  *
- *   ```js
- *   import {urlAttributes} from 'html-url-attributes'
+ * ## What is this?
  *
- *   urlAttributes.formAction
- *   //=> ['button', 'input']
- *   urlAttributes.href
- *   //=> ['a', 'area', 'base', 'link']
- *   ```
+ * This package contains info on attributes that have URLs as values.
  *
- *   ## API
+ * ## When should I use this?
  *
- *   ### `urlAttributes`
+ * You can use this package any time you’re rewriting URLs.
  *
- *   Map of URL attributes in HTML (`Record<string, string[]>`).
+ * ## Use
+ *
+ * ```js
+ * import {urlAttributes} from 'html-url-attributes'
+ *
+ * console.log(urlAttributes.formAction)
+ * //=> ['button', 'input']
+ * console.log(urlAttributes.href)
+ * //=> ['a', 'area', 'base', 'link']
+ * ```
+ *
+ * ## API
+ *
+ * ### `urlAttributes`
+ *
+ * HTML URL properties (`Record<string, Array<string> | null>`).
+ *
+ * Each key is a property name and each value is a list of tag names it applies
+ * to or `null` if it applies to all elements.
  */
 
-/**
- * @type {Record<string, string[]|null>}
- */
-export const urlAttributes = {
-  action: ['form'],
-  cite: ['blockquote', 'del', 'ins', 'q'],
-  data: ['object'],
-  formAction: ['button', 'input'],
-  href: ['a', 'area', 'base', 'link'],
-  icon: ['menuitem'],
-  itemId: null,
-  manifest: ['html'],
-  ping: ['a', 'area'],
-  poster: ['video'],
-  src: [
-    'audio',
-    'embed',
-    'iframe',
-    'img',
-    'input',
-    'script',
-    'source',
-    'track',
-    'video'
-  ]
-}
+export {urlAttributes} from './lib/index.js'

package.json

 {
   "name": "html-url-attributes",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "description": "Map of URL attributes in HTML",
   "license": "MIT",
   "keywords": [
+    "attribute",
+    "attribute",
     "html",
-    "attribute",
     "property",
-    "url",
-    "attribute"
+    "url"
   ],
@@ -25,18 +25,16 @@ "repository": "https://github.com/rehypejs/rehype-minify/tree/main/packages/html-url-attributes",
   "type": "module",
-  "main": "index.js",
-  "types": "index.d.ts",
+  "exports": "./index.js",
   "files": [
     "index.d.ts",
-    "index.js"
+    "index.js",
+    "lib/"
   ],
-  "scripts": {
-    "build": "rimraf \"*.d.ts\" && tsc && type-coverage"
-  },
-  "xo": false,
+  "scripts": {},
   "typeCoverage": {
     "atLeast": 100,
     "detail": true,
-    "strict": true,
-    "ignoreCatch": true
-  }
+    "ignoreCatch": true,
+    "strict": true
+  },
+  "xo": false
 }

readme.md

@@ -1,2 +0,2 @@
-<!--This file is generated by `build-packages.js`-->
+<!--This file is generated-->
 
@@ -9,15 +9,37 @@ # html-url-attributes
 [![Size][size-badge]][size]
-[![Sponsors][sponsors-badge]][collective]
-[![Backers][backers-badge]][collective]
+[![Sponsors][funding-sponsors-badge]][funding]
+[![Backers][funding-backers-badge]][funding]
 [![Chat][chat-badge]][chat]
 
-Map of URL attributes in HTML.
+Utility with info on URL attributes.
 
+## Contents
+
+*   [What is this?](#what-is-this)
+*   [When should I use this?](#when-should-i-use-this)
+*   [Install](#install)
+*   [Use](#use)
+*   [API](#api)
+    *   [`urlAttributes`](#urlattributes)
+*   [Syntax](#syntax)
+*   [Syntax tree](#syntax-tree)
+*   [Types](#types)
+*   [Compatibility](#compatibility)
+*   [Security](#security)
+*   [Contribute](#contribute)
+*   [License](#license)
+
+## What is this?
+
+This package contains info on attributes that have URLs as values.
+
+## When should I use this?
+
+You can use this package any time you’re rewriting URLs.
+
 ## Install
 
-This package is [ESM only][esm]:
-Node 12+ is needed to use it and it must be `imported`ed instead of `required`d.
+This package is [ESM only][esm].
+In Node.js (version 16+), install with [npm][]:
 
-[npm][]:
-
 ```sh
@@ -27,6 +49,16 @@ npm install html-url-attributes
 
-This package exports the following identifiers:
-`urlAttributes`.
-There is no default export.
+In Deno with [`esm.sh`][esm-sh]:
 
+```js
+import {urlAttributes} from 'https://esm.sh/html-url-attributes@3'
+```
+
+In browsers with [`esm.sh`][esm-sh]:
+
+```html
+<script type="module">
+  import {urlAttributes} from 'https://esm.sh/html-url-attributes@3?bundle'
+</script>
+```
+
 ## Use
@@ -37,5 +69,5 @@
 
-urlAttributes.formAction
+console.log(urlAttributes.formAction)
 //=> ['button', 'input']
-urlAttributes.href
+console.log(urlAttributes.href)
 //=> ['a', 'area', 'base', 'link']
@@ -46,6 +78,43 @@ ```
 
+This package exports the identifier
+`urlAttributes`.
+There is no default export.
+
 ### `urlAttributes`
 
-Map of URL attributes in HTML (`Record<string, string[]>`).
+HTML URL properties (`Record<string, Array<string> | null>`).
 
+Each key is a property name and each value is a list of tag names it applies
+to or `null` if it applies to all elements.
+
+## Syntax
+
+HTML is parsed according to WHATWG HTML (the living standard), which is also
+followed by all browsers.
+
+## Syntax tree
+
+The syntax tree used is [hast][].
+
+## Types
+
+This package is fully typed with [TypeScript][].
+
+## Compatibility
+
+Projects maintained by the unified collective are compatible with maintained
+versions of Node.js.
+
+When we cut a new major release, we drop support for unmaintained versions of
+Node.
+This means we try to keep the current release line,
+`html-url-attributes@^3`,
+compatible with Node.js 16.
+
+## Security
+
+As **rehype** works on HTML and improper use of HTML can open you up to a
+[cross-site scripting (XSS)][xss] attack, use of rehype can also be unsafe.
+Use [`rehype-sanitize`][rehype-sanitize] to make the tree safe.
+
 ## Contribute
@@ -65,42 +134,52 @@
 
-[build-badge]: https://github.com/rehypejs/rehype-minify/workflows/main/badge.svg
+[author]: https://wooorm.com
 
 [build]: https://github.com/rehypejs/rehype-minify/actions
 
-[coverage-badge]: https://img.shields.io/codecov/c/github/rehypejs/rehype-minify.svg
+[build-badge]: https://github.com/rehypejs/rehype-minify/workflows/main/badge.svg
 
+[chat]: https://github.com/rehypejs/rehype/discussions
+
+[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
+
+[coc]: https://github.com/rehypejs/.github/blob/main/code-of-conduct.md
+
+[contributing]: https://github.com/rehypejs/.github/blob/main/contributing.md
+
 [coverage]: https://codecov.io/github/rehypejs/rehype-minify
 
-[downloads-badge]: https://img.shields.io/npm/dm/html-url-attributes.svg
+[coverage-badge]: https://img.shields.io/codecov/c/github/rehypejs/rehype-minify.svg
 
 [downloads]: https://www.npmjs.com/package/html-url-attributes
 
-[size-badge]: https://img.shields.io/bundlephobia/minzip/html-url-attributes.svg
+[downloads-badge]: https://img.shields.io/npm/dm/html-url-attributes.svg
 
-[size]: https://bundlephobia.com/result?p=html-url-attributes
+[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
 
-[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
+[esm-sh]: https://esm.sh
 
-[backers-badge]: https://opencollective.com/unified/backers/badge.svg
+[funding]: https://opencollective.com/unified
 
-[collective]: https://opencollective.com/unified
+[funding-backers-badge]: https://opencollective.com/unified/backers/badge.svg
 
-[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
+[funding-sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
 
-[chat]: https://github.com/rehypejs/rehype/discussions
+[hast]: https://github.com/syntax-tree/hast
 
-[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
+[health]: https://github.com/rehypejs/.github
 
+[license]: https://github.com/rehypejs/rehype-minify/blob/main/license
+
 [npm]: https://docs.npmjs.com/cli/install
 
-[health]: https://github.com/rehypejs/.github
+[rehype-sanitize]: https://github.com/rehypejs/rehype-sanitize
 
-[contributing]: https://github.com/rehypejs/.github/blob/main/contributing.md
+[size]: https://bundlejs.com/?q=html-url-attributes
 
+[size-badge]: https://img.shields.io/bundlejs/size/html-url-attributes
+
 [support]: https://github.com/rehypejs/.github/blob/main/support.md
 
-[coc]: https://github.com/rehypejs/.github/blob/main/code-of-conduct.md
+[typescript]: https://www.typescriptlang.org
 
-[license]: https://github.com/rehypejs/rehype-minify/blob/main/license
-
-[author]: https://wooorm.com
+[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

7180

increased by43.4%

Number of package files

6

increased by50%

Lines of code

73

increased by1.39%

Number of lines in readme file

181

increased by77.45%

No dependency changes