Skip to main content

Permissive linter extensions for markup and data languages

Project description

GitHub Actions Codecov Renovate
PyPI TestPyPI Python
NPM Node

Stylebook

The Stylebook logo.

Third-party linter rules and configuration for various data formats not considered as a programming language.

Runner File type Linter Style
Python SQL SQLFluff Mozilla SQL Style Guide
TOML Taplo TOML Spec
YAML yamllint YAML Spec
Node CSS Stylelint Mozilla HTML Coding Guide
HTML HTMLHint Mozilla HTML Style Guide
JSON JSON Lint JSON5 Spec
Markdown markdownlint GitHub Flavored Markdown Spec

Download

PyPI

pip install stylebook-data

NPM

npm install stylebook-markup \
  stylelint @stylistic/stylelint-plugin stylelint-config-recommended \
  @prantlf/jsonlint \
  markdownlint markdownlint-cli2 --save-dev

Usage

Insert target paths into the command. The program will recursively search for qualifying file types and spawn the corresponding linter processes.

npm exec stylebook some-folder/ some-file.sql
source .venv/bin/activate && stylebook **/* # or use uv run

SQLFluff

No setup is necessary. However, to customize behaviors, a local .sqlfluff is needed.

tomllint

No setup is necessary. However, to customize behaviors, a local .taplo.toml is needed.

yamllint

No setup is necessary. However, to customize behaviors, a local .yamllintrc.json is needed.

Stylelint

Create .stylint.config.js file in the root directory.

HTML Hint

No setup is necessary. However, to customize behaviors, a local .htmlhintrc is needed.

JSON Lint

No setup is necessary. However, to customize behaviors, a local .jsonlintrc.config.json is needed.

markdownlint

No setup is necessary. However, to customize behaviors, a local .markdownlint-cli2.json is needed.

Project details


Release history Release notifications | RSS feed

This version

0.1

Download files

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

Source Distribution

stylebook-0.1.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

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

stylebook-0.1-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file stylebook-0.1.tar.gz.

File metadata

  • Download URL: stylebook-0.1.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for stylebook-0.1.tar.gz
Algorithm Hash digest
SHA256 af09a7f1e5bf8e55fc24039ccb3adc35995c969572d6c899a6ee8d69253f5d46
MD5 9750dc32026187df92467c482b33e730
BLAKE2b-256 9b76bf8974d66a3573ee34e187ae04ea3134a0f9eec3baa02fe392d2dd0af106

See more details on using hashes here.

File details

Details for the file stylebook-0.1-py3-none-any.whl.

File metadata

  • Download URL: stylebook-0.1-py3-none-any.whl
  • Upload date:
  • Size: 6.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for stylebook-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bad3407105943c21a02e86e4591e409259585583aadbbb2ace9e11af955e3d29
MD5 f3618ef68b368000c1b77ed15052c88e
BLAKE2b-256 7190f04e872699dda03772688a0a2c34588419e823750293b1a000c09698b27c

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