{"id":13469576,"url":"https://github.com/unjs/knitwork","last_synced_at":"2025-06-10T22:41:50.235Z","repository":{"id":37016488,"uuid":"450635038","full_name":"unjs/knitwork","owner":"unjs","description":"🧶 Utilities to generate safe JavaScript code.","archived":false,"fork":false,"pushed_at":"2024-04-13T17:08:11.000Z","size":429,"stargazers_count":245,"open_issues_count":8,"forks_count":10,"subscribers_count":7,"default_branch":"main","last_synced_at":"2024-04-13T20:45:37.702Z","etag":null,"topics":["code-generation","javascript","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/unjs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-01-21T20:46:14.000Z","updated_at":"2024-04-16T02:40:14.795Z","dependencies_parsed_at":"2023-02-15T20:45:57.965Z","dependency_job_id":"fc1038cc-0470-4cb2-b45b-cc9722dd13a9","html_url":"https://github.com/unjs/knitwork","commit_stats":{"total_commits":79,"total_committers":6,"mean_commits":"13.166666666666666","dds":0.3291139240506329,"last_synced_commit":"da79e384523acc9aca209e975ad898eb07a98e5c"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unjs%2Fknitwork","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unjs%2Fknitwork/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unjs%2Fknitwork/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unjs%2Fknitwork/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/unjs","download_url":"https://codeload.github.com/unjs/knitwork/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222121829,"owners_count":16934973,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["code-generation","javascript","typescript"],"created_at":"2024-07-31T15:01:45.652Z","updated_at":"2025-03-26T07:30:55.544Z","avatar_url":"https://github.com/unjs.png","language":"TypeScript","readme":"# 🧶 knitwork\n\n\u003c!-- automd:badges color=yellow codecov --\u003e\n\n[![npm version](https://img.shields.io/npm/v/knitwork?color=yellow)](https://npmjs.com/package/knitwork)\n[![npm downloads](https://img.shields.io/npm/dm/knitwork?color=yellow)](https://npm.chart.dev/knitwork)\n[![codecov](https://img.shields.io/codecov/c/gh/unjs/knitwork?color=yellow)](https://codecov.io/gh/unjs/knitwork)\n\n\u003c!-- /automd --\u003e\n\nUtilities to generate JavaScript code.\n\n## Install\n\n\u003c!-- automd:pm-install --\u003e\n\n```sh\n# ✨ Auto-detect\nnpx nypm install knitwork\n\n# npm\nnpm install knitwork\n\n# yarn\nyarn add knitwork\n\n# pnpm\npnpm install knitwork\n\n# bun\nbun install knitwork\n\n# deno\ndeno install knitwork\n```\n\n\u003c!-- /automd --\u003e\n\n\u003c!-- automd:jsimport cjs cdn --\u003e\n\n**ESM** (Node.js, Bun, Deno)\n\n```js\nimport {} from \"knitwork\";\n```\n\n**CommonJS** (Legacy Node.js)\n\n```js\nconst {} = require(\"knitwork\");\n```\n\n**CDN** (Deno, Bun and Browsers)\n\n```js\nimport {} from \"https://esm.sh/knitwork\";\n```\n\n\u003c!-- /automd --\u003e\n\n\u003c!-- automd:jsdocs src=./src/index.ts --\u003e\n\n## ESM\n\n### `genDynamicImport(specifier, options)`\n\nGenerate an ESM dynamic `import()` statement.\n\n### `genExport(specifier, exports?, options)`\n\nGenerate an ESM `export` statement.\n\n### `genImport(specifier, imports?, options)`\n\nGenerate an ESM `import` statement.\n\n**Example:**\n\n```js\ngenImport(\"pkg\", \"foo\");\n// ~\u003e `import foo from \"pkg\";`\n\ngenImport(\"pkg\", [\"foo\"]);\n// ~\u003e `import { foo } from \"pkg\";`\n\ngenImport(\"pkg\", [\"a\", \"b\"]);\n// ~\u003e `import { a, b } from \"pkg`;\n\ngenImport(\"pkg\", [{ name: \"default\", as: \"bar\" }]);\n// ~\u003e `import { default as bar } from \"pkg`;\n\ngenImport(\"pkg\", [{ name: \"foo\", as: \"bar\" }]);\n// ~\u003e `import { foo as bar } from \"pkg`;\n\ngenImport(\"pkg\", \"foo\", { attributes: { type: \"json\" } });\n// ~\u003e `import foo from \"pkg\" with { type: \"json\" };\n\ngenExport(\"pkg\", \"foo\");\n// ~\u003e `export foo from \"pkg\";`\n\ngenExport(\"pkg\", [\"a\", \"b\"]);\n// ~\u003e `export { a, b } from \"pkg\";`\n\n// export * as bar from \"pkg\"\ngenExport(\"pkg\", { name: \"*\", as: \"bar\" });\n// ~\u003e `export * as bar from \"pkg\";`\n```\n\n### `genTypeImport(specifier, imports, options)`\n\nGenerate an ESM `import type` statement.\n\n## Serialization\n\n### `genArrayFromRaw(array, indent, options)`\n\nSerialize an array to a string.\n\nValues are not escaped or quoted.\n\n**Example:**\n\n```js\ngenArrayFromRaw([1, 2, 3])\n// ~\u003e `[1, 2, 3]`\n```\n\n### `genObjectFromRaw(object, indent, options)`\n\nSerialize an object to a string.\n\nValues are not escaped or quoted.\n\n**Example:**\n\n```js\ngenObjectFromRaw({ foo: \"bar\", test: '() =\u003e import(\"pkg\")' })\n// ~\u003e `{ foo: bar, test: () =\u003e import(\"pkg\") }`\n```\n\n### `genObjectFromRawEntries(array, indent, options)`\n\nSerialize an array of key-value pairs to a string.\n\nValues are not escaped or quoted.\n\n### `genObjectFromValues(obj, indent, options)`\n\nSerialize an object to a string.\n\nValues are escaped and quoted if necessary.\n\n**Example:**\n\n```js\ngenObjectFromValues({ foo: \"bar\" })\n// ~\u003e `{ foo: \"bar\" }`\n```\n\n## String\n\n### `escapeString(id)`\n\nEscape a string for use in a javascript string.\n\n### `genSafeVariableName(name)`\n\nGenerate a safe javascript variable name.\n\n### `genString(input, options)`\n\nGenerate a string with double or single quotes and handle escapes.\n\n## Typescript\n\n### `genAugmentation(specifier)`\n\nGenerate typescript `declare module` augmentation.\n\n### `genInlineTypeImport(specifier, name, options)`\n\nGenerate an typescript `typeof import()` statement for default import.\n\n### `genInterface(name, contents?, options, indent)`\n\nGenerate typescript interface.\n\n### `genTypeExport(specifier, imports, options)`\n\nGenerate a typescript `export type` statement.\n\n### `genTypeObject(object, indent)`\n\nGenerate typescript object type.\n\n## Utils\n\n### `genObjectKey(key)`\n\nGenerate a safe javascript variable name for an object key.\n\n### `wrapInDelimiters(lines, indent, delimiters, withComma)`\n\nWrap an array of strings in delimiters.\n\n\u003c!-- /automd --\u003e\n\n## Contribution\n\n\u003cdetails\u003e\n  \u003csummary\u003eLocal development\u003c/summary\u003e\n\n- Clone this repository\n- Install the latest LTS version of [Node.js](https://nodejs.org/en/)\n- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`\n- Install dependencies using `bun install`\n- Run tests using `bun dev`\n\n\u003c/details\u003e\n\n## License\n\n\u003c!-- automd:contributors license=MIT author=\"pi0,danielroe\" --\u003e\n\nPublished under the [MIT](https://github.com/unjs/knitwork/blob/main/LICENSE) license.\nMade by [@pi0](https://github.com/pi0), [@danielroe](https://github.com/danielroe) and [community](https://github.com/unjs/knitwork/graphs/contributors) 💛\n\u003cbr\u003e\u003cbr\u003e\n\u003ca href=\"https://github.com/unjs/knitwork/graphs/contributors\"\u003e\n\u003cimg src=\"https://contrib.rocks/image?repo=unjs/knitwork\" /\u003e\n\u003c/a\u003e\n\n\u003c!-- /automd --\u003e\n\n\u003c!-- automd:with-automd --\u003e\n\n---\n\n_🤖 auto updated with [automd](https://automd.unjs.io)_\n\n\u003c!-- /automd --\u003e\n","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funjs%2Fknitwork","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Funjs%2Fknitwork","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funjs%2Fknitwork/lists"}