New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

html-enumerated-attributes

Package Overview
Dependencies
Maintainers
2
Versions
4
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

html-enumerated-attributes - npm Package Compare versions

Comparing version 0.1.0 to 1.0.0

lib/index.d.ts
lib/index.js

45

index.d.ts

@@ -1,43 +0,2 @@

/**
* @fileoverview
* Map of enumerated attributes in HTML
* @longdescription
* ## Use
*
* ```js
* import {enumeratedAttributes} from 'html-enumerated-attributes'
*
* enumeratedAttributes.loading
* //=> {selector: 'iframe, img', invalid: 'eager', missing: 'eager', states: ['eager', 'lazy']}
* ```
*
* ## API
*
* ### `enumeratedAttributes`
*
* Map of enumerated attributes in HTML (`Record<string, Definition|Array.<Definition>>`).
*/
/**
* @typedef Definition
* @property {string} [selector]
* @property {string|null} [missing]
* @property {string|null} [invalid]
* @property {Array.<null|string|string[]>} states
* @property {true} [allowUnknown]
* @property {true} [caseSensitive]
*/
/**
* This map exposes a map of property names to one or more definitions.
* Each definition defines how that attribute is enumerated.
*
* @type {Record<string, Definition|Definition[]>}
*/
export const enumeratedAttributes: Record<string, Definition | Definition[]>
export type Definition = {
selector?: string | undefined
missing?: string | null | undefined
invalid?: string | null | undefined
states: Array<null | string | string[]>
allowUnknown?: true | undefined
caseSensitive?: true | undefined
}
export { enumeratedAttributes } from "./lib/index.js";
export type Definition = import('./lib/index.js').Definition;

535

