Knitwork JavaScript Code Generation Utilities

Common errors

• ReferenceError: require is not defined in ES module scope

  cause Attempting to use `require()` to import Knitwork in an ES module environment.
  fix Change your import statements to use ES module syntax: `import { genImport } from 'knitwork';`

• TypeError: (0, knitwork.genImport) is not a function

  cause This error typically indicates an incorrect named import or a CommonJS context trying to access an ES module export incorrectly.
  fix Ensure you are using `import { functionName } from 'knitwork';` for named exports, and that your environment supports ES Modules or is correctly configured for transpilation if using CJS.

• Error: Cannot find module 'knitwork' or its corresponding type declarations.

  cause The `knitwork` package is not installed or incorrectly resolved by your module system.
  fix Run `npm install knitwork`, `yarn add knitwork`, or `pnpm add knitwork` to install the package. If the error persists, check your module resolution configuration.

Warnings

• gotcha Knitwork is an ESM-first library. Direct `require()` statements for importing Knitwork utilities are not recommended and may lead to issues or require specific CommonJS transpilation setups. Always prefer ES module `import` syntax.
  Fix: Use `import { someUtility } from 'knitwork';` instead of `const { someUtility } = require('knitwork');`.
• gotcha When serializing objects, `genObjectFromRaw` does not escape or quote values, assuming they are raw code snippets. This can lead to invalid JavaScript if string values are passed directly. Use `genObjectFromValues` for general object serialization where values should be properly escaped and quoted.
  Fix: For objects containing string, number, or boolean values that need proper JavaScript serialization, use `genObjectFromValues`. Use `genObjectFromRaw` only when values are guaranteed to be valid, raw JavaScript expressions.
• breaking Versions prior to v1.1.0 might not correctly respect the `singleQuotes` option in `genString`, potentially always outputting double quotes regardless of the setting. This was fixed in v1.1.0.
  Fix: Upgrade to Knitwork v1.1.0 or newer to ensure the `singleQuotes` option in `genString` is respected.
• gotcha Module augmentations generated with `genAugmentation` in versions prior to v1.3.0 might have included unnecessary commas, leading to syntax errors in some TypeScript environments. This was fixed in v1.3.0.
  Fix: Update Knitwork to version 1.3.0 or higher to correctly generate module augmentations without extra commas.

Install

• npm install knitwork npm
• yarn add knitwork yarn
• pnpm add knitwork pnpm

Imports

• genImport
  wrong:

  const { genImport } = require('knitwork')

  correct:

  import { genImport } from 'knitwork'

  Knitwork is primarily an ESM-first package. While CJS usage is possible for some features, ESM is the recommended and best-supported import method.
• genObjectFromValues
  wrong:

  import genObjectFromValues from 'knitwork'

  correct:

  import { genObjectFromValues } from 'knitwork'

  All core utilities are named exports. There is no default export from the main package entry.
• genAugmentation
  wrong:

  const genAugmentation = require('knitwork').genAugmentation

  correct:

  import { genAugmentation } from 'knitwork'

  Ensure named import for TypeScript-specific utilities like module augmentation.

Quickstart

Demonstrates generating various JavaScript and TypeScript code snippets, including imports, object serialization, interfaces, and exports using Knitwork's core utilities.

import { genImport, genObjectFromValues, genInterface, genExport, genString } from 'knitwork';

// Generate ESM imports
const importStatement = genImport('my-package', ['foo', { name: 'default', as: 'MyDefault' }]);
// ~> import { foo, default as MyDefault } from "my-package";

// Generate an object with escaped values
const dataObject = genObjectFromValues({
  name: 'Knitwork Demo',
  version: 1.0,
  isActive: true,
  config: {
    url: 'https://example.com/api',
    timeout: 5000
  }
});
// ~> { name: "Knitwork Demo", version: 1, isActive: true, config: { url: "https://example.com/api", timeout: 5000 } }

// Generate a TypeScript interface
const myInterface = genInterface('MyOptions', `{
  id: string;
  value: number;
}`);
// ~> interface MyOptions {
//      id: string;
//      value: number;
//    }

// Generate an export statement
const exportStatement = genExport('./types', { name: '*', as: 'MyTypes' });
// ~> export * as MyTypes from "./types";

console.log(importStatement + '\n\n' + dataObject + '\n\n' + myInterface + '\n\n' + exportStatement);