ifttt-lint

library0.11.1jsnpmunverified

An open-source implementation of Google's internal IFTTT (IfThisThenThat) linter tool for enforcing atomic pull requests. It analyzes diffs and source files to ensure that when certain files or code regions change, specified dependent files or regions also change. Current stable version is v0.11.1, released periodically. Key differentiators include high-concurrency parallel linting using Node.js worker threads, support for labeled regions, and both CLI and programmatic APIs. It is typed with TypeScript, supports Node.js >=18.18, and integrates with GitHub Actions.

testing devops http-networking

npm install ifttt-lint

package ↗

INSTALL

IMPORT

SIG · IFTTT-LINT

ifttt-lint

testingjavascriptv0.11.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

IfThenElse

✓ import { IfThenElse } from 'ifttt-lint'

✗ import IfThenElse from 'ifttt-lint'

Default export does not exist; must use named import.

lintFile

✓ import { lintFile } from 'ifttt-lint'

✗ const { lintFile } = require('ifttt-lint')

Use ESM import for TypeScript or modern Node.js.

LintContext

✓ import type { LintContext } from 'ifttt-lint'

✗ import { LintContext } from 'ifttt-lint'

If only using type, import with `type` keyword to avoid runtime overhead.

Demonstrates programmatic usage: reading a git diff, linting with ignore patterns, and checking errors.

// Install: npm install --save-dev ifttt-lint // Example: lint a diff from stdin import { execSync } from 'child_process'; const diff = execSync('git diff HEAD~1').toString(); const result = await lintFromString(diff, { ignore: ['**/*.bak'] }); if (result.errors.length > 0) { console.error('IFTTT lint errors:', result.errors); process.exit(1); } console.log('No IFTTT issues found.');

ifttt-lint --version

Debug

Known issues

breakingNode.js >=18.18 required since v0.11.0; older Node.js versions cause import failures.

fix

Upgrade Node.js to v18.18 or later.

affects: >=0.11.0

deprecatedThe CLI option `--scan` is deprecated and will be removed in v1.0. Use `ifttt-lint path/to/file.diff` instead.

fix

Use direct file argument instead of --scan.

affects: >=0.11.0

gotchaBinary files in diffs cause lint failures with 'Binary file not supported' error.

fix

Upgrade to v0.11.0 or later which handles binary diffs gracefully.

affects: <0.11.0

breakingAPI functions previously exported as CommonJS are now ESM-only since v0.11.0.

fix

Use `import` syntax; switch to dynamic import if required from CJS modules.

affects: >=0.11.0

gotchaMissing `LINT.EndLabel` for an open `LINT.Label` causes parser errors without clear error message.

fix

Ensure every `LINT.Label('name')` has a matching `LINT.EndLabel`.

affects: *

gotchaGlob patterns for `-i` (ignore) must be wrapped in quotes in shell to prevent expansion.

fix

Use single quotes: `-i '**/*.bak'`.

affects: *

Errors

Common errors & fixes

SyntaxError: Cannot use import statement outside a module

Using ESM import in a CommonJS project without proper configuration.

fix

Add `"type": "module"` to your package.json or use dynamic import.

Error: Binary file 'image.png' is not supported

Diff contains binary file with changes that cannot be parsed as text.

fix

Ignore binary files via `-i '*.png'` or upgrade to v0.11.0+.

Error: LINT.EndLabel without matching LINT.Label

Unmatched `LINT.EndLabel` annotation in source file.

fix

Check that each `LINT.EndLabel` is preceded by a `LINT.Label` with the same name.

TypeError: IfThenElse is not a constructor

Incorrect import: using default import instead of named import.

fix

Use `import { IfThenElse } from 'ifttt-lint'`.

Upgrade

Version history

0.11.1latest on npm

Audit

Dependencies

commanderrequiredUsed for CLI argument parsing

chalkoptionalUsed for colored output

Agent activity

7 hits · last 30 days

node

Amazon

Resources

packagehttps://www.npmjs.com/package/ifttt-lint ↗