aberlaas-ci

2.27.4 verified Fri May 01 auth: no javascript

Aberlaas CI is a CLI tool (v2.27.4) that automates running tests and linting on every commit in a CI environment. It integrates with GitHub Actions and other CI platforms, providing a zero-config setup for JavaScript/TypeScript projects. Key differentiators include opinionated defaults (Jest, ESLint, Prettier), automatic detection of project structure, and seamless integration with aberlaas core. Maintained primarily for the author's own projects, it follows a monthly release cadence. Alternatives include standard CI scripts or tools like Husky.

Common errors

error Error: Cannot find module 'aberlaas-ci' ↓

cause Package not installed or ESM-only but required with CommonJS.

fix

Run 'npm install aberlaas-ci --save-dev' or use import syntax instead of require.

error ReferenceError: jest is not defined ↓

cause Jest not installed as a devDependency.

fix

Add 'jest' to devDependencies: 'npm install jest --save-dev'

error Could not resolve 'prettier' (ESLint config error) ↓

cause Prettier not installed but required by default eslint config.

fix

Install prettier: 'npm install prettier --save-dev'

Warnings

deprecated v2.x uses jest.config.js; v3 will require jest.config.mjs ↓

fix Rename jest.config.js to jest.config.mjs for future v3 compatibility.

gotcha CI fails if git working tree is dirty; ensure all files committed or staged before run. ↓

fix Run 'git stash --include-untracked' to temporarily stash changes.

breaking v2.0 dropped support for Node.js < 14, breaking many older CI pipelines. ↓

fix Update Node.js version in CI config to >=14.

deprecated Linting with ESLint 7 is no longer supported; v2.27 uses ESLint 8 internally. ↓

fix Migrate ESLint config to v8 format if using custom rules.

Install

npm install aberlaas-ci

yarn add aberlaas-ci

pnpm add aberlaas-ci

Imports

default

wrong

const ci = require('aberlaas-ci')

correct

import ci from 'aberlaas-ci'

Package is ESM-only since v2. Use import syntax.

run
```
import { run } from 'aberlaas-ci'
```
Named export available for programmatic use.
ci (CLI)
```
npx aberlaas-ci
```
CLI binary exposed without import; run via npx or as a script.

Quickstart

Shows how to integrate aberlaas-ci as an npm script and run it via CLI.

// In package.json scripts
{
  "scripts": {
    "ci": "aberlaas-ci"
  }
}
// Then run:
// npm run ci
// or npx aberlaas-ci