index.js
/**
* @fileoverview
* Map of enumerated attributes in HTML
* @longdescription
* ## Use
* Utility with info on enumerated attributes.
*
* ```js
* import {enumeratedAttributes} from 'html-enumerated-attributes'
* ## What is this?
*
* enumeratedAttributes.loading
* //=> {selector: 'iframe, img', invalid: 'eager', missing: 'eager', states: ['eager', 'lazy']}
* ```
* This package contains info on enumerated attributes (attributes that have
* a limited list of acceptable values).
*
* ## API
* ## When should I use this?
*
* ### `enumeratedAttributes`
* You can use this package for linting and minification purposes.
*
* Map of enumerated attributes in HTML (`Record<string, Definition|Array.<Definition>>`).
* ## Use
*
* ```js
* import {enumeratedAttributes} from 'html-enumerated-attributes'
*
* console.log(enumeratedAttributes.loading)
* //=> {selector: 'iframe, img', invalid: 'eager', missing: 'eager', states: ['eager', 'lazy']}
* ```
*
* ## API
*
* ### `enumeratedAttributes`
*
* Enumerated HTML attributes (`Record<string, Array<Definition> | Definition>`).
*
* ### `Definition`
*
* Info (TypeScript type).
*
* ###### Fields
*
* * `allowUnknown` (`boolean`, default: `false`)
* — whether arbitrary values are allowed
* * `caseSensitive` (`boolean`, default: `false`)
* — enumerated values are often treated case-insensitive, except when
* this field is on
* * `invalid` (`string`, `null`, optional)
* — invalid value default; `null` means a particular unnamed state
* * `missing` (`string`, `null`, optional)
* — missing value default; `null` means a particular unnamed state
* * `selector` (`string`, optional, example: `'meta, script'`)
* — simple CSS selector; can contain commas; missing means it applies to
* all elements
* * `states` (`Array<Array<string> | string | null>`)
* — possible states
*/
/**
* @typedef Definition
* @property {string} [selector]
* @property {string|null} [missing]
* @property {string|null} [invalid]
* @property {Array.<null|string|string[]>} states
* @property {true} [allowUnknown]
* @property {true} [caseSensitive]
* @typedef {import('./lib/index.js').Definition} Definition
*/
/**
* This map exposes a map of property names to one or more definitions.
* Each definition defines how that attribute is enumerated.
*
* @type {Record<string, Definition|Definition[]>}
*/
export const enumeratedAttributes = {
autocomplete: {
selector: 'form',
missing: '',
invalid: '',
states: [['', 'on'], 'off']
},
behavior: {
selector: 'marquee',
missing: 'scroll',
states: ['alternate', 'scroll', 'slide']
},
charset: {
selector: 'meta, script',
// In HTML5, utf8 is implied.
// But we let it be here for older versions.
states: [
['utf8', 'utf-8', 'unicode-1-1-utf-8'],
['866', 'cp866', 'ibm866', 'csibm866'],
[
'l1',
'ascii',
'cp819',
'cp1252',
'ibm819',
'latin1',
'us-ascii',
'x-cp1252',
'iso88591',
'iso8859-1',
'iso_8859-1',
'iso-8859-1',
'iso-ir-100',
'csisolatin1',
'windows-1252',
'ansi_x3.4-1968',
'iso_8859-1:1987'
],
[
'l2',
'csisolatin2',
'iso-8859-2',
'iso-ir-101',
'iso8859-2',
'iso88592',
'iso_8859-2',
'iso_8859-2:1987',
'latin2'
],
[
'l3',
'csisolatin3',
'iso-8859-3',
'iso-ir-109',
'iso8859-3',
'iso88593',
'iso_8859-3',
'iso_8859-3:1988',
'latin3'
],
[
'l4',
'csisolatin4',
'iso-8859-4',
'iso-ir-110',
'iso8859-4',
'iso88594',
'iso_8859-4',
'iso_8859-4:1988',
'latin4'
],
[
'l5',
'latin5',
'cp1254',
'x-cp1254',
'iso88599',
'iso8859-9',
'iso-8859-9',
'iso_8859-9',
'iso-ir-148',
'csisolatin5',
'windows-1254',
'iso_8859-9:1989'
],
[
'l6',
'latin6',
'iso885910',
'iso-ir-157',
'iso8859-10',
'csisolatin6',
'iso-8859-10'
],
[
'l9',
'iso885915',
'iso8859-15',
'iso-8859-15',
'iso_8859-15',
'csisolatin9'
],
['cp1250', 'x-cp1250', 'windows-1250'],
['cp1251', 'x-cp1251', 'windows-1251'],
['cp1253', 'x-cp1253', 'windows-1253'],
['cp1255', 'x-cp1255', 'windows-1255'],
['cp1256', 'x-cp1256', 'windows-1256'],
['cp1257', 'x-cp1257', 'windows-1257'],
['cp1258', 'x-cp1258', 'windows-1258'],
[
'cyrillic',
'iso88595',
'iso8859-5',
'iso-8859-5',
'iso_8859-5',
'iso-ir-144',
'iso_8859-5:1988',
'csisolatincyrillic'
],
[
'arabic',
'iso88596',
'ecma-114',
'asmo-708',
'iso8859-6',
'iso-ir-127',
'iso_8859-6',
'iso-8859-6',
'csiso88596e',
'csiso88596i',
'iso-8859-6-e',
'iso-8859-6-i',
'iso_8859-6:1987',
'csisolatinarabic'
],
[
'greek',
'greek8',
'iso88597',
'ecma-118',
'elot_928',
'iso8859-7',
'iso-8859-7',
'iso_8859-7',
'iso-ir-126',
'sun_eu_greek',
'iso_8859-7:1987',
'csisolatingreek'
],
[
'hebrew',
'visual',
'iso88598',
'iso8859-8',
'iso-8859-8',
'iso_8859-8',
'iso-ir-138',
'csiso88598e',
'iso-8859-8-e',
'iso_8859-8:1988',
'csisolatinhebrew'
],
['logical', 'csiso88598i', 'iso-8859-8-i'],
['iso885913', 'iso8859-13', 'iso-8859-13'],
['iso885914', 'iso8859-14', 'iso-8859-14'],
['iso-8859-16'],
['koi', 'koi8', 'koi8-r', 'koi8_r', 'cskoi8r'],
['koi8-u', 'koi8-ru'],
['mac', 'macintosh', 'csmacintosh', 'x-mac-roman'],
[
'dos-874',
'tis-620',
'iso885911',
'iso8859-11',
'iso-8859-11',
'windows-874'
],
['x-mac-cyrillic', 'x-mac-ukrainian'],
[
'gbk',
'x-gbk',
'gb2312',
'chinese',
'gb_2312',
'csgb2312',
'iso-ir-58',
'gb_2312-80',
'csiso58gb231280'
],
['gb18030'],
['big5', 'csbig5', 'cn-big5', 'x-x-big5', 'big5-hkscs'],
['euc-jp', 'x-euc-jp', 'cseucpkdfmtjapanese'],
['csiso2022jp', 'iso-2022-jp'],
[
'ms932',
'sjis',
'x-sjis',
'ms_kanji',
'shift-jis',
'shift_jis',
'csshiftjis',
'windows-31j'
],
[
'korean',
'euc-kr',
'cseuckr',
'ksc5601',
'ksc_5601',
'iso-ir-149',
'windows-949',
'csksc56011987',
'ks_c_5601-1987',
'ks_c_5601-1989'
],
[
'hz-gb-2312',
'csiso2022kr',
'iso-2022-kr',
'iso-2022-cn',
'iso-2022-cn-ext'
],
['utf-16be'],
['utf-16', 'utf-16le'],
['x-user-defined']
]
},
contenteditable: {
missing: null,
invalid: null,
states: [null, ['', 'true'], 'false']
},
crossorigin: {
selector: 'link, img, audio, video, script',
missing: null,
invalid: '',
states: [['', 'anonymous'], 'use-credentials']
},
decoding: {
selector: 'img',
missing: '',
invalid: '',
states: ['sync', 'async', ['', 'auto']]
},
dir: {
missing: '',
invalid: '',
states: ['', 'ltr', 'rtl', 'auto']
},
direction: {
selector: 'marquee',
missing: 'left',
states: ['left', 'right', 'up', 'down']
},
draggable: {
missing: null,
states: [null, 'true', 'false']
},
// When changing `encType`, please also change `formenctype`.
enctype: {
selector: 'form',
invalid: 'application/x-www-form-urlencoded',
missing: 'application/x-www-form-urlencoded',
states: [
'application/x-www-form-urlencoded',
'multipart/form-data',
'text/plain'
]
},
// When changing `formenctype`, please also change `encType`.
formenctype: {
selector: 'button, input',
invalid: 'application/x-www-form-urlencoded',
// Note that `missing: null` here is intentionally different from `encType`.
missing: null,
states: [
'application/x-www-form-urlencoded',
'multipart/form-data',
'text/plain'
]
},
// When changing `formmethod`, please also change `method`.
formmethod: {
selector: 'button, input',
invalid: 'get',
// Note that `missing: null` here is intentionally different from `formmethod`.
missing: null,
states: ['dialog', 'get', 'post']
},
// When changing `formtarget`, please also change `target`.
formtarget: {
selector: 'button, input',
// Note that `missing: null` here is intentionally different from `target`.
missing: null,
allowUnknown: true,
// Note that `formtarget` uses `_self` and `target` uses `['', '_self']`,
// which is intentional.
states: ['_blank', '_parent', '_self', '_top']
},
inputmode: {
// In fact only applies to `text`, `search`, and `password`.
selector: 'input',
invalid: '',
missing: '',
states: [
'',
'email',
'full-width-latin',
'kana',
'kana-name',
'katakana',
'latin',
'latin-name',
'latin-prose',
'numeric',
'tel',
'url',
'verbatim'
]
},
keytype: {
selector: 'keygen',
missing: 'rsa',
states: ['', 'rsa']
},
kind: {
selector: 'track',
missing: 'subtitles',
invalid: 'metadata',
states: ['captions', 'chapters', 'descriptions', 'metadata', 'subtitles']
},
loading: {
selector: 'iframe, img',
invalid: 'eager',
missing: 'eager',
states: ['eager', 'lazy']
},
// When changing `method`, please also change `formmethod`.
method: {
selector: 'form',
invalid: 'get',
missing: 'get',
states: ['dialog', 'get', 'post']
},
preload: {
selector: 'audio, video',
// Note: https://html.spec.whatwg.org/#attr-media-preload
states: [['', 'auto'], 'metadata', 'none']
},
// Should also apply to `content` on `meta[name=referrer]`.
referrerpolicy: {
selector: 'a, area, iframe, img, link',
missing: '',
invalid: '',
states: [
'',
'no-referrer',
'no-referrer-when-downgrade',
'origin',
'origin-when-cross-origin',
'unsafe-url'
]
},
scope: {
selector: 'th',
missing: '',
states: ['', 'col', 'colgroup', 'row', 'rowgroup']
},
shape: {
selector: 'area',
missing: 'rect',
states: [
// The latter are non-conforming.
['rect', 'rectangle'],
['poly', 'polygon'],
['circle', 'circ'],
'default'
]
},
spellcheck: {
missing: null,
invalid: null,
states: [null, ['', 'true'], 'false']
},
// When changing `target`, please also change `formtarget`.
target: {
selector: 'a, area, base, form',
missing: '',
allowUnknown: true,
states: ['_blank', '_parent', ['', '_self'], '_top']
},
translate: {
missing: null,
invalid: null,
states: [['', 'yes'], 'no']
},
type: [
{
selector: 'button',
missing: 'submit',
states: ['button', 'menu', 'reset', 'submit']
},
{
selector: 'input',
missing: 'text',
states: [
'button',
'checkbox',
'color',
'date',
'datetime-local',
'email',
'file',
'hidden',
'image',
'number',
'month',
'password',
'radio',
'range',
'reset',
'search',
'submit',
'tel',
'text',
'time',
'url',
'week'
]
},
{
caseSensitive: true,
selector: 'li',
missing: '',
invalid: '',
states: ['1', 'a', 'A', 'i', 'I', 'circle', 'disc', 'square']
},
{
selector: 'menu',
missing: '',
states: ['', 'context', 'toolbar']
},
{
selector: 'menuitem',
missing: 'command',
states: ['checkbox', 'command', 'radio']
},
{
caseSensitive: true,
selector: 'ol',
missing: '1',
invalid: '1',
states: ['1', 'a', 'A', 'i', 'I']
},
{
selector: 'ul',
missing: '',
invalid: '',
states: ['circle', 'disc', 'square']
}
],
wrap: {
selector: 'textarea',
missing: 'soft',
states: ['hard', 'soft']
}
}
export {enumeratedAttributes} from './lib/index.js'

