react-apiembed - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

 {
   "name": "react-apiembed",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "React api embed component.",
+  "files": [
+    "dist"
+  ],
   "main": "dist/react-apiembed.js",
@@ -6,0 +9,0 @@ "author": "Darren Jennings",

README.md

@@ -30,27 +30,38 @@ # react-apiembed
 ```jsx
-import React from 'react';
-import { render } from 'react-dom';
-import { CodeSnippet, CodeSnippetWidget } from 'react-apiembed';
+import React from "react"
+import { render } from "react-dom"
+import { CodeSnippet, CodeSnippetWidget } from "react-apiembed"
 
-export default class MyApp extends React.Component {
+class MyApp extends React.Component {
+  render() {
+    const har = {
+      method: "POST",
+      url: "http://mockbin.com/request",
+      httpVersion: "HTTP/1.1",
+      queryString: [{ name: "foo", value: "bar" }, { name: "foo", value: "baz" }],
+      headers: [
+        { name: "Accept", value: "application/json" },
+        { name: "Content-Type", value: "application/json" }
+      ],
+      cookies: [{ name: "foo", value: "bar" }, { name: "bar", value: "baz" }],
+      postData: { mimeType: "application/json", text: '{"foo": "bar"}' }
+    }
 
-  render(){
-    const har = { "method": "POST", "url": "http://mockbin.com/request", "httpVersion": "HTTP/1.1", "queryString": [ { "name": "foo", "value": "bar" }, { "name": "foo", "value": "baz" } ], "headers": [ { "name": "Accept", "value": "application/json" }, { "name": "Content-Type", "value": "application/json" } ], "cookies": [ { "name": "foo", "value": "bar" }, { "name": "bar", "value": "baz" } ], "postData": { "mimeType": "application/json", "text": "{\"foo\": \"bar\"}" } }
-
-    const snippets = {[
-      {
-        prismLanguage: "javascript",
-        target: "javascript",
-        client: "jquery"
-      },
-      {
-        prismLanguage: "clike",
-        target: "c"
-      },
-    ]}
-
     return (
       <div>
-        <CodeSnippet har={har} snippet={snippets[0]} />
-        <CodeSnippetWidget har={har} snippets={snippets} />
+        <CodeSnippet har={har} prismLanguage="javascript" target="javascript" client="jquery" />
+        <CodeSnippetWidget
+          har={har}
+          snippets={[
+            {
+              prismLanguage: "go",
+              target: "go"
+            },
+            {
+              prismLanguage: "bash",
+              target: "shell",
+              client: "curl"
+            }
+          ]}
+        />
       </div>
@@ -60,2 +71,4 @@ )
 }
+
+render(<MyApp />, document.getElementById("root"))
 ```
@@ -67,15 +80,9 @@
 
-| Name    | Required | Type   | Description                                                                                    |
-| :------ | :------: | :----- | :--------------------------------------------------------------------------------------------- |
-| har     |    ✔     | Object | HAR Request object as outlined [here](http://www.softwareishard.com/blog/har-12-spec/#request) |
-| snippet |    ✔     | Object | Snippet object with `prismLanguage`, and [hardyhar][hardyhar] `target` and `client`            |
+| Name          | Required | Default | Type   | Description|
+| :------------ | :------: | :------ | :----- | :-----|
+| har           |    ✔     |         | Object | HAR Request object as outlined [here](http://www.softwareishard.com/blog/har-12-spec/#request)|
+| prismLanguage |    ✔     |         | String | Prism languages. Currently supports: `bash`, `javascript`, `php`, `go`, `ruby`, `ocaml`, `ruby`, `java`, `python`, `swift`, `csharp`, `clike`|
+| target        |    ✔     |         | String | [hardyhar][hardyhar] `target` prop e.g. "node", "javascript", "shell", "go" etc.|
+| client        |          | `null`  | String | [hardyhar][hardyhar] `client` prop. e.g. "xhr", "curl" etc.|
 
-`snippet` properties
-
-| Name          | Required | Default | Type   | Description                                                                                                                                   |
-| :------------ | :------: | :------ | :----- | :-------------------------------------------------------------------------------------------------------------------------------------------- |
-| prismLanguage |    ✔     |         | String | Prism languages. Currently supports: `bash`, `javascript`, `php`, `go`, `ruby`, `ocaml`, `ruby`, `java`, `python`, `swift`, `csharp`, `clike` |
-| target        |    ✔     |         | String | [hardyhar][hardyhar] `target` prop e.g. "node", "javascript", "shell", "go" etc.                                                              |
-| client        |          | `null`  | String | [hardyhar][hardyhar] `client` prop. e.g. "xhr", "curl" etc.                                                                                   |
-
 ### `<CodeSnippetWidget/>`
@@ -86,4 +93,12 @@
 | har      |    ✔     | Object | HAR Request object as outlined [here](http://www.softwareishard.com/blog/har-12-spec/#request) |
-| snippets |    ✔     | Object | Array of snippet props                                                                         |
+| snippets |    ✔     | Object | Array of snippet objects                                                                       |
 
+`snippet` properties
+
+| Name          | Required | Default | Type   | Description                                                                      |
+| :------------ | :------: | :------ | :----- | :------------------------------------------------------------------------------- |
+| prismLanguage |    ✔     |         | String | Prism languages. See above for supported languages.                              |
+| target        |    ✔     |         | String | [hardyhar][hardyhar] `target` prop e.g. "node", "javascript", "shell", "go" etc. |
+| client        |          | `null`  | String | [hardyhar][hardyhar] `client` prop. e.g. "xhr", "curl" etc.                      |
+
 ## Testing
@@ -90,0 +105,0 @@

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

Number of lines in readme file

108

increased by16.13%

Worsened metrics

Total package byte prevSize

248078

decreased by-89.93%

Number of package files

3

decreased by-85.71%

Lines of code

1685

decreased by-20.37%

No dependency changes