folder-lint

library1.0.5jsnpmunverified

A library for linting folder structures, currently at version 1.0.5. Designed to enforce directory conventions in projects using custom rules. Differentiates from standard linters by focusing on file system layout rather than code style. Latest release is stable, with no recent updates. The package ships TypeScript types for use in TS projects. It is a small utility primarily configured via Node.js scripts.

testing devops

npm install folder-lint

github ↗package ↗

INSTALL

IMPORT

SIG · FOLDER-LINT

folder-lint

testingjavascriptv1.0.5

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.

folderLint

✓ import folderLint from 'folder-lint'

✗ const folderLint = require('folder-lint')

Package supports both ESM and CJS; ESM recommended for modern projects.

checkStructure

✓ import { checkStructure } from 'folder-lint'

✗ import { checkStructure } from 'folder-lint'

Named export available; no wrong pattern documented.

Demonstrates basic usage: check current directory against a custom rule that disallows nested 'dist' folders.

import folderLint from 'folder-lint'; const result = folderLint.checkStructure('.', { rules: { 'no-nested-dist': true, }, }); if (result.errors.length > 0) { console.error('Folder structure violation:', result.errors); } else { console.log('Structure OK'); }

folder-lint --version

Debug

Known issues

gotchaRule names are case-insensitive but use kebab-case in documentation; mixing case may cause unexpected behavior.

fix

Always use kebab-case for rule names (e.g., 'no-nested-dist').

affects: >=1.0.0

Errors

Common errors & fixes

Cannot find module 'folder-lint'

Package not installed or import path incorrect.

fix

Run 'npm install folder-lint' and ensure import matches version syntax.

Upgrade

Version history

1.0.5latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/servicetitan/folder-lint ↗

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