osdoc-lint

library1.0.6jsnpmunverified

A simple code style lint utility that provides shared configurations for ESLint, Prettier, and Stylelint, designed to enforce consistent code quality. Current stable version is 1.0.6. It allows extending configurations and overriding rules. Differentiators include a single dependency approach and support for ESLint, Prettier, and Stylelint integration, though it relies on @umijs/fabric for Stylelint configuration. Release cadence is not documented; appears low activity.

testing

npm install osdoc-lint

github ↗package ↗

INSTALL

IMPORT

SIG · OSDOC-LINT

osdoc-lint

testingjavascriptv1.0.6

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.

eslint config

✓ extends: [require.resolve('osdoc-lint/eslint')]

✗ extends: ['osdoc-lint/eslint']

Must use require.resolve() to resolve path correctly in .eslintrc.js

prettier config

✓ const lint = require('osdoc-lint'); module.exports = { ...lint.prettier }

✗ import { prettier } from 'osdoc-lint'

CommonJS only; spread into .prettierrc.js

stylelint config

✓ extends: [require.resolve('@umijs/fabric/dist/stylelint')]

✗ extends: ['osdoc-lint/stylelint']

Stylelint config is from @umijs/fabric, not directly from osdoc-lint

Shows how to extend ESLint config, spread prettier config, and configure Stylelint using osdoc-lint.

// .eslintrc.js module.exports = { extends: [require.resolve('osdoc-lint/eslint')], rules: { 'jsx-a11y/alt-text': [0], }, }; // .prettierrc.js const lint = require('osdoc-lint'); module.exports = { ...lint.prettier, }; // .stylelintrc.js module.exports = { extends: [require.resolve('@umijs/fabric/dist/stylelint')], };

Debug

Known issues

gotchaStylelint config is not provided by osdoc-lint itself but by @umijs/fabric, which is a transitive dependency.

fix

Add @umijs/fabric as an explicit dependency or understand it's required.

affects: >=1.0.0

deprecatedThe package uses CommonJS (require) only; no ESM support.

fix

Use require() syntax; cannot import with ESM.

affects: >=1.0.0

gotchaESLint config path must use require.resolve() to resolve correctly; passing string directly may fail.

fix

Use require.resolve('osdoc-lint/eslint') in extends array.

affects: >=1.0.0

gotchaPrettier config must be spread into an object; directly assigning lint.prettier will not work as a config export.

fix

Use module.exports = { ...lint.prettier } or Object.assign.

affects: >=1.0.0

Errors

Common errors & fixes

Cannot find module 'osdoc-lint/eslint'

Using a string path without require.resolve() or incorrect module resolution.

fix

Use require.resolve('osdoc-lint/eslint') in the extends array.

TypeError: Cannot spread non-iterable instance

Trying to spread lint.prettier incorrectly or lint is undefined.

fix

Ensure const lint = require('osdoc-lint'); returns an object with a prettier property.

Configuration for rule 'jsx-a11y/alt-text' is invalid

Rule name misspelled or configuration format wrong.

fix

Check rule name and use array format: 'rule-name': [severity, options].

Failed to load config "osdoc-lint/eslint" to extend from

Missing dependency or incorrect file path.

fix

Install osdoc-lint as a dev dependency and use require.resolve().

Upgrade

Version history

1.0.6latest on npm

Audit

Dependencies

@umijs/fabricrequiredUsed for Stylelint configuration

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/osdoc-dev/osdoc-lint ↗

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