Rattail

Common errors

Warnings

Install

Imports

• rattail
  wrong

  const rattail = require('rattail')

  correct

  import rattail from 'rattail'

  Rattail is ESM-only; require() will fail.

• defineRattailConfig
  wrong

  import defineRattailConfig from 'rattail'

  correct

  import { defineRattailConfig } from 'rattail'

  This is a named export, not default.

• Axle (request tool)
  wrong

  import { Axle } from 'rattail'

  correct

  import { createAxle } from 'rattail/axle'

  Axle is a separate subpath export; import from 'rattail/axle' to avoid pulling unused code. Since v2.

• RulerFactory
  wrong

  import { RulerFactory } from 'rattail'

  correct

  import { RulerFactory } from 'rattail/ruler'

  Ruler factory is exported from rattail/ruler subpath. Direct import from rattail may not include it.

• enum utilities (createEnum)
  wrong

  import { createEnum } from 'rattail'

  correct

  import { createEnum } from 'rattail/enum'

  Enum utilities are subpath exports; import from 'rattail/enum'.

• utility functions (isString, etc.)
  wrong

  import { isString } from 'rattail'

  correct

  import { isString } from 'rattail/utils'

  Utility functions are exported from 'rattail/utils' subpath to enable tree-shaking.

Quickstart

Shows how to install, configure with defineRattailConfig, and use utility functions, Axle, RulerFactory, and createEnum.

// Install: pnpm add rattail @voidzero-dev/vite-plus-core vite-plus

// vite.config.ts
import { defineRattailConfig } from 'rattail';

export default defineRattailConfig({
  // base Vite+ config
});

// Use a utility function
import { isString } from 'rattail/utils';
console.log(isString('hello')); // true

// Use Axle request tool
import { createAxle } from 'rattail/axle';
const axle = createAxle({ baseURL: 'https://api.example.com' });
async function fetchData() {
  const res = await axle.get('/data');
  return res.data;
}

// Use Ruler Factory for validation
import { RulerFactory } from 'rattail/ruler';
const rules = new RulerFactory()
  .required('Name is required')
  .minLength(2, 'Name too short')
  .build();

// Use createEnum
import { createEnum } from 'rattail/enum';
const Status = createEnum({
  Pending: 0,
  Active: 1,
  Inactive: 2,
});