27

package.json
{
"name": "html-enumerated-attributes",
"version": "0.1.0",
"version": "1.0.0",
"description": "Map of info on enumerated attributes in HTML",
"license": "MIT",
"keywords": [
"html",
"attribute",
"property",
"attribute",
"enumerated",
"attribute"
"html",
"property"
],

@@ -25,19 +25,16 @@ "repository": "https://github.com/rehypejs/rehype-minify/tree/main/packages/html-enumerated-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",
"test": "node --conditions development test.js"
},
"xo": false,
"scripts": {},
"typeCoverage": {
"atLeast": 100,
"detail": true,
"strict": true,
"ignoreCatch": true
}
"ignoreCatch": true,
"strict": true
},
"xo": false
}

159

readme.md

@@ -1,2 +0,2 @@

<!--This file is generated by `build-packages.js`-->
<!--This file is generated-->

@@ -9,15 +9,39 @@ # html-enumerated-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 enumerated attributes in HTML.
Utility with info on enumerated attributes.
## Contents
* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [`enumeratedAttributes`](#enumeratedattributes)
* [`Definition`](#definition)
* [Syntax](#syntax)
* [Syntax tree](#syntax-tree)
* [Types](#types)
* [Compatibility](#compatibility)
* [Security](#security)
* [Contribute](#contribute)
* [License](#license)
## What is this?
This package contains info on enumerated attributes (attributes that have
a limited list of acceptable values).
## When should I use this?
You can use this package for linting and minification purposes.
## 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 +51,16 @@ npm install html-enumerated-attributes

This package exports the following identifiers:
`enumeratedAttributes`.
There is no default export.
In Deno with [`esm.sh`][esm-sh]:
```js
import {enumeratedAttributes} from 'https://esm.sh/html-enumerated-attributes@1'
```
In browsers with [`esm.sh`][esm-sh]:
```html
<script type="module">
import {enumeratedAttributes} from 'https://esm.sh/html-enumerated-attributes@1?bundle'
</script>
```
## Use

@@ -37,3 +71,3 @@

enumeratedAttributes.loading
console.log(enumeratedAttributes.loading)
//=> {selector: 'iframe, img', invalid: 'eager', missing: 'eager', states: ['eager', 'lazy']}

@@ -44,6 +78,61 @@ ```

This package exports the identifier
`enumeratedAttributes`.
There is no default export.
### `enumeratedAttributes`
Map of enumerated attributes in HTML (`Record<string, Definition|Array.<Definition>>`).
Enumerated HTML attributes (`Record<string, Array<Definition> | Definition>`).
### `Definition`
Info (TypeScript type).
###### Fields
* `allowUnknown` (`boolean`, default: `false`)
— whether arbitrary values are allowed
* `caseSensitive` (`boolean`, default: `false`)
— enumerated values are often treated case-insensitive, except when
this field is on
* `invalid` (`string`, `null`, optional)
— invalid value default; `null` means a particular unnamed state
* `missing` (`string`, `null`, optional)
— missing value default; `null` means a particular unnamed state
* `selector` (`string`, optional, example: `'meta, script'`)
— simple CSS selector; can contain commas; missing means it applies to
all elements
* `states` (`Array<Array<string> | string | null>`)
— possible states
## 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-enumerated-attributes@^1`,
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

@@ -63,42 +152,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-enumerated-attributes.svg
[coverage-badge]: https://img.shields.io/codecov/c/github/rehypejs/rehype-minify.svg
[downloads]: https://www.npmjs.com/package/html-enumerated-attributes
[size-badge]: https://img.shields.io/bundlephobia/minzip/html-enumerated-attributes.svg
[downloads-badge]: https://img.shields.io/npm/dm/html-enumerated-attributes.svg
[size]: https://bundlephobia.com/result?p=html-enumerated-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-enumerated-attributes
[size-badge]: https://img.shields.io/bundlejs/size/html-enumerated-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
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc