@scalar/snippetz 0.2.0 → 0.2.3

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Scalar
+Copyright (c) 2023-present Scalar
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -0,0 +1,91 @@
+# Snippetz
+
+[![Version](https://img.shields.io/npm/v/%40scalar/snippetz)](https://www.npmjs.com/package/@scalar/snippetz)
+[![Downloads](https://img.shields.io/npm/dm/%40scalar/snippetz)](https://www.npmjs.com/package/@scalar/snippetz)
+[![License](https://img.shields.io/npm/l/%40scalar%2Fsnippetz)](https://www.npmjs.com/package/@scalar/snippetz)
+[![Discord](https://img.shields.io/discord/1135330207960678410?style=flat&color=5865F2)](https://discord.gg/scalar)
+
+A modern way to generate HTTP request examples for different languages and libraries.
+
+## Installation
+
+```bash
+npm install @scalar/snippetz
+```
+
+## Usage
+
+```ts
+import { snippetz } from '@scalar/snippetz'
+
+const snippet = snippetz().print('node', 'undici', {
+  url: 'https://example.com',
+})
+
+/* Output */
+
+// import { request } from 'undici'
+//
+// const { statusCode, body } = await request(
+//   'https://example.com',
+// )
+```
+
+## API
+
+### Get all plugins
+
+```ts
+import { snippetz } from '@scalar/snippetz'
+
+const snippet = snippetz().plugins()
+
+/* Output */
+
+// [
+//   {
+//     target: 'node',
+//     client: 'undici',
+//   }
+// ]
+```
+
+### Check if a plugin is loaded
+
+```ts
+import { snippetz } from '@scalar/snippetz'
+
+const snippet = snippetz().hasPlugin('node', 'undici')
+
+/* Output */
+
+// true
+```
+
+### Lean usage
+
+You can also just use one specific plugin to keep your bundle size small.
+
+```ts
+import { undici } from '@scalar/snippetz/plugins/node/undici'
+
+const source = undici({
+  url: 'https://example.com',
+})
+
+console.log(source.code)
+
+// import { request } from 'undici'
+
+// const { statusCode, body } = await request(
+//   'url': 'https://example.com',
+// )
+```
+
+## Community
+
+We are API nerds. You too? Let’s chat on Discord: <https://discord.gg/scalar>
+
+## License
+
+The source code in this repository is licensed under [MIT](https://github.com/scalar/scalar/blob/main/LICENSE).

package/dist/core/utils/objectToString.js

@@ -1,11 +1,11 @@
 import { isKeyNeedsQuotes } from './isKeyNeedsQuotes.js';
 
 function objectToString(obj, indent = 0) {
-    let parts = [];
-    let indentation = ' '.repeat(indent);
-    let innerIndentation = ' '.repeat(indent + 2);
+    const parts = [];
+    const indentation = ' '.repeat(indent);
+    const innerIndentation = ' '.repeat(indent + 2);
     for (const [key, value] of Object.entries(obj)) {
-        let formattedKey = isKeyNeedsQuotes(key) ? `'${key}'` : key;
+        const formattedKey = isKeyNeedsQuotes(key) ? `'${key}'` : key;
         if (Array.isArray(value)) {
             const arrayString = value
                 .map((item) => {

package/dist/plugins/js/fetch/fetch.d.ts

@@ -1,3 +1,3 @@
-import { type Source, type Request } from '../../../core/index.js';
+import { type Request, type Source } from '../../../core/index.js';
 export declare function fetch(request?: Partial<Request>): Source;
 //# sourceMappingURL=fetch.d.ts.map

package/dist/plugins/js/fetch/fetch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../../../../src/plugins/js/fetch/fetch.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EACX,KAAK,OAAO,EAGb,MAAM,eAAe,CAAA;AAEtB,wBAAgB,KAAK,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,MAAM,CA6ExD"}
+{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../../../../src/plugins/js/fetch/fetch.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,MAAM,EAGZ,MAAM,eAAe,CAAA;AAEtB,wBAAgB,KAAK,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,MAAM,CA6ExD"}

package/dist/plugins/js/ofetch/ofetch.d.ts

@@ -1,3 +1,3 @@
-import { type Source, type Request } from '../../../core/index.js';
+import { type Request, type Source } from '../../../core/index.js';
 export declare function ofetch(request?: Partial<Request>): Source;
 //# sourceMappingURL=ofetch.d.ts.map

package/dist/plugins/js/ofetch/ofetch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ofetch.d.ts","sourceRoot":"","sources":["../../../../src/plugins/js/ofetch/ofetch.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EACX,KAAK,OAAO,EAGb,MAAM,eAAe,CAAA;AAEtB,wBAAgB,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,MAAM,CAiFzD"}
+{"version":3,"file":"ofetch.d.ts","sourceRoot":"","sources":["../../../../src/plugins/js/ofetch/ofetch.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,MAAM,EAGZ,MAAM,eAAe,CAAA;AAEtB,wBAAgB,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,MAAM,CAiFzD"}

package/dist/plugins/node/fetch/fetch.d.ts

@@ -1,3 +1,3 @@
-import { type Source, type Request } from '../../../core/index.js';
+import { type Request, type Source } from '../../../core/index.js';
 export declare function fetch(request?: Partial<Request>): Source;
 //# sourceMappingURL=fetch.d.ts.map

package/dist/plugins/node/fetch/fetch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../../../../src/plugins/node/fetch/fetch.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EACX,KAAK,OAAO,EAGb,MAAM,eAAe,CAAA;AAEtB,wBAAgB,KAAK,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,MAAM,CA6ExD"}
+{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../../../../src/plugins/node/fetch/fetch.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,MAAM,EAGZ,MAAM,eAAe,CAAA;AAEtB,wBAAgB,KAAK,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,MAAM,CA6ExD"}

package/dist/plugins/node/ofetch/ofetch.d.ts

@@ -1,3 +1,3 @@
-import { type Source, type Request } from '../../../core/index.js';
+import { type Request, type Source } from '../../../core/index.js';
 export declare function ofetch(request?: Partial<Request>): Source;
 //# sourceMappingURL=ofetch.d.ts.map

package/dist/plugins/node/ofetch/ofetch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ofetch.d.ts","sourceRoot":"","sources":["../../../../src/plugins/node/ofetch/ofetch.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EACX,KAAK,OAAO,EAGb,MAAM,eAAe,CAAA;AAEtB,wBAAgB,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,MAAM,CAiFzD"}
+{"version":3,"file":"ofetch.d.ts","sourceRoot":"","sources":["../../../../src/plugins/node/ofetch/ofetch.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,MAAM,EAGZ,MAAM,eAAe,CAAA;AAEtB,wBAAgB,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,MAAM,CAiFzD"}

package/dist/plugins/node/undici/undici.d.ts

@@ -1,3 +1,3 @@
-import { type Source, type Request } from '../../../core/index.js';
+import { type Request, type Source } from '../../../core/index.js';
 export declare function undici(request?: Partial<Request>): Source;
 //# sourceMappingURL=undici.d.ts.map

package/dist/plugins/node/undici/undici.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"undici.d.ts","sourceRoot":"","sources":["../../../../src/plugins/node/undici/undici.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EACX,KAAK,OAAO,EAGb,MAAM,eAAe,CAAA;AAEtB,wBAAgB,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,MAAM,CA+EzD"}
+{"version":3,"file":"undici.d.ts","sourceRoot":"","sources":["../../../../src/plugins/node/undici/undici.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,MAAM,EAGZ,MAAM,eAAe,CAAA;AAEtB,wBAAgB,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,MAAM,CA+EzD"}

package/dist/snippetz.d.ts

@@ -1,8 +1,13 @@
-import type { TargetId, ClientId, Request } from './core/index.js';
+import type { ClientId, Request, TargetId } from './core/index.js';
 import { undici } from './plugins/node/undici/index.js';
+/**
+ * Generate code examples for HAR requests
+ */
 export declare function snippetz(): {
-    get(target: TargetId, client: ClientId, request: Partial<Request>): import("./core/index.js").Source | undefined;
-    print(target: TargetId, client: ClientId, request: Partial<Request>): string | undefined;
+    get(target: TargetId, client: ClientId, request: Partial<Request>): import("./core/index.js").Source | {
+        code: string;
+    };
+    print(target: TargetId, client: ClientId, request: Partial<Request>): string;
     targets(): TargetId[];
     clients(): ClientId[];
     plugins(): {

package/dist/snippetz.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"snippetz.d.ts","sourceRoot":"","sources":["../src/snippetz.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAA;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAA;AAM9C,wBAAgB,QAAQ;gBAIR,QAAQ,UAAU,QAAQ,WAAW,OAAO,CAAC,OAAO,CAAC;kBAOnD,QAAQ,UAAU,QAAQ,WAAW,OAAO,CAAC,OAAO,CAAC;;;;;;;uBAyBhD,QAAQ,UAAU,QAAQ;sBAO3B,MAAM,UAAU,MAAM;EAI3C"}
+{"version":3,"file":"snippetz.d.ts","sourceRoot":"","sources":["../src/snippetz.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAA;AAKzD,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAA;AAE9C;;GAEG;AACH,wBAAgB,QAAQ;gBAIR,QAAQ,UAAU,QAAQ,WAAW,OAAO,CAAC,OAAO,CAAC;;;kBAWnD,QAAQ,UAAU,QAAQ,WAAW,OAAO,CAAC,OAAO,CAAC;;;;;;;uBAyBhD,QAAQ,UAAU,QAAQ;sBAO3B,MAAM,UAAU,MAAM;EAI3C"}

package/dist/snippetz.js

@@ -4,6 +4,9 @@ import { fetch as fetch$1 } from './plugins/js/fetch/fetch.js';
 import { ofetch } from './plugins/js/ofetch/ofetch.js';
 import { ofetch as ofetch$1 } from './plugins/node/ofetch/ofetch.js';
 
+/**
+ * Generate code examples for HAR requests
+ */
 function snippetz() {
     const plugins = [undici, fetch, fetch$1, ofetch, ofetch$1];
     return {
@@ -12,6 +15,9 @@ function snippetz() {
             if (plugin) {
                 return plugin(request);
             }
+            return {
+                code: '',
+            };
         },
         print(target, client, request) {
             return this.get(target, client, request)?.code;

package/package.json

@@ -2,19 +2,19 @@
   "name": "@scalar/snippetz",
   "license": "MIT",
   "author": "Scalar (https://github.com/scalar)",
-  "homepage": "https://github.com/scalar/snippetz",
-  "bugs": "https://github.com/scalar/snippetz/issues/new/choose",
+  "homepage": "https://github.com/scalar/scalar",
+  "bugs": "https://github.com/scalar/scalar/issues/new/choose",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/scalar/scalar.git",
+    "directory": "packages/snippetz"
+  },
+  "version": "0.2.3",
   "engines": {
     "node": ">=18"
   },
-  "version": "0.2.0",
   "type": "module",
-  "files": [
-    "dist",
-    "CHANGELOG"
-  ],
   "types": "./dist/index.d.ts",
-  "module": "./dist/index.js",
   "exports": {
     ".": {
       "import": "./dist/index.js",
@@ -45,9 +45,14 @@
       "types": "./dist/core/index.d.ts"
     }
   },
+  "files": [
+    "dist",
+    "CHANGELOG"
+  ],
+  "module": "./dist/index.js",
   "devDependencies": {
-    "@scalar/build-tooling": "^0.1.10",
-    "@types/har-format": "^1.2.15"
+    "@types/har-format": "^1.2.15",
+    "@scalar/build-tooling": "0.1.10"
   },
   "scripts": {
     "build": "scalar-build-rollup",