🧶 knitwork


Utilities to generate JavaScript code.

Install

``sh


✨ Auto-detect

npx nypm install knitwork

npm

npm install knitwork

yarn

yarn add knitwork

pnpm

pnpm add knitwork

bun

bun install knitwork

deno

deno install npm:knitwork
`

ESM (Node.js, Bun, Deno)

`js
import {} from "knitwork";
`

CommonJS (Legacy Node.js)

`js
const {} = require("knitwork");
`

CDN (Deno and Browsers)

`js
import {} from "https://esm.sh/knitwork";
`

ESM

$3

Generate an ESM dynamic import() statement.

$3

Generate an ESM type import() statement.

$3

Generate an ESM export statement.

$3

Generate an ESM import statement.

Example:

`js
genImport("pkg", "foo");
// ~> import foo from "pkg";

genImport("pkg", ["foo"]);
// ~> import { foo } from "pkg";

genImport("pkg", ["a", "b"]);
// ~> import { a, b } from "pkg;

genImport("pkg", [{ name: "default", as: "bar" }]);
// ~> import { default as bar } from "pkg;

genImport("pkg", [{ name: "foo", as: "bar" }]);
// ~> import { foo as bar } from "pkg;

genImport("pkg", "foo", { attributes: { type: "json" } });
// ~> import foo from "pkg" with { type: "json" };

genExport("pkg", "foo");
// ~> export foo from "pkg";

genExport("pkg", ["a", "b"]);
// ~> export { a, b } from "pkg";

// export * as bar from "pkg"
genExport("pkg", { name: "*", as: "bar" });
// ~> export * as bar from "pkg";
``

$3

Generate an ESM import type statement.

Serialization

$3

Serialize an array to a string.

Values are not escaped or quoted.

Example:

`js
genArrayFromRaw([1, 2, 3])
// ~> [1, 2, 3]
`

$3

Serialize an object to a string.

Values are not escaped or quoted.

Example:

`js
genObjectFromRaw({ foo: "bar", test: '() => import("pkg")' })
// ~> { foo: bar, test: () => import("pkg") }
`

$3

Serialize an array of key-value pairs to a string.

Values are not escaped or quoted.

$3

Serialize an object to a string.

Values are escaped and quoted if necessary.

Example:

`js
genObjectFromValues({ foo: "bar" })
// ~> { foo: "bar" }
`

String

$3

Escape a string for use in a javascript string.

$3

Generate a safe javascript variable name.

$3

Generate a string with double or single quotes and handle escapes.

Typescript

$3

Generate typescript declare module augmentation.

$3

Generate an typescript typeof import() statement for default import.

$3

Generate typescript interface.

$3

Generate a typescript export type statement.

$3

Generate typescript object type.

Utils

$3

Generate a safe javascript variable name for an object key.

$3

Wrap an array of strings in delimiters.

Contribution

Local development

- Clone this repository
- Install the latest LTS version of Node.js
- Enable Corepack using corepack enable
- Install dependencies using bun install
- Run tests using bun dev`

License

Published under the MIT license.
Made by @pi0, @danielroe and community 💛

---

_🤖 auto updated with automd_