@markuplint/react-spec - npm Package Compare versions

Comparing version 1.0.0-dev.20211115.0 to 1.0.0-dev.20211213.0

lib/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const spec = {
-    cites: ['https://reactjs.org/docs/dom-elements.html'],
     def: {
         '#globalAttrs': {
-            '#extends': [
-                {
-                    name: 'key',
-                    type: 'String',
-                    description: 'A special attribute for list rendering',
+            '#extends': {
+                /**
+                 * A special attribute for list rendering
+                 */
+                key: {
+                    type: 'Any',
                 },
-                {
-                    name: 'ref',
-                    type: 'String',
-                    description: 'A special attribute for accessing child component instances and child elements',
+                /**
+                 * A special attribute for accessing child component instances
+                 * and child elements
+                 */
+                ref: {
+                    type: 'Any',
                 },
-                {
-                    name: 'dangerouslySetInnerHTML',
-                    type: 'String',
-                    description: 'React’s replacement for using innerHTML in the browser DOM',
+                /**
+                 * React’s replacement for using innerHTML in the browser DOM
+                 */
+                dangerouslySetInnerHTML: {
+                    type: 'Any',
                 },
-                {
-                    name: 'suppressContentEditableWarning',
+                /**
+                 * Normally, there is a warning when an element with children
+                 * is also marked as contentEditable, because it won’t work.
+                 * This attribute suppresses that warning.
+                 */
+                suppressContentEditableWarning: {
                     type: 'Boolean',
-                    description: 'Normally, there is a warning when an element with children is also marked as contentEditable, because it won’t work. This attribute suppresses that warning.',
                 },
-                {
-                    name: 'suppressHydrationWarning',
+                /**
+                 * If you set suppressHydrationWarning to true,
+                 * React will not warn you about mismatches
+                 * in the attributes and the content of that element.
+                 */
+                suppressHydrationWarning: {
                     type: 'Boolean',
-                    description: 'If you set suppressHydrationWarning to true, React will not warn you about mismatches in the attributes and the content of that element.',
                 },
-            ],
+            },
         },
@@ -39,7 +48,10 @@ },
             name: 'input',
-            attributes: [
-                {
-                    name: 'defaultChecked',
+            attributes: {
+                /**
+                 * defaultChecked is the uncontrolled equivalent,
+                 * which sets whether the component is checked
+                 * when it is first mounted.
+                 */
+                defaultChecked: {
                     type: 'Boolean',
-                    description: 'defaultChecked is the uncontrolled equivalent, which sets whether the component is checked when it is first mounted.',
                     caseSensitive: true,
@@ -50,41 +62,56 @@ condition: {
                 },
-                {
-                    name: 'defaultValue',
-                    type: 'String',
+                /**
+                 * defaultValue is the uncontrolled equivalent,
+                 * which sets the value of the component
+                 * when it is first mounted.
+                 */
+                defaultValue: {
+                    type: 'Any',
                     caseSensitive: true,
-                    description: 'defaultValue is the uncontrolled equivalent, which sets the value of the component when it is first mounted.',
                 },
-            ],
+            },
         },
         {
             name: 'select',
-            attributes: [
-                {
-                    name: 'value',
-                    type: 'String',
-                    description: 'The value attribute is supported by <input>, <select> and <textarea> components. You can use it to set the value of the component.',
+            attributes: {
+                /**
+                 * The value attribute is supported by
+                 * <input>, <select> and <textarea> components.
+                 * You can use it to set the value of the component.
+                 */
+                value: {
+                    type: 'Any',
                 },
-                {
-                    name: 'defaultValue',
-                    type: 'String',
+                /**
+                 * defaultValue is the uncontrolled equivalent,
+                 * which sets the value of the component
+                 * when it is first mounted.
+                 */
+                defaultValue: {
+                    type: 'Any',
                     caseSensitive: true,
-                    description: 'defaultValue is the uncontrolled equivalent, which sets the value of the component when it is first mounted.',
                 },
-            ],
+            },
         },
         {
             name: 'textarea',
-            attributes: [
-                {
-                    name: 'value',
-                    type: 'String',
-                    description: 'The value attribute is supported by <input>, <select> and <textarea> components. You can use it to set the value of the component.',
+            attributes: {
+                /**
+                 * The value attribute is supported by
+                 * <input>, <select> and <textarea> components.
+                 * You can use it to set the value of the component.
+                 */
+                value: {
+                    type: 'Any',
                 },
-                {
-                    name: 'defaultValue',
-                    type: 'String',
+                /**
+                 * defaultValue is the uncontrolled equivalent,
+                 * which sets the value of the component
+                 * when it is first mounted.
+                 */
+                defaultValue: {
+                    type: 'Any',
                     caseSensitive: true,
-                    description: 'defaultValue is the uncontrolled equivalent, which sets the value of the component when it is first mounted.',
                 },
-            ],
+            },
         },
@@ -91,0 +118,0 @@ ],

package.json

 {
 	"name": "@markuplint/react-spec",
-	"version": "1.0.0-dev.20211115.0",
+	"version": "1.0.0-dev.20211213.0",
 	"description": "Extended specification for tags and attributes in React",
@@ -19,5 +19,5 @@ "repository": "[e-mail]:markuplint/markuplint.git",
 	"dependencies": {
-		"@markuplint/ml-spec": "^2.0.0-dev.20211115.0"
+		"@markuplint/ml-spec": "2.0.0-dev.20211213.0"
 	},
-	"gitHead": "11bcb81138ae11362add9b502124011735cc784a"
+	"gitHead": "8f4682ca3e0937082af8c39b999443afa4a1aef3"
 }

src/index.ts

 import type { ExtendedSpec } from '@markuplint/ml-spec';
 
 const spec: ExtendedSpec = {
-	cites: ['https://reactjs.org/docs/dom-elements.html'],
 	def: {
 		'#globalAttrs': {
-			'#extends': [
-				{
-					name: 'key',
-					type: 'String',
-					description: 'A special attribute for list rendering',
+			'#extends': {
+				/**
+				 * A special attribute for list rendering
+				 */
+				key: {
+					type: 'Any',
 				},
-				{
-					name: 'ref',
-					type: 'String',
-					description: 'A special attribute for accessing child component instances and child elements',
+				/**
+				 * A special attribute for accessing child component instances
+				 * and child elements
+				 */
+				ref: {
+					type: 'Any',
 				},
-				{
-					name: 'dangerouslySetInnerHTML',
-					type: 'String',
-					description: 'React’s replacement for using innerHTML in the browser DOM',
+				/**
+				 * React’s replacement for using innerHTML in the browser DOM
+				 */
+				dangerouslySetInnerHTML: {
+					type: 'Any',
 				},
-				{
-					name: 'suppressContentEditableWarning',
+				/**
+				 * Normally, there is a warning when an element with children
+				 * is also marked as contentEditable, because it won’t work.
+				 * This attribute suppresses that warning.
+				 */
+				suppressContentEditableWarning: {
 					type: 'Boolean',
-					description:
-						'Normally, there is a warning when an element with children is also marked as contentEditable, because it won’t work. This attribute suppresses that warning.',
 				},
-				{
-					name: 'suppressHydrationWarning',
+				/**
+				 * If you set suppressHydrationWarning to true,
+				 * React will not warn you about mismatches
+				 * in the attributes and the content of that element.
+				 */
+				suppressHydrationWarning: {
 					type: 'Boolean',
-					description:
-						'If you set suppressHydrationWarning to true, React will not warn you about mismatches in the attributes and the content of that element.',
 				},
-			],
+			},
 		},
@@ -41,8 +48,10 @@ },
 			name: 'input',
-			attributes: [
-				{
-					name: 'defaultChecked',
+			attributes: {
+				/**
+				 * defaultChecked is the uncontrolled equivalent,
+				 * which sets whether the component is checked
+				 * when it is first mounted.
+				 */
+				defaultChecked: {
 					type: 'Boolean',
-					description:
-						'defaultChecked is the uncontrolled equivalent, which sets whether the component is checked when it is first mounted.',
 					caseSensitive: true,
@@ -53,46 +62,56 @@ condition: {
 				},
-				{
-					name: 'defaultValue',
-					type: 'String',
+				/**
+				 * defaultValue is the uncontrolled equivalent,
+				 * which sets the value of the component
+				 * when it is first mounted.
+				 */
+				defaultValue: {
+					type: 'Any',
 					caseSensitive: true,
-					description:
-						'defaultValue is the uncontrolled equivalent, which sets the value of the component when it is first mounted.',
 				},
-			],
+			},
 		},
 		{
 			name: 'select',
-			attributes: [
-				{
-					name: 'value',
-					type: 'String',
-					description:
-						'The value attribute is supported by <input>, <select> and <textarea> components. You can use it to set the value of the component.',
+			attributes: {
+				/**
+				 * The value attribute is supported by
+				 * <input>, <select> and <textarea> components.
+				 * You can use it to set the value of the component.
+				 */
+				value: {
+					type: 'Any',
 				},
-				{
-					name: 'defaultValue',
-					type: 'String',
+				/**
+				 * defaultValue is the uncontrolled equivalent,
+				 * which sets the value of the component
+				 * when it is first mounted.
+				 */
+				defaultValue: {
+					type: 'Any',
 					caseSensitive: true,
-					description:
-						'defaultValue is the uncontrolled equivalent, which sets the value of the component when it is first mounted.',
 				},
-			],
+			},
 		},
 		{
 			name: 'textarea',
-			attributes: [
-				{
-					name: 'value',
-					type: 'String',
-					description:
-						'The value attribute is supported by <input>, <select> and <textarea> components. You can use it to set the value of the component.',
+			attributes: {
+				/**
+				 * The value attribute is supported by
+				 * <input>, <select> and <textarea> components.
+				 * You can use it to set the value of the component.
+				 */
+				value: {
+					type: 'Any',
 				},
-				{
-					name: 'defaultValue',
-					type: 'String',
+				/**
+				 * defaultValue is the uncontrolled equivalent,
+				 * which sets the value of the component
+				 * when it is first mounted.
+				 */
+				defaultValue: {
+					type: 'Any',
 					caseSensitive: true,
-					description:
-						'defaultValue is the uncontrolled equivalent, which sets the value of the component when it is first mounted.',
 				},
-			],
+			},
 		},
@@ -99,0 +118,0 @@ ],

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

46766

increased by1.64%

Lines of code

241

increased by23.59%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

Published versions last year

34

decreased by-2.86%

Dependency changes

• + Added@markuplint/ml-spec@2.0.0-dev.20211213.0(transitive)

• - Removed@markuplint/ml-spec@2.1.3(transitive)

• Updated@markuplint/ml-spec@2.0.0-dev.20211213.0