Skip to main content

File length linter for any language — single native binary, zero runtime deps

Project description

open-harness-scopelens

File length linter for any language. Reports files that exceed a configured line limit. Single native binary, zero runtime dependencies.

Part of the open-harness monorepo. Español abajo.

Same tool, other ecosystems: also available on npm (@open_harness/scopelens) and on Packagist (open-harness/scopelens). Identical binary, identical config; pick the registry that matches your stack.

Install

pip install open-harness-scopelens

pip picks the right native wheel for your platform automatically (Linux x86_64, macOS arm64, macOS x86_64, Windows x86_64). Each wheel embeds the Go binary — no runtime deps.

Usage

scopelens check               # scan current directory
scopelens check --fail        # exit 1 on violations (CI / git hooks)
scopelens check --dir ./src   # scan a specific directory
scopelens check --max 200     # override the line limit
scopelens check --no-color    # plain output for logs
scopelens init                # generate a default scopelens.json
scopelens version             # print version

Configuration

Place a scopelens.json at the repo root:

{
  "default": { "maxLines": 100 },
  "rules": [
    { "pattern": "**/*_test.go",     "maxLines": 300 },
    { "pattern": "**/*.spec.*",      "maxLines": 300 },
    { "pattern": "**/migrations/**", "skip": true }
  ],
  "exclude": ["node_modules", "vendor", ".git", "dist"]
}

Pattern semantics follow .gitignore style. The first matching rules entry wins; if no rule matches, default.maxLines applies.

Alternative: configure inside pyproject.toml or the dedicated scopelens.json

If you prefer not to keep a separate scopelens.json, add a scopelens key in your package.json with the same shape:

{
  "name": "my-project",
  "scopelens": {
    "default": { "maxLines": 100 },
    "rules": [{ "pattern": "**/*_test.go", "maxLines": 300 }],
    "exclude": ["node_modules", "dist"]
  }
}

Precedence: --config <path> > scopelens.json > package.json key > built-in defaults. CLI flags (--max, --no-color, etc.) always win.

Integrations

# Husky pre-commit
scopelens check --fail
# lefthook.yml
pre-commit:
  commands:
    scopelens:
      run: scopelens check --fail --no-color
# GitHub Actions
- name: Run scopelens
  run: npx @open_harness/scopelens check --fail

Why a line limit?

Large files concentrate too many responsibilities and become hard to read, test, and refactor. A soft cap (e.g. 100 lines, with exceptions for tests) keeps modules focused and forces responsibility-split decisions early — when they are cheap.

Exit codes

Code Meaning
0 No violations (or --fail not passed)
1 Violations found and --fail was passed, or config error

Español

Linter de longitud de archivos, agnóstico al lenguaje. Reporta los archivos que superan un límite de líneas configurable. Un solo binario nativo, cero dependencias en tiempo de ejecución.

Parte del monorepo open-harness.

Instalación

pip install open-harness-scopelens

pip elige automáticamente la wheel nativa correcta para tu plataforma (Linux x86_64, macOS arm64, macOS x86_64, Windows x86_64). Cada wheel embebe el binario Go — sin deps en runtime.

Uso

scopelens check               # escanea el directorio actual
scopelens check --fail        # exit 1 si hay violaciones (CI / git hooks)
scopelens check --dir ./src   # escanea un directorio específico
scopelens check --max 200     # sobrescribe el límite de líneas
scopelens check --no-color    # salida sin colores
scopelens init                # genera un scopelens.json por defecto
scopelens version             # imprime la versión

Configuración

Colocá un scopelens.json en la raíz del repo. Ver ejemplo arriba. La semántica de patrones sigue el estilo .gitignore. La primera regla coincidente en rules gana; si ninguna coincide, aplica default.maxLines.

Alternativa: configurar dentro de pyproject.toml o scopelens.json

Si preferís no tener un scopelens.json separado, agregá una key scopelens en tu package.json con la misma forma del archivo dedicado. Precedencia: --config <path> > scopelens.json > key en package.json > defaults del binario. Los flags CLI (--max, --no-color, etc.) siempre ganan.

Integraciones

Mismos snippets que arriba — sirven con Husky (.husky/pre-commit), lefthook (lefthook.yml) o GitHub Actions.

Por qué un límite de líneas

Los archivos grandes concentran demasiadas responsabilidades y son difíciles de leer, testear y refactorizar. Un tope blando (por ejemplo 100 líneas, con excepciones para tests) mantiene los módulos enfocados y obliga a tomar decisiones de partición temprano — cuando son baratas.

Códigos de salida

Código Significado
0 Sin violaciones (o no se pasó --fail)
1 Hubo violaciones con --fail, o error de configuración

License

MIT — see the main repository.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

open_harness_scopelens-0.1.0-py3-none-win_amd64.whl (2.3 MB view details)

Uploaded Python 3Windows x86-64

open_harness_scopelens-0.1.0-py3-none-macosx_11_0_arm64.whl (1.0 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

open_harness_scopelens-0.1.0-py3-none-macosx_10_9_x86_64.whl (1.1 MB view details)

Uploaded Python 3macOS 10.9+ x86-64

File details

Details for the file open_harness_scopelens-0.1.0-py3-none-win_amd64.whl.

File metadata

File hashes

Hashes for open_harness_scopelens-0.1.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 d1c604ce04b360266f34223a55111adba530dabdc76a58627678d92050cc59d7
MD5 74e72f84221254b2390722677a96ed32
BLAKE2b-256 9f839689d6ed3b4c633e8a4bea7f737a7615513e12864be354a1dcd4c0ab9440

See more details on using hashes here.

File details

Details for the file open_harness_scopelens-0.1.0-py3-none-manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for open_harness_scopelens-0.1.0-py3-none-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 5fac2f20808c703e72f9985ae450963e4421442e6f14243702ab7a9ab46a44b5
MD5 c7d49c852a6c404207257cb9c0f74d66
BLAKE2b-256 23e7fcf00322851ba9fe19feabd2b5ffe348221fac155ec5a5288893e532e613

See more details on using hashes here.

File details

Details for the file open_harness_scopelens-0.1.0-py3-none-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for open_harness_scopelens-0.1.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 3aa16f0906b66a943c533503376682c5697d8c3c557e99144b622c2281eea69d
MD5 197a713b149facc03cf37ef324daaea9
BLAKE2b-256 bb691850437e9368aeba45e35396ee1674b8dafab99fc8410487d48b7a147211

See more details on using hashes here.

File details

Details for the file open_harness_scopelens-0.1.0-py3-none-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for open_harness_scopelens-0.1.0-py3-none-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 effec24702fb8400be24d4eef853c46996100915cde7804da32aed4346f8ef3b
MD5 fa1e895f193bf61ce0db47ce5e060e86
BLAKE2b-256 d023607003a277fa2c3d4a66f6f8cb035257ff02aa4c58990d6d96cab02efbbb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page