knitwork

🧶 knitwork

Utilities to generate JavaScript code.

Install

# ✨ Auto-detect
npx nypm install knitwork

# npm
npm install knitwork

# yarn
yarn add knitwork

# pnpm
pnpm install knitwork

# bun
bun install knitwork

ESM (Node.js, Bun)

import {} from "knitwork";

CommonJS (Legacy Node.js)

const {} = require("knitwork");

CDN (Deno, Bun and Browsers)

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

ESM

genDynamicImport(specifier, options)

Generate an ESM dynamic import() statement.

genExport(specifier, exports?, options)

Generate an ESM export statement.

genImport(specifier, imports?, options)

Generate an ESM import statement.

Example:

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";`

genTypeImport(specifier, imports, options)

Generate an ESM import type statement.

Serialization

genArrayFromRaw(array, indent, options)

Serialize an array to a string.

Example:

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

genObjectFromRaw(object, indent, options)

Serialize an object to a string.

Example:

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

genObjectFromRawEntries(array, indent, options)

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

genObjectFromValues(obj, indent, options)

Serialize an object to a string.

Example:

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

String

escapeString(id)

Escape a string for use in a javascript string.

genSafeVariableName(name)

Generate a safe javascript variable name.

genString(input, options)

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

Typescript

genAugmentation(specifier)

Generate typescript declare module augmentation.

genInlineTypeImport(specifier, name, options)

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

genInterface(name, contents?, options, indent)

Generate typescript interface.

genTypeExport(specifier, imports, options)

Generate a typescript export type statement.

genTypeObject(object, indent)

Generate typescript object type.

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

Changelog

v1.1.0

compare changes

🚀 Enhancements

• Add genObjectFromValues (#9)
• esm: Support new import attributes syntax (#89)

🩹 Fixes

• Stringify key identifier starting with number literal (#86)
• genString: Respect singleQuotes option (#88)
• typescript: Indent generated augmentation interfaces (#4)

💅 Refactors

• object: Use namespace for options (ba67797)

📖 Documentation

• Fix genImport example with default name (#87)
• Add jsdocs (8a8a673)

🏡 Chore

• Fix renovate config (d5284eb)
• Add @danielroe to license (daf973d)
• Update repo (#62)
• Update deps (0f8fb07)
• Lint (2138f9a)
• Update ci scripts (a5828ce)
• Fix lint (f735700)
• Update readme with automd (749daf7)
• Update jsdocs (79d3ae0)
• Update jsdocs (c8fe63f)
• Provide CODECOV_TOKEN (c205569)

❤️ Contributors

• Daniel Roe (@danielroe)
• Pooya Parsa (@pi0)
• Ricardo Gobbo De Souza (@ricardogobbosouza)
• Max (@onmax)
• 魏 (@wsypower)
• Romain Hamel (@romhml)
• Nozomu Ikuta (@NozomuIkuta)