Registry / testing / office-addin-lint

office-addin-lint

library3.0.7jsnpmunverified

A configuration package that provides ESLint and Prettier integration for Office Add-in projects. Current stable version is 3.0.7, with monthly releases. It simplifies setting up linting and formatting by bundling shared ESLint configs, Prettier options, and TypeScript support. Differentiates from raw ESLint/Prettier by providing pre-tuned rules for Office Add-in development and automatic dependency management.

testing devops

npm install office-addin-lint

github ↗package ↗

INSTALL

IMPORT

SIG · OFFICE-ADDIN-LINT

office-addin-lint

testingjavascriptv3.0.7

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

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

officeAddinLint

✓ import { officeAddinLint } from 'office-addin-lint'

✗ const officeAddinLint = require('office-addin-lint')

Package is ESM-only since v3

configure

✓ import { configure } from 'office-addin-lint'

✗ import configure from 'office-addin-lint'

Named export, not default

ConfigOptions

✓ import type { ConfigOptions } from 'office-addin-lint'

✗ import { ConfigOptions } from 'office-addin-lint'

Type import for TypeScript users

Shows how to import and use the configure function to set up ESLint and Prettier options.

import { configure } from 'office-addin-lint'; const config = configure({ eslint: { fix: false }, prettier: { printWidth: 100 } }); console.log(config);

Debug

Known issues

breakingModules are ESM-only since v3, require() not supported

fix

Use import syntax instead of require(). Ensure your project is configured for ESM (e.g., type: 'module' in package.json).

affects: >=3.0.0

deprecatedofficeAddinLint() function deprecated in v3; use configure() instead

fix

Replace officeAddinLint() with configure() as shown in the quickstart.

affects: >=3.0.0

gotchaESLint and Prettier must be installed as peer dependencies

fix

Run npm install eslint prettier --save-dev in your project.

affects: >=1.0.0

Errors

Common errors & fixes

Cannot find module 'office-addin-lint'

Package not installed or outdated npm cache

fix

Run npm install office-addin-lint --save-dev then clear cache with npm cache clean --force

TypeError: officeAddinLint is not a function

Using deprecated v2 function name in v3

fix

Use configure() instead of officeAddinLint(). See documentation.

Upgrade

Version history

3.0.7latest on npm

Audit

Dependencies

eslintrequiredCore linting engine

prettierrequiredCode formatting

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/OfficeDev/Office-Addin-Scripts ↗

packagehttps://www.npmjs.com/package/office-addin-lint ↗